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 Philippe Proulx <pproulx@efficios.com>
   7 #
   8
   9 # This file is meant to be sourced at the start of shell script-based tests.
  10
  11
  12 # Error out when encountering an undefined variable
  13 set -u
  14
  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/..")
  20 else
  21         testsdir="$scriptdir/.."
  22 fi
  23
  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
  31         MINGW*)
  32                 BT_TESTS_OS_TYPE="mingw"
  33                 ;;
  34         Darwin)
  35                 BT_TESTS_OS_TYPE="darwin"
  36                 ;;
  37         Linux)
  38                 BT_TESTS_OS_TYPE="linux"
  39                 ;;
  40         CYGWIN*)
  41                 BT_TESTS_OS_TYPE="cygwin"
  42                 ;;
  43         *)
  44                 BT_TESTS_OS_TYPE="unsupported"
  45                 ;;
  46         esac
  47 fi
  48 export BT_TESTS_OS_TYPE
  49
  50 # Allow overriding the source and build directories
  51 if [ -z "${BT_TESTS_SRCDIR:-}" ]; then
  52         BT_TESTS_SRCDIR="$testsdir"
  53 fi
  54 export BT_TESTS_SRCDIR
  55
  56 if [ -z "${BT_TESTS_BUILDDIR:-}" ]; then
  57         BT_TESTS_BUILDDIR="$testsdir"
  58 fi
  59 export BT_TESTS_BUILDDIR
  60
  61
  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"
  66 fi
  67
  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"
  73         fi
  74 fi
  75 export BT_TESTS_BT2_BIN
  76
  77 # TODO: Remove when bindings/python/bt2/test_plugin.py is fixed
  78 BT_PLUGINS_PATH="${BT_TESTS_BUILDDIR}/../src/plugins"
  79
  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"
  83 fi
  84 export BT_TESTS_BABELTRACE_PLUGIN_PATH
  85
  86 if [ -z "${BT_TESTS_PROVIDER_DIR:-}" ]; then
  87         BT_TESTS_PROVIDER_DIR="${BT_TESTS_BUILDDIR}/../src/python-plugin-provider/.libs"
  88 fi
  89 export BT_TESTS_PROVIDER_DIR
  90
  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"
  94 fi
  95 export BT_TESTS_PYTHONPATH
  96
  97
  98 ### External Tools ###
  99 if [ -z "${BT_TESTS_AWK_BIN:-}" ]; then
 100         BT_TESTS_AWK_BIN="awk"
 101 fi
 102 export BT_TESTS_AWK_BIN
 103
 104 if [ -z "${BT_TESTS_GREP_BIN:-}" ]; then
 105         BT_TESTS_GREP_BIN="grep"
 106 fi
 107 export BT_TESTS_GREP_BIN
 108
 109 if [ -z "${BT_TESTS_PYTHON_BIN:-}" ]; then
 110         BT_TESTS_PYTHON_BIN="python3"
 111 fi
 112 export BT_TESTS_PYTHON_BIN
 113
 114 BT_TESTS_PYTHON_VERSION=$($BT_TESTS_PYTHON_BIN -c 'import sys; print("{}.{}".format(sys.version_info.major, sys.version_info.minor))')
 115
 116 if [ -z "${BT_TESTS_PYTHON_CONFIG_BIN:-}" ]; then
 117         BT_TESTS_PYTHON_CONFIG_BIN="python3-config"
 118 fi
 119 export BT_TESTS_PYTHON_CONFIG_BIN
 120
 121 if [ -z "${BT_TESTS_SED_BIN:-}" ]; then
 122         BT_TESTS_SED_BIN="sed"
 123 fi
 124 export BT_TESTS_SED_BIN
 125
 126 if [ -z "${BT_TESTS_CC_BIN:-}" ]; then
 127         BT_TESTS_CC_BIN="cc"
 128 fi
 129 export BT_TESTS_CC_BIN
 130
 131
 132 ### Optional features ###
 133
 134 if [ -z "${BT_TESTS_ENABLE_ASAN:-}" ]; then
 135         BT_TESTS_ENABLE_ASAN="0"
 136 fi
 137 export BT_TESTS_ENABLE_ASAN
 138
 139
 140 # Data files path
 141 BT_TESTS_DATADIR="${BT_TESTS_SRCDIR}/data"
 142 BT_CTF_TRACES_PATH="${BT_TESTS_DATADIR}/ctf-traces"
 143
 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
 146 # this script.
 147 if [ "${SH_TAP:-}" = 1 ]; then
 148         # shellcheck source=./tap/tap.sh
 149         . "${BT_TESTS_SRCDIR}/utils/tap/tap.sh"
 150 fi
 151
 152
 153 # Remove CR characters in file "$1".
 154
 155 bt_remove_cr() {
 156         "$BT_TESTS_SED_BIN" -i'' -e 's/\r//g' "$1"
 157 }
 158
 159 # Run the Babeltrace CLI, redirecting stdout and stderr to specified files.
 160 #
 161 #   $1: file to redirect stdout to
 162 #   $2: file to redirect stderr to
 163 #   remaining args: arguments to pass to the CLI
 164 #
 165 # Return the exit code of the CLI.
 166
 167 bt_cli() {
 168         local stdout_file="$1"
 169         local stderr_file="$2"
 170         shift 2
 171         local args=("$@")
 172
 173         echo "Running: $BT_TESTS_BT2_BIN ${args[*]}" >&2
 174         run_python_bt2 "$BT_TESTS_BT2_BIN" "${args[@]}" 1>"$stdout_file" 2>"$stderr_file"
 175 }
 176
 177 ### Diff Functions ###
 178
 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.
 181 #
 182 #   $1: file 1 (expected)
 183 #   $2: file 2 (actual)
 184 #
 185 # Return 0 if there's no difference, and non-zero if there are.
 186 #
 187 # Note that this function modifies the actual output file ($2) _in-place_ to
 188 # remove any \r character.
 189
 190 bt_diff() {
 191         local expected_file="$1"
 192         local actual_file="$2"
 193         local ret=0
 194
 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
 197         # Solaris.
 198         bt_remove_cr "$actual_file"
 199
 200         diff -u "$expected_file" "$actual_file" 1>&2
 201
 202         return $?
 203 }
 204
 205 # Checks the difference between:
 206 #
 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".
 210 #
 211 # And the difference between:
 212 #
 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".
 216 #
 217 # Returns 0 if there's no difference, and 1 if there is, also printing
 218 # said difference to the standard error.
 219 bt_diff_cli() {
 220         local expected_stdout_file="$1"
 221         local expected_stderr_file="$2"
 222         shift 2
 223         local args=("$@")
 224
 225         local temp_stdout_output_file
 226         local temp_stderr_output_file
 227         local ret=0
 228         local ret_stdout
 229         local ret_stderr
 230
 231         temp_stdout_output_file="$(mktemp -t actual_stdout.XXXXXX)"
 232         temp_stderr_output_file="$(mktemp -t actual_stderr.XXXXXX)"
 233
 234         # Run the CLI to get a detailed file.
 235         bt_cli "$temp_stdout_output_file" "$temp_stderr_output_file" "${args[@]}"
 236
 237         bt_diff "$expected_stdout_file" "$temp_stdout_output_file" "${args[@]}"
 238         ret_stdout=$?
 239         bt_diff "$expected_stderr_file" "$temp_stderr_output_file" "${args[@]}"
 240         ret_stderr=$?
 241
 242         if ((ret_stdout != 0 || ret_stderr != 0)); then
 243                 ret=1
 244         fi
 245
 246         rm -f "$temp_stdout_output_file" "$temp_stderr_output_file"
 247
 248         return $ret
 249 }
 250
 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
 254 # this function.
 255 #
 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"
 260         local trace_dir="$2"
 261         shift 2
 262         local extra_details_args=("$@")
 263         expected_stderr_file="/dev/null"
 264
 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[@]}}"
 268 }
 269
 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"
 277         shift 2
 278         local extra_details_args=("$@")
 279
 280         local temp_trace_dir
 281         local ret
 282
 283         temp_trace_dir="$(mktemp -d)"
 284
 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"
 289                 return 1
 290         fi
 291
 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[@]}}"
 295         ret=$?
 296         rm -rf "$temp_trace_dir"
 297         return $ret
 298 }
 299
 300
 301 ### Functions ###
 302
 303 check_coverage() {
 304         coverage run "$@"
 305 }
 306
 307 # Execute a shell command in the appropriate environment to access the Python
 308 # test utility modules in `tests/utils/python`.
 309 run_python() {
 310         local our_pythonpath="${BT_TESTS_SRCDIR}/utils/python"
 311
 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"
 316         fi
 317
 318         PYTHONPATH="${our_pythonpath}${PYTHONPATH:+:}${PYTHONPATH:-}" "$@"
 319 }
 320
 321 # Execute a shell command in the appropriate environment to have access to the
 322 # bt2 Python bindings.
 323 run_python_bt2() {
 324         local lib_asan
 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:-}"
 332
 333         local main_lib_path="${BT_TESTS_BUILDDIR}/../src/lib/.libs"
 334
 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:-}"
 340         else
 341                 local -x LD_LIBRARY_PATH="${main_lib_path}${LD_LIBRARY_PATH:+:}${LD_LIBRARY_PATH:-}"
 342         fi
 343
 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
 348                 local -x PYTHONHOME
 349
 350                 PYTHONHOME=$($BT_TESTS_PYTHON_CONFIG_BIN --prefix)
 351         fi
 352
 353         # If AddressSanitizer is used, we must preload libasan.so so that
 354         # libasan doesn't complain about not being the first loaded library.
 355         #
 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:-}"
 364                 fi
 365
 366                 local -x  "ASAN_OPTIONS=${ASAN_OPTIONS:-}${ASAN_OPTIONS:+,}detect_leaks=0"
 367         fi
 368
 369         run_python "$@"
 370 }
 371
 372 # Set the environment and run python tests in the directory.
 373 #
 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() {
 377         local test_dir="$1"
 378         local test_pattern="${2:-'*'}" # optional, if none default to "*"
 379
 380         local ret
 381         local test_runner_args=()
 382
 383         test_runner_args+=("$test_dir")
 384         if [ -n "${test_pattern}" ]; then
 385                 test_runner_args+=("${test_pattern}")
 386         fi
 387
 388         if test "${BT_TESTS_COVERAGE:-}" = "1"; then
 389                 python_exec="check_coverage"
 390         else
 391                 python_exec="${BT_TESTS_PYTHON_BIN}"
 392         fi
 393
 394         run_python_bt2 \
 395                 "${python_exec}" \
 396                 "${BT_TESTS_SRCDIR}/utils/python/testrunner.py" \
 397                 --pattern "$test_pattern" \
 398                 "$test_dir" \
 399
 400         ret=$?
 401
 402         if test "${BT_TESTS_COVERAGE_REPORT:-}" = "1"; then
 403                 coverage report -m
 404         fi
 405
 406         if test "${BT_TESTS_COVERAGE_HTML:-}" = "1"; then
 407                 coverage html
 408         fi
 409
 410         return $ret
 411 }
 412
 413 # Generate a CTF trace using `mctf.py`.
 414 #
 415 # $1: Input filename
 416 # $2: Base directory path for output files
 417 gen_mctf_trace() {
 418         local input_file="$1"
 419         local base_dir="$2"
 420
 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}"
 424 }