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 if [ -z "${BT_TESTS_PYTHON_CONFIG_BIN:-}" ]; then
115 BT_TESTS_PYTHON_CONFIG_BIN
="python3-config"
117 export BT_TESTS_PYTHON_CONFIG_BIN
119 if [ -z "${BT_TESTS_SED_BIN:-}" ]; then
120 BT_TESTS_SED_BIN
="sed"
122 export BT_TESTS_SED_BIN
124 if [ -z "${BT_TESTS_CC_BIN:-}" ]; then
127 export BT_TESTS_CC_BIN
130 ### Optional features ###
132 if [ -z "${BT_TESTS_ENABLE_ASAN:-}" ]; then
133 BT_TESTS_ENABLE_ASAN
="0"
135 export BT_TESTS_ENABLE_ASAN
139 BT_TESTS_DATADIR
="${BT_TESTS_SRCDIR}/data"
140 BT_CTF_TRACES_PATH
="${BT_TESTS_DATADIR}/ctf-traces"
142 # By default, it will not source tap.sh. If you want to output tap directly
143 # from the test script, define the 'SH_TAP' variable to '1' before sourcing
145 if [ "${SH_TAP:-}" = 1 ]; then
146 # shellcheck source=./tap/tap.sh
147 .
"${BT_TESTS_SRCDIR}/utils/tap/tap.sh"
151 # Remove CR characters in file "$1".
154 "$BT_TESTS_SED_BIN" -i 's/\r//g' "$1"
157 # Run the Babeltrace CLI, redirecting stdout and stderr to specified files.
159 # $1: file to redirect stdout to
160 # $2: file to redirect stderr to
161 # remaining args: arguments to pass to the CLI
163 # Return the exit code of the CLI.
166 local stdout_file
="$1"
167 local stderr_file
="$2"
171 echo "Running: $BT_TESTS_BT2_BIN ${args[*]}" >&2
172 run_python_bt2
"$BT_TESTS_BT2_BIN" "${args[@]}" 1>"$stdout_file" 2>"$stderr_file"
175 ### Diff Functions ###
177 # Check the differences between two files (typically some expected output vs
178 # some actual output). If there are differences, print the diff to stderr.
180 # $1: file 1 (expected)
181 # $2: file 2 (actual)
183 # Return 0 if there's no difference, and non-zero if there are.
185 # Note that this function modifies the actual output file ($2) _in-place_ to
186 # remove any \r character.
189 local expected_file
="$1"
190 local actual_file
="$2"
193 # Strip any \r present due to Windows (\n -> \r\n).
194 # "diff --string-trailing-cr" is not used since it is not present on
196 bt_remove_cr
"$actual_file"
198 diff -u "$expected_file" "$actual_file" 1>&2
203 # Checks the difference between:
205 # 1. What the CLI outputs on its standard output when given the arguments
206 # "$@" (excluding the first two arguments).
207 # 2. The file with path "$1".
209 # And the difference between:
211 # 1. What the CLI outputs on its standard error when given the arguments
212 # "$@" (excluding the first two arguments).
213 # 2. The file with path "$2".
215 # Returns 0 if there's no difference, and 1 if there is, also printing
216 # said difference to the standard error.
218 local expected_stdout_file
="$1"
219 local expected_stderr_file
="$2"
223 local temp_stdout_output_file
224 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" "${args[@]}"
237 bt_diff
"$expected_stderr_file" "$temp_stderr_output_file" "${args[@]}"
240 if ((ret_stdout
!= 0 || ret_stderr
!= 0)); then
244 rm -f "$temp_stdout_output_file" "$temp_stderr_output_file"
249 # Checks the difference between the content of the file with path "$1"
250 # and the output of the CLI when called on the directory path "$2" with
251 # the arguments '-c sink.text.details' and the rest of the arguments to
254 # Returns 0 if there's no difference, and 1 if there is, also printing
255 # said difference to the standard error.
256 bt_diff_details_ctf_single
() {
257 local expected_stdout_file
="$1"
260 local extra_details_args
=("$@")
261 expected_stderr_file
="/dev/null"
263 # Compare using the CLI with `sink.text.details`
264 bt_diff_cli
"$expected_stdout_file" "$expected_stderr_file" "$trace_dir" \
265 "-c" "sink.text.details" "${extra_details_args[@]+${extra_details_args[@]}}"
268 # Calls bt_diff_details_ctf_single(), except that "$1" is the path to a
269 # program which generates the CTF trace to compare to. The program "$1"
270 # receives the path to a temporary, empty directory where to write the
271 # CTF trace as its first argument.
272 bt_diff_details_ctf_gen_single
() {
273 local ctf_gen_prog_path
="$1"
274 local expected_stdout_file
="$2"
276 local extra_details_args
=("$@")
281 temp_trace_dir
="$(mktemp -d)"
283 # Run the CTF trace generator program to get a CTF trace
284 if ! "$ctf_gen_prog_path" "$temp_trace_dir" 2>/dev
/null
; then
285 echo "ERROR: \"$ctf_gen_prog_path\" \"$temp_trace_dir\" failed" >&2
286 rm -rf "$temp_trace_dir"
290 # Compare using the CLI with `sink.text.details`
291 bt_diff_details_ctf_single
"$expected_stdout_file" "$temp_trace_dir" \
292 "${extra_details_args[@]+${extra_details_args[@]}}"
294 rm -rf "$temp_trace_dir"
305 # Execute a shell command in the appropriate environment to have access to the
306 # bt2 Python bindings.
312 "BABELTRACE_PYTHON_BT2_NO_TRACEBACK=1" \
313 "BABELTRACE_PLUGIN_PATH=${BT_TESTS_BABELTRACE_PLUGIN_PATH}" \
314 "LIBBABELTRACE2_PLUGIN_PROVIDER_DIR=${BT_TESTS_PROVIDER_DIR}" \
315 "BT_TESTS_DATADIR=${BT_TESTS_DATADIR}" \
316 "BT_CTF_TRACES_PATH=${BT_CTF_TRACES_PATH}" \
317 "BT_PLUGINS_PATH=${BT_PLUGINS_PATH}" \
318 "PYTHONPATH=${BT_TESTS_PYTHONPATH}:${BT_TESTS_SRCDIR}/utils/python"
321 local main_lib_path
="${BT_TESTS_BUILDDIR}/../src/lib/.libs"
323 # Set the library search path so the python interpreter can load libbabeltrace2
324 if [ "$BT_TESTS_OS_TYPE" = "mingw" ] ||
[ "$BT_TESTS_OS_TYPE" = "cygwin" ]; then
325 env_args
+=("PATH=${main_lib_path}:${PATH:-}")
326 elif [ "$BT_TESTS_OS_TYPE" = "darwin" ]; then
327 env_args
+=("DYLD_LIBRARY_PATH=${main_lib_path}:${DYLD_LIBRARY_PATH:-}")
329 env_args
+=("LD_LIBRARY_PATH=${main_lib_path}:${LD_LIBRARY_PATH:-}")
332 # On Windows, an embedded Python interpreter needs a way to locate the path
333 # to it's internal modules, set the prefix from python-config to the
334 # PYTHONHOME variable.
335 if [ "$BT_TESTS_OS_TYPE" = "mingw" ]; then
336 env_args
+=("PYTHONHOME=$($BT_TESTS_PYTHON_CONFIG_BIN --prefix)")
339 # If AddressSanitizer is used, we must preload libasan.so so that
340 # libasan doesn't complain about not being the first loaded library.
342 # Python and sed (executed as part of the libtool wrapper) produce some
343 # leaks, so we must unfortunately disable leak detection. Append it to
344 # existing ASAN_OPTIONS, such that we override the user's value if it
345 # contains detect_leaks=1.
346 if [ "${BT_TESTS_ENABLE_ASAN:-}" = "1" ]; then
347 lib_asan
=$
(${BT_TESTS_CC_BIN} -print-file-name=libasan.so
)
349 env_args
+=("LD_PRELOAD=${lib_asan}:${LD_PRELOAD:-}")
350 env_args
+=("ASAN_OPTIONS=${ASAN_OPTIONS:-},detect_leaks=0")
353 env
"${env_args[@]}" "$@"
356 # Set the environment and run python tests in the directory.
358 # $1 : The directory containing the python test scripts
359 # $2 : The pattern to match python test script names (optional)
360 run_python_bt2_test
() {
362 local test_pattern
="${2:-'*'}" # optional, if none default to "*"
365 local test_runner_args
=()
367 test_runner_args
+=("$test_dir")
368 if [ -n "${test_pattern}" ]; then
369 test_runner_args
+=("${test_pattern}")
372 if test "${BT_TESTS_COVERAGE:-}" = "1"; then
373 python_exec
="check_coverage"
375 python_exec
="${BT_TESTS_PYTHON_BIN}"
380 "${BT_TESTS_SRCDIR}/utils/python/testrunner.py" \
381 --pattern "$test_pattern" \
386 if test "${BT_TESTS_COVERAGE_REPORT:-}" = "1"; then
390 if test "${BT_TESTS_COVERAGE_HTML:-}" = "1"; then