From: Philippe Proulx Date: Fri, 10 Nov 2023 03:51:50 +0000 (-0500) Subject: tests/utils/utils.sh: improve comments X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=commitdiff_plain;h=07ff3b19ad76e1c2c7e18c244fd9adb84b09a82f tests/utils/utils.sh: improve comments Add some, make some more readable, add details to some, stay within 72 columns. Signed-off-by: Philippe Proulx Change-Id: I9e4a5b59b89a5a8eed6ab595cd4d5cc79be99a47 --- diff --git a/tests/utils/utils.sh b/tests/utils/utils.sh index 037f5307..a068ccb5 100644 --- a/tests/utils/utils.sh +++ b/tests/utils/utils.sh @@ -3,17 +3,30 @@ # SPDX-License-Identifier: GPL-2.0-only # # Copyright (c) 2019 Michael Jeanson -# Copyright (C) 2019 Philippe Proulx -# - -# This file is meant to be sourced at the start of shell script-based tests. +# Copyright (C) 2019-2023 Philippe Proulx +# 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). -# Error out when encountering an undefined variable +# An unbound variable is an error set -u -# If "readlink -f" is available, get a resolved absolute path to the -# tests source dir, otherwise make do with a relative path. +# If `readlink -f` is available, then get a resolved absolute path to +# the tests source directory. Otherwise, make do with a relative path. scriptdir="$(dirname "${BASH_SOURCE[0]}")" if readlink -f "." >/dev/null 2>&1; then testsdir=$(readlink -f "$scriptdir/..") @@ -21,10 +34,21 @@ else testsdir="$scriptdir/.." fi -# The OS on which we are running. See [1] for possible values of 'uname -s'. -# We do a bit of translation to ease our life down the road for comparison. -# Export it so that called executables can use it. -# [1] https://en.wikipedia.org/wiki/Uname#Examples +# 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 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 @@ -47,25 +71,26 @@ if [ -z "${BT_TESTS_OS_TYPE:-}" ]; then fi export BT_TESTS_OS_TYPE -# Allow overriding the source and build directories +# 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 -# Source the generated environment file if it's present. +# Source the generated environment file if it's present if [ -f "${BT_TESTS_BUILDDIR}/utils/env.sh" ]; then # shellcheck disable=SC1091 . "${BT_TESTS_BUILDDIR}/utils/env.sh" fi -# Allow overriding the babeltrace2 executables +# 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 @@ -74,100 +99,113 @@ if [ -z "${BT_TESTS_BT2_BIN:-}" ]; then fi export BT_TESTS_BT2_BIN -# TODO: Remove when bindings/python/bt2/test_plugin.py is fixed +# 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_PLUGINS_PATH="${BT_TESTS_BUILDDIR}/../src/plugins" -# Allow overriding the babeltrace2 plugin path +# Colon-separated list of project plugin paths, if not set if [ -z "${BT_TESTS_BABELTRACE_PLUGIN_PATH:-}" ]; then BT_TESTS_BABELTRACE_PLUGIN_PATH="${BT_PLUGINS_PATH}/ctf:${BT_PLUGINS_PATH}/utils:${BT_PLUGINS_PATH}/text:${BT_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 -# Allow overriding the babeltrace2 executables +# 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 - -### External Tools ### +# 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_PYTHON_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 - -### Optional features ### - +# Whether or not to enable AddressSanitizer, `0` (disabled) if not set. if [ -z "${BT_TESTS_ENABLE_ASAN:-}" ]; then BT_TESTS_ENABLE_ASAN="0" fi export BT_TESTS_ENABLE_ASAN - -# Data files path +# 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" -# By default, it will not source tap.sh. If you want to output tap directly -# from the test script, define the 'SH_TAP' variable to '1' before sourcing -# this script. +# 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 - -# Remove CR characters in file "$1". - +# 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" + "$BT_TESTS_SED_BIN" 's/\r//g' "$1" } -# Run the Babeltrace CLI, redirecting stdout and stderr to specified files. +# 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. # -# $1: file to redirect stdout to -# $2: file to redirect stderr to -# remaining args: arguments to pass to the CLI +# The remaining arguments are forwarded to the `$BT_TESTS_BT2_BIN` +# command. # -# Return the exit code of the CLI. - +# Returns the exit status of the executed `$BT_TESTS_BT2_BIN`. bt_cli() { local stdout_file="$1" local stderr_file="$2" @@ -178,27 +216,21 @@ bt_cli() { run_python_bt2 "$BT_TESTS_BT2_BIN" "${args[@]}" 1>"$stdout_file" 2>"$stderr_file" } -### Diff Functions ### - -# Check the differences between two files (typically some expected output vs -# some actual output). If there are differences, print the diff to stderr. +# Checks the differences between: # -# $1: file 1 (expected) -# $2: file 2 (actual) +# • The (expected) contents of the file having the path `$1`. # -# Return 0 if there's no difference, and non-zero if there are. +# • The contents of another file having the path `$2`. # -# Note that this function modifies the actual output file ($2) _in-place_ to -# remove any \r character. - +# 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 expected_file="$1" local actual_file="$2" local ret=0 - # Strip any \r present due to Windows (\n -> \r\n). - # "diff --string-trailing-cr" is not used since it is not present on - # Solaris. diff -u <(bt_remove_cr_inline "$expected_file") <(bt_remove_cr_inline "$actual_file") 1>&2 return $? @@ -206,18 +238,20 @@ bt_diff() { # Checks the difference between: # -# 1. What the CLI outputs on its standard output when given the arguments -# "$@" (excluding the first two arguments). -# 2. The file with path "$1". +# • 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: # -# And 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. # -# 1. What the CLI outputs on its standard error when given the arguments -# "$@" (excluding the first two arguments). -# 2. The file with path "$2". +# • The file having the path `$2`. # -# Returns 0 if there's no difference, and 1 if there is, also printing -# said difference to the standard error. +# Returns 0 if there's no difference, or 1 otherwise, also printing said +# difference to the standard error. bt_diff_cli() { local expected_stdout_file="$1" local expected_stderr_file="$2" @@ -233,7 +267,6 @@ bt_diff_cli() { temp_stdout_output_file="$(mktemp -t actual-stdout.XXXXXX)" temp_stderr_output_file="$(mktemp -t actual-stderr.XXXXXX)" - # Run the CLI to get a detailed file. bt_cli "$temp_stdout_output_file" "$temp_stderr_output_file" "${args[@]}" bt_diff "$expected_stdout_file" "$temp_stdout_output_file" "${args[@]}" @@ -250,13 +283,19 @@ bt_diff_cli() { return $ret } -# Checks the difference between the content of the file with path "$1" -# and the output of the CLI when called on the directory path "$2" with -# the arguments '-c sink.text.details' and the rest of the arguments to -# this function. +# 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, and 1 if there is, also printing -# said difference to the standard error. +# Returns 0 if there's no difference, or 1 otherwise, also printing said +# difference to the standard error. bt_diff_details_ctf_single() { local expected_stdout_file="$1" local trace_dir="$2" @@ -269,10 +308,11 @@ bt_diff_details_ctf_single() { "-c" "sink.text.details" "${extra_details_args[@]+${extra_details_args[@]}}" } -# Calls 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. +# 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 ctf_gen_prog_path="$1" local expected_stdout_file="$2" @@ -299,7 +339,7 @@ bt_diff_details_ctf_gen_single() { return $ret } -# Run the grep binary configured for the tests. +# Like `grep`, but using `$BT_TESTS_GREP_BIN`. bt_grep() { "$BT_TESTS_GREP_BIN" "$@" } @@ -327,28 +367,28 @@ bt_grep_ok() { return $ret } -### Functions ### - +# Forwards the arguments to `coverage run`. check_coverage() { coverage run "$@" } -# Execute a shell command in the appropriate environment to access the Python -# test utility modules in `tests/utils/python`. +# 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_PYTHON_VERSION =~ 3.[45] ]]; then - # Add a local directory containing a `typing.py` to `PYTHONPATH` for - # Python 3.4 which doesn't offer the `typing` module. + # 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:-}" "$@" } -# Execute a shell command in the appropriate environment to have access to the -# bt2 Python bindings. +# 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 lib_asan local -x "BABELTRACE_PYTHON_BT2_NO_TRACEBACK=1" @@ -361,7 +401,8 @@ run_python_bt2() { local main_lib_path="${BT_TESTS_BUILDDIR}/../src/lib/.libs" - # Set the library search path so the python interpreter can load libbabeltrace2 + # 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 @@ -370,22 +411,23 @@ run_python_bt2() { local -x LD_LIBRARY_PATH="${main_lib_path}${LD_LIBRARY_PATH:+:}${LD_LIBRARY_PATH:-}" fi - # On Windows, an embedded Python interpreter needs a way to locate the path - # to its internal modules, set the prefix from python-config to the - # PYTHONHOME variable. + # 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 + # 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, such that we override the user's value if it - # contains detect_leaks=1. + # 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 lib_asan="$(${BT_TESTS_CC_BIN} -print-file-name=libasan.so)" @@ -398,13 +440,15 @@ run_python_bt2() { run_python "$@" } -# Set the environment and run python tests in the directory. +# Runs the Python tests matching the pattern `$2` (optional, `*` if +# missing) in the directory `$1` using `testrunner.py`. # -# $1 : The directory containing the python test scripts -# $2 : The pattern to match python test script names (optional) +# 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 test_dir="$1" - local test_pattern="${2:-'*'}" # optional, if none default to "*" + local test_pattern="${2:-'*'}" local ret local test_runner_args=() @@ -439,10 +483,8 @@ run_python_bt2_test() { return $ret } -# Generate a CTF trace using `mctf.py`. -# -# $1: Input filename -# $2: Base directory path for output files +# 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"