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)"
44 BT_OS_TYPE
="unsupported"
50 # Allow overriding the source and build directories
51 if [ "x${BT_TESTS_SRCDIR:-}" = "x" ]; then
52 BT_TESTS_SRCDIR
="$scriptdir/.."
54 export BT_TESTS_SRCDIR
56 if [ "x${BT_TESTS_BUILDDIR:-}" = "x" ]; then
57 BT_TESTS_BUILDDIR
="$scriptdir/.."
59 export BT_TESTS_BUILDDIR
61 # By default, it will not source tap.sh. If you to tap output directly from
62 # the test script, define the 'SH_TAP' variable to '1' before sourcing this
64 if [ "x${SH_TAP:-}" = x1
]; then
65 .
"${BT_TESTS_SRCDIR}/utils/tap/tap.sh"
68 # Allow overriding the babeltrace2 executables
69 if [ "x${BT_TESTS_BT2_BIN:-}" = "x" ]; then
70 BT_TESTS_BT2_BIN
="$BT_TESTS_BUILDDIR/../src/cli/babeltrace2"
71 if [ "$BT_OS_TYPE" = "mingw" ]; then
72 BT_TESTS_BT2_BIN
="${BT_TESTS_BT2_BIN}.exe"
75 export BT_TESTS_BT2_BIN
77 if [ "x${BT_TESTS_BT2LOG_BIN:-}" = "x" ]; then
78 BT_TESTS_BT2LOG_BIN
="$BT_TESTS_BUILDDIR/../src/cli/babeltrace2-log"
79 if [ "$BT_OS_TYPE" = "mingw" ]; then
80 BT_TESTS_BT2LOG_BIN
="${BT_TESTS_BT2LOG_BIN}.exe"
83 export BT_TESTS_BT2LOG_BIN
85 # TODO: Remove when bindings/python/bt2/test_plugin.py is fixed
86 BT_PLUGINS_PATH
="${BT_TESTS_BUILDDIR}/../src/plugins"
88 # Allow overriding the babeltrace2 plugin path
89 if [ "x${BT_TESTS_BABELTRACE_PLUGIN_PATH:-}" = "x" ]; then
90 BT_TESTS_BABELTRACE_PLUGIN_PATH
="${BT_PLUGINS_PATH}/ctf:${BT_PLUGINS_PATH}/utils:${BT_PLUGINS_PATH}/text"
93 # Allow overriding the babeltrace2 executables
94 if [ "x${BT_TESTS_PYTHONPATH:-}" = "x" ]; then
95 BT_TESTS_PYTHONPATH
="${BT_TESTS_BUILDDIR}/../src/bindings/python/bt2/build/build_lib"
99 ### External Tools ###
100 if [ "x${BT_TESTS_AWK_BIN:-}" = "x" ]; then
101 BT_TESTS_AWK_BIN
="awk"
103 export BT_TESTS_AWK_BIN
105 if [ "x${BT_TESTS_GREP_BIN:-}" = "x" ]; then
106 BT_TESTS_GREP_BIN
="grep"
108 export BT_TESTS_GREP_BIN
110 if [ "x${BT_TESTS_PYTHON_BIN:-}" = "x" ]; then
111 BT_TESTS_PYTHON_BIN
="python3"
113 export BT_TESTS_PYTHON_BIN
115 if [ "x${BT_TESTS_SED_BIN:-}" = "x" ]; then
116 BT_TESTS_SED_BIN
="sed"
118 export BT_TESTS_SED_BIN
122 BT_TESTS_DATADIR
="${BT_TESTS_SRCDIR}/data"
123 BT_CTF_TRACES_PATH
="${BT_TESTS_DATADIR}/ctf-traces"
124 BT_DEBUG_INFO_PATH
="${BT_TESTS_DATADIR}/debug-info"
127 ### Diff Functions ###
129 # Checks the difference between the content of the file with path "$1"
130 # and the output of the CLI when called with the rest of arguments
133 # Returns 0 if there's no difference, and 1 if there is, also printing
134 # said difference to the standard error.
136 local expected_file
="$1"
140 local temp_output_file
144 temp_output_file
="$(mktemp)"
145 temp_diff
="$(mktemp)"
147 # Run the CLI to get a detailed file. Strip any \r present due to
148 # Windows (\n -> \r\n). "diff --string-trailing-cr" is not used since it
149 # is not present on Solaris.
150 "$BT_TESTS_BT2_BIN" "${args[@]}" |
tr -d "\r" > "$temp_output_file"
152 # Compare output with expected output
153 if ! diff -u "$temp_output_file" "$expected_file" 2>/dev
/null
>"$temp_diff"; then
154 echo "ERROR: for '${args[*]}': actual and expected outputs differ:" >&2
159 rm -f "$temp_output_file" "$temp_diff"
164 # Checks the difference between the content of the file with path "$1"
165 # and the output of the CLI when called on the directory path "$2" with
166 # the arguments '-c sink.text.details' and the rest of the arguments to
169 # Returns 0 if there's no difference, and 1 if there is, also printing
170 # said difference to the standard error.
171 bt_diff_details_ctf_single
() {
172 local expected_file
="$1"
175 local extra_details_args
=("$@")
177 # Compare using the CLI with `sink.text.details`
178 bt_diff_cli
"$expected_file" "$trace_dir" "-c" "sink.text.details" "${extra_details_args[@]}"
181 # Calls bt_diff_details_ctf_single(), except that "$1" is the path to a
182 # program which generates the CTF trace to compare to. The program "$1"
183 # receives the path to a temporary, empty directory where to write the
184 # CTF trace as its first argument.
185 bt_diff_details_ctf_gen_single
() {
186 local ctf_gen_prog_path
="$1"
187 local expected_file
="$2"
189 local extra_details_args
=("$@")
194 temp_trace_dir
="$(mktemp -d)"
196 # Run the CTF trace generator program to get a CTF trace
197 if ! "$ctf_gen_prog_path" "$temp_trace_dir" 2>/dev
/null
; then
198 echo "ERROR: \"$ctf_gen_prog_path\" \"$temp_trace_dir\" failed" >&2
199 rm -rf "$temp_trace_dir"
203 # Compare using the CLI with `sink.text.details`
204 bt_diff_details_ctf_single
"$expected_file" "$temp_trace_dir" "${extra_details_args[@]}"
206 rm -rf "$temp_trace_dir"
217 # Execute a shell command in the appropriate environment to have access to the
218 # bt2 Python bindings.
221 local lib_search_path
223 local python_provider_path
="${BT_TESTS_BUILDDIR}/../src/python-plugin-provider/.libs"
224 local main_lib_path
="${BT_TESTS_BUILDDIR}/../src/lib/.libs"
226 # Set the library search path so the python interpreter can load libbabeltrace2
227 if [ "$BT_OS_TYPE" = "mingw" ]; then
228 lib_search_var
="PATH"
229 lib_search_path
="${python_provider_path}:${main_lib_path}:${PATH:-}"
230 elif [ "$BT_OS_TYPE" = "darwin" ]; then
231 lib_search_var
="DYLD_LIBRARY_PATH"
232 lib_search_path
="${python_provider_path}:${main_lib_path}:${DYLD_LIBRARY_PATH:-}"
234 lib_search_var
="LD_LIBRARY_PATH"
235 lib_search_path
="${python_provider_path}:${main_lib_path}:${LD_LIBRARY_PATH:-}"
239 BABELTRACE_PYTHON_BT2_NO_TRACEBACK
=1 \
240 BABELTRACE_PLUGIN_PATH
="${BT_TESTS_BABELTRACE_PLUGIN_PATH}" \
241 BT_CTF_TRACES_PATH
="${BT_CTF_TRACES_PATH}" \
242 BT_PLUGINS_PATH
="${BT_PLUGINS_PATH}" \
243 PYTHONPATH
="${BT_TESTS_PYTHONPATH}:${BT_TESTS_SRCDIR}/utils/python" \
244 "${lib_search_var}"="${lib_search_path}" \
248 # Set the environment and run python tests in the directory.
250 # $1 : The directory containing the python test scripts
251 # $2 : The pattern to match python test script names (optional)
252 run_python_bt2_test
() {
254 local test_pattern
="${2:-'*'}" # optional, if none default to "*"
257 local test_runner_args
=()
259 test_runner_args
+=("$test_dir")
260 if [ "x${test_pattern}" != "x" ]; then
261 test_runner_args
+=("${test_pattern}")
264 if test "x${BT_TESTS_COVERAGE:-}" = "x1"; then
265 python_exec
="check_coverage"
267 python_exec
="${BT_TESTS_PYTHON_BIN}"
272 "${BT_TESTS_SRCDIR}/utils/python/testrunner.py" \
273 --pattern "$test_pattern" \
278 if test "x${BT_TESTS_COVERAGE_REPORT:-}" = "x1"; then
282 if test "x${BT_TESTS_COVERAGE_HTML:-}" = "x1"; then