#!/bin/bash
-
+#
+# SPDX-License-Identifier: GPL-2.0-only
+#
# Copyright (c) 2019 Michael Jeanson <mjeanson@efficios.com>
-# Copyright (C) 2019 Philippe Proulx <pproulx@efficios.com>
+# Copyright (C) 2019-2023 Philippe Proulx <pproulx@efficios.com>
+
+# Source this file at the beginning of a shell script test to access
+# useful testing variables and functions:
#
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; under version 2 of the License.
+# SH_TAP=1
#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
+# if [[ -n ${BT_TESTS_SRCDIR:-} ]]; then
+# UTILSSH=$BT_TESTS_SRCDIR/utils/utils.sh
+# else
+# UTILSSH=$(dirname "$0")/../utils/utils.sh
+# fi
#
-# You should have received a copy of the GNU General Public License along
-# with this program; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-
-# This file is meant to be sourced at the start of shell script-based tests.
-
+# # shellcheck source=../utils/utils.sh
+# source "$UTILSSH"
+#
+# Make sure the relative path to `utils.sh` (this file) above is
+# correct (twice).
-# Error out when encountering an undefined variable
+# An unbound variable is an error
set -u
-# If "readlink -f" is available, get a resolved absolute path to the
-# tests source dir, otherwise make do with a relative path.
-scriptdir="$(dirname "${BASH_SOURCE[0]}")"
-if readlink -f "." >/dev/null 2>&1; then
- testsdir=$(readlink -f "$scriptdir/..")
-else
- testsdir="$scriptdir/.."
-fi
-
-# The OS on which we are running. See [1] for possible values of 'uname -s'.
-# We do a bit of translation to ease our life down the road for comparison.
-# Export it so that called executables can use it.
-# [1] https://en.wikipedia.org/wiki/Uname#Examples
-if [ "x${BT_OS_TYPE:-}" = "x" ]; then
- BT_OS_TYPE="$(uname -s)"
- case "$BT_OS_TYPE" in
+# Name of the OS on which we're running, if not set.
+#
+# One of:
+#
+# `mingw`: MinGW (Windows)
+# `darwin`: macOS
+# `linux`: Linux
+# `cygwin`: Cygwin (Windows)
+# `unsupported`: Anything else
+#
+# See <https://en.wikipedia.org/wiki/Uname#Examples> for possible values
+# of `uname -s`.
+#
+# Do some translation to ease our life down the road for comparison.
+# Export it so that executed commands can use it.
+if [ -z "${BT_TESTS_OS_TYPE:-}" ]; then
+ BT_TESTS_OS_TYPE="$(uname -s)"
+ case "$BT_TESTS_OS_TYPE" in
MINGW*)
- BT_OS_TYPE="mingw"
+ BT_TESTS_OS_TYPE="mingw"
;;
Darwin)
- BT_OS_TYPE="darwin"
+ BT_TESTS_OS_TYPE="darwin"
;;
Linux)
- BT_OS_TYPE="linux"
+ BT_TESTS_OS_TYPE="linux"
;;
CYGWIN*)
- BT_OS_TYPE="cygwin"
+ BT_TESTS_OS_TYPE="cygwin"
;;
*)
- BT_OS_TYPE="unsupported"
+ BT_TESTS_OS_TYPE="unsupported"
;;
esac
fi
-export BT_OS_TYPE
+export BT_TESTS_OS_TYPE
-# Allow overriding the source and build directories
-if [ "x${BT_TESTS_SRCDIR:-}" = "x" ]; then
- BT_TESTS_SRCDIR="$testsdir"
-fi
-export BT_TESTS_SRCDIR
+# Sets and exports, if not set:
+#
+# • `BT_TESTS_SRCDIR` to the base source directory of tests.
+# • `BT_TESTS_BUILDDIR` to the base build directory of tests.
+_set_vars_srcdir_builddir() {
+ # If `readlink -f` is available, then get a resolved absolute path
+ # to the tests source directory. Otherwise, make do with a relative
+ # path.
+ local -r scriptdir="$(dirname "${BASH_SOURCE[0]}")"
+ local testsdir
+
+ if readlink -f "." >/dev/null 2>&1; then
+ testsdir=$(readlink -f "$scriptdir/..")
+ else
+ testsdir="$scriptdir/.."
+ fi
-if [ "x${BT_TESTS_BUILDDIR:-}" = "x" ]; then
- BT_TESTS_BUILDDIR="$testsdir"
-fi
-export BT_TESTS_BUILDDIR
+ # Base source directory of tests
+ if [ -z "${BT_TESTS_SRCDIR:-}" ]; then
+ BT_TESTS_SRCDIR="$testsdir"
+ fi
+ export BT_TESTS_SRCDIR
-# By default, it will not source tap.sh. If you to tap output directly from
-# the test script, define the 'SH_TAP' variable to '1' before sourcing this
-# script.
-if [ "x${SH_TAP:-}" = x1 ]; then
- # shellcheck source=./tap/tap.sh
- . "${BT_TESTS_SRCDIR}/utils/tap/tap.sh"
-fi
+ # Base build directory of tests
+ if [ -z "${BT_TESTS_BUILDDIR:-}" ]; then
+ BT_TESTS_BUILDDIR="$testsdir"
+ fi
+ export BT_TESTS_BUILDDIR
+}
-# Allow overriding the babeltrace2 executables
-if [ "x${BT_TESTS_BT2_BIN:-}" = "x" ]; then
+_set_vars_srcdir_builddir
+unset -f _set_vars_srcdir_builddir
+
+# Sources the generated environment file (`env.sh`) if it exists.
+_source_env_sh() {
+ local -r env_sh_path="$BT_TESTS_BUILDDIR/utils/env.sh"
+
+ if [ -f "${env_sh_path}" ]; then
+ # shellcheck disable=SC1090,SC1091
+ . "${env_sh_path}"
+ fi
+}
+
+_source_env_sh
+unset -f _source_env_sh
+
+# Path to the `babeltrace2` command, if not set
+if [ -z "${BT_TESTS_BT2_BIN:-}" ]; then
BT_TESTS_BT2_BIN="$BT_TESTS_BUILDDIR/../src/cli/babeltrace2"
- if [ "$BT_OS_TYPE" = "mingw" ]; then
+ if [ "$BT_TESTS_OS_TYPE" = "mingw" ]; then
BT_TESTS_BT2_BIN="${BT_TESTS_BT2_BIN}.exe"
fi
fi
export BT_TESTS_BT2_BIN
-# TODO: Remove when bindings/python/bt2/test_plugin.py is fixed
-BT_PLUGINS_PATH="${BT_TESTS_BUILDDIR}/../src/plugins"
+# This doesn't need to be exported, but it needs to remain set for
+# run_python_bt2() to use it.
+#
+# TODO: Remove when `tests/bindings/python/bt2/test_plugin.py` is fixed.
+_bt_tests_plugins_path="${BT_TESTS_BUILDDIR}/../src/plugins"
-# Allow overriding the babeltrace2 plugin path
-if [ "x${BT_TESTS_BABELTRACE_PLUGIN_PATH:-}" = "x" ]; then
- BT_TESTS_BABELTRACE_PLUGIN_PATH="${BT_PLUGINS_PATH}/ctf:${BT_PLUGINS_PATH}/utils:${BT_PLUGINS_PATH}/text"
+# Colon-separated list of project plugin paths, if not set
+if [ -z "${BT_TESTS_BABELTRACE_PLUGIN_PATH:-}" ]; then
+ 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"
fi
+export BT_TESTS_BABELTRACE_PLUGIN_PATH
-if [ "x${BT_TESTS_PROVIDER_DIR:-}" = "x" ]; then
+# Directory containing the Python plugin provider library, if not set
+if [ -z "${BT_TESTS_PROVIDER_DIR:-}" ]; then
BT_TESTS_PROVIDER_DIR="${BT_TESTS_BUILDDIR}/../src/python-plugin-provider/.libs"
fi
+export BT_TESTS_PROVIDER_DIR
-# Allow overriding the babeltrace2 executables
-if [ "x${BT_TESTS_PYTHONPATH:-}" = "x" ]; then
+# Directory containing the built `bt2` Python package, if not set
+if [ -z "${BT_TESTS_PYTHONPATH:-}" ]; then
BT_TESTS_PYTHONPATH="${BT_TESTS_BUILDDIR}/../src/bindings/python/bt2/build/build_lib"
fi
+export BT_TESTS_PYTHONPATH
-
-### External Tools ###
-if [ "x${BT_TESTS_AWK_BIN:-}" = "x" ]; then
+# Name of the `awk` command to use when testing, if not set
+if [ -z "${BT_TESTS_AWK_BIN:-}" ]; then
BT_TESTS_AWK_BIN="awk"
fi
export BT_TESTS_AWK_BIN
-if [ "x${BT_TESTS_GREP_BIN:-}" = "x" ]; then
+# Name of the `grep` command to use when testing, if not set
+if [ -z "${BT_TESTS_GREP_BIN:-}" ]; then
BT_TESTS_GREP_BIN="grep"
fi
export BT_TESTS_GREP_BIN
-if [ "x${BT_TESTS_PYTHON_BIN:-}" = "x" ]; then
+# Name of the `python3` command to use when testing, if not set
+if [ -z "${BT_TESTS_PYTHON_BIN:-}" ]; then
BT_TESTS_PYTHON_BIN="python3"
fi
export BT_TESTS_PYTHON_BIN
-if [ "x${BT_TESTS_PYTHON_CONFIG_BIN:-}" = "x" ]; then
+# Major and minor version of the `python3` command to use when testing.
+#
+# This doesn't need to be exported, but it needs to remain set for
+# run_python() to use it.
+_bt_tests_py3_version=$("$BT_TESTS_PYTHON_BIN" -c 'import sys; print("{}.{}".format(sys.version_info.major, sys.version_info.minor))')
+
+# Name of the `python3-config` command to use when testing, if not set
+if [ -z "${BT_TESTS_PYTHON_CONFIG_BIN:-}" ]; then
BT_TESTS_PYTHON_CONFIG_BIN="python3-config"
fi
export BT_TESTS_PYTHON_CONFIG_BIN
-if [ "x${BT_TESTS_SED_BIN:-}" = "x" ]; then
+# Name of the `sed` command to use when testing, if not set
+if [ -z "${BT_TESTS_SED_BIN:-}" ]; then
BT_TESTS_SED_BIN="sed"
fi
export BT_TESTS_SED_BIN
+# Name of the `cc` command to use when testing, if not set
+if [ -z "${BT_TESTS_CC_BIN:-}" ]; then
+ BT_TESTS_CC_BIN="cc"
+fi
+export BT_TESTS_CC_BIN
+
+# Whether or not to enable AddressSanitizer, `0` (disabled) if not set.
+#
+# This doesn't need to be exported from the point of view of this file,
+# but the sourced `env.sh` above does export it.
+if [ -z "${BT_TESTS_ENABLE_ASAN:-}" ]; then
+ BT_TESTS_ENABLE_ASAN="0"
+fi
-# Data files path
+# Directory containing test data
BT_TESTS_DATADIR="${BT_TESTS_SRCDIR}/data"
-BT_CTF_TRACES_PATH="${BT_TESTS_DATADIR}/ctf-traces"
+# Directory containing test CTF traces
+BT_CTF_TRACES_PATH="${BT_TESTS_DATADIR}/ctf-traces"
-### Diff Functions ###
+# Source the shell TAP utilities if `SH_TAP` is `1`
+if [ "${SH_TAP:-}" = 1 ]; then
+ # shellcheck source=./tap/tap.sh
+ . "${BT_TESTS_SRCDIR}/utils/tap/tap.sh"
+fi
-# Checks the difference between stdout:
-#
-# The file with path "$1", and the file with path "$2"
+# Removes the CR characters from the file having the path `$1`.
#
-# And the difference between stderr:
+# This is sometimes needed on Windows with text files.
#
-# The file with path "$3", and the file with path "$4"
-#
-# Returns 0 if there's no difference, and 1 if there is, also printing
-# said difference to the standard error, and an error message with the
-# args starting at "$5".
-bt_diff() {
- local expected_stdout_file="$1"
- local actual_stdout_file="$2"
- local expected_stderr_file="$3"
- local actual_stderr_file="$4"
- shift 4
- local args=("$@")
-
- local ret=0
- local temp_diff
-
- temp_diff="$(mktemp -t diff.XXXXXX)"
-
- # Strip any \r present due to Windows (\n -> \r\n).
- # "diff --string-trailing-cr" is not used since it is not present on
- # Solaris.
- "$BT_TESTS_SED_BIN" -i 's/\r//g' "$actual_stdout_file"
- "$BT_TESTS_SED_BIN" -i 's/\r//g' "$actual_stderr_file"
-
- # Compare stdout output with expected stdout output
- if ! diff -u "$actual_stdout_file" "$expected_stdout_file" 2>/dev/null >"$temp_diff"; then
- echo "ERROR: for '${args[*]}': actual standard output and expected output differ:" >&2
- cat "$temp_diff" >&2
- ret=1
- fi
+# We can't use the `--string-trailing-cr` option of `diff` because
+# Solaris doesn't have it.
+bt_remove_cr() {
+ "$BT_TESTS_SED_BIN" -i'' -e 's/\r//g' "$1"
+}
- # Compare stderr output with expected stderr output
- if ! diff -u "$actual_stderr_file" "$expected_stderr_file" 2>/dev/null >"$temp_diff"; then
- echo "ERROR: for '${args[*]}': actual standard error and expected error differ:" >&2
- cat "$temp_diff" >&2
- ret=1
- fi
+# Prints `$1` without CR characters.
+bt_remove_cr_inline() {
+ "$BT_TESTS_SED_BIN" 's/\r//g' "$1"
+}
- rm -f "$temp_diff"
+# Runs the `$BT_TESTS_BT2_BIN` command within an environment which can
+# import the `bt2` Python package, redirecting the standard output to
+# the `$1` file and the standard error to the `$2` file.
+#
+# The remaining arguments are forwarded to the `$BT_TESTS_BT2_BIN`
+# command.
+#
+# Returns the exit status of the executed `$BT_TESTS_BT2_BIN`.
+bt_cli() {
+ local -r stdout_file="$1"
+ local -r stderr_file="$2"
+ shift 2
+ local -r args=("$@")
- return $ret
+ echo "Running: $BT_TESTS_BT2_BIN ${args[*]}" >&2
+ run_python_bt2 "$BT_TESTS_BT2_BIN" "${args[@]}" 1>"$stdout_file" 2>"$stderr_file"
}
-# Checks the difference between:
+# Checks the differences between:
#
-# 1. What the CLI outputs on its standard output when given the arguments
-# "$@" (excluding the first two arguments).
-# 2. The file with path "$1".
+# • The (expected) contents of the file having the path `$1`.
#
-# And the difference between:
+# • The contents of another file having the path `$2`.
#
-# 1. What the CLI outputs on its standard error when given the arguments
-# "$@" (excluding the first two arguments).
-# 2. The file with path "$2".
+# Both files are passed through bt_remove_cr_inline() to remove CR
+# characters.
#
-# Returns 0 if there's no difference, and 1 if there is, also printing
-# said difference to the standard error.
-bt_diff_cli() {
- local expected_stdout_file="$1"
- local expected_stderr_file="$2"
- shift 2
- local args=("$@")
-
- local temp_stdout_output_file
- local temp_stderr_output_file
+# Returns 0 if there's no difference, or not zero otherwise.
+bt_diff() {
+ local -r expected_file="$1"
+ local -r actual_file="$2"
local ret=0
- temp_stdout_output_file="$(mktemp -t actual_stdout.XXXXXX)"
- temp_stderr_output_file="$(mktemp -t actual_stderr.XXXXXX)"
+ diff -u <(bt_remove_cr_inline "$expected_file") <(bt_remove_cr_inline "$actual_file") 1>&2
- # Run the CLI to get a detailed file.
- run_python_bt2 "$BT_TESTS_BT2_BIN" "${args[@]}" 1>"$temp_stdout_output_file" 2>"$temp_stderr_output_file"
-
- bt_diff "$expected_stdout_file" "$temp_stdout_output_file" "$expected_stderr_file" "$temp_stderr_output_file" "${args[@]}"
- ret=$?
-
- rm -f "$temp_stdout_output_file" "$temp_stderr_output_file"
-
- return $ret
+ return $?
}
# Checks the difference between:
#
-# 1. What the CLI outputs on its standard output when given the arguments
-# "$@" (excluding the first two arguments), sorted with the default "sort".
-# 2. The file with path "$1".
+# • What the `$BT_TESTS_BT2_BIN` command prints to its standard output
+# when given the third and following arguments of this function.
+#
+# • The file having the path `$1`.
+#
+# as well as the difference between:
#
-# And the difference between:
+# • What the `$BT_TESTS_BT2_BIN` command prints to its standard error
+# when given the third and following arguments of this function.
#
-# 1. What the CLI outputs on its standard error when given the arguments
-# "$@" (excluding the first two arguments).
-# 2. The file with path "$2".
+# • The file having the path `$2`.
#
-# Returns 0 if there's no difference, and 1 if there is, also printing
-# said difference to the standard error.
-bt_diff_cli_sorted() {
- local expected_stdout_file="$1"
- local expected_stderr_file="$2"
+# Returns 0 if there's no difference, or 1 otherwise, also printing said
+# difference to the standard error.
+bt_diff_cli() {
+ local -r expected_stdout_file="$1"
+ local -r expected_stderr_file="$2"
shift 2
- local args=("$@")
+ local -r args=("$@")
- local temp_stdout_output_file
- local temp_stderr_output_file
+ local -r temp_stdout_output_file="$(mktemp -t actual-stdout.XXXXXX)"
+ local -r temp_stderr_output_file="$(mktemp -t actual-stderr.XXXXXX)"
local ret=0
- temp_stdout_output_file="$(mktemp -t actual_stdout.XXXXXX)"
- temp_stderr_output_file="$(mktemp -t actual_stderr.XXXXXX)"
-
- # Run the CLI to get a detailed file.
- run_python_bt2 "$BT_TESTS_BT2_BIN" "${args[@]}" 1>"$temp_stdout_output_file" 2>"$temp_stderr_output_file"
+ bt_cli "$temp_stdout_output_file" "$temp_stderr_output_file" "${args[@]}"
- # Sort the stdout file, use a subshell to do it in-place
- # shellcheck disable=SC2005
- echo "$(LC_ALL=C sort "$temp_stdout_output_file")" > "$temp_stdout_output_file"
+ bt_diff "$expected_stdout_file" "$temp_stdout_output_file" "${args[@]}"
+ local -r ret_stdout=$?
+ bt_diff "$expected_stderr_file" "$temp_stderr_output_file" "${args[@]}"
+ local -r ret_stderr=$?
- bt_diff "$expected_stdout_file" "$temp_stdout_output_file" "$expected_stderr_file" "$temp_stderr_output_file" "${args[@]}"
- ret=$?
+ if ((ret_stdout != 0 || ret_stderr != 0)); then
+ ret=1
+ fi
rm -f "$temp_stdout_output_file" "$temp_stderr_output_file"
return $ret
}
-# Checks the difference between the content of the file with path "$1"
-# and the output of the CLI when called on the directory path "$2" with
-# the arguments '-c sink.text.details' and the rest of the arguments to
-# this function.
+# Checks the difference between:
+#
+# • The content of the file having the path `$1`.
#
-# Returns 0 if there's no difference, and 1 if there is, also printing
-# said difference to the standard error.
+# • What the `$BT_TESTS_BT2_BIN` command prints to the standard output
+# when executed with:
+#
+# 1. The CTF trace directory `$2`.
+# 2. The arguments `-c` and `sink.text.details`.
+# 3. The third and following arguments of this function.
+#
+# Returns 0 if there's no difference, or 1 otherwise, also printing said
+# difference to the standard error.
bt_diff_details_ctf_single() {
- local expected_stdout_file="$1"
- local trace_dir="$2"
+ local -r expected_stdout_file="$1"
+ local -r trace_dir="$2"
shift 2
- local extra_details_args=("$@")
+ local -r extra_details_args=("$@")
expected_stderr_file="/dev/null"
# Compare using the CLI with `sink.text.details`
- bt_diff_cli "$expected_stdout_file" "$expected_stderr_file" "$trace_dir" "-c" "sink.text.details" "${extra_details_args[@]}"
+ bt_diff_cli "$expected_stdout_file" "$expected_stderr_file" "$trace_dir" \
+ "-c" "sink.text.details" "${extra_details_args[@]+${extra_details_args[@]}}"
}
-# Calls bt_diff_details_ctf_single(), except that "$1" is the path to a
-# program which generates the CTF trace to compare to. The program "$1"
-# receives the path to a temporary, empty directory where to write the
-# CTF trace as its first argument.
+# Like bt_diff_details_ctf_single(), except that `$1` is the path to a
+# program which generates the CTF trace to compare to.
+#
+# The program `$1` receives the path to a temporary, empty directory
+# where to write the CTF trace as its first argument.
bt_diff_details_ctf_gen_single() {
- local ctf_gen_prog_path="$1"
- local expected_stdout_file="$2"
+ local -r ctf_gen_prog_path="$1"
+ local -r expected_stdout_file="$2"
shift 2
- local extra_details_args=("$@")
-
- local temp_trace_dir
- local ret
+ local -r extra_details_args=("$@")
- temp_trace_dir="$(mktemp -d)"
+ local -r temp_trace_dir="$(mktemp -d)"
# Run the CTF trace generator program to get a CTF trace
if ! "$ctf_gen_prog_path" "$temp_trace_dir" 2>/dev/null; then
fi
# Compare using the CLI with `sink.text.details`
- bt_diff_details_ctf_single "$expected_stdout_file" "$temp_trace_dir" "${extra_details_args[@]}"
- ret=$?
+ bt_diff_details_ctf_single "$expected_stdout_file" "$temp_trace_dir" \
+ "${extra_details_args[@]+${extra_details_args[@]}}"
+ local -r ret=$?
rm -rf "$temp_trace_dir"
return $ret
}
+# Like `grep`, but using `$BT_TESTS_GREP_BIN`.
+bt_grep() {
+ "$BT_TESTS_GREP_BIN" "$@"
+}
+
+# ok() with the test name `$3` on the result of bt_grep() matching the
+# pattern `$1` within the file `$2`.
+bt_grep_ok() {
+ local -r pattern=$1
+ local -r file=$2
+ local -r test_name=$3
+
+ bt_grep --silent "$pattern" "$file"
-### Functions ###
+ local -r ret=$?
+ if ! ok $ret "$test_name"; then
+ {
+ echo "Pattern \`$pattern\` doesn't match the contents of \`$file\`:"
+ echo '--- 8< ---'
+ cat "$file"
+ echo '--- >8 ---'
+ } >&2
+ fi
+
+ return $ret
+}
+
+# Forwards the arguments to `coverage run`.
check_coverage() {
coverage run "$@"
}
-# Execute a shell command in the appropriate environment to have access to the
-# bt2 Python bindings.
+# Executes a command within an environment which can import the testing
+# Python modules (in `tests/utils/python`).
+run_python() {
+ local our_pythonpath="${BT_TESTS_SRCDIR}/utils/python"
+
+ if [[ $_bt_tests_py3_version =~ 3.[45] ]]; then
+ # Add a local directory containing a `typing.py` to `PYTHONPATH`
+ # for Python 3.4 and Python 3.5 which either don't offer the
+ # `typing` module at all, or offer a partial one.
+ our_pythonpath="$our_pythonpath:${BT_TESTS_SRCDIR}/utils/python/typing"
+ fi
+
+ PYTHONPATH="${our_pythonpath}${PYTHONPATH:+:}${PYTHONPATH:-}" "$@"
+}
+
+# Executes a command within an environment which can import the testing
+# Python modules (in `tests/utils/python`) and the `bt2` Python package.
run_python_bt2() {
- local env_args
-
- env_args=(
- "BABELTRACE_PYTHON_BT2_NO_TRACEBACK=1" \
- "BABELTRACE_PLUGIN_PATH=${BT_TESTS_BABELTRACE_PLUGIN_PATH}" \
- "LIBBABELTRACE2_PLUGIN_PROVIDER_DIR=${BT_TESTS_PROVIDER_DIR}" \
- "BT_CTF_TRACES_PATH=${BT_CTF_TRACES_PATH}" \
- "BT_PLUGINS_PATH=${BT_PLUGINS_PATH}" \
- "PYTHONPATH=${BT_TESTS_PYTHONPATH}:${BT_TESTS_SRCDIR}/utils/python"
- )
-
- local main_lib_path="${BT_TESTS_BUILDDIR}/../src/lib/.libs"
-
- # Set the library search path so the python interpreter can load libbabeltrace2
- if [ "$BT_OS_TYPE" = "mingw" ] || [ "$BT_OS_TYPE" = "cygwin" ]; then
- env_args+=("PATH=${main_lib_path}:${PATH:-}")
- elif [ "$BT_OS_TYPE" = "darwin" ]; then
- env_args+=("DYLD_LIBRARY_PATH=${main_lib_path}:${DYLD_LIBRARY_PATH:-}")
+ local -x "BABELTRACE_PLUGIN_PATH=${BT_TESTS_BABELTRACE_PLUGIN_PATH}"
+ local -x "LIBBABELTRACE2_PLUGIN_PROVIDER_DIR=${BT_TESTS_PROVIDER_DIR}"
+ local -x "BT_TESTS_DATADIR=${BT_TESTS_DATADIR}"
+ local -x "BT_CTF_TRACES_PATH=${BT_CTF_TRACES_PATH}"
+ local -x "BT_PLUGINS_PATH=${_bt_tests_plugins_path}"
+ local -x "PYTHONPATH=${BT_TESTS_PYTHONPATH}${PYTHONPATH:+:}${PYTHONPATH:-}"
+
+ local -r main_lib_path="${BT_TESTS_BUILDDIR}/../src/lib/.libs"
+
+ # Set the library search path so that the Python 3 interpreter can
+ # load `libbabeltrace2`.
+ if [ "$BT_TESTS_OS_TYPE" = "mingw" ] || [ "$BT_TESTS_OS_TYPE" = "cygwin" ]; then
+ local -x PATH="${main_lib_path}${PATH:+:}${PATH:-}"
+ elif [ "$BT_TESTS_OS_TYPE" = "darwin" ]; then
+ local -x DYLD_LIBRARY_PATH="${main_lib_path}${DYLD_LIBRARY_PATH:+:}${DYLD_LIBRARY_PATH:-}"
else
- env_args+=("LD_LIBRARY_PATH=${main_lib_path}:${LD_LIBRARY_PATH:-}")
+ local -x LD_LIBRARY_PATH="${main_lib_path}${LD_LIBRARY_PATH:+:}${LD_LIBRARY_PATH:-}"
+ fi
+
+ # On Windows, an embedded Python 3 interpreter needs a way to locate
+ # the path to its internal modules: set the `PYTHONHOME` variable to
+ # the prefix from `python3-config`.
+ if [ "$BT_TESTS_OS_TYPE" = "mingw" ]; then
+ local -x PYTHONHOME
+
+ PYTHONHOME=$("$BT_TESTS_PYTHON_CONFIG_BIN" --prefix)
fi
- # On Windows, an embedded Python interpreter needs a way to locate the path
- # to it's internal modules, set the prefix from python-config to the
- # PYTHONHOME variable.
- if [ "$BT_OS_TYPE" = "mingw" ]; then
- env_args+=("PYTHONHOME=$($BT_TESTS_PYTHON_CONFIG_BIN --prefix)")
+ # If AddressSanitizer is used, we must preload `libasan.so` so that
+ # libasan doesn't complain about not being the first loaded library.
+ #
+ # Python and sed (executed as part of the Libtool wrapper) produce
+ # some leaks, so we must unfortunately disable leak detection.
+ #
+ # Append it to existing `ASAN_OPTIONS` variable, such that we
+ # override the user's value if it contains `detect_leaks=1`.
+ if [ "${BT_TESTS_ENABLE_ASAN:-}" = "1" ]; then
+ if "${BT_TESTS_CC_BIN}" --version | head -n 1 | bt_grep -q '^gcc'; then
+ local -r lib_asan="$("${BT_TESTS_CC_BIN}" -print-file-name=libasan.so)"
+ local -x LD_PRELOAD="${lib_asan}${LD_PRELOAD:+:}${LD_PRELOAD:-}"
+ fi
+
+ local -x "ASAN_OPTIONS=${ASAN_OPTIONS:-}${ASAN_OPTIONS:+,}detect_leaks=0"
fi
- env "${env_args[@]}" "$@"
+ run_python "$@"
}
-# Set the environment and run python tests in the directory.
+# Runs the Python tests matching the pattern `$2` (optional, `*` if
+# missing) in the directory `$1` using `testrunner.py`.
#
-# $1 : The directory containing the python test scripts
-# $2 : The pattern to match python test script names (optional)
+# This function uses run_python_bt2(), therefore such tests can import
+# the testing Python modules (in `tests/utils/python`) and the `bt2`
+# Python package.
run_python_bt2_test() {
- local test_dir="$1"
- local test_pattern="${2:-'*'}" # optional, if none default to "*"
+ local -r test_dir="$1"
+ local -r test_pattern="${2:-'*'}"
- local ret
- local test_runner_args=()
-
- test_runner_args+=("$test_dir")
- if [ "x${test_pattern}" != "x" ]; then
- test_runner_args+=("${test_pattern}")
- fi
-
- if test "x${BT_TESTS_COVERAGE:-}" = "x1"; then
+ if test "${BT_TESTS_COVERAGE:-}" = "1"; then
python_exec="check_coverage"
else
python_exec="${BT_TESTS_PYTHON_BIN}"
--pattern "$test_pattern" \
"$test_dir" \
- ret=$?
+ local -r ret=$?
- if test "x${BT_TESTS_COVERAGE_REPORT:-}" = "x1"; then
+ if test "${BT_TESTS_COVERAGE_REPORT:-}" = "1"; then
coverage report -m
fi
- if test "x${BT_TESTS_COVERAGE_HTML:-}" = "x1"; then
+ if test "${BT_TESTS_COVERAGE_HTML:-}" = "1"; then
coverage html
fi
return $ret
}
+
+# Generates a CTF trace into the directory `$2` from the moultipart
+# document `$1` using `mctf.py`.
+gen_mctf_trace() {
+ local input_file="$1"
+ local base_dir="$2"
+
+ diag "Running: ${BT_TESTS_PYTHON_BIN} ${BT_TESTS_SRCDIR}/utils/python/mctf.py --base-dir ${base_dir} ${input_file}"
+ run_python "${BT_TESTS_PYTHON_BIN}" "${BT_TESTS_SRCDIR}/utils/python/mctf.py" \
+ --base-dir "${base_dir}" "${input_file}"
+}