X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=tests%2Futils%2Futils.sh;h=5c7b3eeb54e43bb465c1225da9292e258a2a2811;hb=9a8ce5a3c9841832a2ae47223c4ee490f0f3bc5d;hp=3a1a6d054dfc592e034ea0b084bfcb77931cf9c9;hpb=c0d75ae3783d580c357e305ce3276ff6104593b6;p=babeltrace.git

diff --git a/tests/utils/utils.sh b/tests/utils/utils.sh
index 3a1a6d05..5c7b3eeb 100644
--- a/tests/utils/utils.sh
+++ b/tests/utils/utils.sh
@@ -25,6 +25,18 @@
 # An unbound variable is an error
 set -u
 
+# Sets the variable named `$1` to `$2` if it's not set, and exports it.
+_bt_tests_set_var_def() {
+	local -r varname=$1
+	local -r val=$2
+
+	if [[ -z ${!varname:-} ]]; then
+		eval "$varname='$val'"
+	fi
+
+	export "${varname?}"
+}
+
 # Name of the OS on which we're running, if not set.
 #
 # One of:
@@ -42,6 +54,7 @@ set -u
 # 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
@@ -60,6 +73,7 @@ if [[ -z ${BT_TESTS_OS_TYPE:-} ]]; then
 		;;
 	esac
 fi
+
 export BT_TESTS_OS_TYPE
 
 # Sets and exports, if not set:
@@ -80,16 +94,10 @@ _set_vars_srcdir_builddir() {
 	fi
 
 	# Base source directory of tests
-	if [[ -z ${BT_TESTS_SRCDIR:-} ]]; then
-		BT_TESTS_SRCDIR=$testsdir
-	fi
-	export BT_TESTS_SRCDIR
+	_bt_tests_set_var_def BT_TESTS_SRCDIR "$testsdir"
 
 	# Base build directory of tests
-	if [[ -z ${BT_TESTS_BUILDDIR:-} ]]; then
-		BT_TESTS_BUILDDIR=$testsdir
-	fi
-	export BT_TESTS_BUILDDIR
+	_bt_tests_set_var_def BT_TESTS_BUILDDIR "$testsdir"
 }
 
 _set_vars_srcdir_builddir
@@ -99,9 +107,9 @@ unset -f _set_vars_srcdir_builddir
 _source_env_sh() {
 	local -r env_sh_path=$BT_TESTS_BUILDDIR/utils/env.sh
 
-	if [[ -f ${env_sh_path} ]]; then
+	if [[ -f $env_sh_path ]]; then
 		# shellcheck disable=SC1090,SC1091
-		. "${env_sh_path}"
+		. "$env_sh_path"
 	fi
 }
 
@@ -111,77 +119,56 @@ 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+=.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.
+# bt_run_in_py_env() to use it.
 #
 # TODO: Remove when `tests/bindings/python/bt2/test_plugin.py` is fixed.
-_bt_tests_plugins_path=${BT_TESTS_BUILDDIR}/../src/plugins
+_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
+_bt_tests_set_var_def 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"
 
 # 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
+_bt_tests_set_var_def BT_TESTS_PROVIDER_DIR "$BT_TESTS_BUILDDIR/../src/python-plugin-provider/.libs"
 
 # 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
+_bt_tests_set_var_def BT_TESTS_PYTHONPATH "$BT_TESTS_BUILDDIR/../src/bindings/python/bt2/build/build_lib"
 
 # 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
+_bt_tests_set_var_def BT_TESTS_AWK_BIN awk
 
 # 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
+_bt_tests_set_var_def BT_TESTS_GREP_BIN grep
 
 # 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
+_bt_tests_set_var_def BT_TESTS_PYTHON_BIN python3
 
 # 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))')
+# bt_run_in_py_utils_env() 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
+_bt_tests_set_var_def BT_TESTS_PYTHON_CONFIG_BIN python3-config
 
 # 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
+_bt_tests_set_var_def BT_TESTS_SED_BIN sed
 
 # 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
+_bt_tests_set_var_def BT_TESTS_CC_BIN cc
+
+# Done with _bt_tests_set_var_def()
+unset -f _bt_tests_set_var_def
 
 # Whether or not to enable AddressSanitizer, `0` (disabled) if not set.
 #
@@ -192,15 +179,15 @@ if [[ -z ${BT_TESTS_ENABLE_ASAN:-} ]]; then
 fi
 
 # Directory containing test data
-BT_TESTS_DATADIR=${BT_TESTS_SRCDIR}/data
+BT_TESTS_DATADIR=$BT_TESTS_SRCDIR/data
 
 # Directory containing test CTF traces
-BT_CTF_TRACES_PATH=${BT_TESTS_DATADIR}/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"
+	. "$BT_TESTS_SRCDIR/utils/tap/tap.sh"
 fi
 
 # Removes the CR characters from the file having the path `$1`.
