tests/utils/utils.sh

   1 #!/bin/bash
   2 #
   3 # SPDX-License-Identifier: GPL-2.0-only
   4 #
   5 # Copyright (c) 2019 Michael Jeanson <mjeanson@efficios.com>
   6 # Copyright (C) 2019-2023 Philippe Proulx <pproulx@efficios.com>
   7
   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).
  24
  25 # An unbound variable is an error
  26 set -u
  27
  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.
  43 if [ -z "${BT_TESTS_OS_TYPE:-}" ]; then
  44         BT_TESTS_OS_TYPE="$(uname -s)"
  45         case "$BT_TESTS_OS_TYPE" in
  46         MINGW*)
  47                 BT_TESTS_OS_TYPE="mingw"
  48                 ;;
  49         Darwin)
  50                 BT_TESTS_OS_TYPE="darwin"
  51                 ;;
  52         Linux)
  53                 BT_TESTS_OS_TYPE="linux"
  54                 ;;
  55         CYGWIN*)
  56                 BT_TESTS_OS_TYPE="cygwin"
  57                 ;;
  58         *)
  59                 BT_TESTS_OS_TYPE="unsupported"
  60                 ;;
  61         esac
  62 fi
  63 export BT_TESTS_OS_TYPE
  64
  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
  75
  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 }
  94
  95 _set_vars_srcdir_builddir
  96 unset -f _set_vars_srcdir_builddir
  97
  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
 110
 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"
 116         fi
 117 fi
 118 export BT_TESTS_BT2_BIN
 119
 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.
 124 _bt_tests_plugins_path="${BT_TESTS_BUILDDIR}/../src/plugins"
 125
 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"
 129 fi
 130 export BT_TESTS_BABELTRACE_PLUGIN_PATH
 131
 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"
 135 fi
 136 export BT_TESTS_PROVIDER_DIR
 137
 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"
 141 fi
 142 export BT_TESTS_PYTHONPATH
 143
 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"
 147 fi
 148 export BT_TESTS_AWK_BIN
 149
 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"
 153 fi
 154 export BT_TESTS_GREP_BIN
 155
 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"
 159 fi
 160 export BT_TESTS_PYTHON_BIN
 161
 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.
 166 _bt_tests_py3_version=$("$BT_TESTS_PYTHON_BIN" -c 'import sys; print("{}.{}".format(sys.version_info.major, sys.version_info.minor))')
 167
 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"
 171 fi
 172 export BT_TESTS_PYTHON_CONFIG_BIN
 173
 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"
 177 fi
 178 export BT_TESTS_SED_BIN
 179
 180 # Name of the `cc` command to use when testing, if not set
 181 if [ -z "${BT_TESTS_CC_BIN:-}" ]; then
 182         BT_TESTS_CC_BIN="cc"
 183 fi
 184 export BT_TESTS_CC_BIN
 185
 186 # Whether or not to enable AddressSanitizer, `0` (disabled) if not set.
 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.
 190 if [ -z "${BT_TESTS_ENABLE_ASAN:-}" ]; then
 191         BT_TESTS_ENABLE_ASAN="0"
 192 fi
 193
 194 # Directory containing test data
 195 BT_TESTS_DATADIR="${BT_TESTS_SRCDIR}/data"
 196
 197 # Directory containing test CTF traces
 198 BT_CTF_TRACES_PATH="${BT_TESTS_DATADIR}/ctf-traces"
 199
 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"
 204 fi
 205
 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.
 212 bt_remove_cr() {
 213         "$BT_TESTS_SED_BIN" -i'' -e 's/\r//g' "$1"
 214 }
 215
 216 # Prints `$1` without CR characters.
 217 bt_remove_cr_inline() {
 218     "$BT_TESTS_SED_BIN" 's/\r//g' "$1"
 219 }
 220
 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.
 224 #
 225 # The remaining arguments are forwarded to the `$BT_TESTS_BT2_BIN`
 226 # command.
 227 #
 228 # Returns the exit status of the executed `$BT_TESTS_BT2_BIN`.
 229 bt_cli() {
 230         local -r stdout_file="$1"
 231         local -r stderr_file="$2"
 232         shift 2
 233         local -r args=("$@")
 234
 235         echo "Running: \`$BT_TESTS_BT2_BIN ${args[*]}\`" >&2
 236         run_python_bt2 "$BT_TESTS_BT2_BIN" "${args[@]}" 1>"$stdout_file" 2>"$stderr_file"
 237 }
 238
 239 # Checks the differences between:
 240 #
 241 # • The (expected) contents of the file having the path `$1`.
 242 #
 243 # • The contents of another file having the path `$2`.
 244 #
 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.
 249 bt_diff() {
 250         local -r expected_file="$1"
 251         local -r actual_file="$2"
 252
 253         diff -u <(bt_remove_cr_inline "$expected_file") <(bt_remove_cr_inline "$actual_file") 1>&2
 254 }
 255
 256 # Checks the difference between:
 257 #
 258 # • What the `$BT_TESTS_BT2_BIN` command prints to its standard output
 259 #   when given the third and following arguments of this function.
 260 #
 261 # • The file having the path `$1`.
 262 #
 263 # as well as the difference between:
 264 #
 265 # • What the `$BT_TESTS_BT2_BIN` command prints to its standard error
 266 #   when given the third and following arguments of this function.
 267 #
 268 # • The file having the path `$2`.
 269 #
 270 # Returns 0 if there's no difference, or 1 otherwise, also printing said
 271 # difference to the standard error.
 272 bt_diff_cli() {
 273         local -r expected_stdout_file="$1"
 274         local -r expected_stderr_file="$2"
 275         shift 2
 276         local -r args=("$@")
 277
 278         local -r temp_stdout_output_file="$(mktemp -t actual-stdout.XXXXXX)"
 279         local -r temp_stderr_output_file="$(mktemp -t actual-stderr.XXXXXX)"
 280         local ret=0
 281
 282         bt_cli "$temp_stdout_output_file" "$temp_stderr_output_file" "${args[@]}"
 283
 284         bt_diff "$expected_stdout_file" "$temp_stdout_output_file" "${args[@]}"
 285         local -r ret_stdout=$?
 286         bt_diff "$expected_stderr_file" "$temp_stderr_output_file" "${args[@]}"
 287         local -r ret_stderr=$?
 288
 289         if ((ret_stdout != 0 || ret_stderr != 0)); then
 290                 ret=1
 291         fi
 292
 293         rm -f "$temp_stdout_output_file" "$temp_stderr_output_file"
 294
 295         return $ret
 296 }
 297
 298 # Checks the difference between:
 299 #
 300 # • The content of the file having the path `$1`.
 301 #
 302 # • What the `$BT_TESTS_BT2_BIN` command prints to the standard output
 303 #   when executed with:
 304 #
 305 #   1. The CTF trace directory `$2`.
 306 #   2. The arguments `-c` and `sink.text.details`.
 307 #   3. The third and following arguments of this function.
 308 #
 309 # Returns 0 if there's no difference, or 1 otherwise, also printing said
 310 # difference to the standard error.
 311 bt_diff_details_ctf_single() {
 312         local -r expected_stdout_file="$1"
 313         local -r trace_dir="$2"
 314         shift 2
 315         local -r extra_details_args=("$@")
 316         expected_stderr_file="/dev/null"
 317
 318         # Compare using the CLI with `sink.text.details`
 319         bt_diff_cli "$expected_stdout_file" "$expected_stderr_file" "$trace_dir" \
 320                 "-c" "sink.text.details" "${extra_details_args[@]+${extra_details_args[@]}}"
 321 }
 322
 323 # Like bt_diff_details_ctf_single(), except that `$1` is the path to a
 324 # program which generates the CTF trace to compare to.
 325 #
 326 # The program `$1` receives the path to a temporary, empty directory
 327 # where to write the CTF trace as its first argument.
 328 bt_diff_details_ctf_gen_single() {
 329         local -r ctf_gen_prog_path="$1"
 330         local -r expected_stdout_file="$2"
 331         shift 2
 332         local -r extra_details_args=("$@")
 333
 334         local -r temp_trace_dir="$(mktemp -d)"
 335
 336         # Run the CTF trace generator program to get a CTF trace
 337         if ! "$ctf_gen_prog_path" "$temp_trace_dir" 2>/dev/null; then
 338                 echo "ERROR: \`$ctf_gen_prog_path $temp_trace_dir\` failed" >&2
 339                 rm -rf "$temp_trace_dir"
 340                 return 1
 341         fi
 342
 343         # Compare using the CLI with `sink.text.details`
 344         bt_diff_details_ctf_single "$expected_stdout_file" "$temp_trace_dir" \
 345                 "${extra_details_args[@]+${extra_details_args[@]}}"
 346         local -r ret=$?
 347         rm -rf "$temp_trace_dir"
 348         return $ret
 349 }
 350
 351 # Like `grep`, but using `$BT_TESTS_GREP_BIN`.
 352 bt_grep() {
 353         "$BT_TESTS_GREP_BIN" "$@"
 354 }
 355
 356 # ok() with the test name `$3` on the result of bt_grep() matching the
 357 # pattern `$1` within the file `$2`.
 358 bt_grep_ok() {
 359         local -r pattern=$1
 360         local -r file=$2
 361         local -r test_name=$3
 362
 363         bt_grep --silent "$pattern" "$file"
 364
 365         local -r ret=$?
 366
 367         if ! ok $ret "$test_name"; then
 368                 {
 369                         echo "Pattern \`$pattern\` doesn't match the contents of \`$file\`:"
 370                         echo '--- 8< ---'
 371                         cat "$file"
 372                         echo '--- >8 ---'
 373                 } >&2
 374         fi
 375
 376         return $ret
 377 }
 378
 379 # Forwards the arguments to `coverage run`.
 380 check_coverage() {
 381         coverage run "$@"
 382 }
 383
 384 # Executes a command within an environment which can import the testing
 385 # Python modules (in `tests/utils/python`).
 386 run_python() {
 387         local our_pythonpath="${BT_TESTS_SRCDIR}/utils/python"
 388
 389         if [[ $_bt_tests_py3_version =~ 3.[45] ]]; then
 390                 # Add a local directory containing a `typing.py` to `PYTHONPATH`
 391                 # for Python 3.4 and Python 3.5 which either don't offer the
 392                 # `typing` module at all, or offer a partial one.
 393                 our_pythonpath="$our_pythonpath:${BT_TESTS_SRCDIR}/utils/python/typing"
 394         fi
 395
 396         PYTHONPATH="${our_pythonpath}${PYTHONPATH:+:}${PYTHONPATH:-}" "$@"
 397 }
 398
 399 # Executes a command within an environment which can import the testing
 400 # Python modules (in `tests/utils/python`) and the `bt2` Python package.
 401 run_python_bt2() {
 402         local -x "BABELTRACE_PLUGIN_PATH=${BT_TESTS_BABELTRACE_PLUGIN_PATH}"
 403         local -x "LIBBABELTRACE2_PLUGIN_PROVIDER_DIR=${BT_TESTS_PROVIDER_DIR}"
 404         local -x "BT_TESTS_DATADIR=${BT_TESTS_DATADIR}"
 405         local -x "BT_CTF_TRACES_PATH=${BT_CTF_TRACES_PATH}"
 406         local -x "BT_PLUGINS_PATH=${_bt_tests_plugins_path}"
 407         local -x "PYTHONPATH=${BT_TESTS_PYTHONPATH}${PYTHONPATH:+:}${PYTHONPATH:-}"
 408
 409         local -r main_lib_path="${BT_TESTS_BUILDDIR}/../src/lib/.libs"
 410
 411         # Set the library search path so that the Python 3 interpreter can
 412         # load `libbabeltrace2`.
 413         if [ "$BT_TESTS_OS_TYPE" = "mingw" ] || [ "$BT_TESTS_OS_TYPE" = "cygwin" ]; then
 414                 local -x PATH="${main_lib_path}${PATH:+:}${PATH:-}"
 415         elif [ "$BT_TESTS_OS_TYPE" = "darwin" ]; then
 416                 local -x DYLD_LIBRARY_PATH="${main_lib_path}${DYLD_LIBRARY_PATH:+:}${DYLD_LIBRARY_PATH:-}"
 417         else
 418                 local -x LD_LIBRARY_PATH="${main_lib_path}${LD_LIBRARY_PATH:+:}${LD_LIBRARY_PATH:-}"
 419         fi
 420
 421         # On Windows, an embedded Python 3 interpreter needs a way to locate
 422         # the path to its internal modules: set the `PYTHONHOME` variable to
 423         # the prefix from `python3-config`.
 424         if [ "$BT_TESTS_OS_TYPE" = "mingw" ]; then
 425                 local -x PYTHONHOME
 426
 427                 PYTHONHOME=$("$BT_TESTS_PYTHON_CONFIG_BIN" --prefix)
 428         fi
 429
 430         # If AddressSanitizer is used, we must preload `libasan.so` so that
 431         # libasan doesn't complain about not being the first loaded library.
 432         #
 433         # Python and sed (executed as part of the Libtool wrapper) produce
 434         # some leaks, so we must unfortunately disable leak detection.
 435         #
 436         # Append it to existing `ASAN_OPTIONS` variable, such that we
 437         # override the user's value if it contains `detect_leaks=1`.
 438         if [ "${BT_TESTS_ENABLE_ASAN:-}" = "1" ]; then
 439                 if "${BT_TESTS_CC_BIN}" --version | head -n 1 | bt_grep -q '^gcc'; then
 440                         local -r lib_asan="$("${BT_TESTS_CC_BIN}" -print-file-name=libasan.so)"
 441                         local -x LD_PRELOAD="${lib_asan}${LD_PRELOAD:+:}${LD_PRELOAD:-}"
 442                 fi
 443
 444                 local -x  "ASAN_OPTIONS=${ASAN_OPTIONS:-}${ASAN_OPTIONS:+,}detect_leaks=0"
 445         fi
 446
 447         run_python "$@"
 448 }
 449
 450 # Runs the Python tests matching the pattern `$2` (optional, `*` if
 451 # missing) in the directory `$1` using `testrunner.py`.
 452 #
 453 # This function uses run_python_bt2(), therefore such tests can import
 454 # the testing Python modules (in `tests/utils/python`) and the `bt2`
 455 # Python package.
 456 run_python_bt2_test() {
 457         local -r test_dir="$1"
 458         local -r test_pattern="${2:-'*'}"
 459
 460         local python_exec
 461
 462         if test "${BT_TESTS_COVERAGE:-}" = "1"; then
 463                 python_exec="check_coverage"
 464         else
 465                 python_exec="${BT_TESTS_PYTHON_BIN}"
 466         fi
 467
 468         run_python_bt2 \
 469                 "${python_exec}" \
 470                 "${BT_TESTS_SRCDIR}/utils/python/testrunner.py" \
 471                 --pattern "$test_pattern" \
 472                 "$test_dir" \
 473
 474         local -r ret=$?
 475
 476         if test "${BT_TESTS_COVERAGE_REPORT:-}" = "1"; then
 477                 coverage report -m
 478         fi
 479
 480         if test "${BT_TESTS_COVERAGE_HTML:-}" = "1"; then
 481                 coverage html
 482         fi
 483
 484         return $ret
 485 }
 486
 487 # Generates a CTF trace into the directory `$2` from the moultipart
 488 # document `$1` using `mctf.py`.
 489 gen_mctf_trace() {
 490         local -r input_file="$1"
 491         local -r base_dir="$2"
 492
 493         diag "Running: \`${BT_TESTS_PYTHON_BIN} ${BT_TESTS_SRCDIR}/utils/python/mctf.py --base-dir ${base_dir} ${input_file}\`"
 494         run_python "${BT_TESTS_PYTHON_BIN}" "${BT_TESTS_SRCDIR}/utils/python/mctf.py" \
 495                 --base-dir "${base_dir}" "${input_file}"
 496 }