Move to kernel style SPDX license identifiers
[babeltrace.git] / tests / utils / utils.sh
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 Philippe Proulx <pproulx@efficios.com>
7 #
8
9 # This file is meant to be sourced at the start of shell script-based tests.
10
11
12 # Error out when encountering an undefined variable
13 set -u
14
15 # If "readlink -f" is available, get a resolved absolute path to the
16 # tests source dir, otherwise make do with a relative path.
17 scriptdir="$(dirname "${BASH_SOURCE[0]}")"
18 if readlink -f "." >/dev/null 2>&1; then
19 testsdir=$(readlink -f "$scriptdir/..")
20 else
21 testsdir="$scriptdir/.."
22 fi
23
24 # The OS on which we are running. See [1] for possible values of 'uname -s'.
25 # We do a bit of translation to ease our life down the road for comparison.
26 # Export it so that called executables can use it.
27 # [1] https://en.wikipedia.org/wiki/Uname#Examples
28 if [ "x${BT_OS_TYPE:-}" = "x" ]; then
29 BT_OS_TYPE="$(uname -s)"
30 case "$BT_OS_TYPE" in
31 MINGW*)
32 BT_OS_TYPE="mingw"
33 ;;
34 Darwin)
35 BT_OS_TYPE="darwin"
36 ;;
37 Linux)
38 BT_OS_TYPE="linux"
39 ;;
40 CYGWIN*)
41 BT_OS_TYPE="cygwin"
42 ;;
43 *)
44 BT_OS_TYPE="unsupported"
45 ;;
46 esac
47 fi
48 export BT_OS_TYPE
49
50 # Allow overriding the source and build directories
51 if [ "x${BT_TESTS_SRCDIR:-}" = "x" ]; then
52 BT_TESTS_SRCDIR="$testsdir"
53 fi
54 export BT_TESTS_SRCDIR
55
56 if [ "x${BT_TESTS_BUILDDIR:-}" = "x" ]; then
57 BT_TESTS_BUILDDIR="$testsdir"
58 fi
59 export BT_TESTS_BUILDDIR
60
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
63 # script.
64 if [ "x${SH_TAP:-}" = x1 ]; then
65 # shellcheck source=./tap/tap.sh
66 . "${BT_TESTS_SRCDIR}/utils/tap/tap.sh"
67 fi
68
69 # Allow overriding the babeltrace2 executables
70 if [ "x${BT_TESTS_BT2_BIN:-}" = "x" ]; then
71 BT_TESTS_BT2_BIN="$BT_TESTS_BUILDDIR/../src/cli/babeltrace2"
72 if [ "$BT_OS_TYPE" = "mingw" ]; then
73 BT_TESTS_BT2_BIN="${BT_TESTS_BT2_BIN}.exe"
74 fi
75 fi
76 export BT_TESTS_BT2_BIN
77
78 # TODO: Remove when bindings/python/bt2/test_plugin.py is fixed
79 BT_PLUGINS_PATH="${BT_TESTS_BUILDDIR}/../src/plugins"
80
81 # Allow overriding the babeltrace2 plugin path
82 if [ "x${BT_TESTS_BABELTRACE_PLUGIN_PATH:-}" = "x" ]; then
83 BT_TESTS_BABELTRACE_PLUGIN_PATH="${BT_PLUGINS_PATH}/ctf:${BT_PLUGINS_PATH}/utils:${BT_PLUGINS_PATH}/text:${BT_PLUGINS_PATH}/lttng-utils"
84 fi
85
86 if [ "x${BT_TESTS_PROVIDER_DIR:-}" = "x" ]; then
87 BT_TESTS_PROVIDER_DIR="${BT_TESTS_BUILDDIR}/../src/python-plugin-provider/.libs"
88 fi
89
90 # Allow overriding the babeltrace2 executables
91 if [ "x${BT_TESTS_PYTHONPATH:-}" = "x" ]; then
92 BT_TESTS_PYTHONPATH="${BT_TESTS_BUILDDIR}/../src/bindings/python/bt2/build/build_lib"
93 fi
94
95
96 ### External Tools ###
97 if [ "x${BT_TESTS_AWK_BIN:-}" = "x" ]; then
98 BT_TESTS_AWK_BIN="awk"
99 fi
100 export BT_TESTS_AWK_BIN
101
102 if [ "x${BT_TESTS_GREP_BIN:-}" = "x" ]; then
103 BT_TESTS_GREP_BIN="grep"
104 fi
105 export BT_TESTS_GREP_BIN
106
107 if [ "x${BT_TESTS_PYTHON_BIN:-}" = "x" ]; then
108 BT_TESTS_PYTHON_BIN="python3"
109 fi
110 export BT_TESTS_PYTHON_BIN
111
112 if [ "x${BT_TESTS_PYTHON_CONFIG_BIN:-}" = "x" ]; then
113 BT_TESTS_PYTHON_CONFIG_BIN="python3-config"
114 fi
115 export BT_TESTS_PYTHON_CONFIG_BIN
116
117 if [ "x${BT_TESTS_SED_BIN:-}" = "x" ]; then
118 BT_TESTS_SED_BIN="sed"
119 fi
120 export BT_TESTS_SED_BIN
121
122
123 # Data files path
124 BT_TESTS_DATADIR="${BT_TESTS_SRCDIR}/data"
125 BT_CTF_TRACES_PATH="${BT_TESTS_DATADIR}/ctf-traces"
126
127 # Remove CR characters in file "$1".
128
129 bt_remove_cr() {
130 "$BT_TESTS_SED_BIN" -i 's/\r//g' "$1"
131 }
132
133 # Run the Babeltrace CLI, redirecting stdout and stderr to specified files.
134 #
135 # $1: file to redirect stdout to
136 # $2: file to redirect stderr to
137 # remaining args: arguments to pass to the CLI
138 #
139 # Return the exit code of the CLI.
140
141 bt_cli() {
142 local stdout_file="$1"
143 local stderr_file="$2"
144 shift 2
145 local args=("$@")
146
147 echo "Running: $BT_TESTS_BT2_BIN ${args[*]}" >&2
148 run_python_bt2 "$BT_TESTS_BT2_BIN" "${args[@]}" 1>"$stdout_file" 2>"$stderr_file"
149 }
150
151 ### Diff Functions ###
152
153 # Check the differences between two files (typically some expected output vs
154 # some actual output). If there are differences, print the diff to stderr.
155 #
156 # $1: file 1 (expected)
157 # $2: file 2 (actual)
158 #
159 # Return 0 if there's no difference, and non-zero if there are.
160 #
161 # Note that this function modifies the actual output file ($2) _in-place_ to
162 # remove any \r character.
163
164 bt_diff() {
165 local expected_file="$1"
166 local actual_file="$2"
167 local ret=0
168
169 # Strip any \r present due to Windows (\n -> \r\n).
170 # "diff --string-trailing-cr" is not used since it is not present on
171 # Solaris.
172 bt_remove_cr "$actual_file"
173
174 diff -u "$expected_file" "$actual_file" 1>&2
175
176 return $?
177 }
178
179 # Checks the difference between:
180 #
181 # 1. What the CLI outputs on its standard output when given the arguments
182 # "$@" (excluding the first two arguments).
183 # 2. The file with path "$1".
184 #
185 # And the difference between:
186 #
187 # 1. What the CLI outputs on its standard error when given the arguments
188 # "$@" (excluding the first two arguments).
189 # 2. The file with path "$2".
190 #
191 # Returns 0 if there's no difference, and 1 if there is, also printing
192 # said difference to the standard error.
193 bt_diff_cli() {
194 local expected_stdout_file="$1"
195 local expected_stderr_file="$2"
196 shift 2
197 local args=("$@")
198
199 local temp_stdout_output_file
200 local temp_stderr_output_file
201 local ret=0
202 local ret_stdout
203 local ret_stderr
204
205 temp_stdout_output_file="$(mktemp -t actual_stdout.XXXXXX)"
206 temp_stderr_output_file="$(mktemp -t actual_stderr.XXXXXX)"
207
208 # Run the CLI to get a detailed file.
209 bt_cli "$temp_stdout_output_file" "$temp_stderr_output_file" "${args[@]}"
210
211 bt_diff "$expected_stdout_file" "$temp_stdout_output_file" "${args[@]}"
212 ret_stdout=$?
213 bt_diff "$expected_stderr_file" "$temp_stderr_output_file" "${args[@]}"
214 ret_stderr=$?
215
216 if ((ret_stdout != 0 || ret_stderr != 0)); then
217 ret=1
218 fi
219
220 rm -f "$temp_stdout_output_file" "$temp_stderr_output_file"
221
222 return $ret
223 }
224
225 # Checks the difference between the content of the file with path "$1"
226 # and the output of the CLI when called on the directory path "$2" with
227 # the arguments '-c sink.text.details' and the rest of the arguments to
228 # this function.
229 #
230 # Returns 0 if there's no difference, and 1 if there is, also printing
231 # said difference to the standard error.
232 bt_diff_details_ctf_single() {
233 local expected_stdout_file="$1"
234 local trace_dir="$2"
235 shift 2
236 local extra_details_args=("$@")
237 expected_stderr_file="/dev/null"
238
239 # Compare using the CLI with `sink.text.details`
240 bt_diff_cli "$expected_stdout_file" "$expected_stderr_file" "$trace_dir" \
241 "-c" "sink.text.details" "${extra_details_args[@]+${extra_details_args[@]}}"
242 }
243
244 # Calls bt_diff_details_ctf_single(), except that "$1" is the path to a
245 # program which generates the CTF trace to compare to. The program "$1"
246 # receives the path to a temporary, empty directory where to write the
247 # CTF trace as its first argument.
248 bt_diff_details_ctf_gen_single() {
249 local ctf_gen_prog_path="$1"
250 local expected_stdout_file="$2"
251 shift 2
252 local extra_details_args=("$@")
253
254 local temp_trace_dir
255 local ret
256
257 temp_trace_dir="$(mktemp -d)"
258
259 # Run the CTF trace generator program to get a CTF trace
260 if ! "$ctf_gen_prog_path" "$temp_trace_dir" 2>/dev/null; then
261 echo "ERROR: \"$ctf_gen_prog_path\" \"$temp_trace_dir\" failed" >&2
262 rm -rf "$temp_trace_dir"
263 return 1
264 fi
265
266 # Compare using the CLI with `sink.text.details`
267 bt_diff_details_ctf_single "$expected_stdout_file" "$temp_trace_dir" \
268 "${extra_details_args[@]+${extra_details_args[@]}}"
269 ret=$?
270 rm -rf "$temp_trace_dir"
271 return $ret
272 }
273
274
275 ### Functions ###
276
277 check_coverage() {
278 coverage run "$@"
279 }
280
281 # Execute a shell command in the appropriate environment to have access to the
282 # bt2 Python bindings.
283 run_python_bt2() {
284 local env_args
285
286 env_args=(
287 "BABELTRACE_PYTHON_BT2_NO_TRACEBACK=1" \
288 "BABELTRACE_PLUGIN_PATH=${BT_TESTS_BABELTRACE_PLUGIN_PATH}" \
289 "LIBBABELTRACE2_PLUGIN_PROVIDER_DIR=${BT_TESTS_PROVIDER_DIR}" \
290 "BT_TESTS_DATADIR=${BT_TESTS_DATADIR}" \
291 "BT_CTF_TRACES_PATH=${BT_CTF_TRACES_PATH}" \
292 "BT_PLUGINS_PATH=${BT_PLUGINS_PATH}" \
293 "PYTHONPATH=${BT_TESTS_PYTHONPATH}:${BT_TESTS_SRCDIR}/utils/python"
294 )
295
296 local main_lib_path="${BT_TESTS_BUILDDIR}/../src/lib/.libs"
297
298 # Set the library search path so the python interpreter can load libbabeltrace2
299 if [ "$BT_OS_TYPE" = "mingw" ] || [ "$BT_OS_TYPE" = "cygwin" ]; then
300 env_args+=("PATH=${main_lib_path}:${PATH:-}")
301 elif [ "$BT_OS_TYPE" = "darwin" ]; then
302 env_args+=("DYLD_LIBRARY_PATH=${main_lib_path}:${DYLD_LIBRARY_PATH:-}")
303 else
304 env_args+=("LD_LIBRARY_PATH=${main_lib_path}:${LD_LIBRARY_PATH:-}")
305 fi
306
307 # On Windows, an embedded Python interpreter needs a way to locate the path
308 # to it's internal modules, set the prefix from python-config to the
309 # PYTHONHOME variable.
310 if [ "$BT_OS_TYPE" = "mingw" ]; then
311 env_args+=("PYTHONHOME=$($BT_TESTS_PYTHON_CONFIG_BIN --prefix)")
312 fi
313
314 env "${env_args[@]}" "$@"
315 }
316
317 # Set the environment and run python tests in the directory.
318 #
319 # $1 : The directory containing the python test scripts
320 # $2 : The pattern to match python test script names (optional)
321 run_python_bt2_test() {
322 local test_dir="$1"
323 local test_pattern="${2:-'*'}" # optional, if none default to "*"
324
325 local ret
326 local test_runner_args=()
327
328 test_runner_args+=("$test_dir")
329 if [ "x${test_pattern}" != "x" ]; then
330 test_runner_args+=("${test_pattern}")
331 fi
332
333 if test "x${BT_TESTS_COVERAGE:-}" = "x1"; then
334 python_exec="check_coverage"
335 else
336 python_exec="${BT_TESTS_PYTHON_BIN}"
337 fi
338
339 run_python_bt2 \
340 "${python_exec}" \
341 "${BT_TESTS_SRCDIR}/utils/python/testrunner.py" \
342 --pattern "$test_pattern" \
343 "$test_dir" \
344
345 ret=$?
346
347 if test "x${BT_TESTS_COVERAGE_REPORT:-}" = "x1"; then
348 coverage report -m
349 fi
350
351 if test "x${BT_TESTS_COVERAGE_HTML:-}" = "x1"; then
352 coverage html
353 fi
354
355 return $ret
356 }
This page took 0.037072 seconds and 4 git commands to generate.