@@ -229,11 +216,13 @@ bt_remove_cr_inline() {
 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"
+	local -a bt_cli_args=("$@")
+
+	echo "Running: \`$BT_TESTS_BT2_BIN ${bt_cli_args[*]}\`" >&2
+	bt_run_in_py_env "$BT_TESTS_BT2_BIN" "${bt_cli_args[@]}" 1>"$stdout_file" 2>"$stderr_file"
 }
 
 # Checks the differences between:
@@ -272,21 +261,23 @@ bt_diff() {
 bt_diff_cli() {
 	local -r expected_stdout_file=$1
 	local -r expected_stderr_file=$2
+
 	shift 2
-	local -r args=("$@")
 
+	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)
 
 	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=$?
 
 	rm -f "$temp_stdout_output_file" "$temp_stderr_output_file"
-
 	return $((ret_stdout || ret_stderr))
 }
 
@@ -306,7 +297,9 @@ bt_diff_cli() {
 bt_diff_details_ctf_single() {
 	local -r expected_stdout_file=$1
 	local -r trace_dir=$2
+
 	shift 2
+
 	local -r extra_details_args=("$@")
 
 	# Compare using the CLI with `sink.text.details`
@@ -322,9 +315,10 @@ bt_diff_details_ctf_single() {
 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 gen_extra_details_args=("$@")
 	local -r temp_trace_dir=$(mktemp -d)
 
 	# Run the CTF trace generator program to get a CTF trace
@@ -336,8 +330,10 @@ bt_diff_details_ctf_gen_single() {
 
 	# 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[@]}}"
+		"${gen_extra_details_args[@]+${gen_extra_details_args[@]}}"
+
 	local -r ret=$?
+
 	rm -rf "$temp_trace_dir"
 	return $ret
 }
@@ -380,39 +376,38 @@ _bt_tests_check_coverage() {
 
 # 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
+bt_run_in_py_utils_env() {
+	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
+		our_pythonpath=$our_pythonpath:$BT_TESTS_SRCDIR/utils/python/typing
 	fi
 
-	PYTHONPATH=${our_pythonpath}${PYTHONPATH:+:}${PYTHONPATH:-} "$@"
+	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
+bt_run_in_py_env() {
+	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:-}
+		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:-}
+		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:-}
+		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
@@ -421,7 +416,7 @@ run_python_bt2() {
 	if [[ $BT_TESTS_OS_TYPE == mingw ]]; then
 		local -x PYTHONHOME
 
-		PYTHONHOME=$("$BT_TESTS_PYTHON_CONFIG_BIN" --prefix)
+		PYTHONHOME=$($BT_TESTS_PYTHON_CONFIG_BIN --prefix)
 	fi
 
 	# If AddressSanitizer is used, we must preload `libasan.so` so that
@@ -433,40 +428,37 @@ run_python_bt2() {
 	# 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:-}
+		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 "$@"
+	bt_run_in_py_utils_env "$@"
 }
 
 # 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
+# This function uses bt_run_in_py_env(), therefore such tests can import
 # the testing Python modules (in `tests/utils/python`) and the `bt2`
 # Python package.
-run_python_bt2_test() {
+bt_run_py_test() {
 	local -r test_dir=$1
 	local -r test_pattern=${2:-*}
-
 	local python_exec
 
 	if [[ ${BT_TESTS_COVERAGE:-} == 1 ]]; then
 		python_exec=_bt_tests_check_coverage
 	else
-		python_exec=${BT_TESTS_PYTHON_BIN}
+		python_exec=$BT_TESTS_PYTHON_BIN
 	fi
 
-	run_python_bt2 \
-		"${python_exec}" \
-		"${BT_TESTS_SRCDIR}/utils/python/testrunner.py" \
-		--pattern "$test_pattern" \
-		"$test_dir" \
+	bt_run_in_py_env \
+		"$python_exec" "$BT_TESTS_SRCDIR/utils/python/testrunner.py" \
+		--pattern "$test_pattern" "$test_dir"
 
 	local -r ret=$?
 
@@ -483,7 +475,7 @@ run_python_bt2_test() {
 
 # Generates a CTF trace into the directory `$2` from the moultipart
 # document `$1` using `mctf.py`.
-gen_mctf_trace() {
+bt_gen_mctf_trace() {
 	local -r input_file=$1
 	local -r base_dir=$2
 	local -r cmd=(
@@ -493,5 +485,5 @@ gen_mctf_trace() {
 	)
 
 	echo "Running: \`${cmd[*]}\`" >&2
-	run_python "${cmd[@]}"
+	bt_run_in_py_utils_env "${cmd[@]}"
 }