X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=tests%2Futils%2Futils.sh;h=e2b730923685828301a158ecbba35a19e3fc1402;hb=ecd7492f21a492b70569d5ecc1d3a808241b63f0;hp=3cbea1609d07666d0c046e65fe726422b35a7f37;hpb=0b0893d4a069f17d1326ebc3bfc9f9f987f411f3;p=babeltrace.git diff --git a/tests/utils/utils.sh b/tests/utils/utils.sh index 3cbea160..e2b73092 100644 --- a/tests/utils/utils.sh +++ b/tests/utils/utils.sh @@ -25,7 +25,7 @@ fi # We do a bit of translation to ease our life down the road for comparison. # Export it so that called executables can use it. # [1] https://en.wikipedia.org/wiki/Uname#Examples -if [ "x${BT_TESTS_OS_TYPE:-}" = "x" ]; then +if [ -z "${BT_TESTS_OS_TYPE:-}" ]; then BT_TESTS_OS_TYPE="$(uname -s)" case "$BT_TESTS_OS_TYPE" in MINGW*) @@ -48,12 +48,12 @@ fi export BT_TESTS_OS_TYPE # Allow overriding the source and build directories -if [ "x${BT_TESTS_SRCDIR:-}" = "x" ]; then +if [ -z "${BT_TESTS_SRCDIR:-}" ]; then BT_TESTS_SRCDIR="$testsdir" fi export BT_TESTS_SRCDIR -if [ "x${BT_TESTS_BUILDDIR:-}" = "x" ]; then +if [ -z "${BT_TESTS_BUILDDIR:-}" ]; then BT_TESTS_BUILDDIR="$testsdir" fi export BT_TESTS_BUILDDIR @@ -66,7 +66,7 @@ if [ -f "${BT_TESTS_BUILDDIR}/utils/env.sh" ]; then fi # Allow overriding the babeltrace2 executables -if [ "x${BT_TESTS_BT2_BIN:-}" = "x" ]; then +if [ -z "${BT_TESTS_BT2_BIN:-}" ]; then BT_TESTS_BT2_BIN="$BT_TESTS_BUILDDIR/../src/cli/babeltrace2" if [ "$BT_TESTS_OS_TYPE" = "mingw" ]; then BT_TESTS_BT2_BIN="${BT_TESTS_BT2_BIN}.exe" @@ -78,50 +78,52 @@ export BT_TESTS_BT2_BIN BT_PLUGINS_PATH="${BT_TESTS_BUILDDIR}/../src/plugins" # Allow overriding the babeltrace2 plugin path -if [ "x${BT_TESTS_BABELTRACE_PLUGIN_PATH:-}" = "x" ]; then +if [ -z "${BT_TESTS_BABELTRACE_PLUGIN_PATH:-}" ]; then BT_TESTS_BABELTRACE_PLUGIN_PATH="${BT_PLUGINS_PATH}/ctf:${BT_PLUGINS_PATH}/utils:${BT_PLUGINS_PATH}/text:${BT_PLUGINS_PATH}/lttng-utils" fi export BT_TESTS_BABELTRACE_PLUGIN_PATH -if [ "x${BT_TESTS_PROVIDER_DIR:-}" = "x" ]; then +if [ -z "${BT_TESTS_PROVIDER_DIR:-}" ]; then BT_TESTS_PROVIDER_DIR="${BT_TESTS_BUILDDIR}/../src/python-plugin-provider/.libs" fi export BT_TESTS_PROVIDER_DIR # Allow overriding the babeltrace2 executables -if [ "x${BT_TESTS_PYTHONPATH:-}" = "x" ]; then +if [ -z "${BT_TESTS_PYTHONPATH:-}" ]; then BT_TESTS_PYTHONPATH="${BT_TESTS_BUILDDIR}/../src/bindings/python/bt2/build/build_lib" fi export BT_TESTS_PYTHONPATH ### External Tools ### -if [ "x${BT_TESTS_AWK_BIN:-}" = "x" ]; then +if [ -z "${BT_TESTS_AWK_BIN:-}" ]; then BT_TESTS_AWK_BIN="awk" fi export BT_TESTS_AWK_BIN -if [ "x${BT_TESTS_GREP_BIN:-}" = "x" ]; then +if [ -z "${BT_TESTS_GREP_BIN:-}" ]; then BT_TESTS_GREP_BIN="grep" fi export BT_TESTS_GREP_BIN -if [ "x${BT_TESTS_PYTHON_BIN:-}" = "x" ]; then +if [ -z "${BT_TESTS_PYTHON_BIN:-}" ]; then BT_TESTS_PYTHON_BIN="python3" fi export BT_TESTS_PYTHON_BIN -if [ "x${BT_TESTS_PYTHON_CONFIG_BIN:-}" = "x" ]; then +BT_TESTS_PYTHON_VERSION=$($BT_TESTS_PYTHON_BIN -c 'import sys; print("{}.{}".format(sys.version_info.major, sys.version_info.minor))') + +if [ -z "${BT_TESTS_PYTHON_CONFIG_BIN:-}" ]; then BT_TESTS_PYTHON_CONFIG_BIN="python3-config" fi export BT_TESTS_PYTHON_CONFIG_BIN -if [ "x${BT_TESTS_SED_BIN:-}" = "x" ]; then +if [ -z "${BT_TESTS_SED_BIN:-}" ]; then BT_TESTS_SED_BIN="sed" fi export BT_TESTS_SED_BIN -if [ "x${BT_TESTS_CC_BIN:-}" = "x" ]; then +if [ -z "${BT_TESTS_CC_BIN:-}" ]; then BT_TESTS_CC_BIN="cc" fi export BT_TESTS_CC_BIN @@ -129,7 +131,7 @@ export BT_TESTS_CC_BIN ### Optional features ### -if [ "x${BT_TESTS_ENABLE_ASAN:-}" = "x" ]; then +if [ -z "${BT_TESTS_ENABLE_ASAN:-}" ]; then BT_TESTS_ENABLE_ASAN="0" fi export BT_TESTS_ENABLE_ASAN @@ -142,7 +144,7 @@ BT_CTF_TRACES_PATH="${BT_TESTS_DATADIR}/ctf-traces" # By default, it will not source tap.sh. If you want to output tap directly # from the test script, define the 'SH_TAP' variable to '1' before sourcing # this script. -if [ "x${SH_TAP:-}" = x1 ]; then +if [ "${SH_TAP:-}" = 1 ]; then # shellcheck source=./tap/tap.sh . "${BT_TESTS_SRCDIR}/utils/tap/tap.sh" fi @@ -151,7 +153,7 @@ fi # Remove CR characters in file "$1". bt_remove_cr() { - "$BT_TESTS_SED_BIN" -i 's/\r//g' "$1" + "$BT_TESTS_SED_BIN" -i'' -e 's/\r//g' "$1" } # Run the Babeltrace CLI, redirecting stdout and stderr to specified files. @@ -226,8 +228,8 @@ bt_diff_cli() { local ret_stdout local ret_stderr - temp_stdout_output_file="$(mktemp -t actual_stdout.XXXXXX)" - temp_stderr_output_file="$(mktemp -t actual_stderr.XXXXXX)" + temp_stdout_output_file="$(mktemp -t actual-stdout.XXXXXX)" + temp_stderr_output_file="$(mktemp -t actual-stderr.XXXXXX)" # Run the CLI to get a detailed file. bt_cli "$temp_stdout_output_file" "$temp_stderr_output_file" "${args[@]}" @@ -302,38 +304,50 @@ check_coverage() { coverage run "$@" } +# Execute a shell command in the appropriate environment to access the Python +# test utility modules in `tests/utils/python`. +run_python() { + local our_pythonpath="${BT_TESTS_SRCDIR}/utils/python" + + if [[ $BT_TESTS_PYTHON_VERSION =~ 3.[45] ]]; then + # Add a local directory containing a `typing.py` to `PYTHONPATH` for + # Python 3.4 which doesn't offer the `typing` module. + our_pythonpath="$our_pythonpath:${BT_TESTS_SRCDIR}/utils/python/typing" + fi + + PYTHONPATH="${our_pythonpath}${PYTHONPATH:+:}${PYTHONPATH:-}" "$@" +} + # Execute a shell command in the appropriate environment to have access to the # bt2 Python bindings. run_python_bt2() { - local env_args local lib_asan - - env_args=( - "BABELTRACE_PYTHON_BT2_NO_TRACEBACK=1" \ - "BABELTRACE_PLUGIN_PATH=${BT_TESTS_BABELTRACE_PLUGIN_PATH}" \ - "LIBBABELTRACE2_PLUGIN_PROVIDER_DIR=${BT_TESTS_PROVIDER_DIR}" \ - "BT_TESTS_DATADIR=${BT_TESTS_DATADIR}" \ - "BT_CTF_TRACES_PATH=${BT_CTF_TRACES_PATH}" \ - "BT_PLUGINS_PATH=${BT_PLUGINS_PATH}" \ - "PYTHONPATH=${BT_TESTS_PYTHONPATH}:${BT_TESTS_SRCDIR}/utils/python" - ) + local -x "BABELTRACE_PYTHON_BT2_NO_TRACEBACK=1" + local -x "BABELTRACE_PLUGIN_PATH=${BT_TESTS_BABELTRACE_PLUGIN_PATH}" + local -x "LIBBABELTRACE2_PLUGIN_PROVIDER_DIR=${BT_TESTS_PROVIDER_DIR}" + local -x "BT_TESTS_DATADIR=${BT_TESTS_DATADIR}" + local -x "BT_CTF_TRACES_PATH=${BT_CTF_TRACES_PATH}" + local -x "BT_PLUGINS_PATH=${BT_PLUGINS_PATH}" + local -x "PYTHONPATH=${BT_TESTS_PYTHONPATH}${PYTHONPATH:+:}${PYTHONPATH:-}" local main_lib_path="${BT_TESTS_BUILDDIR}/../src/lib/.libs" # Set the library search path so the python interpreter can load libbabeltrace2 if [ "$BT_TESTS_OS_TYPE" = "mingw" ] || [ "$BT_TESTS_OS_TYPE" = "cygwin" ]; then - env_args+=("PATH=${main_lib_path}:${PATH:-}") + local -x PATH="${main_lib_path}${PATH:+:}${PATH:-}" elif [ "$BT_TESTS_OS_TYPE" = "darwin" ]; then - env_args+=("DYLD_LIBRARY_PATH=${main_lib_path}:${DYLD_LIBRARY_PATH:-}") + local -x DYLD_LIBRARY_PATH="${main_lib_path}${DYLD_LIBRARY_PATH:+:}${DYLD_LIBRARY_PATH:-}" else - env_args+=("LD_LIBRARY_PATH=${main_lib_path}:${LD_LIBRARY_PATH:-}") + local -x LD_LIBRARY_PATH="${main_lib_path}${LD_LIBRARY_PATH:+:}${LD_LIBRARY_PATH:-}" fi # On Windows, an embedded Python interpreter needs a way to locate the path - # to it's internal modules, set the prefix from python-config to the + # to its internal modules, set the prefix from python-config to the # PYTHONHOME variable. if [ "$BT_TESTS_OS_TYPE" = "mingw" ]; then - env_args+=("PYTHONHOME=$($BT_TESTS_PYTHON_CONFIG_BIN --prefix)") + local -x PYTHONHOME + + PYTHONHOME=$($BT_TESTS_PYTHON_CONFIG_BIN --prefix) fi # If AddressSanitizer is used, we must preload libasan.so so that @@ -343,14 +357,16 @@ run_python_bt2() { # leaks, so we must unfortunately disable leak detection. Append it to # existing ASAN_OPTIONS, such that we override the user's value if it # contains detect_leaks=1. - if [ "x${BT_TESTS_ENABLE_ASAN:-}" = "x1" ]; then - lib_asan=$(${BT_TESTS_CC_BIN} -print-file-name=libasan.so) + if [ "${BT_TESTS_ENABLE_ASAN:-}" = "1" ]; then + if ${BT_TESTS_CC_BIN} --version | head -n 1 | grep -q '^gcc'; then + lib_asan="$(${BT_TESTS_CC_BIN} -print-file-name=libasan.so)" + local -x LD_PRELOAD="${lib_asan}${LD_PRELOAD:+:}${LD_PRELOAD:-}" + fi - env_args+=("LD_PRELOAD=${lib_asan}:${LD_PRELOAD:-}") - env_args+=("ASAN_OPTIONS=${ASAN_OPTIONS:-},detect_leaks=0") + local -x "ASAN_OPTIONS=${ASAN_OPTIONS:-}${ASAN_OPTIONS:+,}detect_leaks=0" fi - env "${env_args[@]}" "$@" + run_python "$@" } # Set the environment and run python tests in the directory. @@ -365,11 +381,11 @@ run_python_bt2_test() { local test_runner_args=() test_runner_args+=("$test_dir") - if [ "x${test_pattern}" != "x" ]; then + if [ -n "${test_pattern}" ]; then test_runner_args+=("${test_pattern}") fi - if test "x${BT_TESTS_COVERAGE:-}" = "x1"; then + if test "${BT_TESTS_COVERAGE:-}" = "1"; then python_exec="check_coverage" else python_exec="${BT_TESTS_PYTHON_BIN}" @@ -383,13 +399,26 @@ run_python_bt2_test() { ret=$? - if test "x${BT_TESTS_COVERAGE_REPORT:-}" = "x1"; then + if test "${BT_TESTS_COVERAGE_REPORT:-}" = "1"; then coverage report -m fi - if test "x${BT_TESTS_COVERAGE_HTML:-}" = "x1"; then + if test "${BT_TESTS_COVERAGE_HTML:-}" = "1"; then coverage html fi return $ret } + +# Generate a CTF trace using `mctf.py`. +# +# $1: Input filename +# $2: Base directory path for output files +gen_mctf_trace() { + local input_file="$1" + local base_dir="$2" + + diag "Running: ${BT_TESTS_PYTHON_BIN} ${BT_TESTS_SRCDIR}/utils/python/mctf.py --base-dir ${base_dir} ${input_file}" + run_python "${BT_TESTS_PYTHON_BIN}" "${BT_TESTS_SRCDIR}/utils/python/mctf.py" \ + --base-dir "${base_dir}" "${input_file}" +}