X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=tests%2Futils%2Futils.sh;h=afdc856bf12ad07881ac962a679ad2226a4ef3f7;hb=a0baab4a979e830f7dc4698c20b71e84dea6ff9d;hp=5691721be67969d966dcd3cfea14db79afed52c6;hpb=22703f66b1011d07a5afb1ae5b766784158f27bd;p=babeltrace.git diff --git a/tests/utils/utils.sh b/tests/utils/utils.sh index 5691721b..afdc856b 100644 --- a/tests/utils/utils.sh +++ b/tests/utils/utils.sh @@ -1,20 +1,10 @@ #!/bin/bash - -# Copyright (c) 2019 Michael Jeanson -# Copyright (C) 2019 Philippe Proulx # -# This program is free software; you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation; under version 2 of the License. +# SPDX-License-Identifier: GPL-2.0-only # -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. +# Copyright (c) 2019 Michael Jeanson +# Copyright (C) 2019 Philippe Proulx # -# You should have received a copy of the GNU General Public License along -# with this program; if not, write to the Free Software Foundation, Inc., -# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. # This file is meant to be sourced at the start of shell script-based tests. @@ -35,27 +25,27 @@ 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_OS_TYPE:-}" = "x" ]; then - BT_OS_TYPE="$(uname -s)" - case "$BT_OS_TYPE" in +if [ "x${BT_TESTS_OS_TYPE:-}" = "x" ]; then + BT_TESTS_OS_TYPE="$(uname -s)" + case "$BT_TESTS_OS_TYPE" in MINGW*) - BT_OS_TYPE="mingw" + BT_TESTS_OS_TYPE="mingw" ;; Darwin) - BT_OS_TYPE="darwin" + BT_TESTS_OS_TYPE="darwin" ;; Linux) - BT_OS_TYPE="linux" + BT_TESTS_OS_TYPE="linux" ;; CYGWIN*) - BT_OS_TYPE="cygwin" + BT_TESTS_OS_TYPE="cygwin" ;; *) - BT_OS_TYPE="unsupported" + BT_TESTS_OS_TYPE="unsupported" ;; esac fi -export BT_OS_TYPE +export BT_TESTS_OS_TYPE # Allow overriding the source and build directories if [ "x${BT_TESTS_SRCDIR:-}" = "x" ]; then @@ -79,7 +69,7 @@ fi # Allow overriding the babeltrace2 executables if [ "x${BT_TESTS_BT2_BIN:-}" = "x" ]; then BT_TESTS_BT2_BIN="$BT_TESTS_BUILDDIR/../src/cli/babeltrace2" - if [ "$BT_OS_TYPE" = "mingw" ]; then + if [ "$BT_TESTS_OS_TYPE" = "mingw" ]; then BT_TESTS_BT2_BIN="${BT_TESTS_BT2_BIN}.exe" fi fi @@ -90,7 +80,7 @@ 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 @@ -134,6 +124,12 @@ export BT_TESTS_SED_BIN BT_TESTS_DATADIR="${BT_TESTS_SRCDIR}/data" BT_CTF_TRACES_PATH="${BT_TESTS_DATADIR}/ctf-traces" +# 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 @@ -148,58 +144,36 @@ bt_cli() { 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 ### -# Checks the difference between stdout: +# Check the differences between two files (typically some expected output vs +# some actual output). If there are differences, print the diff to stderr. # -# The file with path "$1", and the file with path "$2" +# $1: file 1 (expected) +# $2: file 2 (actual) # -# And the difference between stderr: +# Return 0 if there's no difference, and non-zero if there are. # -# 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=("$@") +# 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 - 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" + bt_remove_cr "$actual_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" + diff -u "$expected_file" "$actual_file" 1>&2 - return $ret + return $? } # Checks the difference between: @@ -225,6 +199,8 @@ bt_diff_cli() { local temp_stdout_output_file local temp_stderr_output_file local ret=0 + local ret_stdout + local ret_stderr temp_stdout_output_file="$(mktemp -t actual_stdout.XXXXXX)" temp_stderr_output_file="$(mktemp -t actual_stderr.XXXXXX)" @@ -232,50 +208,14 @@ bt_diff_cli() { # Run the CLI to get a detailed file. bt_cli "$temp_stdout_output_file" "$temp_stderr_output_file" "${args[@]}" - 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 -} - -# 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. - bt_cli "$temp_stdout_output_file" "$temp_stderr_output_file" "${args[@]}" - - # 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" "${args[@]}" + ret_stdout=$? + bt_diff "$expected_stderr_file" "$temp_stderr_output_file" "${args[@]}" + ret_stderr=$? - bt_diff "$expected_stdout_file" "$temp_stdout_output_file" "$expected_stderr_file" "$temp_stderr_output_file" "${args[@]}" - ret=$? + if ((ret_stdout != 0 || ret_stderr != 0)); then + ret=1 + fi rm -f "$temp_stdout_output_file" "$temp_stderr_output_file" @@ -297,7 +237,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 @@ -323,7 +264,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 @@ -345,6 +287,7 @@ run_python_bt2() { "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" @@ -353,9 +296,9 @@ run_python_bt2() { 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 + if [ "$BT_TESTS_OS_TYPE" = "mingw" ] || [ "$BT_TESTS_OS_TYPE" = "cygwin" ]; then env_args+=("PATH=${main_lib_path}:${PATH:-}") - elif [ "$BT_OS_TYPE" = "darwin" ]; then + elif [ "$BT_TESTS_OS_TYPE" = "darwin" ]; then env_args+=("DYLD_LIBRARY_PATH=${main_lib_path}:${DYLD_LIBRARY_PATH:-}") else env_args+=("LD_LIBRARY_PATH=${main_lib_path}:${LD_LIBRARY_PATH:-}") @@ -364,7 +307,7 @@ run_python_bt2() { # 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 + if [ "$BT_TESTS_OS_TYPE" = "mingw" ]; then env_args+=("PYTHONHOME=$($BT_TESTS_PYTHON_CONFIG_BIN --prefix)") fi