Move to kernel style SPDX license identifiers

[babeltrace.git] / tests / utils / utils.sh

diff --git a/tests/utils/utils.sh b/tests/utils/utils.sh
index 4b545d09c602ce28675ab9218c47dce9eb4f3bad..a6b17dbe17c17edd4a96314334a180148b052974 100644 (file)
--- a/tests/utils/utils.sh
+++ b/tests/utils/utils.sh
@@ -1,20 +1,10 @@
 #!/bin/bash
-
-# Copyright (c) 2019 Michael Jeanson <mjeanson@efficios.com>
-# Copyright (C) 2019 Philippe Proulx <pproulx@efficios.com>
 #
-# 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 <mjeanson@efficios.com>
+# Copyright (C) 2019 Philippe Proulx <pproulx@efficios.com>
 #
-# 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.
 
@@ -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
@@ -173,7 +169,7 @@ bt_diff() {
        # 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_file"
+       bt_remove_cr "$actual_file"
 
        diff -u "$expected_file" "$actual_file" 1>&2
 
@@ -226,56 +222,6 @@ bt_diff_cli() {
        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
-       local ret_stdout
-       local ret_stderr
-
-       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"
-       ret_stdout=$?
-       bt_diff "$expected_stderr_file" "$temp_stderr_output_file"
-       ret_stderr=$?
-
-       if ((ret_stdout != 0 || ret_stderr != 0)); then
-               ret=1
-       fi
-
-       rm -f "$temp_stdout_output_file" "$temp_stderr_output_file"
-
-       return $ret
-}
-
 # Checks the difference between the content of the file with path "$1"
 # and the output of the CLI when called on the directory path "$2" with
 # the arguments '-c sink.text.details' and the rest of the arguments to
@@ -291,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
@@ -317,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
@@ -339,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"