3 # Copyright (c) 2019 Michael Jeanson <mjeanson@efficios.com>
4 # Copyright (C) 2019 Philippe Proulx <pproulx@efficios.com>
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; under version 2 of the License.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License along
16 # with this program; if not, write to the Free Software Foundation, Inc.,
17 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 # This file is meant to be sourced at the start of shell script-based tests.
22 # Error out when encountering an undefined variable
25 # If "readlink -f" is available, get a resolved absolute path to the
26 # tests source dir, otherwise make do with a relative path.
27 scriptdir
="$(dirname "${BASH_SOURCE[0]}")"
28 if readlink
-f "." >/dev
/null
2>&1; then
29 testsdir
=$
(readlink
-f "$scriptdir/..")
31 testsdir
="$scriptdir/.."
34 # The OS on which we are running. See [1] for possible values of 'uname -s'.
35 # We do a bit of translation to ease our life down the road for comparison.
36 # Export it so that called executables can use it.
37 # [1] https://en.wikipedia.org/wiki/Uname#Examples
38 if [ "x${BT_OS_TYPE:-}" = "x" ]; then
39 BT_OS_TYPE
="$(uname -s)"
54 BT_OS_TYPE
="unsupported"
60 # Allow overriding the source and build directories
61 if [ "x${BT_TESTS_SRCDIR:-}" = "x" ]; then
62 BT_TESTS_SRCDIR
="$testsdir"
64 export BT_TESTS_SRCDIR
66 if [ "x${BT_TESTS_BUILDDIR:-}" = "x" ]; then
67 BT_TESTS_BUILDDIR
="$testsdir"
69 export BT_TESTS_BUILDDIR
71 # By default, it will not source tap.sh. If you to tap output directly from
72 # the test script, define the 'SH_TAP' variable to '1' before sourcing this
74 if [ "x${SH_TAP:-}" = x1
]; then
75 # shellcheck source=./tap/tap.sh
76 .
"${BT_TESTS_SRCDIR}/utils/tap/tap.sh"
79 # Allow overriding the babeltrace2 executables
80 if [ "x${BT_TESTS_BT2_BIN:-}" = "x" ]; then
81 BT_TESTS_BT2_BIN
="$BT_TESTS_BUILDDIR/../src/cli/babeltrace2"
82 if [ "$BT_OS_TYPE" = "mingw" ]; then
83 BT_TESTS_BT2_BIN
="${BT_TESTS_BT2_BIN}.exe"
86 export BT_TESTS_BT2_BIN
88 # TODO: Remove when bindings/python/bt2/test_plugin.py is fixed
89 BT_PLUGINS_PATH
="${BT_TESTS_BUILDDIR}/../src/plugins"
91 # Allow overriding the babeltrace2 plugin path
92 if [ "x${BT_TESTS_BABELTRACE_PLUGIN_PATH:-}" = "x" ]; then
93 BT_TESTS_BABELTRACE_PLUGIN_PATH
="${BT_PLUGINS_PATH}/ctf:${BT_PLUGINS_PATH}/utils:${BT_PLUGINS_PATH}/text"
96 if [ "x${BT_TESTS_PROVIDER_DIR:-}" = "x" ]; then
97 BT_TESTS_PROVIDER_DIR
="${BT_TESTS_BUILDDIR}/../src/python-plugin-provider/.libs"
100 # Allow overriding the babeltrace2 executables
101 if [ "x${BT_TESTS_PYTHONPATH:-}" = "x" ]; then
102 BT_TESTS_PYTHONPATH
="${BT_TESTS_BUILDDIR}/../src/bindings/python/bt2/build/build_lib"
106 ### External Tools ###
107 if [ "x${BT_TESTS_AWK_BIN:-}" = "x" ]; then
108 BT_TESTS_AWK_BIN
="awk"
110 export BT_TESTS_AWK_BIN
112 if [ "x${BT_TESTS_GREP_BIN:-}" = "x" ]; then
113 BT_TESTS_GREP_BIN
="grep"
115 export BT_TESTS_GREP_BIN
117 if [ "x${BT_TESTS_PYTHON_BIN:-}" = "x" ]; then
118 BT_TESTS_PYTHON_BIN
="python3"
120 export BT_TESTS_PYTHON_BIN
122 if [ "x${BT_TESTS_PYTHON_CONFIG_BIN:-}" = "x" ]; then
123 BT_TESTS_PYTHON_CONFIG_BIN
="python3-config"
125 export BT_TESTS_PYTHON_CONFIG_BIN
127 if [ "x${BT_TESTS_SED_BIN:-}" = "x" ]; then
128 BT_TESTS_SED_BIN
="sed"
130 export BT_TESTS_SED_BIN
134 BT_TESTS_DATADIR
="${BT_TESTS_SRCDIR}/data"
135 BT_CTF_TRACES_PATH
="${BT_TESTS_DATADIR}/ctf-traces"
137 # Run the Babeltrace CLI, redirecting stdout and stderr to specified files.
139 # $1: file to redirect stdout to
140 # $2: file to redirect stderr to
141 # remaining args: arguments to pass to the CLI
143 # Return the exit code of the CLI.
146 local stdout_file
="$1"
147 local stderr_file
="$2"
151 run_python_bt2
"$BT_TESTS_BT2_BIN" "${args[@]}" 1>"$stdout_file" 2>"$stderr_file"
154 ### Diff Functions ###
156 # Checks the difference between stdout:
158 # The file with path "$1", and the file with path "$2"
160 # And the difference between stderr:
162 # The file with path "$3", and the file with path "$4"
164 # Returns 0 if there's no difference, and 1 if there is, also printing
165 # said difference to the standard error, and an error message with the
166 # args starting at "$5".
168 local expected_stdout_file
="$1"
169 local actual_stdout_file
="$2"
170 local expected_stderr_file
="$3"
171 local actual_stderr_file
="$4"
178 temp_diff
="$(mktemp -t diff.XXXXXX)"
180 # Strip any \r present due to Windows (\n -> \r\n).
181 # "diff --string-trailing-cr" is not used since it is not present on
183 "$BT_TESTS_SED_BIN" -i 's/\r//g' "$actual_stdout_file"
184 "$BT_TESTS_SED_BIN" -i 's/\r//g' "$actual_stderr_file"
186 # Compare stdout output with expected stdout output
187 if ! diff -u "$actual_stdout_file" "$expected_stdout_file" 2>/dev
/null
>"$temp_diff"; then
188 echo "ERROR: for '${args[*]}': actual standard output and expected output differ:" >&2
193 # Compare stderr output with expected stderr output
194 if ! diff -u "$actual_stderr_file" "$expected_stderr_file" 2>/dev
/null
>"$temp_diff"; then
195 echo "ERROR: for '${args[*]}': actual standard error and expected error differ:" >&2
205 # Checks the difference between:
207 # 1. What the CLI outputs on its standard output when given the arguments
208 # "$@" (excluding the first two arguments).
209 # 2. The file with path "$1".
211 # And the difference between:
213 # 1. What the CLI outputs on its standard error when given the arguments
214 # "$@" (excluding the first two arguments).
215 # 2. The file with path "$2".
217 # Returns 0 if there's no difference, and 1 if there is, also printing
218 # said difference to the standard error.
220 local expected_stdout_file
="$1"
221 local expected_stderr_file
="$2"
225 local temp_stdout_output_file
226 local temp_stderr_output_file
229 temp_stdout_output_file
="$(mktemp -t actual_stdout.XXXXXX)"
230 temp_stderr_output_file
="$(mktemp -t actual_stderr.XXXXXX)"
232 # Run the CLI to get a detailed file.
233 bt_cli
"$temp_stdout_output_file" "$temp_stderr_output_file" "${args[@]}"
235 bt_diff
"$expected_stdout_file" "$temp_stdout_output_file" "$expected_stderr_file" "$temp_stderr_output_file" "${args[@]}"
238 rm -f "$temp_stdout_output_file" "$temp_stderr_output_file"
243 # Checks the difference between:
245 # 1. What the CLI outputs on its standard output when given the arguments
246 # "$@" (excluding the first two arguments), sorted with the default "sort".
247 # 2. The file with path "$1".
249 # And the difference between:
251 # 1. What the CLI outputs on its standard error when given the arguments
252 # "$@" (excluding the first two arguments).
253 # 2. The file with path "$2".
255 # Returns 0 if there's no difference, and 1 if there is, also printing
256 # said difference to the standard error.
257 bt_diff_cli_sorted
() {
258 local expected_stdout_file
="$1"
259 local expected_stderr_file
="$2"
263 local temp_stdout_output_file
264 local temp_stderr_output_file
267 temp_stdout_output_file
="$(mktemp -t actual_stdout.XXXXXX)"
268 temp_stderr_output_file
="$(mktemp -t actual_stderr.XXXXXX)"
270 # Run the CLI to get a detailed file.
271 bt_cli
"$temp_stdout_output_file" "$temp_stderr_output_file" "${args[@]}"
273 # Sort the stdout file, use a subshell to do it in-place
274 # shellcheck disable=SC2005
275 echo "$(LC_ALL=C sort "$temp_stdout_output_file")" > "$temp_stdout_output_file"
277 bt_diff
"$expected_stdout_file" "$temp_stdout_output_file" "$expected_stderr_file" "$temp_stderr_output_file" "${args[@]}"
280 rm -f "$temp_stdout_output_file" "$temp_stderr_output_file"
285 # Checks the difference between the content of the file with path "$1"
286 # and the output of the CLI when called on the directory path "$2" with
287 # the arguments '-c sink.text.details' and the rest of the arguments to
290 # Returns 0 if there's no difference, and 1 if there is, also printing
291 # said difference to the standard error.
292 bt_diff_details_ctf_single
() {
293 local expected_stdout_file
="$1"
296 local extra_details_args
=("$@")
297 expected_stderr_file
="/dev/null"
299 # Compare using the CLI with `sink.text.details`
300 bt_diff_cli
"$expected_stdout_file" "$expected_stderr_file" "$trace_dir" "-c" "sink.text.details" "${extra_details_args[@]}"
303 # Calls bt_diff_details_ctf_single(), except that "$1" is the path to a
304 # program which generates the CTF trace to compare to. The program "$1"
305 # receives the path to a temporary, empty directory where to write the
306 # CTF trace as its first argument.
307 bt_diff_details_ctf_gen_single
() {
308 local ctf_gen_prog_path
="$1"
309 local expected_stdout_file
="$2"
311 local extra_details_args
=("$@")
316 temp_trace_dir
="$(mktemp -d)"
318 # Run the CTF trace generator program to get a CTF trace
319 if ! "$ctf_gen_prog_path" "$temp_trace_dir" 2>/dev
/null
; then
320 echo "ERROR: \"$ctf_gen_prog_path\" \"$temp_trace_dir\" failed" >&2
321 rm -rf "$temp_trace_dir"
325 # Compare using the CLI with `sink.text.details`
326 bt_diff_details_ctf_single
"$expected_stdout_file" "$temp_trace_dir" "${extra_details_args[@]}"
328 rm -rf "$temp_trace_dir"
339 # Execute a shell command in the appropriate environment to have access to the
340 # bt2 Python bindings.
345 "BABELTRACE_PYTHON_BT2_NO_TRACEBACK=1" \
346 "BABELTRACE_PLUGIN_PATH=${BT_TESTS_BABELTRACE_PLUGIN_PATH}" \
347 "LIBBABELTRACE2_PLUGIN_PROVIDER_DIR=${BT_TESTS_PROVIDER_DIR}" \
348 "BT_CTF_TRACES_PATH=${BT_CTF_TRACES_PATH}" \
349 "BT_PLUGINS_PATH=${BT_PLUGINS_PATH}" \
350 "PYTHONPATH=${BT_TESTS_PYTHONPATH}:${BT_TESTS_SRCDIR}/utils/python"
353 local main_lib_path
="${BT_TESTS_BUILDDIR}/../src/lib/.libs"
355 # Set the library search path so the python interpreter can load libbabeltrace2
356 if [ "$BT_OS_TYPE" = "mingw" ] ||
[ "$BT_OS_TYPE" = "cygwin" ]; then
357 env_args
+=("PATH=${main_lib_path}:${PATH:-}")
358 elif [ "$BT_OS_TYPE" = "darwin" ]; then
359 env_args
+=("DYLD_LIBRARY_PATH=${main_lib_path}:${DYLD_LIBRARY_PATH:-}")
361 env_args
+=("LD_LIBRARY_PATH=${main_lib_path}:${LD_LIBRARY_PATH:-}")
364 # On Windows, an embedded Python interpreter needs a way to locate the path
365 # to it's internal modules, set the prefix from python-config to the
366 # PYTHONHOME variable.
367 if [ "$BT_OS_TYPE" = "mingw" ]; then
368 env_args
+=("PYTHONHOME=$($BT_TESTS_PYTHON_CONFIG_BIN --prefix)")
371 env
"${env_args[@]}" "$@"
374 # Set the environment and run python tests in the directory.
376 # $1 : The directory containing the python test scripts
377 # $2 : The pattern to match python test script names (optional)
378 run_python_bt2_test
() {
380 local test_pattern
="${2:-'*'}" # optional, if none default to "*"
383 local test_runner_args
=()
385 test_runner_args
+=("$test_dir")
386 if [ "x${test_pattern}" != "x" ]; then
387 test_runner_args
+=("${test_pattern}")
390 if test "x${BT_TESTS_COVERAGE:-}" = "x1"; then
391 python_exec
="check_coverage"
393 python_exec
="${BT_TESTS_PYTHON_BIN}"
398 "${BT_TESTS_SRCDIR}/utils/python/testrunner.py" \
399 --pattern "$test_pattern" \
404 if test "x${BT_TESTS_COVERAGE_REPORT:-}" = "x1"; then
408 if test "x${BT_TESTS_COVERAGE_HTML:-}" = "x1"; then