#!/bin/bash
-
-# Copyright (c) 2019 Michael Jeanson <mjeanson@efficios.com>
-# Copyright (C) 2019 Philippe Proulx <pproulx@efficios.com>
#
-# 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.
+# SPDX-License-Identifier: GPL-2.0-only
#
-# 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.
+# Copyright (c) 2019 Michael Jeanson <mjeanson@efficios.com>
+# Copyright (C) 2019 Philippe Proulx <pproulx@efficios.com>
#
-# 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.
# 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
+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
+if [ -z "${BT_TESTS_SRCDIR:-}" ]; then
BT_TESTS_SRCDIR="$testsdir"
fi
export BT_TESTS_SRCDIR
-if [ "x${BT_TESTS_BUILDDIR:-}" = "x" ]; then
+if [ -z "${BT_TESTS_BUILDDIR:-}" ]; then
BT_TESTS_BUILDDIR="$testsdir"
fi
export BT_TESTS_BUILDDIR
-# 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"
+
+# Source the generated environment file if it's present.
+if [ -f "${BT_TESTS_BUILDDIR}/utils/env.sh" ]; then
+ # shellcheck source=./env.sh
+ . "${BT_TESTS_BUILDDIR}/utils/env.sh"
fi
# Allow overriding the babeltrace2 executables
-if [ "x${BT_TESTS_BT2_BIN:-}" = "x" ]; then
+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
BT_PLUGINS_PATH="${BT_TESTS_BUILDDIR}/../src/plugins"
# Allow overriding the babeltrace2 plugin path
-if [ "x${BT_TESTS_BABELTRACE_PLUGIN_PATH:-}" = "x" ]; then
+if [ -z "${BT_TESTS_BABELTRACE_PLUGIN_PATH:-}" ]; then
BT_TESTS_BABELTRACE_PLUGIN_PATH="${BT_PLUGINS_PATH}/ctf:${BT_PLUGINS_PATH}/utils:${BT_PLUGINS_PATH}/text:${BT_PLUGINS_PATH}/lttng-utils"
fi
+export BT_TESTS_BABELTRACE_PLUGIN_PATH
-if [ "x${BT_TESTS_PROVIDER_DIR:-}" = "x" ]; then
+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
+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
+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
+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
+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
+BT_TESTS_PYTHON_VERSION=$($BT_TESTS_PYTHON_BIN -c 'import sys; print("{}.{}".format(sys.version_info.major, sys.version_info.minor))')
+
+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
+if [ -z "${BT_TESTS_SED_BIN:-}" ]; then
BT_TESTS_SED_BIN="sed"
fi
export BT_TESTS_SED_BIN
+if [ -z "${BT_TESTS_CC_BIN:-}" ]; then
+ BT_TESTS_CC_BIN="cc"
+fi
+export BT_TESTS_CC_BIN
+
+
+### Optional features ###
+
+if [ -z "${BT_TESTS_ENABLE_ASAN:-}" ]; then
+ BT_TESTS_ENABLE_ASAN="0"
+fi
+export BT_TESTS_ENABLE_ASAN
+
# Data files path
BT_TESTS_DATADIR="${BT_TESTS_SRCDIR}/data"
BT_CTF_TRACES_PATH="${BT_TESTS_DATADIR}/ctf-traces"
+# By default, it will not source tap.sh. If you want to output tap directly
+# from the test script, define the 'SH_TAP' variable to '1' before sourcing
+# this script.
+if [ "${SH_TAP:-}" = 1 ]; then
+ # shellcheck source=./tap/tap.sh
+ . "${BT_TESTS_SRCDIR}/utils/tap/tap.sh"
+fi
+
+
+# Remove CR characters in file "$1".
+
+bt_remove_cr() {
+ "$BT_TESTS_SED_BIN" -i'' -e 's/\r//g' "$1"
+}
+
# Run the Babeltrace CLI, redirecting stdout and stderr to specified files.
#
# $1: file to redirect stdout to
# 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_file"
+ bt_remove_cr "$actual_file"
diff -u "$expected_file" "$actual_file" 1>&2
local ret_stdout
local ret_stderr
- temp_stdout_output_file="$(mktemp -t actual_stdout.XXXXXX)"
- temp_stderr_output_file="$(mktemp -t actual_stderr.XXXXXX)"
+ 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.
bt_cli "$temp_stdout_output_file" "$temp_stderr_output_file" "${args[@]}"
coverage run "$@"
}
+# Execute a shell command in the appropriate environment to access the Python
+# test utility modules in `tests/utils/python`.
+run_python() {
+ local our_pythonpath="${BT_TESTS_SRCDIR}/utils/python"
+
+ if [[ $BT_TESTS_PYTHON_VERSION = 3.4 ]]; then
+ # Add a local directory containing a `typing.py` to `PYTHONPATH` for
+ # Python 3.4 which doesn't offer the `typing` module.
+ our_pythonpath="$our_pythonpath:${BT_TESTS_SRCDIR}/utils/python/typing"
+ fi
+
+ PYTHONPATH="${our_pythonpath}${PYTHONPATH:+:}${PYTHONPATH:-}" "$@"
+}
+
# Execute a shell command in the appropriate environment to have access to the
# bt2 Python bindings.
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_TESTS_DATADIR=${BT_TESTS_DATADIR}" \
- "BT_CTF_TRACES_PATH=${BT_CTF_TRACES_PATH}" \
- "BT_PLUGINS_PATH=${BT_PLUGINS_PATH}" \
- "PYTHONPATH=${BT_TESTS_PYTHONPATH}:${BT_TESTS_SRCDIR}/utils/python"
- )
+ local lib_asan
+ local -x "BABELTRACE_PYTHON_BT2_NO_TRACEBACK=1"
+ 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_PLUGINS_PATH}"
+ local -x "PYTHONPATH=${BT_TESTS_PYTHONPATH}${PYTHONPATH:+:}${PYTHONPATH:-}"
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:-}")
+ 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 interpreter needs a way to locate the path
- # to it's internal modules, set the prefix from python-config to the
+ # to its 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 [ "$BT_TESTS_OS_TYPE" = "mingw" ]; then
+ local -x PYTHONHOME
+
+ PYTHONHOME=$($BT_TESTS_PYTHON_CONFIG_BIN --prefix)
+ fi
+
+ # 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, 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 | grep -q '^gcc'; then
+ 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.
local test_runner_args=()
test_runner_args+=("$test_dir")
- if [ "x${test_pattern}" != "x" ]; then
+ if [ -n "${test_pattern}" ]; 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}"
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
}
+
+# Generate a CTF trace using `mctf.py`.
+#
+# $1: Input filename
+# $2: Base directory path for output files
+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}"
+ "${BT_TESTS_PYTHON_BIN}" "${BT_TESTS_SRCDIR}/utils/python/mctf.py" \
+ --base-dir "${base_dir}" "${input_file}"
+}
projects / babeltrace.git / blobdiff