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 # Run the Babeltrace CLI, redirecting stdout and stderr to specified files.
 138 #
 139 #   $1: file to redirect stdout to
 140 #   $2: file to redirect stderr to
 141 #   remaining args: arguments to pass to the CLI
 142 #
 143 # Return the exit code of the CLI.
 144
 145 bt_cli() {
 146         local stdout_file="$1"
 147         local stderr_file="$2"
 148         shift 2
 149         local args=("$@")
 150
 151         echo "Running: $BT_TESTS_BT2_BIN ${args[*]}" >&2
 152         run_python_bt2 "$BT_TESTS_BT2_BIN" "${args[@]}" 1>"$stdout_file" 2>"$stderr_file"
 153 }
 154
 155 ### Diff Functions ###
 156
 157 # Check the differences between two files (typically some expected output vs
 158 # some actual output).  If there are differences, print the diff to stderr.
 159 #
 160 #   $1: file 1 (expected)
 161 #   $2: file 2 (actual)
 162 #
 163 # Return 0 if there's no difference, and non-zero if there are.
 164 #
 165 # Note that this function modifies the actual output file ($2) _in-place_ to
 166 # remove any \r character.
 167
 168 bt_diff() {
 169         local expected_file="$1"
 170         local actual_file="$2"
 171         local ret=0
 172
 173         # Strip any \r present due to Windows (\n -> \r\n).
 174         # "diff --string-trailing-cr" is not used since it is not present on
 175         # Solaris.
 176         "$BT_TESTS_SED_BIN" -i 's/\r//g' "$actual_file"
 177
 178         diff -u "$expected_file" "$actual_file" 1>&2
 179
 180         return $?
 181 }
 182
 183 # Checks the difference between:
 184 #
 185 #   1. What the CLI outputs on its standard output when given the arguments
 186 #   "$@" (excluding the first two arguments).
 187 #   2. The file with path "$1".
 188 #
 189 # And the difference between:
 190 #
 191 #   1. What the CLI outputs on its standard error when given the arguments
 192 #   "$@" (excluding the first two arguments).
 193 #   2. The file with path "$2".
 194 #
 195 # Returns 0 if there's no difference, and 1 if there is, also printing
 196 # said difference to the standard error.
 197 bt_diff_cli() {
 198         local expected_stdout_file="$1"
 199         local expected_stderr_file="$2"
 200         shift 2
 201         local args=("$@")
 202
 203         local temp_stdout_output_file
 204         local temp_stderr_output_file
 205         local ret=0
 206         local ret_stdout
 207         local ret_stderr
 208
 209         temp_stdout_output_file="$(mktemp -t actual_stdout.XXXXXX)"
 210         temp_stderr_output_file="$(mktemp -t actual_stderr.XXXXXX)"
 211
 212         # Run the CLI to get a detailed file.
 213         bt_cli "$temp_stdout_output_file" "$temp_stderr_output_file" "${args[@]}"
 214
 215         bt_diff "$expected_stdout_file" "$temp_stdout_output_file" "${args[@]}"
 216         ret_stdout=$?
 217         bt_diff "$expected_stderr_file" "$temp_stderr_output_file" "${args[@]}"
 218         ret_stderr=$?
 219
 220         if ((ret_stdout != 0 || ret_stderr != 0)); then
 221                 ret=1
 222         fi
 223
 224         rm -f "$temp_stdout_output_file" "$temp_stderr_output_file"
 225
 226         return $ret
 227 }
 228
 229 # Checks the difference between the content of the file with path "$1"
 230 # and the output of the CLI when called on the directory path "$2" with
 231 # the arguments '-c sink.text.details' and the rest of the arguments to
 232 # this function.
 233 #
 234 # Returns 0 if there's no difference, and 1 if there is, also printing
 235 # said difference to the standard error.
 236 bt_diff_details_ctf_single() {
 237         local expected_stdout_file="$1"
 238         local trace_dir="$2"
 239         shift 2
 240         local extra_details_args=("$@")
 241         expected_stderr_file="/dev/null"
 242
 243         # Compare using the CLI with `sink.text.details`
 244         bt_diff_cli "$expected_stdout_file" "$expected_stderr_file" "$trace_dir" \
 245                 "-c" "sink.text.details" "${extra_details_args[@]+${extra_details_args[@]}}"
 246 }
 247
 248 # Calls bt_diff_details_ctf_single(), except that "$1" is the path to a
 249 # program which generates the CTF trace to compare to. The program "$1"
 250 # receives the path to a temporary, empty directory where to write the
 251 # CTF trace as its first argument.
 252 bt_diff_details_ctf_gen_single() {
 253         local ctf_gen_prog_path="$1"
 254         local expected_stdout_file="$2"
 255         shift 2
 256         local extra_details_args=("$@")
 257
 258         local temp_trace_dir
 259         local ret
 260
 261         temp_trace_dir="$(mktemp -d)"
 262
 263         # Run the CTF trace generator program to get a CTF trace
 264         if ! "$ctf_gen_prog_path" "$temp_trace_dir" 2>/dev/null; then
 265                 echo "ERROR: \"$ctf_gen_prog_path\" \"$temp_trace_dir\" failed" >&2
 266                 rm -rf "$temp_trace_dir"
 267                 return 1
 268         fi
 269
 270         # Compare using the CLI with `sink.text.details`
 271         bt_diff_details_ctf_single "$expected_stdout_file" "$temp_trace_dir" \
 272                 "${extra_details_args[@]+${extra_details_args[@]}}"
 273         ret=$?
 274         rm -rf "$temp_trace_dir"
 275         return $ret
 276 }
 277
 278
 279 ### Functions ###
 280
 281 check_coverage() {
 282         coverage run "$@"
 283 }
 284
 285 # Execute a shell command in the appropriate environment to have access to the
 286 # bt2 Python bindings.
 287 run_python_bt2() {
 288         local env_args
 289
 290         env_args=(
 291                 "BABELTRACE_PYTHON_BT2_NO_TRACEBACK=1" \
 292                 "BABELTRACE_PLUGIN_PATH=${BT_TESTS_BABELTRACE_PLUGIN_PATH}" \
 293                 "LIBBABELTRACE2_PLUGIN_PROVIDER_DIR=${BT_TESTS_PROVIDER_DIR}" \
 294                 "BT_TESTS_DATADIR=${BT_TESTS_DATADIR}" \
 295                 "BT_CTF_TRACES_PATH=${BT_CTF_TRACES_PATH}" \
 296                 "BT_PLUGINS_PATH=${BT_PLUGINS_PATH}" \
 297                 "PYTHONPATH=${BT_TESTS_PYTHONPATH}:${BT_TESTS_SRCDIR}/utils/python"
 298                 )
 299
 300         local main_lib_path="${BT_TESTS_BUILDDIR}/../src/lib/.libs"
 301
 302         # Set the library search path so the python interpreter can load libbabeltrace2
 303         if [ "$BT_OS_TYPE" = "mingw" ] || [ "$BT_OS_TYPE" = "cygwin" ]; then
 304                 env_args+=("PATH=${main_lib_path}:${PATH:-}")
 305         elif [ "$BT_OS_TYPE" = "darwin" ]; then
 306                 env_args+=("DYLD_LIBRARY_PATH=${main_lib_path}:${DYLD_LIBRARY_PATH:-}")
 307         else
 308                 env_args+=("LD_LIBRARY_PATH=${main_lib_path}:${LD_LIBRARY_PATH:-}")
 309         fi
 310
 311         # On Windows, an embedded Python interpreter needs a way to locate the path
 312         # to it's internal modules, set the prefix from python-config to the
 313         # PYTHONHOME variable.
 314         if [ "$BT_OS_TYPE" = "mingw" ]; then
 315                 env_args+=("PYTHONHOME=$($BT_TESTS_PYTHON_CONFIG_BIN --prefix)")
 316         fi
 317
 318         env "${env_args[@]}" "$@"
 319 }
 320
 321 # Set the environment and run python tests in the directory.
 322 #
 323 # $1 : The directory containing the python test scripts
 324 # $2 : The pattern to match python test script names (optional)
 325 run_python_bt2_test() {
 326         local test_dir="$1"
 327         local test_pattern="${2:-'*'}" # optional, if none default to "*"
 328
 329         local ret
 330         local test_runner_args=()
 331
 332         test_runner_args+=("$test_dir")
 333         if [ "x${test_pattern}" != "x" ]; then
 334                 test_runner_args+=("${test_pattern}")
 335         fi
 336
 337         if test "x${BT_TESTS_COVERAGE:-}" = "x1"; then
 338                 python_exec="check_coverage"
 339         else
 340                 python_exec="${BT_TESTS_PYTHON_BIN}"
 341         fi
 342
 343         run_python_bt2 \
 344                 "${python_exec}" \
 345                 "${BT_TESTS_SRCDIR}/utils/python/testrunner.py" \
 346                 --pattern "$test_pattern" \
 347                 "$test_dir" \
 348
 349         ret=$?
 350
 351         if test "x${BT_TESTS_COVERAGE_REPORT:-}" = "x1"; then
 352                 coverage report -m
 353         fi
 354
 355         if test "x${BT_TESTS_COVERAGE_HTML:-}" = "x1"; then
 356                 coverage html
 357         fi
 358
 359         return $ret
 360 }