X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=tests%2Futils%2Futils.sh;h=6c87f309df9efdbb6ac66437fab9727e89d1e358;hb=90a8a0f23a364a3e1e3b7702c57b9c22473500a3;hp=27a5f3ee903e4fd85d165a151fcf3955ab58383c;hpb=58db335ee64dfdedc0e351fd8e1524e7ca381896;p=babeltrace.git diff --git a/tests/utils/utils.sh b/tests/utils/utils.sh index 27a5f3ee..6c87f309 100644 --- a/tests/utils/utils.sh +++ b/tests/utils/utils.sh @@ -22,7 +22,14 @@ # Error out when encountering an undefined variable set -u +# If "readlink -f" is available, get a resolved absolute path to the +# tests source dir, otherwise make do with a relative path. scriptdir="$(dirname "${BASH_SOURCE[0]}")" +if readlink -f "." >/dev/null 2>&1; then + testsdir=$(readlink -f "$scriptdir/..") +else + testsdir="$scriptdir/.." +fi # The OS on which we are running. See [1] for possible values of 'uname -s'. # We do a bit of translation to ease our life down the road for comparison. @@ -52,12 +59,12 @@ export BT_OS_TYPE # Allow overriding the source and build directories if [ "x${BT_TESTS_SRCDIR:-}" = "x" ]; then - BT_TESTS_SRCDIR="$scriptdir/.." + BT_TESTS_SRCDIR="$testsdir" fi export BT_TESTS_SRCDIR if [ "x${BT_TESTS_BUILDDIR:-}" = "x" ]; then - BT_TESTS_BUILDDIR="$scriptdir/.." + BT_TESTS_BUILDDIR="$testsdir" fi export BT_TESTS_BUILDDIR @@ -78,20 +85,12 @@ if [ "x${BT_TESTS_BT2_BIN:-}" = "x" ]; then fi export BT_TESTS_BT2_BIN -if [ "x${BT_TESTS_BT2LOG_BIN:-}" = "x" ]; then - BT_TESTS_BT2LOG_BIN="$BT_TESTS_BUILDDIR/../src/cli/babeltrace2-log" - if [ "$BT_OS_TYPE" = "mingw" ]; then - BT_TESTS_BT2LOG_BIN="${BT_TESTS_BT2LOG_BIN}.exe" - fi -fi -export BT_TESTS_BT2LOG_BIN - # TODO: Remove when bindings/python/bt2/test_plugin.py is fixed BT_PLUGINS_PATH="${BT_TESTS_BUILDDIR}/../src/plugins" # Allow overriding the babeltrace2 plugin path if [ "x${BT_TESTS_BABELTRACE_PLUGIN_PATH:-}" = "x" ]; then - BT_TESTS_BABELTRACE_PLUGIN_PATH="${BT_PLUGINS_PATH}/ctf:${BT_PLUGINS_PATH}/utils:${BT_PLUGINS_PATH}/text" + BT_TESTS_BABELTRACE_PLUGIN_PATH="${BT_PLUGINS_PATH}/ctf:${BT_PLUGINS_PATH}/utils:${BT_PLUGINS_PATH}/text:${BT_PLUGINS_PATH}/lttng-utils" fi if [ "x${BT_TESTS_PROVIDER_DIR:-}" = "x" ]; then @@ -120,6 +119,11 @@ if [ "x${BT_TESTS_PYTHON_BIN:-}" = "x" ]; then fi export BT_TESTS_PYTHON_BIN +if [ "x${BT_TESTS_PYTHON_CONFIG_BIN:-}" = "x" ]; then + BT_TESTS_PYTHON_CONFIG_BIN="python3-config" +fi +export BT_TESTS_PYTHON_CONFIG_BIN + if [ "x${BT_TESTS_SED_BIN:-}" = "x" ]; then BT_TESTS_SED_BIN="sed" fi @@ -129,11 +133,59 @@ export BT_TESTS_SED_BIN # Data files path BT_TESTS_DATADIR="${BT_TESTS_SRCDIR}/data" BT_CTF_TRACES_PATH="${BT_TESTS_DATADIR}/ctf-traces" -BT_DEBUG_INFO_PATH="${BT_TESTS_DATADIR}/debug-info" +# Remove CR characters in file "$1". + +bt_remove_cr() { + "$BT_TESTS_SED_BIN" -i 's/\r//g' "$1" +} + +# Run the Babeltrace CLI, redirecting stdout and stderr to specified files. +# +# $1: file to redirect stdout to +# $2: file to redirect stderr to +# remaining args: arguments to pass to the CLI +# +# Return the exit code of the CLI. + +bt_cli() { + local stdout_file="$1" + local stderr_file="$2" + shift 2 + local args=("$@") + + echo "Running: $BT_TESTS_BT2_BIN ${args[*]}" >&2 + run_python_bt2 "$BT_TESTS_BT2_BIN" "${args[@]}" 1>"$stdout_file" 2>"$stderr_file" +} ### Diff Functions ### +# Check the differences between two files (typically some expected output vs +# some actual output). If there are differences, print the diff to stderr. +# +# $1: file 1 (expected) +# $2: file 2 (actual) +# +# Return 0 if there's no difference, and non-zero if there are. +# +# Note that this function modifies the actual output file ($2) _in-place_ to +# remove any \r character. + +bt_diff() { + local expected_file="$1" + local actual_file="$2" + local ret=0 + + # Strip any \r present due to Windows (\n -> \r\n). + # "diff --string-trailing-cr" is not used since it is not present on + # Solaris. + bt_remove_cr "$actual_file" + + diff -u "$expected_file" "$actual_file" 1>&2 + + return $? +} + # Checks the difference between: # # 1. What the CLI outputs on its standard output when given the arguments @@ -156,37 +208,26 @@ bt_diff_cli() { local temp_stdout_output_file local temp_stderr_output_file - local temp_diff local ret=0 + local ret_stdout + local ret_stderr - temp_stdout_output_file="$(mktemp)" - temp_stderr_output_file="$(mktemp)" - temp_diff="$(mktemp)" + 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. - run_python_bt2 "$BT_TESTS_BT2_BIN" "${args[@]}" 1>"$temp_stdout_output_file" 2>"$temp_stderr_output_file" + bt_cli "$temp_stdout_output_file" "$temp_stderr_output_file" "${args[@]}" - # Strip any \r present due to Windows (\n -> \r\n). - # "diff --string-trailing-cr" is not used since it is not present on - # Solaris. - "$BT_TESTS_SED_BIN" -i 's/\r//g' "$temp_stdout_output_file" - "$BT_TESTS_SED_BIN" -i 's/\r//g' "$temp_stderr_output_file" + bt_diff "$expected_stdout_file" "$temp_stdout_output_file" "${args[@]}" + ret_stdout=$? + bt_diff "$expected_stderr_file" "$temp_stderr_output_file" "${args[@]}" + ret_stderr=$? - # Compare stdout output with expected stdout output - if ! diff -u "$temp_stdout_output_file" "$expected_stdout_file" 2>/dev/null >"$temp_diff"; then - echo "ERROR: for '${args[*]}': actual standard output and expected output differ:" >&2 - cat "$temp_diff" >&2 + if ((ret_stdout != 0 || ret_stderr != 0)); then ret=1 fi - # Compare stderr output with expected stderr output - if ! diff -u "$temp_stderr_output_file" "$expected_stderr_file" 2>/dev/null >"$temp_diff"; then - echo "ERROR: for '${args[*]}': actual standard error and expected error differ:" >&2 - cat "$temp_diff" >&2 - ret=1 - fi - - rm -f "$temp_stdout_output_file" "$temp_stderr_output_file" "$temp_diff" + rm -f "$temp_stdout_output_file" "$temp_stderr_output_file" return $ret } @@ -206,7 +247,8 @@ bt_diff_details_ctf_single() { expected_stderr_file="/dev/null" # Compare using the CLI with `sink.text.details` - bt_diff_cli "$expected_stdout_file" "$expected_stderr_file" "$trace_dir" "-c" "sink.text.details" "${extra_details_args[@]}" + bt_diff_cli "$expected_stdout_file" "$expected_stderr_file" "$trace_dir" \ + "-c" "sink.text.details" "${extra_details_args[@]+${extra_details_args[@]}}" } # Calls bt_diff_details_ctf_single(), except that "$1" is the path to a @@ -232,7 +274,8 @@ bt_diff_details_ctf_gen_single() { fi # Compare using the CLI with `sink.text.details` - bt_diff_details_ctf_single "$expected_stdout_file" "$temp_trace_dir" "${extra_details_args[@]}" + bt_diff_details_ctf_single "$expected_stdout_file" "$temp_trace_dir" \ + "${extra_details_args[@]+${extra_details_args[@]}}" ret=$? rm -rf "$temp_trace_dir" return $ret @@ -248,32 +291,37 @@ check_coverage() { # Execute a shell command in the appropriate environment to have access to the # bt2 Python bindings. run_python_bt2() { - local lib_search_var - local lib_search_path + local env_args + + 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 main_lib_path="${BT_TESTS_BUILDDIR}/../src/lib/.libs" # Set the library search path so the python interpreter can load libbabeltrace2 if [ "$BT_OS_TYPE" = "mingw" ] || [ "$BT_OS_TYPE" = "cygwin" ]; then - lib_search_var="PATH" - lib_search_path="${main_lib_path}:${PATH:-}" + env_args+=("PATH=${main_lib_path}:${PATH:-}") elif [ "$BT_OS_TYPE" = "darwin" ]; then - lib_search_var="DYLD_LIBRARY_PATH" - lib_search_path="${main_lib_path}:${DYLD_LIBRARY_PATH:-}" + env_args+=("DYLD_LIBRARY_PATH=${main_lib_path}:${DYLD_LIBRARY_PATH:-}") else - lib_search_var="LD_LIBRARY_PATH" - lib_search_path="${main_lib_path}:${LD_LIBRARY_PATH:-}" + env_args+=("LD_LIBRARY_PATH=${main_lib_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 + # PYTHONHOME variable. + if [ "$BT_OS_TYPE" = "mingw" ]; then + env_args+=("PYTHONHOME=$($BT_TESTS_PYTHON_CONFIG_BIN --prefix)") fi - env \ - BABELTRACE_PYTHON_BT2_NO_TRACEBACK=1 \ - BABELTRACE_PLUGIN_PATH="${BT_TESTS_BABELTRACE_PLUGIN_PATH}" \ - LIBBABELTRACE2_PLUGIN_PROVIDER_DIR=${BT_TESTS_PROVIDER_DIR} \ - BT_CTF_TRACES_PATH="${BT_CTF_TRACES_PATH}" \ - BT_PLUGINS_PATH="${BT_PLUGINS_PATH}" \ - PYTHONPATH="${BT_TESTS_PYTHONPATH}:${BT_TESTS_SRCDIR}/utils/python" \ - "${lib_search_var}"="${lib_search_path}" \ - "$@" + env "${env_args[@]}" "$@" } # Set the environment and run python tests in the directory.