3 # SPDX-License-Identifier: GPL-2.0-only
5 # Copyright (c) 2019 Michael Jeanson <mjeanson@efficios.com>
6 # Copyright (C) 2019 Philippe Proulx <pproulx@efficios.com>
9 # This file is meant to be sourced at the start of shell script-based tests.
12 # Error out when encountering an undefined variable
15 # If "readlink -f" is available, get a resolved absolute path to the
16 # tests source dir, otherwise make do with a relative path.
17 scriptdir
="$(dirname "${BASH_SOURCE[0]}")"
18 if readlink
-f "." >/dev
/null
2>&1; then
19 testsdir
=$
(readlink
-f "$scriptdir/..")
21 testsdir
="$scriptdir/.."
24 # The OS on which we are running. See [1] for possible values of 'uname -s'.
25 # We do a bit of translation to ease our life down the road for comparison.
26 # Export it so that called executables can use it.
27 # [1] https://en.wikipedia.org/wiki/Uname#Examples
28 if [ -z "${BT_TESTS_OS_TYPE:-}" ]; then
29 BT_TESTS_OS_TYPE
="$(uname -s)"
30 case "$BT_TESTS_OS_TYPE" in
32 BT_TESTS_OS_TYPE
="mingw"
35 BT_TESTS_OS_TYPE
="darwin"
38 BT_TESTS_OS_TYPE
="linux"
41 BT_TESTS_OS_TYPE
="cygwin"
44 BT_TESTS_OS_TYPE
="unsupported"
48 export BT_TESTS_OS_TYPE
50 # Allow overriding the source and build directories
51 if [ -z "${BT_TESTS_SRCDIR:-}" ]; then
52 BT_TESTS_SRCDIR
="$testsdir"
54 export BT_TESTS_SRCDIR
56 if [ -z "${BT_TESTS_BUILDDIR:-}" ]; then
57 BT_TESTS_BUILDDIR
="$testsdir"
59 export BT_TESTS_BUILDDIR
62 # Source the generated environment file if it's present.
63 if [ -f "${BT_TESTS_BUILDDIR}/utils/env.sh" ]; then
64 # shellcheck source=./env.sh
65 .
"${BT_TESTS_BUILDDIR}/utils/env.sh"
68 # Allow overriding the babeltrace2 executables
69 if [ -z "${BT_TESTS_BT2_BIN:-}" ]; then
70 BT_TESTS_BT2_BIN
="$BT_TESTS_BUILDDIR/../src/cli/babeltrace2"
71 if [ "$BT_TESTS_OS_TYPE" = "mingw" ]; then
72 BT_TESTS_BT2_BIN
="${BT_TESTS_BT2_BIN}.exe"
75 export BT_TESTS_BT2_BIN
77 # TODO: Remove when bindings/python/bt2/test_plugin.py is fixed
78 BT_PLUGINS_PATH
="${BT_TESTS_BUILDDIR}/../src/plugins"
80 # Allow overriding the babeltrace2 plugin path
81 if [ -z "${BT_TESTS_BABELTRACE_PLUGIN_PATH:-}" ]; then
82 BT_TESTS_BABELTRACE_PLUGIN_PATH
="${BT_PLUGINS_PATH}/ctf:${BT_PLUGINS_PATH}/utils:${BT_PLUGINS_PATH}/text:${BT_PLUGINS_PATH}/lttng-utils"
84 export BT_TESTS_BABELTRACE_PLUGIN_PATH
86 if [ -z "${BT_TESTS_PROVIDER_DIR:-}" ]; then
87 BT_TESTS_PROVIDER_DIR
="${BT_TESTS_BUILDDIR}/../src/python-plugin-provider/.libs"
89 export BT_TESTS_PROVIDER_DIR
91 # Allow overriding the babeltrace2 executables
92 if [ -z "${BT_TESTS_PYTHONPATH:-}" ]; then
93 BT_TESTS_PYTHONPATH
="${BT_TESTS_BUILDDIR}/../src/bindings/python/bt2/build/build_lib"
95 export BT_TESTS_PYTHONPATH
98 ### External Tools ###
99 if [ -z "${BT_TESTS_AWK_BIN:-}" ]; then
100 BT_TESTS_AWK_BIN
="awk"
102 export BT_TESTS_AWK_BIN
104 if [ -z "${BT_TESTS_GREP_BIN:-}" ]; then
105 BT_TESTS_GREP_BIN
="grep"
107 export BT_TESTS_GREP_BIN
109 if [ -z "${BT_TESTS_PYTHON_BIN:-}" ]; then
110 BT_TESTS_PYTHON_BIN
="python3"
112 export BT_TESTS_PYTHON_BIN
114 BT_TESTS_PYTHON_VERSION
=$
($BT_TESTS_PYTHON_BIN -c 'import sys; print("{}.{}".format(sys.version_info.major, sys.version_info.minor))')
116 if [ -z "${BT_TESTS_PYTHON_CONFIG_BIN:-}" ]; then
117 BT_TESTS_PYTHON_CONFIG_BIN
="python3-config"
119 export BT_TESTS_PYTHON_CONFIG_BIN
121 if [ -z "${BT_TESTS_SED_BIN:-}" ]; then
122 BT_TESTS_SED_BIN
="sed"
124 export BT_TESTS_SED_BIN
126 if [ -z "${BT_TESTS_CC_BIN:-}" ]; then
129 export BT_TESTS_CC_BIN
132 ### Optional features ###
134 if [ -z "${BT_TESTS_ENABLE_ASAN:-}" ]; then
135 BT_TESTS_ENABLE_ASAN
="0"
137 export BT_TESTS_ENABLE_ASAN
141 BT_TESTS_DATADIR
="${BT_TESTS_SRCDIR}/data"
142 BT_CTF_TRACES_PATH
="${BT_TESTS_DATADIR}/ctf-traces"
144 # By default, it will not source tap.sh. If you want to output tap directly
145 # from the test script, define the 'SH_TAP' variable to '1' before sourcing
147 if [ "${SH_TAP:-}" = 1 ]; then
148 # shellcheck source=./tap/tap.sh
149 .
"${BT_TESTS_SRCDIR}/utils/tap/tap.sh"
153 # Remove CR characters in file "$1".
156 "$BT_TESTS_SED_BIN" -i 's/\r//g' "$1"
159 # Run the Babeltrace CLI, redirecting stdout and stderr to specified files.
161 # $1: file to redirect stdout to
162 # $2: file to redirect stderr to
163 # remaining args: arguments to pass to the CLI
165 # Return the exit code of the CLI.
168 local stdout_file
="$1"
169 local stderr_file
="$2"
173 echo "Running: $BT_TESTS_BT2_BIN ${args[*]}" >&2
174 run_python_bt2
"$BT_TESTS_BT2_BIN" "${args[@]}" 1>"$stdout_file" 2>"$stderr_file"
177 ### Diff Functions ###
179 # Check the differences between two files (typically some expected output vs
180 # some actual output). If there are differences, print the diff to stderr.
182 # $1: file 1 (expected)
183 # $2: file 2 (actual)
185 # Return 0 if there's no difference, and non-zero if there are.
187 # Note that this function modifies the actual output file ($2) _in-place_ to
188 # remove any \r character.
191 local expected_file
="$1"
192 local actual_file
="$2"
195 # Strip any \r present due to Windows (\n -> \r\n).
196 # "diff --string-trailing-cr" is not used since it is not present on
198 bt_remove_cr
"$actual_file"
200 diff -u "$expected_file" "$actual_file" 1>&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
231 temp_stdout_output_file
="$(mktemp -t actual_stdout.XXXXXX)"
232 temp_stderr_output_file
="$(mktemp -t actual_stderr.XXXXXX)"
234 # Run the CLI to get a detailed file.
235 bt_cli
"$temp_stdout_output_file" "$temp_stderr_output_file" "${args[@]}"
237 bt_diff
"$expected_stdout_file" "$temp_stdout_output_file" "${args[@]}"
239 bt_diff
"$expected_stderr_file" "$temp_stderr_output_file" "${args[@]}"
242 if ((ret_stdout
!= 0 || ret_stderr
!= 0)); then
246 rm -f "$temp_stdout_output_file" "$temp_stderr_output_file"
251 # Checks the difference between the content of the file with path "$1"
252 # and the output of the CLI when called on the directory path "$2" with
253 # the arguments '-c sink.text.details' and the rest of the arguments to
256 # Returns 0 if there's no difference, and 1 if there is, also printing
257 # said difference to the standard error.
258 bt_diff_details_ctf_single
() {
259 local expected_stdout_file
="$1"
262 local extra_details_args
=("$@")
263 expected_stderr_file
="/dev/null"
265 # Compare using the CLI with `sink.text.details`
266 bt_diff_cli
"$expected_stdout_file" "$expected_stderr_file" "$trace_dir" \
267 "-c" "sink.text.details" "${extra_details_args[@]+${extra_details_args[@]}}"
270 # Calls bt_diff_details_ctf_single(), except that "$1" is the path to a
271 # program which generates the CTF trace to compare to. The program "$1"
272 # receives the path to a temporary, empty directory where to write the
273 # CTF trace as its first argument.
274 bt_diff_details_ctf_gen_single
() {
275 local ctf_gen_prog_path
="$1"
276 local expected_stdout_file
="$2"
278 local extra_details_args
=("$@")
283 temp_trace_dir
="$(mktemp -d)"
285 # Run the CTF trace generator program to get a CTF trace
286 if ! "$ctf_gen_prog_path" "$temp_trace_dir" 2>/dev
/null
; then
287 echo "ERROR: \"$ctf_gen_prog_path\" \"$temp_trace_dir\" failed" >&2
288 rm -rf "$temp_trace_dir"
292 # Compare using the CLI with `sink.text.details`
293 bt_diff_details_ctf_single
"$expected_stdout_file" "$temp_trace_dir" \
294 "${extra_details_args[@]+${extra_details_args[@]}}"
296 rm -rf "$temp_trace_dir"
307 # Execute a shell command in the appropriate environment to access the Python
308 # test utility modules in `tests/utils/python`.
310 local our_pythonpath
="${BT_TESTS_SRCDIR}/utils/python"
312 if [[ $BT_TESTS_PYTHON_VERSION = 3.4 ]]; then
313 # Add a local directory containing a `typing.py` to `PYTHONPATH` for
314 # Python 3.4 which doesn't offer the `typing` module.
315 our_pythonpath
="$our_pythonpath:${BT_TESTS_SRCDIR}/utils/python/typing"
318 PYTHONPATH
="${our_pythonpath}${PYTHONPATH:+:}${PYTHONPATH:-}" "$@"
321 # Execute a shell command in the appropriate environment to have access to the
322 # bt2 Python bindings.
325 local -x "BABELTRACE_PYTHON_BT2_NO_TRACEBACK=1"
326 local -x "BABELTRACE_PLUGIN_PATH=${BT_TESTS_BABELTRACE_PLUGIN_PATH}"
327 local -x "LIBBABELTRACE2_PLUGIN_PROVIDER_DIR=${BT_TESTS_PROVIDER_DIR}"
328 local -x "BT_TESTS_DATADIR=${BT_TESTS_DATADIR}"
329 local -x "BT_CTF_TRACES_PATH=${BT_CTF_TRACES_PATH}"
330 local -x "BT_PLUGINS_PATH=${BT_PLUGINS_PATH}"
331 local -x "PYTHONPATH=${BT_TESTS_PYTHONPATH}${PYTHONPATH:+:}${PYTHONPATH:-}"
333 local main_lib_path
="${BT_TESTS_BUILDDIR}/../src/lib/.libs"
335 # Set the library search path so the python interpreter can load libbabeltrace2
336 if [ "$BT_TESTS_OS_TYPE" = "mingw" ] ||
[ "$BT_TESTS_OS_TYPE" = "cygwin" ]; then
337 local -x PATH
="${main_lib_path}${PATH:+:}${PATH:-}"
338 elif [ "$BT_TESTS_OS_TYPE" = "darwin" ]; then
339 local -x DYLD_LIBRARY_PATH
="${main_lib_path}${DYLD_LIBRARY_PATH:+:}${DYLD_LIBRARY_PATH:-}"
341 local -x LD_LIBRARY_PATH
="${main_lib_path}${LD_LIBRARY_PATH:+:}${LD_LIBRARY_PATH:-}"
344 # On Windows, an embedded Python interpreter needs a way to locate the path
345 # to its internal modules, set the prefix from python-config to the
346 # PYTHONHOME variable.
347 if [ "$BT_TESTS_OS_TYPE" = "mingw" ]; then
350 PYTHONHOME
=$
($BT_TESTS_PYTHON_CONFIG_BIN --prefix)
353 # If AddressSanitizer is used, we must preload libasan.so so that
354 # libasan doesn't complain about not being the first loaded library.
356 # Python and sed (executed as part of the libtool wrapper) produce some
357 # leaks, so we must unfortunately disable leak detection. Append it to
358 # existing ASAN_OPTIONS, such that we override the user's value if it
359 # contains detect_leaks=1.
360 if [ "${BT_TESTS_ENABLE_ASAN:-}" = "1" ]; then
361 if ${BT_TESTS_CC_BIN} --version |
head -n 1 |
grep -q '^gcc'; then
362 lib_asan
="$(${BT_TESTS_CC_BIN} -print-file-name=libasan.so)"
363 local -x LD_PRELOAD
="${lib_asan}${LD_PRELOAD:+:}${LD_PRELOAD:-}"
366 local -x "ASAN_OPTIONS=${ASAN_OPTIONS:-}${ASAN_OPTIONS:+,}detect_leaks=0"
372 # Set the environment and run python tests in the directory.
374 # $1 : The directory containing the python test scripts
375 # $2 : The pattern to match python test script names (optional)
376 run_python_bt2_test
() {
378 local test_pattern
="${2:-'*'}" # optional, if none default to "*"
381 local test_runner_args
=()
383 test_runner_args
+=("$test_dir")
384 if [ -n "${test_pattern}" ]; then
385 test_runner_args
+=("${test_pattern}")
388 if test "${BT_TESTS_COVERAGE:-}" = "1"; then
389 python_exec
="check_coverage"
391 python_exec
="${BT_TESTS_PYTHON_BIN}"
396 "${BT_TESTS_SRCDIR}/utils/python/testrunner.py" \
397 --pattern "$test_pattern" \
402 if test "${BT_TESTS_COVERAGE_REPORT:-}" = "1"; then
406 if test "${BT_TESTS_COVERAGE_HTML:-}" = "1"; then
413 # Generate a CTF trace using `mctf.py`.
416 # $2: Base directory path for output files
418 local input_file
="$1"
421 diag
"Running: ${BT_TESTS_PYTHON_BIN} ${BT_TESTS_SRCDIR}/utils/python/mctf.py --base-dir ${base_dir} ${input_file}"
422 "${BT_TESTS_PYTHON_BIN}" "${BT_TESTS_SRCDIR}/utils/python/mctf.py" \
423 --base-dir "${base_dir}" "${input_file}"