tests/utils/utils.sh

   1 #!/bin/bash
   2
   3 # Copyright (c) 2019 Michael Jeanson <mjeanson@efficios.com>
   4 # Copyright (C) 2019 Philippe Proulx <pproulx@efficios.com>
   5 #
   6 # This program is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; under version 2 of the License.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License along
  16 # with this program; if not, write to the Free Software Foundation, Inc.,
  17 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18
  19 # This file is meant to be sourced at the start of shell script-based tests.
  20
  21
  22 # Error out when encountering an undefined variable
  23 set -u
  24
  25 # If "readlink -f" is available, get a resolved absolute path to the
  26 # tests source dir, otherwise make do with a relative path.
  27 scriptdir="$(dirname "${BASH_SOURCE[0]}")"
  28 if readlink -f "." >/dev/null 2>&1; then
  29         testsdir=$(readlink -f "$scriptdir/..")
  30 else
  31         testsdir="$scriptdir/.."
  32 fi
  33
  34 # The OS on which we are running. See [1] for possible values of 'uname -s'.
  35 # We do a bit of translation to ease our life down the road for comparison.
  36 # Export it so that called executables can use it.
  37 # [1] https://en.wikipedia.org/wiki/Uname#Examples
  38 if [ "x${BT_OS_TYPE:-}" = "x" ]; then
  39         BT_OS_TYPE="$(uname -s)"
  40         case "$BT_OS_TYPE" in
  41         MINGW*)
  42                 BT_OS_TYPE="mingw"
  43                 ;;
  44         Darwin)
  45                 BT_OS_TYPE="darwin"
  46                 ;;
  47         Linux)
  48                 BT_OS_TYPE="linux"
  49                 ;;
  50         CYGWIN*)
  51                 BT_OS_TYPE="cygwin"
  52                 ;;
  53         *)
  54                 BT_OS_TYPE="unsupported"
  55                 ;;
  56         esac
  57 fi
  58 export BT_OS_TYPE
  59
  60 # Allow overriding the source and build directories
  61 if [ "x${BT_TESTS_SRCDIR:-}" = "x" ]; then
  62         BT_TESTS_SRCDIR="$testsdir"
  63 fi
  64 export BT_TESTS_SRCDIR
  65
  66 if [ "x${BT_TESTS_BUILDDIR:-}" = "x" ]; then
  67         BT_TESTS_BUILDDIR="$testsdir"
  68 fi
  69 export BT_TESTS_BUILDDIR
  70
  71 # By default, it will not source tap.sh.  If you to tap output directly from
  72 # the test script, define the 'SH_TAP' variable to '1' before sourcing this
  73 # script.
  74 if [ "x${SH_TAP:-}" = x1 ]; then
  75         # shellcheck source=./tap/tap.sh
  76         . "${BT_TESTS_SRCDIR}/utils/tap/tap.sh"
  77 fi
  78
  79 # Allow overriding the babeltrace2 executables
  80 if [ "x${BT_TESTS_BT2_BIN:-}" = "x" ]; then
  81         BT_TESTS_BT2_BIN="$BT_TESTS_BUILDDIR/../src/cli/babeltrace2"
  82         if [ "$BT_OS_TYPE" = "mingw" ]; then
  83                 BT_TESTS_BT2_BIN="${BT_TESTS_BT2_BIN}.exe"
  84         fi
  85 fi
  86 export BT_TESTS_BT2_BIN
  87
  88 # TODO: Remove when bindings/python/bt2/test_plugin.py is fixed
  89 BT_PLUGINS_PATH="${BT_TESTS_BUILDDIR}/../src/plugins"
  90
  91 # Allow overriding the babeltrace2 plugin path
  92 if [ "x${BT_TESTS_BABELTRACE_PLUGIN_PATH:-}" = "x" ]; then
  93         BT_TESTS_BABELTRACE_PLUGIN_PATH="${BT_PLUGINS_PATH}/ctf:${BT_PLUGINS_PATH}/utils:${BT_PLUGINS_PATH}/text:${BT_PLUGINS_PATH}/lttng-utils"
  94 fi
  95
  96 if [ "x${BT_TESTS_PROVIDER_DIR:-}" = "x" ]; then
  97         BT_TESTS_PROVIDER_DIR="${BT_TESTS_BUILDDIR}/../src/python-plugin-provider/.libs"
  98 fi
  99
 100 # Allow overriding the babeltrace2 executables
 101 if [ "x${BT_TESTS_PYTHONPATH:-}" = "x" ]; then
 102         BT_TESTS_PYTHONPATH="${BT_TESTS_BUILDDIR}/../src/bindings/python/bt2/build/build_lib"
 103 fi
 104
 105
 106 ### External Tools ###
 107 if [ "x${BT_TESTS_AWK_BIN:-}" = "x" ]; then
 108         BT_TESTS_AWK_BIN="awk"
 109 fi
 110 export BT_TESTS_AWK_BIN
 111
 112 if [ "x${BT_TESTS_GREP_BIN:-}" = "x" ]; then
 113         BT_TESTS_GREP_BIN="grep"
 114 fi
 115 export BT_TESTS_GREP_BIN
 116
 117 if [ "x${BT_TESTS_PYTHON_BIN:-}" = "x" ]; then
 118         BT_TESTS_PYTHON_BIN="python3"
 119 fi
 120 export BT_TESTS_PYTHON_BIN
 121
 122 if [ "x${BT_TESTS_PYTHON_CONFIG_BIN:-}" = "x" ]; then
 123         BT_TESTS_PYTHON_CONFIG_BIN="python3-config"
 124 fi
 125 export BT_TESTS_PYTHON_CONFIG_BIN
 126
 127 if [ "x${BT_TESTS_SED_BIN:-}" = "x" ]; then
 128         BT_TESTS_SED_BIN="sed"
 129 fi
 130 export BT_TESTS_SED_BIN
 131
 132
 133 # Data files path
 134 BT_TESTS_DATADIR="${BT_TESTS_SRCDIR}/data"
 135 BT_CTF_TRACES_PATH="${BT_TESTS_DATADIR}/ctf-traces"
 136
 137 # Remove CR characters in file "$1".
 138
 139 bt_remove_cr() {
 140         "$BT_TESTS_SED_BIN" -i 's/\r//g' "$1"
 141 }
 142
 143 # Run the Babeltrace CLI, redirecting stdout and stderr to specified files.
 144 #
 145 #   $1: file to redirect stdout to
 146 #   $2: file to redirect stderr to
 147 #   remaining args: arguments to pass to the CLI
 148 #
 149 # Return the exit code of the CLI.
 150
 151 bt_cli() {
 152         local stdout_file="$1"
 153         local stderr_file="$2"
 154         shift 2
 155         local args=("$@")
 156
 157         echo "Running: $BT_TESTS_BT2_BIN ${args[*]}" >&2
 158         run_python_bt2 "$BT_TESTS_BT2_BIN" "${args[@]}" 1>"$stdout_file" 2>"$stderr_file"
 159 }
 160
 161 ### Diff Functions ###
 162
 163 # Check the differences between two files (typically some expected output vs
 164 # some actual output).  If there are differences, print the diff to stderr.
 165 #
 166 #   $1: file 1 (expected)
 167 #   $2: file 2 (actual)
 168 #
 169 # Return 0 if there's no difference, and non-zero if there are.
 170 #
 171 # Note that this function modifies the actual output file ($2) _in-place_ to
 172 # remove any \r character.
 173
 174 bt_diff() {
 175         local expected_file="$1"
 176         local actual_file="$2"
 177         local ret=0
 178
 179         # Strip any \r present due to Windows (\n -> \r\n).
 180         # "diff --string-trailing-cr" is not used since it is not present on
 181         # Solaris.
 182         bt_remove_cr "$actual_file"
 183
 184         diff -u "$expected_file" "$actual_file" 1>&2
 185
 186         return $?
 187 }
 188
 189 # Checks the difference between:
 190 #
 191 #   1. What the CLI outputs on its standard output when given the arguments
 192 #   "$@" (excluding the first two arguments).
 193 #   2. The file with path "$1".
 194 #
 195 # And the difference between:
 196 #
 197 #   1. What the CLI outputs on its standard error when given the arguments
 198 #   "$@" (excluding the first two arguments).
 199 #   2. The file with path "$2".
 200 #
 201 # Returns 0 if there's no difference, and 1 if there is, also printing
 202 # said difference to the standard error.
 203 bt_diff_cli() {
 204         local expected_stdout_file="$1"
 205         local expected_stderr_file="$2"
 206         shift 2
 207         local args=("$@")
 208
 209         local temp_stdout_output_file
 210         local temp_stderr_output_file
 211         local ret=0
 212         local ret_stdout
 213         local ret_stderr
 214
 215         temp_stdout_output_file="$(mktemp -t actual_stdout.XXXXXX)"
 216         temp_stderr_output_file="$(mktemp -t actual_stderr.XXXXXX)"
 217
 218         # Run the CLI to get a detailed file.
 219         bt_cli "$temp_stdout_output_file" "$temp_stderr_output_file" "${args[@]}"
 220
 221         bt_diff "$expected_stdout_file" "$temp_stdout_output_file" "${args[@]}"
 222         ret_stdout=$?
 223         bt_diff "$expected_stderr_file" "$temp_stderr_output_file" "${args[@]}"
 224         ret_stderr=$?
 225
 226         if ((ret_stdout != 0 || ret_stderr != 0)); then
 227                 ret=1
 228         fi
 229
 230         rm -f "$temp_stdout_output_file" "$temp_stderr_output_file"
 231
 232         return $ret
 233 }
 234
 235 # Checks the difference between the content of the file with path "$1"
 236 # and the output of the CLI when called on the directory path "$2" with
 237 # the arguments '-c sink.text.details' and the rest of the arguments to
 238 # this function.
 239 #
 240 # Returns 0 if there's no difference, and 1 if there is, also printing
 241 # said difference to the standard error.
 242 bt_diff_details_ctf_single() {
 243         local expected_stdout_file="$1"
 244         local trace_dir="$2"
 245         shift 2
 246         local extra_details_args=("$@")
 247         expected_stderr_file="/dev/null"
 248
 249         # Compare using the CLI with `sink.text.details`
 250         bt_diff_cli "$expected_stdout_file" "$expected_stderr_file" "$trace_dir" \
 251                 "-c" "sink.text.details" "${extra_details_args[@]+${extra_details_args[@]}}"
 252 }
 253
 254 # Calls bt_diff_details_ctf_single(), except that "$1" is the path to a
 255 # program which generates the CTF trace to compare to. The program "$1"
 256 # receives the path to a temporary, empty directory where to write the
 257 # CTF trace as its first argument.
 258 bt_diff_details_ctf_gen_single() {
 259         local ctf_gen_prog_path="$1"
 260         local expected_stdout_file="$2"
 261         shift 2
 262         local extra_details_args=("$@")
 263
 264         local temp_trace_dir
 265         local ret
 266
 267         temp_trace_dir="$(mktemp -d)"
 268
 269         # Run the CTF trace generator program to get a CTF trace
 270         if ! "$ctf_gen_prog_path" "$temp_trace_dir" 2>/dev/null; then
 271                 echo "ERROR: \"$ctf_gen_prog_path\" \"$temp_trace_dir\" failed" >&2
 272                 rm -rf "$temp_trace_dir"
 273                 return 1
 274         fi
 275
 276         # Compare using the CLI with `sink.text.details`
 277         bt_diff_details_ctf_single "$expected_stdout_file" "$temp_trace_dir" \
 278                 "${extra_details_args[@]+${extra_details_args[@]}}"
 279         ret=$?
 280         rm -rf "$temp_trace_dir"
 281         return $ret
 282 }
 283
 284
 285 ### Functions ###
 286
 287 check_coverage() {
 288         coverage run "$@"
 289 }
 290
 291 # Execute a shell command in the appropriate environment to have access to the
 292 # bt2 Python bindings.
 293 run_python_bt2() {
 294         local env_args
 295
 296         env_args=(
 297                 "BABELTRACE_PYTHON_BT2_NO_TRACEBACK=1" \
 298                 "BABELTRACE_PLUGIN_PATH=${BT_TESTS_BABELTRACE_PLUGIN_PATH}" \
 299                 "LIBBABELTRACE2_PLUGIN_PROVIDER_DIR=${BT_TESTS_PROVIDER_DIR}" \
 300                 "BT_TESTS_DATADIR=${BT_TESTS_DATADIR}" \
 301                 "BT_CTF_TRACES_PATH=${BT_CTF_TRACES_PATH}" \
 302                 "BT_PLUGINS_PATH=${BT_PLUGINS_PATH}" \
 303                 "PYTHONPATH=${BT_TESTS_PYTHONPATH}:${BT_TESTS_SRCDIR}/utils/python"
 304                 )
 305
 306         local main_lib_path="${BT_TESTS_BUILDDIR}/../src/lib/.libs"
 307
 308         # Set the library search path so the python interpreter can load libbabeltrace2
 309         if [ "$BT_OS_TYPE" = "mingw" ] || [ "$BT_OS_TYPE" = "cygwin" ]; then
 310                 env_args+=("PATH=${main_lib_path}:${PATH:-}")
 311         elif [ "$BT_OS_TYPE" = "darwin" ]; then
 312                 env_args+=("DYLD_LIBRARY_PATH=${main_lib_path}:${DYLD_LIBRARY_PATH:-}")
 313         else
 314                 env_args+=("LD_LIBRARY_PATH=${main_lib_path}:${LD_LIBRARY_PATH:-}")
 315         fi
 316
 317         # On Windows, an embedded Python interpreter needs a way to locate the path
 318         # to it's internal modules, set the prefix from python-config to the
 319         # PYTHONHOME variable.
 320         if [ "$BT_OS_TYPE" = "mingw" ]; then
 321                 env_args+=("PYTHONHOME=$($BT_TESTS_PYTHON_CONFIG_BIN --prefix)")
 322         fi
 323
 324         env "${env_args[@]}" "$@"
 325 }
 326
 327 # Set the environment and run python tests in the directory.
 328 #
 329 # $1 : The directory containing the python test scripts
 330 # $2 : The pattern to match python test script names (optional)
 331 run_python_bt2_test() {
 332         local test_dir="$1"
 333         local test_pattern="${2:-'*'}" # optional, if none default to "*"
 334
 335         local ret
 336         local test_runner_args=()
 337
 338         test_runner_args+=("$test_dir")
 339         if [ "x${test_pattern}" != "x" ]; then
 340                 test_runner_args+=("${test_pattern}")
 341         fi
 342
 343         if test "x${BT_TESTS_COVERAGE:-}" = "x1"; then
 344                 python_exec="check_coverage"
 345         else
 346                 python_exec="${BT_TESTS_PYTHON_BIN}"
 347         fi
 348
 349         run_python_bt2 \
 350                 "${python_exec}" \
 351                 "${BT_TESTS_SRCDIR}/utils/python/testrunner.py" \
 352                 --pattern "$test_pattern" \
 353                 "$test_dir" \
 354
 355         ret=$?
 356
 357         if test "x${BT_TESTS_COVERAGE_REPORT:-}" = "x1"; then
 358                 coverage report -m
 359         fi
 360
 361         if test "x${BT_TESTS_COVERAGE_HTML:-}" = "x1"; then
 362                 coverage html
 363         fi
 364
 365         return $ret
 366 }