mirror of
https://github.com/opencontainers/runc.git
synced 2026-11-06 13:27:23 +00:00
Kir Kolyshkin
2c7405b300
When a test fails on a string comparison, all we see is the failed expression, which usually means adding some debug output and rerunning the test to find out what the actual value was. The bats-assert library solves this, but it (together with its bats-support dependency) has to be installed separately on every distro we test on, which is more trouble than it's worth for a few functions. Add assert_output, refute_output, and assert_line, implementing a subset of the bats-assert API (so that the tests read the same way, and this code can be dropped should bats-assert ever be added as a dependency), and use them for the comparisons against an exact value. Now, when such a check fails, the test log shows what was expected and what was there: -- output does not match (exact) -- expected: '/override' actual: $'\0/override' -- Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
94 lines
2.9 KiB
Bash
94 lines
2.9 KiB
Bash
#!/bin/bash
|
|
#
|
|
# The assert_* functions below implement a subset of the bats-assert library
|
|
# (https://github.com/bats-core/bats-assert). We do not use the real thing
|
|
# because it, together with its bats-support dependency, has to be installed
|
|
# separately on every distribution the tests are run on.
|
|
#
|
|
# assert_output [--partial | --regexp] EXPECTED
|
|
# refute_output [--partial | --regexp] UNEXPECTED
|
|
# assert_line --index IDX [--partial | --regexp] EXPECTED
|
|
#
|
|
# This file lives in its own directory so that bats can be told to skip it
|
|
# when capturing stack traces (see below); otherwise every failed assertion
|
|
# is prefixed by a few useless frames pointing into this file.
|
|
if declare -F bats_setup_tracing >/dev/null &&
|
|
! declare -F __assert_orig_setup_tracing >/dev/null; then
|
|
# Rename bats_setup_tracing to __assert_orig_setup_tracing ...
|
|
eval "__assert_orig_setup_tracing() $(declare -f bats_setup_tracing | tail -n +2)"
|
|
# ... and wrap it, so that this directory is added to the list of paths
|
|
# excluded from stack traces. This can not be done at load time, as bats
|
|
# resets the exclude list in bats_setup_tracing, which runs afterwards.
|
|
function bats_setup_tracing() {
|
|
__assert_orig_setup_tracing "$@"
|
|
bats_add_debug_exclude_path "${BASH_SOURCE[0]%/*}"
|
|
}
|
|
fi
|
|
|
|
# __assert_matches MODE ACTUAL EXPECTED
|
|
function __assert_matches() {
|
|
case "$1" in
|
|
exact) [ "$2" = "$3" ] ;;
|
|
partial) [[ $2 == *"$3"* ]] ;;
|
|
regexp) [[ $2 =~ $3 ]] ;;
|
|
*) fail "assert: unknown mode: $1" ;;
|
|
esac
|
|
}
|
|
|
|
# __assert_fail WHAT MODE EXPECTED ACTUAL
|
|
function __assert_fail() {
|
|
{
|
|
echo "-- $1 ($2) --"
|
|
echo "expected: ${3@Q}"
|
|
echo " actual: ${4@Q}"
|
|
echo "--"
|
|
} >&2
|
|
|
|
return 1
|
|
}
|
|
|
|
# __assert_mode ARG -- prints the match mode for an optional flag.
|
|
function __assert_mode() {
|
|
case "$1" in
|
|
--partial) echo partial ;;
|
|
--regexp) echo regexp ;;
|
|
# Guard against a typo or an unimplemented bats-assert option being
|
|
# silently treated as the expected value.
|
|
-*) fail "assert: unknown option: $1" ;;
|
|
*) echo exact ;;
|
|
esac
|
|
}
|
|
|
|
function assert_output() {
|
|
local mode
|
|
mode=$(__assert_mode "${1:-}")
|
|
[ "$mode" = exact ] || shift
|
|
|
|
# shellcheck disable=SC2154 # $output is set by bats' run helper.
|
|
__assert_matches "$mode" "$output" "$1" && return 0
|
|
__assert_fail "output does not match" "$mode" "$1" "$output"
|
|
}
|
|
|
|
function refute_output() {
|
|
local mode
|
|
mode=$(__assert_mode "${1:-}")
|
|
[ "$mode" = exact ] || shift
|
|
|
|
# shellcheck disable=SC2154 # $output is set by bats' run helper.
|
|
__assert_matches "$mode" "$output" "$1" || return 0
|
|
__assert_fail "output should not match" "$mode" "$1" "$output"
|
|
}
|
|
|
|
function assert_line() {
|
|
local idx mode
|
|
[ "${1:-}" = "--index" ] || fail "assert_line: --index IDX is required"
|
|
idx="$2"
|
|
shift 2
|
|
mode=$(__assert_mode "${1:-}")
|
|
[ "$mode" = exact ] || shift
|
|
|
|
# shellcheck disable=SC2154 # $lines is set by bats' run helper.
|
|
__assert_matches "$mode" "${lines[idx]:-}" "$1" && return 0
|
|
__assert_fail "line $idx does not match" "$mode" "$1" "${lines[idx]:-}"
|
|
}
|