[babeltrace.git] / tests / utils / utils.sh

#!/bin/bash
#
# SPDX-License-Identifier: GPL-2.0-only
#
# Copyright (c) 2019 Michael Jeanson <mjeanson@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:
#
#     SH_TAP=1
#
#     if [[ -n ${BT_TESTS_SRCDIR:-} ]]; then
#         UTILSSH=$BT_TESTS_SRCDIR/utils/utils.sh
#     else
#         UTILSSH=$(dirname "$0")/../utils/utils.sh
#     fi
#
#     # shellcheck source=../utils/utils.sh
#     source "$UTILSSH"
#
# Make sure the relative path to `utils.sh` (this file) above is
# correct (twice).

# An unbound variable is an error
set -u

# 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_TESTS_OS_TYPE="mingw"
		;;
	Darwin)
		BT_TESTS_OS_TYPE="darwin"
		;;
	Linux)
		BT_TESTS_OS_TYPE="linux"
		;;
	CYGWIN*)
		BT_TESTS_OS_TYPE="cygwin"
		;;
	*)
		BT_TESTS_OS_TYPE="unsupported"
		;;
	esac
fi
export BT_TESTS_OS_TYPE

# 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

	# Base source directory of tests
	if [ -z "${BT_TESTS_SRCDIR:-}" ]; then
		BT_TESTS_SRCDIR="$testsdir"
	fi
	export BT_TESTS_SRCDIR

	# Base build directory of tests
	if [ -z "${BT_TESTS_BUILDDIR:-}" ]; then
		BT_TESTS_BUILDDIR="$testsdir"
	fi
	export BT_TESTS_BUILDDIR
}

_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_TESTS_OS_TYPE" = "mingw" ]; then
		BT_TESTS_BT2_BIN="${BT_TESTS_BT2_BIN}.exe"
	fi
fi
export BT_TESTS_BT2_BIN

# 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"

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# 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

# Directory containing test data
BT_TESTS_DATADIR="${BT_TESTS_SRCDIR}/data"

# Directory containing test CTF traces
BT_CTF_TRACES_PATH="${BT_TESTS_DATADIR}/ctf-traces"

# 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

# Removes the CR characters from the file having the path `$1`.
#
# This is sometimes needed on Windows with text files.
#
# 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"
}

# Prints `$1` without CR characters.
bt_remove_cr_inline() {
    "$BT_TESTS_SED_BIN" 's/\r//g' "$1"
}

# 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=("$@")

	echo "Running: $BT_TESTS_BT2_BIN ${args[*]}" >&2
	run_python_bt2 "$BT_TESTS_BT2_BIN" "${args[@]}" 1>"$stdout_file" 2>"$stderr_file"
}

# Checks the differences between:
#
# • The (expected) contents of the file having the path `$1`.
#
# • The contents of another file having the path `$2`.
#
# Both files are passed through bt_remove_cr_inline() to remove CR
# characters.
#
# 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

	diff -u <(bt_remove_cr_inline "$expected_file") <(bt_remove_cr_inline "$actual_file") 1>&2

	return $?
}

# Checks the difference between:
#
# • 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:
#
# • What the `$BT_TESTS_BT2_BIN` command prints to its standard error
#   when given the third and following arguments of this function.
#
# • The file having the path `$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 -r args=("$@")

	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

	bt_cli "$temp_stdout_output_file" "$temp_stderr_output_file" "${args[@]}"

	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=$?

	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 having the path `$1`.
#
# • 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 -r expected_stdout_file="$1"
	local -r trace_dir="$2"
	shift 2
	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[@]+${extra_details_args[@]}}"
}

# 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 -r ctf_gen_prog_path="$1"
	local -r expected_stdout_file="$2"
	shift 2
	local -r extra_details_args=("$@")

	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
		echo "ERROR: \"$ctf_gen_prog_path\" \"$temp_trace_dir\" failed" >&2
		rm -rf "$temp_trace_dir"
		return 1
	fi

	# Compare using the CLI with `sink.text.details`
	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"

	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 "$@"
}

