Commit | Line | Data |
---|---|---|
644e0364 | 1 | #!/bin/bash |
644e0364 | 2 | # |
0235b0db | 3 | # SPDX-License-Identifier: GPL-2.0-only |
644e0364 | 4 | # |
0235b0db | 5 | # Copyright (c) 2019 Michael Jeanson <mjeanson@efficios.com> |
07ff3b19 | 6 | # Copyright (C) 2019-2023 Philippe Proulx <pproulx@efficios.com> |
644e0364 | 7 | |
07ff3b19 PP |
8 | # Source this file at the beginning of a shell script test to access |
9 | # useful testing variables and functions: | |
10 | # | |
11 | # SH_TAP=1 | |
12 | # | |
13 | # if [[ -n ${BT_TESTS_SRCDIR:-} ]]; then | |
14 | # UTILSSH=$BT_TESTS_SRCDIR/utils/utils.sh | |
15 | # else | |
16 | # UTILSSH=$(dirname "$0")/../utils/utils.sh | |
17 | # fi | |
18 | # | |
19 | # # shellcheck source=../utils/utils.sh | |
20 | # source "$UTILSSH" | |
21 | # | |
22 | # Make sure the relative path to `utils.sh` (this file) above is | |
23 | # correct (twice). | |
644e0364 | 24 | |
07ff3b19 | 25 | # An unbound variable is an error |
644e0364 MJ |
26 | set -u |
27 | ||
07ff3b19 PP |
28 | # Name of the OS on which we're running, if not set. |
29 | # | |
30 | # One of: | |
31 | # | |
32 | # `mingw`: MinGW (Windows) | |
33 | # `darwin`: macOS | |
34 | # `linux`: Linux | |
35 | # `cygwin`: Cygwin (Windows) | |
36 | # `unsupported`: Anything else | |
37 | # | |
38 | # See <https://en.wikipedia.org/wiki/Uname#Examples> for possible values | |
39 | # of `uname -s`. | |
40 | # | |
41 | # Do some translation to ease our life down the road for comparison. | |
42 | # Export it so that executed commands can use it. | |
75e396f6 | 43 | if [ -z "${BT_TESTS_OS_TYPE:-}" ]; then |
a0baab4a SM |
44 | BT_TESTS_OS_TYPE="$(uname -s)" |
45 | case "$BT_TESTS_OS_TYPE" in | |
5058d31b | 46 | MINGW*) |
a0baab4a | 47 | BT_TESTS_OS_TYPE="mingw" |
5058d31b JR |
48 | ;; |
49 | Darwin) | |
a0baab4a | 50 | BT_TESTS_OS_TYPE="darwin" |
5058d31b JR |
51 | ;; |
52 | Linux) | |
a0baab4a | 53 | BT_TESTS_OS_TYPE="linux" |
5058d31b | 54 | ;; |
df9db467 | 55 | CYGWIN*) |
a0baab4a | 56 | BT_TESTS_OS_TYPE="cygwin" |
df9db467 | 57 | ;; |
5058d31b | 58 | *) |
a0baab4a | 59 | BT_TESTS_OS_TYPE="unsupported" |
5058d31b JR |
60 | ;; |
61 | esac | |
62 | fi | |
a0baab4a | 63 | export BT_TESTS_OS_TYPE |
5058d31b | 64 | |
7030f9fe PP |
65 | # Sets and exports, if not set: |
66 | # | |
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 | |
72 | # path. | |
73 | local -r scriptdir="$(dirname "${BASH_SOURCE[0]}")" | |
74 | local testsdir | |
644e0364 | 75 | |
7030f9fe PP |
76 | if readlink -f "." >/dev/null 2>&1; then |
77 | testsdir=$(readlink -f "$scriptdir/..") | |
78 | else | |
79 | testsdir="$scriptdir/.." | |
80 | fi | |
81 | ||
82 | # Base source directory of tests | |
83 | if [ -z "${BT_TESTS_SRCDIR:-}" ]; then | |
84 | BT_TESTS_SRCDIR="$testsdir" | |
85 | fi | |
86 | export BT_TESTS_SRCDIR | |
87 | ||
88 | # Base build directory of tests | |
89 | if [ -z "${BT_TESTS_BUILDDIR:-}" ]; then | |
90 | BT_TESTS_BUILDDIR="$testsdir" | |
91 | fi | |
92 | export BT_TESTS_BUILDDIR | |
93 | } | |
644e0364 | 94 | |
7030f9fe PP |
95 | _set_vars_srcdir_builddir |
96 | unset -f _set_vars_srcdir_builddir | |
e46cbefe | 97 | |
4a162893 PP |
98 | # Sources the generated environment file (`env.sh`) if it exists. |
99 | _source_env_sh() { | |
100 | local -r env_sh_path="$BT_TESTS_BUILDDIR/utils/env.sh" | |
101 | ||
102 | if [ -f "${env_sh_path}" ]; then | |
103 | # shellcheck disable=SC1090,SC1091 | |
104 | . "${env_sh_path}" | |
105 | fi | |
106 | } | |
107 | ||
108 | _source_env_sh | |
109 | unset -f _source_env_sh | |
644e0364 | 110 | |
07ff3b19 | 111 | # Path to the `babeltrace2` command, if not set |
75e396f6 | 112 | if [ -z "${BT_TESTS_BT2_BIN:-}" ]; then |
4881a20e | 113 | BT_TESTS_BT2_BIN="$BT_TESTS_BUILDDIR/../src/cli/babeltrace2" |
a0baab4a | 114 | if [ "$BT_TESTS_OS_TYPE" = "mingw" ]; then |
27e2c58d JR |
115 | BT_TESTS_BT2_BIN="${BT_TESTS_BT2_BIN}.exe" |
116 | fi | |
644e0364 MJ |
117 | fi |
118 | export BT_TESTS_BT2_BIN | |
119 | ||
07ff3b19 PP |
120 | # This doesn't need to be exported, but it needs to remain set for |
121 | # run_python_bt2() to use it. | |
122 | # | |
123 | # TODO: Remove when `tests/bindings/python/bt2/test_plugin.py` is fixed. | |
315323f4 | 124 | _bt_tests_plugins_path="${BT_TESTS_BUILDDIR}/../src/plugins" |
644e0364 | 125 | |
07ff3b19 | 126 | # Colon-separated list of project plugin paths, if not set |
75e396f6 | 127 | if [ -z "${BT_TESTS_BABELTRACE_PLUGIN_PATH:-}" ]; then |
315323f4 | 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" |
644e0364 | 129 | fi |
e46cbefe | 130 | export BT_TESTS_BABELTRACE_PLUGIN_PATH |
644e0364 | 131 | |
07ff3b19 | 132 | # Directory containing the Python plugin provider library, if not set |
75e396f6 | 133 | if [ -z "${BT_TESTS_PROVIDER_DIR:-}" ]; then |
b14c7bf1 MJ |
134 | BT_TESTS_PROVIDER_DIR="${BT_TESTS_BUILDDIR}/../src/python-plugin-provider/.libs" |
135 | fi | |
e46cbefe | 136 | export BT_TESTS_PROVIDER_DIR |
b14c7bf1 | 137 | |
07ff3b19 | 138 | # Directory containing the built `bt2` Python package, if not set |
75e396f6 | 139 | if [ -z "${BT_TESTS_PYTHONPATH:-}" ]; then |
644e0364 MJ |
140 | BT_TESTS_PYTHONPATH="${BT_TESTS_BUILDDIR}/../src/bindings/python/bt2/build/build_lib" |
141 | fi | |
e46cbefe | 142 | export BT_TESTS_PYTHONPATH |
644e0364 | 143 | |
07ff3b19 | 144 | # Name of the `awk` command to use when testing, if not set |
75e396f6 | 145 | if [ -z "${BT_TESTS_AWK_BIN:-}" ]; then |
644e0364 MJ |
146 | BT_TESTS_AWK_BIN="awk" |
147 | fi | |
148 | export BT_TESTS_AWK_BIN | |
149 | ||
07ff3b19 | 150 | # Name of the `grep` command to use when testing, if not set |
75e396f6 | 151 | if [ -z "${BT_TESTS_GREP_BIN:-}" ]; then |
644e0364 MJ |
152 | BT_TESTS_GREP_BIN="grep" |
153 | fi | |
154 | export BT_TESTS_GREP_BIN | |
155 | ||
07ff3b19 | 156 | # Name of the `python3` command to use when testing, if not set |
75e396f6 | 157 | if [ -z "${BT_TESTS_PYTHON_BIN:-}" ]; then |
644e0364 MJ |
158 | BT_TESTS_PYTHON_BIN="python3" |
159 | fi | |
160 | export BT_TESTS_PYTHON_BIN | |
161 | ||
07ff3b19 PP |
162 | # Major and minor version of the `python3` command to use when testing. |
163 | # | |
164 | # This doesn't need to be exported, but it needs to remain set for | |
165 | # run_python() to use it. | |
315323f4 | 166 | _bt_tests_py3_version=$("$BT_TESTS_PYTHON_BIN" -c 'import sys; print("{}.{}".format(sys.version_info.major, sys.version_info.minor))') |
7747a39f | 167 | |
07ff3b19 | 168 | # Name of the `python3-config` command to use when testing, if not set |
75e396f6 | 169 | if [ -z "${BT_TESTS_PYTHON_CONFIG_BIN:-}" ]; then |
e23e08c4 MJ |
170 | BT_TESTS_PYTHON_CONFIG_BIN="python3-config" |
171 | fi | |
242ddcb7 | 172 | export BT_TESTS_PYTHON_CONFIG_BIN |
e23e08c4 | 173 | |
07ff3b19 | 174 | # Name of the `sed` command to use when testing, if not set |
75e396f6 | 175 | if [ -z "${BT_TESTS_SED_BIN:-}" ]; then |
644e0364 MJ |
176 | BT_TESTS_SED_BIN="sed" |
177 | fi | |
178 | export BT_TESTS_SED_BIN | |
179 | ||
07ff3b19 | 180 | # Name of the `cc` command to use when testing, if not set |
75e396f6 | 181 | if [ -z "${BT_TESTS_CC_BIN:-}" ]; then |
0b0893d4 SM |
182 | BT_TESTS_CC_BIN="cc" |
183 | fi | |
184 | export BT_TESTS_CC_BIN | |
185 | ||
07ff3b19 | 186 | # Whether or not to enable AddressSanitizer, `0` (disabled) if not set. |
ea81414f PP |
187 | # |
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. | |
75e396f6 | 190 | if [ -z "${BT_TESTS_ENABLE_ASAN:-}" ]; then |
0b0893d4 SM |
191 | BT_TESTS_ENABLE_ASAN="0" |
192 | fi | |
0b0893d4 | 193 | |
07ff3b19 | 194 | # Directory containing test data |
644e0364 | 195 | BT_TESTS_DATADIR="${BT_TESTS_SRCDIR}/data" |
07ff3b19 PP |
196 | |
197 | # Directory containing test CTF traces | |
644e0364 | 198 | BT_CTF_TRACES_PATH="${BT_TESTS_DATADIR}/ctf-traces" |
644e0364 | 199 | |
07ff3b19 | 200 | # Source the shell TAP utilities if `SH_TAP` is `1` |
75e396f6 | 201 | if [ "${SH_TAP:-}" = 1 ]; then |
e46cbefe MJ |
202 | # shellcheck source=./tap/tap.sh |
203 | . "${BT_TESTS_SRCDIR}/utils/tap/tap.sh" | |
204 | fi | |
205 | ||
07ff3b19 PP |
206 | # Removes the CR characters from the file having the path `$1`. |
207 | # | |
208 | # This is sometimes needed on Windows with text files. | |
209 | # | |
210 | # We can't use the `--string-trailing-cr` option of `diff` because | |
211 | # Solaris doesn't have it. | |
90a8a0f2 | 212 | bt_remove_cr() { |
717a01a7 | 213 | "$BT_TESTS_SED_BIN" -i'' -e 's/\r//g' "$1" |
90a8a0f2 SM |
214 | } |
215 | ||
07ff3b19 | 216 | # Prints `$1` without CR characters. |
10ba5f69 | 217 | bt_remove_cr_inline() { |
07ff3b19 | 218 | "$BT_TESTS_SED_BIN" 's/\r//g' "$1" |
10ba5f69 OD |
219 | } |
220 | ||
07ff3b19 PP |
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. | |
22703f66 | 224 | # |
07ff3b19 PP |
225 | # The remaining arguments are forwarded to the `$BT_TESTS_BT2_BIN` |
226 | # command. | |
22703f66 | 227 | # |
07ff3b19 | 228 | # Returns the exit status of the executed `$BT_TESTS_BT2_BIN`. |
22703f66 | 229 | bt_cli() { |
0824c914 PP |
230 | local -r stdout_file="$1" |
231 | local -r stderr_file="$2" | |
22703f66 | 232 | shift 2 |
0824c914 | 233 | local -r args=("$@") |
22703f66 | 234 | |
ea458b95 | 235 | echo "Running: $BT_TESTS_BT2_BIN ${args[*]}" >&2 |
22703f66 SM |
236 | run_python_bt2 "$BT_TESTS_BT2_BIN" "${args[@]}" 1>"$stdout_file" 2>"$stderr_file" |
237 | } | |
644e0364 | 238 | |
07ff3b19 | 239 | # Checks the differences between: |
ff89ed28 | 240 | # |
07ff3b19 | 241 | # • The (expected) contents of the file having the path `$1`. |
ff89ed28 | 242 | # |
07ff3b19 | 243 | # • The contents of another file having the path `$2`. |
ff89ed28 | 244 | # |
07ff3b19 PP |
245 | # Both files are passed through bt_remove_cr_inline() to remove CR |
246 | # characters. | |
247 | # | |
248 | # Returns 0 if there's no difference, or not zero otherwise. | |
ff89ed28 | 249 | bt_diff() { |
61ef15c9 PP |
250 | local -r expected_file="$1" |
251 | local -r actual_file="$2" | |
ff89ed28 | 252 | local ret=0 |
ff89ed28 | 253 | |
10ba5f69 | 254 | diff -u <(bt_remove_cr_inline "$expected_file") <(bt_remove_cr_inline "$actual_file") 1>&2 |
ff89ed28 | 255 | |
ea458b95 | 256 | return $? |
ff89ed28 MJ |
257 | } |
258 | ||
58db335e FD |
259 | # Checks the difference between: |
260 | # | |
07ff3b19 PP |
261 | # • What the `$BT_TESTS_BT2_BIN` command prints to its standard output |
262 | # when given the third and following arguments of this function. | |
263 | # | |
264 | # • The file having the path `$1`. | |
265 | # | |
266 | # as well as the difference between: | |
58db335e | 267 | # |
07ff3b19 PP |
268 | # • What the `$BT_TESTS_BT2_BIN` command prints to its standard error |
269 | # when given the third and following arguments of this function. | |
58db335e | 270 | # |
07ff3b19 | 271 | # • The file having the path `$2`. |
644e0364 | 272 | # |
07ff3b19 PP |
273 | # Returns 0 if there's no difference, or 1 otherwise, also printing said |
274 | # difference to the standard error. | |
644e0364 | 275 | bt_diff_cli() { |
af34d92b PP |
276 | local -r expected_stdout_file="$1" |
277 | local -r expected_stderr_file="$2" | |
58db335e | 278 | shift 2 |
af34d92b | 279 | local -r args=("$@") |
53cc240b | 280 | |
af34d92b PP |
281 | local -r temp_stdout_output_file="$(mktemp -t actual-stdout.XXXXXX)" |
282 | local -r temp_stderr_output_file="$(mktemp -t actual-stderr.XXXXXX)" | |
644e0364 | 283 | local ret=0 |
644e0364 | 284 | |
22703f66 | 285 | bt_cli "$temp_stdout_output_file" "$temp_stderr_output_file" "${args[@]}" |
58db335e | 286 | |
a70b6702 | 287 | bt_diff "$expected_stdout_file" "$temp_stdout_output_file" "${args[@]}" |
af34d92b | 288 | local -r ret_stdout=$? |
a70b6702 | 289 | bt_diff "$expected_stderr_file" "$temp_stderr_output_file" "${args[@]}" |
af34d92b | 290 | local -r ret_stderr=$? |
a70b6702 SM |
291 | |
292 | if ((ret_stdout != 0 || ret_stderr != 0)); then | |
293 | ret=1 | |
294 | fi | |
58db335e | 295 | |
ff89ed28 | 296 | rm -f "$temp_stdout_output_file" "$temp_stderr_output_file" |
644e0364 | 297 | |
ff89ed28 MJ |
298 | return $ret |
299 | } | |
300 | ||
07ff3b19 PP |
301 | # Checks the difference between: |
302 | # | |
303 | # • The content of the file having the path `$1`. | |
304 | # | |
305 | # • What the `$BT_TESTS_BT2_BIN` command prints to the standard output | |
306 | # when executed with: | |
307 | # | |
308 | # 1. The CTF trace directory `$2`. | |
309 | # 2. The arguments `-c` and `sink.text.details`. | |
310 | # 3. The third and following arguments of this function. | |
644e0364 | 311 | # |
07ff3b19 PP |
312 | # Returns 0 if there's no difference, or 1 otherwise, also printing said |
313 | # difference to the standard error. | |
644e0364 | 314 | bt_diff_details_ctf_single() { |
30723e1c PP |
315 | local -r expected_stdout_file="$1" |
316 | local -r trace_dir="$2" | |
53cc240b | 317 | shift 2 |
30723e1c | 318 | local -r extra_details_args=("$@") |
58db335e | 319 | expected_stderr_file="/dev/null" |
644e0364 MJ |
320 | |
321 | # Compare using the CLI with `sink.text.details` | |
8b729209 PP |
322 | bt_diff_cli "$expected_stdout_file" "$expected_stderr_file" "$trace_dir" \ |
323 | "-c" "sink.text.details" "${extra_details_args[@]+${extra_details_args[@]}}" | |
644e0364 MJ |
324 | } |
325 | ||
07ff3b19 PP |
326 | # Like bt_diff_details_ctf_single(), except that `$1` is the path to a |
327 | # program which generates the CTF trace to compare to. | |
328 | # | |
329 | # The program `$1` receives the path to a temporary, empty directory | |
330 | # where to write the CTF trace as its first argument. | |
644e0364 | 331 | bt_diff_details_ctf_gen_single() { |
69b5f89d PP |
332 | local -r ctf_gen_prog_path="$1" |
333 | local -r expected_stdout_file="$2" | |
53cc240b | 334 | shift 2 |
69b5f89d | 335 | local -r extra_details_args=("$@") |
644e0364 | 336 | |
69b5f89d | 337 | local -r temp_trace_dir="$(mktemp -d)" |
644e0364 MJ |
338 | |
339 | # Run the CTF trace generator program to get a CTF trace | |
340 | if ! "$ctf_gen_prog_path" "$temp_trace_dir" 2>/dev/null; then | |
341 | echo "ERROR: \"$ctf_gen_prog_path\" \"$temp_trace_dir\" failed" >&2 | |
342 | rm -rf "$temp_trace_dir" | |
343 | return 1 | |
344 | fi | |
345 | ||
346 | # Compare using the CLI with `sink.text.details` | |
8b729209 PP |
347 | bt_diff_details_ctf_single "$expected_stdout_file" "$temp_trace_dir" \ |
348 | "${extra_details_args[@]+${extra_details_args[@]}}" | |
69b5f89d | 349 | local -r ret=$? |
644e0364 MJ |
350 | rm -rf "$temp_trace_dir" |
351 | return $ret | |
352 | } | |
353 | ||
07ff3b19 | 354 | # Like `grep`, but using `$BT_TESTS_GREP_BIN`. |
407d3b10 SM |
355 | bt_grep() { |
356 | "$BT_TESTS_GREP_BIN" "$@" | |
357 | } | |
644e0364 | 358 | |
db01f759 SM |
359 | # ok() with the test name `$3` on the result of bt_grep() matching the |
360 | # pattern `$1` within the file `$2`. | |
361 | bt_grep_ok() { | |
6184c5f5 PP |
362 | local -r pattern=$1 |
363 | local -r file=$2 | |
364 | local -r test_name=$3 | |
db01f759 SM |
365 | |
366 | bt_grep --silent "$pattern" "$file" | |
367 | ||
6184c5f5 | 368 | local -r ret=$? |
db01f759 SM |
369 | |
370 | if ! ok $ret "$test_name"; then | |
371 | { | |
372 | echo "Pattern \`$pattern\` doesn't match the contents of \`$file\`:" | |
373 | echo '--- 8< ---' | |
374 | cat "$file" | |
375 | echo '--- >8 ---' | |
376 | } >&2 | |
377 | fi | |
378 | ||
379 | return $ret | |
380 | } | |
381 | ||
07ff3b19 | 382 | # Forwards the arguments to `coverage run`. |
644e0364 MJ |
383 | check_coverage() { |
384 | coverage run "$@" | |
385 | } | |
386 | ||
07ff3b19 PP |
387 | # Executes a command within an environment which can import the testing |
388 | # Python modules (in `tests/utils/python`). | |
1e14ec65 | 389 | run_python() { |
7747a39f PP |
390 | local our_pythonpath="${BT_TESTS_SRCDIR}/utils/python" |
391 | ||
315323f4 | 392 | if [[ $_bt_tests_py3_version =~ 3.[45] ]]; then |
07ff3b19 PP |
393 | # Add a local directory containing a `typing.py` to `PYTHONPATH` |
394 | # for Python 3.4 and Python 3.5 which either don't offer the | |
395 | # `typing` module at all, or offer a partial one. | |
7747a39f PP |
396 | our_pythonpath="$our_pythonpath:${BT_TESTS_SRCDIR}/utils/python/typing" |
397 | fi | |
398 | ||
399 | PYTHONPATH="${our_pythonpath}${PYTHONPATH:+:}${PYTHONPATH:-}" "$@" | |
1e14ec65 PP |
400 | } |
401 | ||
07ff3b19 PP |
402 | # Executes a command within an environment which can import the testing |
403 | # Python modules (in `tests/utils/python`) and the `bt2` Python package. | |
644e0364 | 404 | run_python_bt2() { |
1e14ec65 PP |
405 | local -x "BABELTRACE_PLUGIN_PATH=${BT_TESTS_BABELTRACE_PLUGIN_PATH}" |
406 | local -x "LIBBABELTRACE2_PLUGIN_PROVIDER_DIR=${BT_TESTS_PROVIDER_DIR}" | |
407 | local -x "BT_TESTS_DATADIR=${BT_TESTS_DATADIR}" | |
408 | local -x "BT_CTF_TRACES_PATH=${BT_CTF_TRACES_PATH}" | |
315323f4 | 409 | local -x "BT_PLUGINS_PATH=${_bt_tests_plugins_path}" |
1e14ec65 | 410 | local -x "PYTHONPATH=${BT_TESTS_PYTHONPATH}${PYTHONPATH:+:}${PYTHONPATH:-}" |
644e0364 | 411 | |
163f39d1 | 412 | local -r main_lib_path="${BT_TESTS_BUILDDIR}/../src/lib/.libs" |
0408934a | 413 | |
07ff3b19 PP |
414 | # Set the library search path so that the Python 3 interpreter can |
415 | # load `libbabeltrace2`. | |
a0baab4a | 416 | if [ "$BT_TESTS_OS_TYPE" = "mingw" ] || [ "$BT_TESTS_OS_TYPE" = "cygwin" ]; then |
1e14ec65 | 417 | local -x PATH="${main_lib_path}${PATH:+:}${PATH:-}" |
a0baab4a | 418 | elif [ "$BT_TESTS_OS_TYPE" = "darwin" ]; then |
1e14ec65 | 419 | local -x DYLD_LIBRARY_PATH="${main_lib_path}${DYLD_LIBRARY_PATH:+:}${DYLD_LIBRARY_PATH:-}" |
644e0364 | 420 | else |
1e14ec65 | 421 | local -x LD_LIBRARY_PATH="${main_lib_path}${LD_LIBRARY_PATH:+:}${LD_LIBRARY_PATH:-}" |
e23e08c4 MJ |
422 | fi |
423 | ||
07ff3b19 PP |
424 | # On Windows, an embedded Python 3 interpreter needs a way to locate |
425 | # the path to its internal modules: set the `PYTHONHOME` variable to | |
426 | # the prefix from `python3-config`. | |
a0baab4a | 427 | if [ "$BT_TESTS_OS_TYPE" = "mingw" ]; then |
1e14ec65 PP |
428 | local -x PYTHONHOME |
429 | ||
e612f2da | 430 | PYTHONHOME=$("$BT_TESTS_PYTHON_CONFIG_BIN" --prefix) |
644e0364 MJ |
431 | fi |
432 | ||
07ff3b19 | 433 | # If AddressSanitizer is used, we must preload `libasan.so` so that |
0b0893d4 SM |
434 | # libasan doesn't complain about not being the first loaded library. |
435 | # | |
07ff3b19 PP |
436 | # Python and sed (executed as part of the Libtool wrapper) produce |
437 | # some leaks, so we must unfortunately disable leak detection. | |
438 | # | |
439 | # Append it to existing `ASAN_OPTIONS` variable, such that we | |
440 | # override the user's value if it contains `detect_leaks=1`. | |
75e396f6 | 441 | if [ "${BT_TESTS_ENABLE_ASAN:-}" = "1" ]; then |
e612f2da | 442 | if "${BT_TESTS_CC_BIN}" --version | head -n 1 | bt_grep -q '^gcc'; then |
163f39d1 | 443 | local -r lib_asan="$("${BT_TESTS_CC_BIN}" -print-file-name=libasan.so)" |
1e14ec65 | 444 | local -x LD_PRELOAD="${lib_asan}${LD_PRELOAD:+:}${LD_PRELOAD:-}" |
2d12d310 | 445 | fi |
0b0893d4 | 446 | |
1e14ec65 | 447 | local -x "ASAN_OPTIONS=${ASAN_OPTIONS:-}${ASAN_OPTIONS:+,}detect_leaks=0" |
0b0893d4 SM |
448 | fi |
449 | ||
1e14ec65 | 450 | run_python "$@" |
644e0364 MJ |
451 | } |
452 | ||
07ff3b19 PP |
453 | # Runs the Python tests matching the pattern `$2` (optional, `*` if |
454 | # missing) in the directory `$1` using `testrunner.py`. | |
644e0364 | 455 | # |
07ff3b19 PP |
456 | # This function uses run_python_bt2(), therefore such tests can import |
457 | # the testing Python modules (in `tests/utils/python`) and the `bt2` | |
458 | # Python package. | |
644e0364 | 459 | run_python_bt2_test() { |
04c029a2 PP |
460 | local -r test_dir="$1" |
461 | local -r test_pattern="${2:-'*'}" | |
644e0364 | 462 | |
7c577b1d PP |
463 | local python_exec |
464 | ||
75e396f6 | 465 | if test "${BT_TESTS_COVERAGE:-}" = "1"; then |
644e0364 MJ |
466 | python_exec="check_coverage" |
467 | else | |
468 | python_exec="${BT_TESTS_PYTHON_BIN}" | |
469 | fi | |
470 | ||
471 | run_python_bt2 \ | |
472 | "${python_exec}" \ | |
473 | "${BT_TESTS_SRCDIR}/utils/python/testrunner.py" \ | |
a818a617 FD |
474 | --pattern "$test_pattern" \ |
475 | "$test_dir" \ | |
476 | ||
04c029a2 | 477 | local -r ret=$? |
644e0364 | 478 | |
75e396f6 | 479 | if test "${BT_TESTS_COVERAGE_REPORT:-}" = "1"; then |
644e0364 MJ |
480 | coverage report -m |
481 | fi | |
482 | ||
75e396f6 | 483 | if test "${BT_TESTS_COVERAGE_HTML:-}" = "1"; then |
644e0364 MJ |
484 | coverage html |
485 | fi | |
486 | ||
487 | return $ret | |
488 | } | |
89ec984e | 489 | |
07ff3b19 PP |
490 | # Generates a CTF trace into the directory `$2` from the moultipart |
491 | # document `$1` using `mctf.py`. | |
89ec984e | 492 | gen_mctf_trace() { |
71646a6b PP |
493 | local -r input_file="$1" |
494 | local -r base_dir="$2" | |
89ec984e SM |
495 | |
496 | diag "Running: ${BT_TESTS_PYTHON_BIN} ${BT_TESTS_SRCDIR}/utils/python/mctf.py --base-dir ${base_dir} ${input_file}" | |
ec48dce5 | 497 | run_python "${BT_TESTS_PYTHON_BIN}" "${BT_TESTS_SRCDIR}/utils/python/mctf.py" \ |
89ec984e SM |
498 | --base-dir "${base_dir}" "${input_file}" |
499 | } |