X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=tests%2Futils%2Futils.sh;h=69fb84714a72469095f014fb9b988bc88c3dbab5;hb=d8f6e7fb3f682ac97d7498e7041df82b4574f6b7;hp=27a5f3ee903e4fd85d165a151fcf3955ab58383c;hpb=ca5f10448a7b4e89d9a8a922c78eacb7fdadf1b8;p=babeltrace.git diff --git a/tests/utils/utils.sh b/tests/utils/utils.sh index 27a5f3ee..69fb8471 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 @@ -120,6 +127,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_BIN + if [ "x${BT_TESTS_SED_BIN:-}" = "x" ]; then BT_TESTS_SED_BIN="sed" fi @@ -129,11 +141,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" ### Diff Functions ### +# Checks the difference between stdout: +# +# The file with path "$1", and the file with path "$2" +# +# And the difference between stderr: +# +# The file with path "$3", and the file with path "$4" +# +# Returns 0 if there's no difference, and 1 if there is, also printing +# said difference to the standard error, and an error message with the +# args starting at "$5". +bt_diff() { + local expected_stdout_file="$1" + local actual_stdout_file="$2" + local expected_stderr_file="$3" + local actual_stderr_file="$4" + shift 4 + local args=("$@") + + local ret=0 + local temp_diff + + temp_diff="$(mktemp -t diff.XXXXXX)" + + # 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' "$actual_stdout_file" + "$BT_TESTS_SED_BIN" -i 's/\r//g' "$actual_stderr_file" + + # Compare stdout output with expected stdout output + if ! diff -u "$actual_stdout_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 + ret=1 + fi + + # Compare stderr output with expected stderr output + if ! diff -u "$actual_stderr_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_diff" + + return $ret +} + # Checks the difference between: # # 1. What the CLI outputs on its standard output when given the arguments @@ -156,37 +216,60 @@ bt_diff_cli() { local temp_stdout_output_file local temp_stderr_output_file - local temp_diff local ret=0 - 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" - # 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" "$expected_stderr_file" "$temp_stderr_output_file" "${args[@]}" + ret=$? - # 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 - ret=1 - fi + rm -f "$temp_stdout_output_file" "$temp_stderr_output_file" - # 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 + return $ret +} - rm -f "$temp_stdout_output_file" "$temp_stderr_output_file" "$temp_diff" +# Checks the difference between: +# +# 1. What the CLI outputs on its standard output when given the arguments +# "$@" (excluding the first two arguments), sorted with the default "sort". +# 2. The file with path "$1". +# +# And the difference between: +# +# 1. What the CLI outputs on its standard error when given the arguments +# "$@" (excluding the first two arguments). +# 2. The file with path "$2". +# +# Returns 0 if there's no difference, and 1 if there is, also printing +# said difference to the standard error. +bt_diff_cli_sorted() { + local expected_stdout_file="$1" + local expected_stderr_file="$2" + shift 2 + local args=("$@") + + local temp_stdout_output_file + local temp_stderr_output_file + local ret=0 + + 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" + + # Sort the stdout file, use a subshell to do it in-place + # shellcheck disable=SC2005 + echo "$(LC_ALL=C sort "$temp_stdout_output_file")" > "$temp_stdout_output_file" + + bt_diff "$expected_stdout_file" "$temp_stdout_output_file" "$expected_stderr_file" "$temp_stderr_output_file" "${args[@]}" + ret=$? + + rm -f "$temp_stdout_output_file" "$temp_stderr_output_file" return $ret } @@ -248,32 +331,36 @@ 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_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.