3 # Copyright (c) 2019 Michael Jeanson <mjeanson@efficios.com>
4 # Copyright (C) 2019 Philippe Proulx <pproulx@efficios.com>
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; under version 2 of the License.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License along
16 # with this program; if not, write to the Free Software Foundation, Inc.,
17 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 # This file is meant to be sourced at the start of shell script-based tests.
22 # Error out when encountering an undefined variable
25 scriptdir
="$(dirname "${BASH_SOURCE[0]}")"
27 # The OS on which we are running. See [1] for possible values of 'uname -s'.
28 # We do a bit of translation to ease our life down the road for comparison.
29 # Export it so that called executables can use it.
30 # [1] https://en.wikipedia.org/wiki/Uname#Examples
31 if [ "x${BT_OS_TYPE:-}" = "x" ]; then
32 BT_OS_TYPE
="$(uname -s)"
47 BT_OS_TYPE
="unsupported"
53 # Allow overriding the source and build directories
54 if [ "x${BT_TESTS_SRCDIR:-}" = "x" ]; then
55 BT_TESTS_SRCDIR
="$scriptdir/.."
57 export BT_TESTS_SRCDIR
59 if [ "x${BT_TESTS_BUILDDIR:-}" = "x" ]; then
60 BT_TESTS_BUILDDIR
="$scriptdir/.."
62 export BT_TESTS_BUILDDIR
64 # By default, it will not source tap.sh. If you to tap output directly from
65 # the test script, define the 'SH_TAP' variable to '1' before sourcing this
67 if [ "x${SH_TAP:-}" = x1
]; then
68 # shellcheck source=./tap/tap.sh
69 .
"${BT_TESTS_SRCDIR}/utils/tap/tap.sh"
72 # Allow overriding the babeltrace2 executables
73 if [ "x${BT_TESTS_BT2_BIN:-}" = "x" ]; then
74 BT_TESTS_BT2_BIN
="$BT_TESTS_BUILDDIR/../src/cli/babeltrace2"
75 if [ "$BT_OS_TYPE" = "mingw" ]; then
76 BT_TESTS_BT2_BIN
="${BT_TESTS_BT2_BIN}.exe"
79 export BT_TESTS_BT2_BIN
81 if [ "x${BT_TESTS_BT2LOG_BIN:-}" = "x" ]; then
82 BT_TESTS_BT2LOG_BIN
="$BT_TESTS_BUILDDIR/../src/cli/babeltrace2-log"
83 if [ "$BT_OS_TYPE" = "mingw" ]; then
84 BT_TESTS_BT2LOG_BIN
="${BT_TESTS_BT2LOG_BIN}.exe"
87 export BT_TESTS_BT2LOG_BIN
89 # TODO: Remove when bindings/python/bt2/test_plugin.py is fixed
90 BT_PLUGINS_PATH
="${BT_TESTS_BUILDDIR}/../src/plugins"
92 # Allow overriding the babeltrace2 plugin path
93 if [ "x${BT_TESTS_BABELTRACE_PLUGIN_PATH:-}" = "x" ]; then
94 BT_TESTS_BABELTRACE_PLUGIN_PATH
="${BT_PLUGINS_PATH}/ctf:${BT_PLUGINS_PATH}/utils:${BT_PLUGINS_PATH}/text"
97 if [ "x${BT_TESTS_PROVIDER_DIR:-}" = "x" ]; then
98 BT_TESTS_PROVIDER_DIR
="${BT_TESTS_BUILDDIR}/../src/python-plugin-provider/.libs"
101 # Allow overriding the babeltrace2 executables
102 if [ "x${BT_TESTS_PYTHONPATH:-}" = "x" ]; then
103 BT_TESTS_PYTHONPATH
="${BT_TESTS_BUILDDIR}/../src/bindings/python/bt2/build/build_lib"
107 ### External Tools ###
108 if [ "x${BT_TESTS_AWK_BIN:-}" = "x" ]; then
109 BT_TESTS_AWK_BIN
="awk"
111 export BT_TESTS_AWK_BIN
113 if [ "x${BT_TESTS_GREP_BIN:-}" = "x" ]; then
114 BT_TESTS_GREP_BIN
="grep"
116 export BT_TESTS_GREP_BIN
118 if [ "x${BT_TESTS_PYTHON_BIN:-}" = "x" ]; then
119 BT_TESTS_PYTHON_BIN
="python3"
121 export BT_TESTS_PYTHON_BIN
123 if [ "x${BT_TESTS_SED_BIN:-}" = "x" ]; then
124 BT_TESTS_SED_BIN
="sed"
126 export BT_TESTS_SED_BIN
130 BT_TESTS_DATADIR
="${BT_TESTS_SRCDIR}/data"
131 BT_CTF_TRACES_PATH
="${BT_TESTS_DATADIR}/ctf-traces"
134 ### Diff Functions ###
136 # Checks the difference between:
138 # 1. What the CLI outputs on its standard output when given the arguments
139 # "$@" (excluding the first two arguments).
140 # 2. The file with path "$1".
142 # And the difference between:
144 # 1. What the CLI outputs on its standard error when given the arguments
145 # "$@" (excluding the first two arguments).
146 # 2. The file with path "$2".
148 # Returns 0 if there's no difference, and 1 if there is, also printing
149 # said difference to the standard error.
151 local expected_stdout_file
="$1"
152 local expected_stderr_file
="$2"
156 local temp_stdout_output_file
157 local temp_stderr_output_file
161 temp_stdout_output_file
="$(mktemp)"
162 temp_stderr_output_file
="$(mktemp)"
163 temp_diff
="$(mktemp)"
165 # Run the CLI to get a detailed file.
166 run_python_bt2
"$BT_TESTS_BT2_BIN" "${args[@]}" 1>"$temp_stdout_output_file" 2>"$temp_stderr_output_file"
168 # Strip any \r present due to Windows (\n -> \r\n).
169 # "diff --string-trailing-cr" is not used since it is not present on
171 "$BT_TESTS_SED_BIN" -i 's/\r//g' "$temp_stdout_output_file"
172 "$BT_TESTS_SED_BIN" -i 's/\r//g' "$temp_stderr_output_file"
174 # Compare stdout output with expected stdout output
175 if ! diff -u "$temp_stdout_output_file" "$expected_stdout_file" 2>/dev
/null
>"$temp_diff"; then
176 echo "ERROR: for '${args[*]}': actual standard output and expected output differ:" >&2
181 # Compare stderr output with expected stderr output
182 if ! diff -u "$temp_stderr_output_file" "$expected_stderr_file" 2>/dev
/null
>"$temp_diff"; then
183 echo "ERROR: for '${args[*]}': actual standard error and expected error differ:" >&2
188 rm -f "$temp_stdout_output_file" "$temp_stderr_output_file" "$temp_diff"
193 # Checks the difference between the content of the file with path "$1"
194 # and the output of the CLI when called on the directory path "$2" with
195 # the arguments '-c sink.text.details' and the rest of the arguments to
198 # Returns 0 if there's no difference, and 1 if there is, also printing
199 # said difference to the standard error.
200 bt_diff_details_ctf_single
() {
201 local expected_stdout_file
="$1"
204 local extra_details_args
=("$@")
205 expected_stderr_file
="/dev/null"
207 # Compare using the CLI with `sink.text.details`
208 bt_diff_cli
"$expected_stdout_file" "$expected_stderr_file" "$trace_dir" "-c" "sink.text.details" "${extra_details_args[@]}"
211 # Calls bt_diff_details_ctf_single(), except that "$1" is the path to a
212 # program which generates the CTF trace to compare to. The program "$1"
213 # receives the path to a temporary, empty directory where to write the
214 # CTF trace as its first argument.
215 bt_diff_details_ctf_gen_single
() {
216 local ctf_gen_prog_path
="$1"
217 local expected_stdout_file
="$2"
219 local extra_details_args
=("$@")
224 temp_trace_dir
="$(mktemp -d)"
226 # Run the CTF trace generator program to get a CTF trace
227 if ! "$ctf_gen_prog_path" "$temp_trace_dir" 2>/dev
/null
; then
228 echo "ERROR: \"$ctf_gen_prog_path\" \"$temp_trace_dir\" failed" >&2
229 rm -rf "$temp_trace_dir"
233 # Compare using the CLI with `sink.text.details`
234 bt_diff_details_ctf_single
"$expected_stdout_file" "$temp_trace_dir" "${extra_details_args[@]}"
236 rm -rf "$temp_trace_dir"
247 # Execute a shell command in the appropriate environment to have access to the
248 # bt2 Python bindings.
251 local lib_search_path
253 local main_lib_path
="${BT_TESTS_BUILDDIR}/../src/lib/.libs"
255 # Set the library search path so the python interpreter can load libbabeltrace2
256 if [ "$BT_OS_TYPE" = "mingw" ] ||
[ "$BT_OS_TYPE" = "cygwin" ]; then
257 lib_search_var
="PATH"
258 lib_search_path
="${main_lib_path}:${PATH:-}"
259 elif [ "$BT_OS_TYPE" = "darwin" ]; then
260 lib_search_var
="DYLD_LIBRARY_PATH"
261 lib_search_path
="${main_lib_path}:${DYLD_LIBRARY_PATH:-}"
263 lib_search_var
="LD_LIBRARY_PATH"
264 lib_search_path
="${main_lib_path}:${LD_LIBRARY_PATH:-}"
268 BABELTRACE_PYTHON_BT2_NO_TRACEBACK
=1 \
269 BABELTRACE_PLUGIN_PATH
="${BT_TESTS_BABELTRACE_PLUGIN_PATH}" \
270 LIBBABELTRACE2_PLUGIN_PROVIDER_DIR
=${BT_TESTS_PROVIDER_DIR} \
271 BT_CTF_TRACES_PATH
="${BT_CTF_TRACES_PATH}" \
272 BT_PLUGINS_PATH
="${BT_PLUGINS_PATH}" \
273 PYTHONPATH
="${BT_TESTS_PYTHONPATH}:${BT_TESTS_SRCDIR}/utils/python" \
274 "${lib_search_var}"="${lib_search_path}" \
278 # Set the environment and run python tests in the directory.
280 # $1 : The directory containing the python test scripts
281 # $2 : The pattern to match python test script names (optional)
282 run_python_bt2_test
() {
284 local test_pattern
="${2:-'*'}" # optional, if none default to "*"
287 local test_runner_args
=()
289 test_runner_args
+=("$test_dir")
290 if [ "x${test_pattern}" != "x" ]; then
291 test_runner_args
+=("${test_pattern}")
294 if test "x${BT_TESTS_COVERAGE:-}" = "x1"; then
295 python_exec
="check_coverage"
297 python_exec
="${BT_TESTS_PYTHON_BIN}"
302 "${BT_TESTS_SRCDIR}/utils/python/testrunner.py" \
303 --pattern "$test_pattern" \
308 if test "x${BT_TESTS_COVERAGE_REPORT:-}" = "x1"; then
312 if test "x${BT_TESTS_COVERAGE_HTML:-}" = "x1"; then