# 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 -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
		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

	# 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

	run_python "$@"
}

# Runs the Python tests matching the pattern `$2` (optional, `*` if
# missing) in the directory `$1` using `testrunner.py`.
#
# 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 -r test_dir="$1"
	local -r test_pattern="${2:-'*'}"

	if test "${BT_TESTS_COVERAGE:-}" = "1"; then
		python_exec="check_coverage"
	else
		python_exec="${BT_TESTS_PYTHON_BIN}"
	fi

	run_python_bt2 \
		"${python_exec}" \
		"${BT_TESTS_SRCDIR}/utils/python/testrunner.py" \
		--pattern "$test_pattern" \
		"$test_dir" \

	local -r ret=$?

	if test "${BT_TESTS_COVERAGE_REPORT:-}" = "1"; then
		coverage report -m
	fi

	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}"
}
Commit	Line	Data
	1	#!/bin/bash
	2	#
	3	# SPDX-License-Identifier: GPL-2.0-only
	4	#
	5	# Copyright (c) 2019 Michael Jeanson <mjeanson@efficios.com>
	6	# Copyright (C) 2019-2023 Philippe Proulx <pproulx@efficios.com>
	7
	8	# Source this file at the beginning of a shell script test to access
	9	# useful testing variables and functions:
	10	#
	11	# SH_TAP=1
	12	#
	13	# if [[ -n ${BT_TESTS_SRCDIR:-} ]]; then
	14	# UTILSSH=$BT_TESTS_SRCDIR/utils/utils.sh
	15	# else
	16	# UTILSSH=$(dirname "$0")/../utils/utils.sh
	17	# fi
	18	#
	19	# # shellcheck source=../utils/utils.sh
	20	# source "$UTILSSH"
	21	#
	22	# Make sure the relative path to `utils.sh` (this file) above is
	23	# correct (twice).
	24
	25	# An unbound variable is an error
	26	set -u
	27
	28	# Name of the OS on which we're running, if not set.
	29	#
	30	# One of:
	31	#
	32	# `mingw`: MinGW (Windows)
	33	# `darwin`: macOS
	34	# `linux`: Linux
	35	# `cygwin`: Cygwin (Windows)
	36	# `unsupported`: Anything else
	37	#
	38	# See <https://en.wikipedia.org/wiki/Uname#Examples> for possible values
	39	# of `uname -s`.
	40	#
	41	# Do some translation to ease our life down the road for comparison.
	42	# Export it so that executed commands can use it.
	43	if [ -z "${BT_TESTS_OS_TYPE:-}" ]; then
	44	BT_TESTS_OS_TYPE="$(uname -s)"
	45	case "$BT_TESTS_OS_TYPE" in
	46	MINGW*)
	47	BT_TESTS_OS_TYPE="mingw"
	48	;;
	49	Darwin)
	50	BT_TESTS_OS_TYPE="darwin"
	51	;;
	52	Linux)
	53	BT_TESTS_OS_TYPE="linux"
	54	;;
	55	CYGWIN*)
	56	BT_TESTS_OS_TYPE="cygwin"
	57	;;
	58	*)
	59	BT_TESTS_OS_TYPE="unsupported"
	60	;;
	61	esac
	62	fi
	63	export BT_TESTS_OS_TYPE
	64
	65	# Sets and exports, if not set:
	66	#
	67	# • `BT_TESTS_SRCDIR` to the base source directory of tests.
	68	# • `BT_TESTS_BUILDDIR` to the base build directory of tests.
	69	_set_vars_srcdir_builddir() {
	70	# If `readlink -f` is available, then get a resolved absolute path
	71	# to the tests source directory. Otherwise, make do with a relative
	72	# path.
	73	local -r scriptdir="$(dirname "${BASH_SOURCE[0]}")"
	74	local testsdir
	75
	76	if readlink -f "." >/dev/null 2>&1; then
	77	testsdir=$(readlink -f "$scriptdir/..")
	78	else
	79	testsdir="$scriptdir/.."
	80	fi
	81
	82	# Base source directory of tests
	83	if [ -z "${BT_TESTS_SRCDIR:-}" ]; then
	84	BT_TESTS_SRCDIR="$testsdir"
	85	fi
	86	export BT_TESTS_SRCDIR
	87
	88	# Base build directory of tests
	89	if [ -z "${BT_TESTS_BUILDDIR:-}" ]; then
	90	BT_TESTS_BUILDDIR="$testsdir"
	91	fi
	92	export BT_TESTS_BUILDDIR
	93	}
	94
	95	_set_vars_srcdir_builddir
	96	unset -f _set_vars_srcdir_builddir
	97
	98	# Sources the generated environment file (`env.sh`) if it exists.
	99	_source_env_sh() {
	100	local -r env_sh_path="$BT_TESTS_BUILDDIR/utils/env.sh"
	101
	102	if [ -f "${env_sh_path}" ]; then
	103	# shellcheck disable=SC1090,SC1091
	104	. "${env_sh_path}"
	105	fi
	106	}
	107
	108	_source_env_sh
	109	unset -f _source_env_sh
	110
	111	# Path to the `babeltrace2` command, if not set
	112	if [ -z "${BT_TESTS_BT2_BIN:-}" ]; then
	113	BT_TESTS_BT2_BIN="$BT_TESTS_BUILDDIR/../src/cli/babeltrace2"
	114	if [ "$BT_TESTS_OS_TYPE" = "mingw" ]; then
	115	BT_TESTS_BT2_BIN="${BT_TESTS_BT2_BIN}.exe"
	116	fi
	117	fi
	118	export BT_TESTS_BT2_BIN
	119
	120	# This doesn't need to be exported, but it needs to remain set for
	121	# run_python_bt2() to use it.
	122	#
	123	# TODO: Remove when `tests/bindings/python/bt2/test_plugin.py` is fixed.
	124	_bt_tests_plugins_path="${BT_TESTS_BUILDDIR}/../src/plugins"
	125
	126	# Colon-separated list of project plugin paths, if not set
	127	if [ -z "${BT_TESTS_BABELTRACE_PLUGIN_PATH:-}" ]; then
	128	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"
	129	fi
	130	export BT_TESTS_BABELTRACE_PLUGIN_PATH
	131
	132	# Directory containing the Python plugin provider library, if not set
	133	if [ -z "${BT_TESTS_PROVIDER_DIR:-}" ]; then
	134	BT_TESTS_PROVIDER_DIR="${BT_TESTS_BUILDDIR}/../src/python-plugin-provider/.libs"
	135	fi
	136	export BT_TESTS_PROVIDER_DIR
	137
	138	# Directory containing the built `bt2` Python package, if not set
	139	if [ -z "${BT_TESTS_PYTHONPATH:-}" ]; then
	140	BT_TESTS_PYTHONPATH="${BT_TESTS_BUILDDIR}/../src/bindings/python/bt2/build/build_lib"
	141	fi
	142	export BT_TESTS_PYTHONPATH
	143
	144	# Name of the `awk` command to use when testing, if not set
	145	if [ -z "${BT_TESTS_AWK_BIN:-}" ]; then
	146	BT_TESTS_AWK_BIN="awk"
	147	fi
	148	export BT_TESTS_AWK_BIN
	149
	150	# Name of the `grep` command to use when testing, if not set
	151	if [ -z "${BT_TESTS_GREP_BIN:-}" ]; then
	152	BT_TESTS_GREP_BIN="grep"
	153	fi
	154	export BT_TESTS_GREP_BIN
	155
	156	# Name of the `python3` command to use when testing, if not set
	157	if [ -z "${BT_TESTS_PYTHON_BIN:-}" ]; then
	158	BT_TESTS_PYTHON_BIN="python3"
	159	fi
	160	export BT_TESTS_PYTHON_BIN
	161
	162	# Major and minor version of the `python3` command to use when testing.
	163	#
	164	# This doesn't need to be exported, but it needs to remain set for
	165	# run_python() to use it.
	166	_bt_tests_py3_version=$("$BT_TESTS_PYTHON_BIN" -c 'import sys; print("{}.{}".format(sys.version_info.major, sys.version_info.minor))')
	167
	168	# Name of the `python3-config` command to use when testing, if not set
	169	if [ -z "${BT_TESTS_PYTHON_CONFIG_BIN:-}" ]; then
	170	BT_TESTS_PYTHON_CONFIG_BIN="python3-config"
	171	fi
	172	export BT_TESTS_PYTHON_CONFIG_BIN
	173
	174	# Name of the `sed` command to use when testing, if not set
	175	if [ -z "${BT_TESTS_SED_BIN:-}" ]; then
	176	BT_TESTS_SED_BIN="sed"
	177	fi
	178	export BT_TESTS_SED_BIN
	179
	180	# Name of the `cc` command to use when testing, if not set
	181	if [ -z "${BT_TESTS_CC_BIN:-}" ]; then
	182	BT_TESTS_CC_BIN="cc"
	183	fi
	184	export BT_TESTS_CC_BIN
	185
	186	# Whether or not to enable AddressSanitizer, `0` (disabled) if not set.
	187	#
	188	# This doesn't need to be exported from the point of view of this file,
	189	# but the sourced `env.sh` above does export it.
	190	if [ -z "${BT_TESTS_ENABLE_ASAN:-}" ]; then
	191	BT_TESTS_ENABLE_ASAN="0"
	192	fi
	193
	194	# Directory containing test data
	195	BT_TESTS_DATADIR="${BT_TESTS_SRCDIR}/data"
	196
	197	# Directory containing test CTF traces
	198	BT_CTF_TRACES_PATH="${BT_TESTS_DATADIR}/ctf-traces"
	199
	200	# Source the shell TAP utilities if `SH_TAP` is `1`
	201	if [ "${SH_TAP:-}" = 1 ]; then
	202	# shellcheck source=./tap/tap.sh
	203	. "${BT_TESTS_SRCDIR}/utils/tap/tap.sh"
	204	fi
	205
	206	# Removes the CR characters from the file having the path `$1`.
	207	#
	208	# This is sometimes needed on Windows with text files.
	209	#
	210	# We can't use the `--string-trailing-cr` option of `diff` because
	211	# Solaris doesn't have it.
	212	bt_remove_cr() {
	213	"$BT_TESTS_SED_BIN" -i'' -e 's/\r//g' "$1"
	214	}
	215
	216	# Prints `$1` without CR characters.
	217	bt_remove_cr_inline() {
	218	"$BT_TESTS_SED_BIN" 's/\r//g' "$1"
	219	}
	220
	221	# Runs the `$BT_TESTS_BT2_BIN` command within an environment which can
	222	# import the `bt2` Python package, redirecting the standard output to
	223	# the `$1` file and the standard error to the `$2` file.
	224	#
	225	# The remaining arguments are forwarded to the `$BT_TESTS_BT2_BIN`
	226	# command.
	227	#
	228	# Returns the exit status of the executed `$BT_TESTS_BT2_BIN`.
	229	bt_cli() {
	230	local -r stdout_file="$1"
	231	local -r stderr_file="$2"
	232	shift 2
	233	local -r args=("$@")
	234
	235	echo "Running: $BT_TESTS_BT2_BIN ${args[*]}" >&2
	236	run_python_bt2 "$BT_TESTS_BT2_BIN" "${args[@]}" 1>"$stdout_file" 2>"$stderr_file"
	237	}
	238
	239	# Checks the differences between:
	240	#
	241	# • The (expected) contents of the file having the path `$1`.
	242	#
	243	# • The contents of another file having the path `$2`.
	244	#
	245	# Both files are passed through bt_remove_cr_inline() to remove CR
	246	# characters.
	247	#
	248	# Returns 0 if there's no difference, or not zero otherwise.
	249	bt_diff() {
	250	local -r expected_file="$1"
	251	local -r actual_file="$2"
	252	local ret=0
	253
	254	diff -u <(bt_remove_cr_inline "$expected_file") <(bt_remove_cr_inline "$actual_file") 1>&2
	255
	256	return $?
	257	}
	258
	259	# Checks the difference between:
	260	#
	261	# • What the `$BT_TESTS_BT2_BIN` command prints to its standard output
	262	# when given the third and following arguments of this function.
	263	#
	264	# • The file having the path `$1`.
	265	#
	266	# as well as the difference between:
	267	#
	268	# • What the `$BT_TESTS_BT2_BIN` command prints to its standard error
	269	# when given the third and following arguments of this function.
	270	#
	271	# • The file having the path `$2`.
	272	#
	273	# Returns 0 if there's no difference, or 1 otherwise, also printing said
	274	# difference to the standard error.
	275	bt_diff_cli() {
	276	local -r expected_stdout_file="$1"
	277	local -r expected_stderr_file="$2"
	278	shift 2
	279	local -r args=("$@")
	280
	281	local -r temp_stdout_output_file="$(mktemp -t actual-stdout.XXXXXX)"
	282	local -r temp_stderr_output_file="$(mktemp -t actual-stderr.XXXXXX)"
	283	local ret=0
	284
	285	bt_cli "$temp_stdout_output_file" "$temp_stderr_output_file" "${args[@]}"
	286
	287	bt_diff "$expected_stdout_file" "$temp_stdout_output_file" "${args[@]}"
	288	local -r ret_stdout=$?
	289	bt_diff "$expected_stderr_file" "$temp_stderr_output_file" "${args[@]}"
	290	local -r ret_stderr=$?
	291
	292	if ((ret_stdout != 0 \|\| ret_stderr != 0)); then
	293	ret=1
	294	fi
	295
	296	rm -f "$temp_stdout_output_file" "$temp_stderr_output_file"
	297
	298	return $ret
	299	}
	300
	301	# Checks the difference between:
	302	#
	303	# • The content of the file having the path `$1`.
	304	#
	305	# • What the `$BT_TESTS_BT2_BIN` command prints to the standard output
	306	# when executed with:
	307	#
	308	# 1. The CTF trace directory `$2`.
	309	# 2. The arguments `-c` and `sink.text.details`.
	310	# 3. The third and following arguments of this function.
	311	#
	312	# Returns 0 if there's no difference, or 1 otherwise, also printing said
	313	# difference to the standard error.
	314	bt_diff_details_ctf_single() {
	315	local -r expected_stdout_file="$1"
	316	local -r trace_dir="$2"
	317	shift 2
	318	local -r extra_details_args=("$@")
	319	expected_stderr_file="/dev/null"
	320
	321	# Compare using the CLI with `sink.text.details`
	322	bt_diff_cli "$expected_stdout_file" "$expected_stderr_file" "$trace_dir" \
	323	"-c" "sink.text.details" "${extra_details_args[@]+${extra_details_args[@]}}"
	324	}
	325
	326	# Like bt_diff_details_ctf_single(), except that `$1` is the path to a
	327	# program which generates the CTF trace to compare to.
	328	#
	329	# The program `$1` receives the path to a temporary, empty directory
	330	# where to write the CTF trace as its first argument.
	331	bt_diff_details_ctf_gen_single() {
	332	local -r ctf_gen_prog_path="$1"
	333	local -r expected_stdout_file="$2"
	334	shift 2
	335	local -r extra_details_args=("$@")
	336
	337	local -r temp_trace_dir="$(mktemp -d)"
	338
	339	# Run the CTF trace generator program to get a CTF trace
	340	if ! "$ctf_gen_prog_path" "$temp_trace_dir" 2>/dev/null; then
	341	echo "ERROR: \"$ctf_gen_prog_path\" \"$temp_trace_dir\" failed" >&2
	342	rm -rf "$temp_trace_dir"
	343	return 1
	344	fi
	345
	346	# Compare using the CLI with `sink.text.details`
	347	bt_diff_details_ctf_single "$expected_stdout_file" "$temp_trace_dir" \
	348	"${extra_details_args[@]+${extra_details_args[@]}}"
	349	local -r ret=$?
	350	rm -rf "$temp_trace_dir"
	351	return $ret
	352	}
	353
	354	# Like `grep`, but using `$BT_TESTS_GREP_BIN`.
	355	bt_grep() {
	356	"$BT_TESTS_GREP_BIN" "$@"
	357	}
	358
	359	# ok() with the test name `$3` on the result of bt_grep() matching the
	360	# pattern `$1` within the file `$2`.
	361	bt_grep_ok() {
	362	local -r pattern=$1
	363	local -r file=$2
	364	local -r test_name=$3
	365
	366	bt_grep --silent "$pattern" "$file"
	367
	368	local -r ret=$?
	369
	370	if ! ok $ret "$test_name"; then
	371	{
	372	echo "Pattern \`$pattern\` doesn't match the contents of \`$file\`:"
	373	echo '--- 8< ---'
	374	cat "$file"
	375	echo '--- >8 ---'
	376	} >&2
	377	fi
	378
	379	return $ret
	380	}
	381
	382	# Forwards the arguments to `coverage run`.
	383	check_coverage() {
	384	coverage run "$@"
	385	}
	386
	387	# Executes a command within an environment which can import the testing
	388	# Python modules (in `tests/utils/python`).
	389	run_python() {
	390	local our_pythonpath="${BT_TESTS_SRCDIR}/utils/python"
	391
	392	if [[ $_bt_tests_py3_version =~ 3.[45] ]]; then
	393	# Add a local directory containing a `typing.py` to `PYTHONPATH`
	394	# for Python 3.4 and Python 3.5 which either don't offer the
	395	# `typing` module at all, or offer a partial one.
	396	our_pythonpath="$our_pythonpath:${BT_TESTS_SRCDIR}/utils/python/typing"
	397	fi
	398
	399	PYTHONPATH="${our_pythonpath}${PYTHONPATH:+:}${PYTHONPATH:-}" "$@"
	400	}
	401
	402	# Executes a command within an environment which can import the testing
	403	# Python modules (in `tests/utils/python`) and the `bt2` Python package.
	404	run_python_bt2() {
	405	local -x "BABELTRACE_PLUGIN_PATH=${BT_TESTS_BABELTRACE_PLUGIN_PATH}"
	406	local -x "LIBBABELTRACE2_PLUGIN_PROVIDER_DIR=${BT_TESTS_PROVIDER_DIR}"
	407	local -x "BT_TESTS_DATADIR=${BT_TESTS_DATADIR}"
	408	local -x "BT_CTF_TRACES_PATH=${BT_CTF_TRACES_PATH}"
	409	local -x "BT_PLUGINS_PATH=${_bt_tests_plugins_path}"
	410	local -x "PYTHONPATH=${BT_TESTS_PYTHONPATH}${PYTHONPATH:+:}${PYTHONPATH:-}"
	411
	412	local -r main_lib_path="${BT_TESTS_BUILDDIR}/../src/lib/.libs"
	413
	414	# Set the library search path so that the Python 3 interpreter can
	415	# load `libbabeltrace2`.
	416	if [ "$BT_TESTS_OS_TYPE" = "mingw" ] \|\| [ "$BT_TESTS_OS_TYPE" = "cygwin" ]; then
	417	local -x PATH="${main_lib_path}${PATH:+:}${PATH:-}"
	418	elif [ "$BT_TESTS_OS_TYPE" = "darwin" ]; then
	419	local -x DYLD_LIBRARY_PATH="${main_lib_path}${DYLD_LIBRARY_PATH:+:}${DYLD_LIBRARY_PATH:-}"
	420	else
	421	local -x LD_LIBRARY_PATH="${main_lib_path}${LD_LIBRARY_PATH:+:}${LD_LIBRARY_PATH:-}"
	422	fi
	423
	424	# On Windows, an embedded Python 3 interpreter needs a way to locate
	425	# the path to its internal modules: set the `PYTHONHOME` variable to
	426	# the prefix from `python3-config`.
	427	if [ "$BT_TESTS_OS_TYPE" = "mingw" ]; then
	428	local -x PYTHONHOME
	429
	430	PYTHONHOME=$("$BT_TESTS_PYTHON_CONFIG_BIN" --prefix)
	431	fi
	432
	433	# If AddressSanitizer is used, we must preload `libasan.so` so that
	434	# libasan doesn't complain about not being the first loaded library.
	435	#
	436	# Python and sed (executed as part of the Libtool wrapper) produce
	437	# some leaks, so we must unfortunately disable leak detection.
	438	#
	439	# Append it to existing `ASAN_OPTIONS` variable, such that we
	440	# override the user's value if it contains `detect_leaks=1`.
	441	if [ "${BT_TESTS_ENABLE_ASAN:-}" = "1" ]; then
	442	if "${BT_TESTS_CC_BIN}" --version \| head -n 1 \| bt_grep -q '^gcc'; then
	443	local -r lib_asan="$("${BT_TESTS_CC_BIN}" -print-file-name=libasan.so)"
	444	local -x LD_PRELOAD="${lib_asan}${LD_PRELOAD:+:}${LD_PRELOAD:-}"
	445	fi
	446
	447	local -x "ASAN_OPTIONS=${ASAN_OPTIONS:-}${ASAN_OPTIONS:+,}detect_leaks=0"
	448	fi
	449
	450	run_python "$@"
	451	}
	452
	453	# Runs the Python tests matching the pattern `$2` (optional, `*` if
	454	# missing) in the directory `$1` using `testrunner.py`.
	455	#
	456	# This function uses run_python_bt2(), therefore such tests can import
	457	# the testing Python modules (in `tests/utils/python`) and the `bt2`
	458	# Python package.
	459	run_python_bt2_test() {
	460	local -r test_dir="$1"
	461	local -r test_pattern="${2:-'*'}"
	462
	463	if test "${BT_TESTS_COVERAGE:-}" = "1"; then
	464	python_exec="check_coverage"
	465	else
	466	python_exec="${BT_TESTS_PYTHON_BIN}"
	467	fi
	468
	469	run_python_bt2 \
	470	"${python_exec}" \
	471	"${BT_TESTS_SRCDIR}/utils/python/testrunner.py" \
	472	--pattern "$test_pattern" \
	473	"$test_dir" \
	474
	475	local -r ret=$?
	476
	477	if test "${BT_TESTS_COVERAGE_REPORT:-}" = "1"; then
	478	coverage report -m
	479	fi
	480
	481	if test "${BT_TESTS_COVERAGE_HTML:-}" = "1"; then
	482	coverage html
	483	fi
	484
	485	return $ret
	486	}
	487
	488	# Generates a CTF trace into the directory `$2` from the moultipart
	489	# document `$1` using `mctf.py`.
	490	gen_mctf_trace() {
	491	local input_file="$1"
	492	local base_dir="$2"
	493
	494	diag "Running: ${BT_TESTS_PYTHON_BIN} ${BT_TESTS_SRCDIR}/utils/python/mctf.py --base-dir ${base_dir} ${input_file}"
	495	run_python "${BT_TESTS_PYTHON_BIN}" "${BT_TESTS_SRCDIR}/utils/python/mctf.py" \
	496	--base-dir "${base_dir}" "${input_file}"
	497	}