3 # SPDX-License-Identifier: GPL-2.0-only
5 # Copyright (c) 2019 Michael Jeanson <mjeanson@efficios.com>
6 # Copyright (C) 2019-2023 Philippe Proulx <pproulx@efficios.com>
8 # Source this file at the beginning of a shell script test to access
9 # useful testing variables and functions:
13 # if [[ -n ${BT_TESTS_SRCDIR:-} ]]; then
14 # UTILSSH=$BT_TESTS_SRCDIR/utils/utils.sh
16 # UTILSSH=$(dirname "$0")/../utils/utils.sh
19 # # shellcheck source=../utils/utils.sh
22 # Make sure the relative path to `utils.sh` (this file) above is
25 # An unbound variable is an error
28 # Name of the OS on which we're running, if not set.
32 # `mingw`: MinGW (Windows)
35 # `cygwin`: Cygwin (Windows)
36 # `unsupported`: Anything else
38 # See <https://en.wikipedia.org/wiki/Uname#Examples> for possible values
41 # Do some translation to ease our life down the road for comparison.
42 # Export it so that executed commands can use it.
43 if [ -z "${BT_TESTS_OS_TYPE:-}" ]; then
44 BT_TESTS_OS_TYPE
="$(uname -s)"
45 case "$BT_TESTS_OS_TYPE" in
47 BT_TESTS_OS_TYPE
="mingw"
50 BT_TESTS_OS_TYPE
="darwin"
53 BT_TESTS_OS_TYPE
="linux"
56 BT_TESTS_OS_TYPE
="cygwin"
59 BT_TESTS_OS_TYPE
="unsupported"
63 export BT_TESTS_OS_TYPE
65 # Sets and exports, if not set:
67 # • `BT_TESTS_SRCDIR` to the base source directory of tests.
68 # • `BT_TESTS_BUILDDIR` to the base build directory of tests.
69 _set_vars_srcdir_builddir
() {
70 # If `readlink -f` is available, then get a resolved absolute path
71 # to the tests source directory. Otherwise, make do with a relative
73 local -r scriptdir
="$(dirname "${BASH_SOURCE[0]}")"
76 if readlink
-f "." >/dev
/null
2>&1; then
77 testsdir
=$
(readlink
-f "$scriptdir/..")
79 testsdir
="$scriptdir/.."
82 # Base source directory of tests
83 if [ -z "${BT_TESTS_SRCDIR:-}" ]; then
84 BT_TESTS_SRCDIR
="$testsdir"
86 export BT_TESTS_SRCDIR
88 # Base build directory of tests
89 if [ -z "${BT_TESTS_BUILDDIR:-}" ]; then
90 BT_TESTS_BUILDDIR
="$testsdir"
92 export BT_TESTS_BUILDDIR
95 _set_vars_srcdir_builddir
96 unset -f _set_vars_srcdir_builddir
98 # Sources the generated environment file (`env.sh`) if it exists.
100 local -r env_sh_path
="$BT_TESTS_BUILDDIR/utils/env.sh"
102 if [ -f "${env_sh_path}" ]; then
103 # shellcheck disable=SC1090,SC1091
109 unset -f _source_env_sh
111 # Path to the `babeltrace2` command, if not set
112 if [ -z "${BT_TESTS_BT2_BIN:-}" ]; then
113 BT_TESTS_BT2_BIN
="$BT_TESTS_BUILDDIR/../src/cli/babeltrace2"
114 if [ "$BT_TESTS_OS_TYPE" = "mingw" ]; then
115 BT_TESTS_BT2_BIN
="${BT_TESTS_BT2_BIN}.exe"
118 export BT_TESTS_BT2_BIN
120 # This doesn't need to be exported, but it needs to remain set for
121 # run_python_bt2() to use it.
123 # TODO: Remove when `tests/bindings/python/bt2/test_plugin.py` is fixed.
124 _bt_tests_plugins_path
="${BT_TESTS_BUILDDIR}/../src/plugins"
126 # Colon-separated list of project plugin paths, if not set
127 if [ -z "${BT_TESTS_BABELTRACE_PLUGIN_PATH:-}" ]; then
128 BT_TESTS_BABELTRACE_PLUGIN_PATH
="${_bt_tests_plugins_path}/ctf:${_bt_tests_plugins_path}/utils:${_bt_tests_plugins_path}/text:${_bt_tests_plugins_path}/lttng-utils"
130 export BT_TESTS_BABELTRACE_PLUGIN_PATH
132 # Directory containing the Python plugin provider library, if not set
133 if [ -z "${BT_TESTS_PROVIDER_DIR:-}" ]; then
134 BT_TESTS_PROVIDER_DIR
="${BT_TESTS_BUILDDIR}/../src/python-plugin-provider/.libs"
136 export BT_TESTS_PROVIDER_DIR
138 # Directory containing the built `bt2` Python package, if not set
139 if [ -z "${BT_TESTS_PYTHONPATH:-}" ]; then
140 BT_TESTS_PYTHONPATH
="${BT_TESTS_BUILDDIR}/../src/bindings/python/bt2/build/build_lib"
142 export BT_TESTS_PYTHONPATH
144 # Name of the `awk` command to use when testing, if not set
145 if [ -z "${BT_TESTS_AWK_BIN:-}" ]; then
146 BT_TESTS_AWK_BIN
="awk"
148 export BT_TESTS_AWK_BIN
150 # Name of the `grep` command to use when testing, if not set
151 if [ -z "${BT_TESTS_GREP_BIN:-}" ]; then
152 BT_TESTS_GREP_BIN
="grep"
154 export BT_TESTS_GREP_BIN
156 # Name of the `python3` command to use when testing, if not set
157 if [ -z "${BT_TESTS_PYTHON_BIN:-}" ]; then
158 BT_TESTS_PYTHON_BIN
="python3"
160 export BT_TESTS_PYTHON_BIN
162 # Major and minor version of the `python3` command to use when testing.
164 # This doesn't need to be exported, but it needs to remain set for
165 # run_python() to use it.
166 _bt_tests_py3_version
=$
("$BT_TESTS_PYTHON_BIN" -c 'import sys; print("{}.{}".format(sys.version_info.major, sys.version_info.minor))')
168 # Name of the `python3-config` command to use when testing, if not set
169 if [ -z "${BT_TESTS_PYTHON_CONFIG_BIN:-}" ]; then
170 BT_TESTS_PYTHON_CONFIG_BIN
="python3-config"
172 export BT_TESTS_PYTHON_CONFIG_BIN
174 # Name of the `sed` command to use when testing, if not set
175 if [ -z "${BT_TESTS_SED_BIN:-}" ]; then
176 BT_TESTS_SED_BIN
="sed"
178 export BT_TESTS_SED_BIN
180 # Name of the `cc` command to use when testing, if not set
181 if [ -z "${BT_TESTS_CC_BIN:-}" ]; then
184 export BT_TESTS_CC_BIN
186 # Whether or not to enable AddressSanitizer, `0` (disabled) if not set.
188 # This doesn't need to be exported from the point of view of this file,
189 # but the sourced `env.sh` above does export it.
190 if [ -z "${BT_TESTS_ENABLE_ASAN:-}" ]; then
191 BT_TESTS_ENABLE_ASAN
="0"
194 # Directory containing test data
195 BT_TESTS_DATADIR
="${BT_TESTS_SRCDIR}/data"
197 # Directory containing test CTF traces
198 BT_CTF_TRACES_PATH
="${BT_TESTS_DATADIR}/ctf-traces"
200 # Source the shell TAP utilities if `SH_TAP` is `1`
201 if [ "${SH_TAP:-}" = 1 ]; then
202 # shellcheck source=./tap/tap.sh
203 .
"${BT_TESTS_SRCDIR}/utils/tap/tap.sh"
206 # Removes the CR characters from the file having the path `$1`.
208 # This is sometimes needed on Windows with text files.
210 # We can't use the `--string-trailing-cr` option of `diff` because
211 # Solaris doesn't have it.
213 "$BT_TESTS_SED_BIN" -i'' -e 's/\r//g' "$1"
216 # Prints `$1` without CR characters.
217 bt_remove_cr_inline
() {
218 "$BT_TESTS_SED_BIN" 's/\r//g' "$1"
221 # Runs the `$BT_TESTS_BT2_BIN` command within an environment which can
222 # import the `bt2` Python package, redirecting the standard output to
223 # the `$1` file and the standard error to the `$2` file.
225 # The remaining arguments are forwarded to the `$BT_TESTS_BT2_BIN`
228 # Returns the exit status of the executed `$BT_TESTS_BT2_BIN`.
230 local -r stdout_file
="$1"
231 local -r stderr_file
="$2"
235 echo "Running: \`$BT_TESTS_BT2_BIN ${args[*]}\`" >&2
236 run_python_bt2
"$BT_TESTS_BT2_BIN" "${args[@]}" 1>"$stdout_file" 2>"$stderr_file"
239 # Checks the differences between:
241 # • The (expected) contents of the file having the path `$1`.
243 # • The contents of another file having the path `$2`.
245 # Both files are passed through bt_remove_cr_inline() to remove CR
248 # Returns 0 if there's no difference, or not zero otherwise.
250 local -r expected_file
="$1"
251 local -r actual_file
="$2"
253 diff -u <(bt_remove_cr_inline
"$expected_file") <(bt_remove_cr_inline
"$actual_file") 1>&2
256 # Checks the difference between:
258 # • What the `$BT_TESTS_BT2_BIN` command prints to its standard output
259 # when given the third and following arguments of this function.
261 # • The file having the path `$1`.
263 # as well as the difference between:
265 # • What the `$BT_TESTS_BT2_BIN` command prints to its standard error
266 # when given the third and following arguments of this function.
268 # • The file having the path `$2`.
270 # Returns 0 if there's no difference, or 1 otherwise, also printing said
271 # difference to the standard error.
273 local -r expected_stdout_file
="$1"
274 local -r expected_stderr_file
="$2"
278 local -r temp_stdout_output_file
="$(mktemp -t actual-stdout.XXXXXX)"
279 local -r temp_stderr_output_file
="$(mktemp -t actual-stderr.XXXXXX)"
281 bt_cli
"$temp_stdout_output_file" "$temp_stderr_output_file" "${args[@]}"
283 bt_diff
"$expected_stdout_file" "$temp_stdout_output_file" "${args[@]}"
284 local -r ret_stdout
=$?
285 bt_diff
"$expected_stderr_file" "$temp_stderr_output_file" "${args[@]}"
286 local -r ret_stderr
=$?
288 rm -f "$temp_stdout_output_file" "$temp_stderr_output_file"
290 return $
((ret_stdout || ret_stderr
))
293 # Checks the difference between:
295 # • The content of the file having the path `$1`.
297 # • What the `$BT_TESTS_BT2_BIN` command prints to the standard output
298 # when executed with:
300 # 1. The CTF trace directory `$2`.
301 # 2. The arguments `-c` and `sink.text.details`.
302 # 3. The third and following arguments of this function.
304 # Returns 0 if there's no difference, or 1 otherwise, also printing said
305 # difference to the standard error.
306 bt_diff_details_ctf_single
() {
307 local -r expected_stdout_file
="$1"
308 local -r trace_dir
="$2"
310 local -r extra_details_args
=("$@")
312 # Compare using the CLI with `sink.text.details`
313 bt_diff_cli
"$expected_stdout_file" /dev
/null
"$trace_dir" \
314 "-c" "sink.text.details" "${extra_details_args[@]+${extra_details_args[@]}}"
317 # Like bt_diff_details_ctf_single(), except that `$1` is the path to a
318 # program which generates the CTF trace to compare to.
320 # The program `$1` receives the path to a temporary, empty directory
321 # where to write the CTF trace as its first argument.
322 bt_diff_details_ctf_gen_single
() {
323 local -r ctf_gen_prog_path
="$1"
324 local -r expected_stdout_file
="$2"
326 local -r extra_details_args
=("$@")
328 local -r temp_trace_dir
="$(mktemp -d)"
330 # Run the CTF trace generator program to get a CTF trace
331 if ! "$ctf_gen_prog_path" "$temp_trace_dir" 2>/dev
/null
; then
332 echo "ERROR: \`$ctf_gen_prog_path $temp_trace_dir\` failed" >&2
333 rm -rf "$temp_trace_dir"
337 # Compare using the CLI with `sink.text.details`
338 bt_diff_details_ctf_single
"$expected_stdout_file" "$temp_trace_dir" \
339 "${extra_details_args[@]+${extra_details_args[@]}}"
341 rm -rf "$temp_trace_dir"
345 # Like `grep`, but using `$BT_TESTS_GREP_BIN`.
347 "$BT_TESTS_GREP_BIN" "$@"
350 # Only if `tap.sh` is sourced because bt_grep_ok() uses ok()
351 if [[ ${SH_TAP:-} == 1 ]]; then
352 # ok() with the test name `$3` on the result of bt_grep() matching
353 # the pattern `$1` within the file `$2`.
357 local -r test_name
=$3
359 bt_grep
--silent "$pattern" "$file"
363 if ! ok
$ret "$test_name"; then
365 echo "Pattern \`$pattern\` doesn't match the contents of \`$file\`:"
376 # Forwards the arguments to `coverage run`.
377 _bt_tests_check_coverage
() {
381 # Executes a command within an environment which can import the testing
382 # Python modules (in `tests/utils/python`).
384 local our_pythonpath
="${BT_TESTS_SRCDIR}/utils/python"
386 if [[ $_bt_tests_py3_version =~
3.
[45] ]]; then
387 # Add a local directory containing a `typing.py` to `PYTHONPATH`
388 # for Python 3.4 and Python 3.5 which either don't offer the
389 # `typing` module at all, or offer a partial one.
390 our_pythonpath
="$our_pythonpath:${BT_TESTS_SRCDIR}/utils/python/typing"
393 PYTHONPATH
="${our_pythonpath}${PYTHONPATH:+:}${PYTHONPATH:-}" "$@"
396 # Executes a command within an environment which can import the testing
397 # Python modules (in `tests/utils/python`) and the `bt2` Python package.
399 local -x "BABELTRACE_PLUGIN_PATH=${BT_TESTS_BABELTRACE_PLUGIN_PATH}"
400 local -x "LIBBABELTRACE2_PLUGIN_PROVIDER_DIR=${BT_TESTS_PROVIDER_DIR}"
401 local -x "BT_TESTS_DATADIR=${BT_TESTS_DATADIR}"
402 local -x "BT_CTF_TRACES_PATH=${BT_CTF_TRACES_PATH}"
403 local -x "BT_PLUGINS_PATH=${_bt_tests_plugins_path}"
404 local -x "PYTHONPATH=${BT_TESTS_PYTHONPATH}${PYTHONPATH:+:}${PYTHONPATH:-}"
406 local -r main_lib_path
="${BT_TESTS_BUILDDIR}/../src/lib/.libs"
408 # Set the library search path so that the Python 3 interpreter can
409 # load `libbabeltrace2`.
410 if [ "$BT_TESTS_OS_TYPE" = "mingw" ] ||
[ "$BT_TESTS_OS_TYPE" = "cygwin" ]; then
411 local -x PATH
="${main_lib_path}${PATH:+:}${PATH:-}"
412 elif [ "$BT_TESTS_OS_TYPE" = "darwin" ]; then
413 local -x DYLD_LIBRARY_PATH
="${main_lib_path}${DYLD_LIBRARY_PATH:+:}${DYLD_LIBRARY_PATH:-}"
415 local -x LD_LIBRARY_PATH
="${main_lib_path}${LD_LIBRARY_PATH:+:}${LD_LIBRARY_PATH:-}"
418 # On Windows, an embedded Python 3 interpreter needs a way to locate
419 # the path to its internal modules: set the `PYTHONHOME` variable to
420 # the prefix from `python3-config`.
421 if [ "$BT_TESTS_OS_TYPE" = "mingw" ]; then
424 PYTHONHOME
=$
("$BT_TESTS_PYTHON_CONFIG_BIN" --prefix)
427 # If AddressSanitizer is used, we must preload `libasan.so` so that
428 # libasan doesn't complain about not being the first loaded library.
430 # Python and sed (executed as part of the Libtool wrapper) produce
431 # some leaks, so we must unfortunately disable leak detection.
433 # Append it to existing `ASAN_OPTIONS` variable, such that we
434 # override the user's value if it contains `detect_leaks=1`.
435 if [ "${BT_TESTS_ENABLE_ASAN:-}" = "1" ]; then
436 if "${BT_TESTS_CC_BIN}" --version |
head -n 1 | bt_grep
-q '^gcc'; then
437 local -r lib_asan
="$("${BT_TESTS_CC_BIN}" -print-file-name=libasan.so)"
438 local -x LD_PRELOAD
="${lib_asan}${LD_PRELOAD:+:}${LD_PRELOAD:-}"
441 local -x "ASAN_OPTIONS=${ASAN_OPTIONS:-}${ASAN_OPTIONS:+,}detect_leaks=0"
447 # Runs the Python tests matching the pattern `$2` (optional, `*` if
448 # missing) in the directory `$1` using `testrunner.py`.
450 # This function uses run_python_bt2(), therefore such tests can import
451 # the testing Python modules (in `tests/utils/python`) and the `bt2`
453 run_python_bt2_test
() {
454 local -r test_dir
="$1"
455 local -r test_pattern
="${2:-'*'}"
459 if test "${BT_TESTS_COVERAGE:-}" = "1"; then
460 python_exec
="_bt_tests_check_coverage"
462 python_exec
="${BT_TESTS_PYTHON_BIN}"
467 "${BT_TESTS_SRCDIR}/utils/python/testrunner.py" \
468 --pattern "$test_pattern" \
473 if test "${BT_TESTS_COVERAGE_REPORT:-}" = "1"; then
477 if test "${BT_TESTS_COVERAGE_HTML:-}" = "1"; then
484 # Generates a CTF trace into the directory `$2` from the moultipart
485 # document `$1` using `mctf.py`.
487 local -r input_file
="$1"
488 local -r base_dir
="$2"
490 diag
"Running: \`${BT_TESTS_PYTHON_BIN} ${BT_TESTS_SRCDIR}/utils/python/mctf.py --base-dir ${base_dir} ${input_file}\`"
491 run_python
"${BT_TESTS_PYTHON_BIN}" "${BT_TESTS_SRCDIR}/utils/python/mctf.py" \
492 --base-dir "${base_dir}" "${input_file}"