X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=tests%2Futils%2Futils.sh;h=6107a610453e3dff10cfe3138cb556a2ebee113d;hp=6c87f309df9efdbb6ac66437fab9727e89d1e358;hb=75e396f6b20bdf52c76a3c7312e7fb815ac1e5e9;hpb=90a8a0f23a364a3e1e3b7702c57b9c22473500a3 diff --git a/tests/utils/utils.sh b/tests/utils/utils.sh index 6c87f309..6107a610 100644 --- a/tests/utils/utils.sh +++ b/tests/utils/utils.sh @@ -1,20 +1,10 @@ #!/bin/bash - -# Copyright (c) 2019 Michael Jeanson -# Copyright (C) 2019 Philippe Proulx # -# 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 +# Copyright (C) 2019 Philippe Proulx # -# 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. @@ -35,51 +25,50 @@ fi # 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 @@ -89,51 +78,76 @@ export BT_TESTS_BT2_BIN 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 +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() { @@ -292,6 +306,7 @@ check_coverage() { # bt2 Python bindings. run_python_bt2() { local env_args + local lib_asan env_args=( "BABELTRACE_PYTHON_BT2_NO_TRACEBACK=1" \ @@ -306,9 +321,9 @@ run_python_bt2() { 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 + if [ "$BT_TESTS_OS_TYPE" = "mingw" ] || [ "$BT_TESTS_OS_TYPE" = "cygwin" ]; then env_args+=("PATH=${main_lib_path}:${PATH:-}") - elif [ "$BT_OS_TYPE" = "darwin" ]; then + elif [ "$BT_TESTS_OS_TYPE" = "darwin" ]; then env_args+=("DYLD_LIBRARY_PATH=${main_lib_path}:${DYLD_LIBRARY_PATH:-}") else env_args+=("LD_LIBRARY_PATH=${main_lib_path}:${LD_LIBRARY_PATH:-}") @@ -317,10 +332,24 @@ run_python_bt2() { # 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 + if [ "$BT_TESTS_OS_TYPE" = "mingw" ]; then env_args+=("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 + lib_asan=$(${BT_TESTS_CC_BIN} -print-file-name=libasan.so) + + env_args+=("LD_PRELOAD=${lib_asan}:${LD_PRELOAD:-}") + env_args+=("ASAN_OPTIONS=${ASAN_OPTIONS:-},detect_leaks=0") + fi + env "${env_args[@]}" "$@" } @@ -336,11 +365,11 @@ run_python_bt2_test() { 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}" @@ -354,11 +383,11 @@ run_python_bt2_test() { 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