4bd30f5d2c
This test suite is implemented using [bats](https://github.com/sstephenson/bats). Not all features are tested. For instance ssl features and custom nginx config are missing. Probably others. This test suite won't work with TravisCI. Too many evenings were wasted trying to overcome [issues](http://stackoverflow.com/questions/32846800/travis-fails-to-stop-docker-containers) that arises only on the TravisCI platform. However it runs on [CircleCI](https://circleci.com) which is also free for opensource projects.
596 lines
18 KiB
Bash
596 lines
18 KiB
Bash
#
|
|
# batslib.bash
|
|
# ------------
|
|
#
|
|
# The Standard Library is a collection of test helpers intended to
|
|
# simplify testing. It contains the following types of test helpers.
|
|
#
|
|
# - Assertions are functions that perform a test and output relevant
|
|
# information on failure to help debugging. They return 1 on failure
|
|
# and 0 otherwise.
|
|
#
|
|
# All output is formatted for readability using the functions of
|
|
# `output.bash' and sent to the standard error.
|
|
#
|
|
|
|
source "${BATS_LIB}/batslib/output.bash"
|
|
|
|
|
|
########################################################################
|
|
# ASSERTIONS
|
|
########################################################################
|
|
|
|
# Fail and display a message. When no parameters are specified, the
|
|
# message is read from the standard input. Other functions use this to
|
|
# report failure.
|
|
#
|
|
# Globals:
|
|
# none
|
|
# Arguments:
|
|
# $@ - [=STDIN] message
|
|
# Returns:
|
|
# 1 - always
|
|
# Inputs:
|
|
# STDIN - [=$@] message
|
|
# Outputs:
|
|
# STDERR - message
|
|
fail() {
|
|
(( $# == 0 )) && batslib_err || batslib_err "$@"
|
|
return 1
|
|
}
|
|
|
|
# Fail and display details if the expression evaluates to false. Details
|
|
# include the expression, `$status' and `$output'.
|
|
#
|
|
# NOTE: The expression must be a simple command. Compound commands, such
|
|
# as `[[', can be used only when executed with `bash -c'.
|
|
#
|
|
# Globals:
|
|
# status
|
|
# output
|
|
# Arguments:
|
|
# $1 - expression
|
|
# Returns:
|
|
# 0 - expression evaluates to TRUE
|
|
# 1 - otherwise
|
|
# Outputs:
|
|
# STDERR - details, on failure
|
|
assert() {
|
|
if ! "$@"; then
|
|
{ local -ar single=(
|
|
'expression' "$*"
|
|
'status' "$status"
|
|
)
|
|
local -ar may_be_multi=(
|
|
'output' "$output"
|
|
)
|
|
local -ir width="$( batslib_get_max_single_line_key_width \
|
|
"${single[@]}" "${may_be_multi[@]}" )"
|
|
batslib_print_kv_single "$width" "${single[@]}"
|
|
batslib_print_kv_single_or_multi "$width" "${may_be_multi[@]}"
|
|
} | batslib_decorate 'assertion failed' \
|
|
| fail
|
|
fi
|
|
}
|
|
|
|
# Fail and display details if the expected and actual values do not
|
|
# equal. Details include both values.
|
|
#
|
|
# Globals:
|
|
# none
|
|
# Arguments:
|
|
# $1 - actual value
|
|
# $2 - expected value
|
|
# Returns:
|
|
# 0 - values equal
|
|
# 1 - otherwise
|
|
# Outputs:
|
|
# STDERR - details, on failure
|
|
assert_equal() {
|
|
if [[ $1 != "$2" ]]; then
|
|
batslib_print_kv_single_or_multi 8 \
|
|
'expected' "$2" \
|
|
'actual' "$1" \
|
|
| batslib_decorate 'values do not equal' \
|
|
| fail
|
|
fi
|
|
}
|
|
|
|
# Fail and display details if `$status' is not 0. Details include
|
|
# `$status' and `$output'.
|
|
#
|
|
# Globals:
|
|
# status
|
|
# output
|
|
# Arguments:
|
|
# none
|
|
# Returns:
|
|
# 0 - `$status' is 0
|
|
# 1 - otherwise
|
|
# Outputs:
|
|
# STDERR - details, on failure
|
|
assert_success() {
|
|
if (( status != 0 )); then
|
|
{ local -ir width=6
|
|
batslib_print_kv_single "$width" 'status' "$status"
|
|
batslib_print_kv_single_or_multi "$width" 'output' "$output"
|
|
} | batslib_decorate 'command failed' \
|
|
| fail
|
|
fi
|
|
}
|
|
|
|
# Fail and display details if `$status' is 0. Details include `$output'.
|
|
#
|
|
# Optionally, when the expected status is specified, fail when it does
|
|
# not equal `$status'. In this case, details include the expected and
|
|
# actual status, and `$output'.
|
|
#
|
|
# Globals:
|
|
# status
|
|
# output
|
|
# Arguments:
|
|
# $1 - [opt] expected status
|
|
# Returns:
|
|
# 0 - `$status' is not 0, or
|
|
# `$status' equals the expected status
|
|
# 1 - otherwise
|
|
# Outputs:
|
|
# STDERR - details, on failure
|
|
assert_failure() {
|
|
(( $# > 0 )) && local -r expected="$1"
|
|
if (( status == 0 )); then
|
|
batslib_print_kv_single_or_multi 6 'output' "$output" \
|
|
| batslib_decorate 'command succeeded, but it was expected to fail' \
|
|
| fail
|
|
elif (( $# > 0 )) && (( status != expected )); then
|
|
{ local -ir width=8
|
|
batslib_print_kv_single "$width" \
|
|
'expected' "$expected" \
|
|
'actual' "$status"
|
|
batslib_print_kv_single_or_multi "$width" \
|
|
'output' "$output"
|
|
} | batslib_decorate 'command failed as expected, but status differs' \
|
|
| fail
|
|
fi
|
|
}
|
|
|
|
# Fail and display details if the expected does not match the actual
|
|
# output or a fragment of it.
|
|
#
|
|
# By default, the entire output is matched. The assertion fails if the
|
|
# expected output does not equal `$output'. Details include both values.
|
|
#
|
|
# When `-l <index>' is used, only the <index>-th line is matched. The
|
|
# assertion fails if the expected line does not equal
|
|
# `${lines[<index>}'. Details include the compared lines and <index>.
|
|
#
|
|
# When `-l' is used without the <index> argument, the output is searched
|
|
# for the expected line. The expected line is matched against each line
|
|
# in `${lines[@]}'. If no match is found the assertion fails. Details
|
|
# include the expected line and `$output'.
|
|
#
|
|
# By default, literal matching is performed. Options `-p' and `-r'
|
|
# enable partial (i.e. substring) and extended regular expression
|
|
# matching, respectively. Specifying an invalid extended regular
|
|
# expression with `-r' displays an error.
|
|
#
|
|
# Options `-p' and `-r' are mutually exclusive. When used
|
|
# simultaneously, an error is displayed.
|
|
#
|
|
# Globals:
|
|
# output
|
|
# lines
|
|
# Options:
|
|
# -l <index> - match against the <index>-th element of `${lines[@]}'
|
|
# -l - search `${lines[@]}' for the expected line
|
|
# -p - partial matching
|
|
# -r - extended regular expression matching
|
|
# Arguments:
|
|
# $1 - expected output
|
|
# Returns:
|
|
# 0 - expected matches the actual output
|
|
# 1 - otherwise
|
|
# Outputs:
|
|
# STDERR - details, on failure
|
|
# error message, on error
|
|
assert_output() {
|
|
local -i is_match_line=0
|
|
local -i is_match_contained=0
|
|
local -i is_mode_partial=0
|
|
local -i is_mode_regex=0
|
|
|
|
# Handle options.
|
|
while (( $# > 0 )); do
|
|
case "$1" in
|
|
-l)
|
|
if (( $# > 2 )) && [[ $2 =~ ^([0-9]|[1-9][0-9]+)$ ]]; then
|
|
is_match_line=1
|
|
local -ri idx="$2"
|
|
shift
|
|
else
|
|
is_match_contained=1;
|
|
fi
|
|
shift
|
|
;;
|
|
-p) is_mode_partial=1; shift ;;
|
|
-r) is_mode_regex=1; shift ;;
|
|
--) break ;;
|
|
*) break ;;
|
|
esac
|
|
done
|
|
|
|
if (( is_match_line )) && (( is_match_contained )); then
|
|
echo "\`-l' and \`-l <index>' are mutually exclusive" \
|
|
| batslib_decorate 'ERROR: assert_output' \
|
|
| fail
|
|
return $?
|
|
fi
|
|
|
|
if (( is_mode_partial )) && (( is_mode_regex )); then
|
|
echo "\`-p' and \`-r' are mutually exclusive" \
|
|
| batslib_decorate 'ERROR: assert_output' \
|
|
| fail
|
|
return $?
|
|
fi
|
|
|
|
# Arguments.
|
|
local -r expected="$1"
|
|
|
|
if (( is_mode_regex == 1 )) && [[ '' =~ $expected ]] || (( $? == 2 )); then
|
|
echo "Invalid extended regular expression: \`$expected'" \
|
|
| batslib_decorate 'ERROR: assert_output' \
|
|
| fail
|
|
return $?
|
|
fi
|
|
|
|
# Matching.
|
|
if (( is_match_contained )); then
|
|
# Line contained in output.
|
|
if (( is_mode_regex )); then
|
|
local -i idx
|
|
for (( idx = 0; idx < ${#lines[@]}; ++idx )); do
|
|
[[ ${lines[$idx]} =~ $expected ]] && return 0
|
|
done
|
|
{ local -ar single=(
|
|
'regex' "$expected"
|
|
)
|
|
local -ar may_be_multi=(
|
|
'output' "$output"
|
|
)
|
|
local -ir width="$( batslib_get_max_single_line_key_width \
|
|
"${single[@]}" "${may_be_multi[@]}" )"
|
|
batslib_print_kv_single "$width" "${single[@]}"
|
|
batslib_print_kv_single_or_multi "$width" "${may_be_multi[@]}"
|
|
} | batslib_decorate 'no output line matches regular expression' \
|
|
| fail
|
|
elif (( is_mode_partial )); then
|
|
local -i idx
|
|
for (( idx = 0; idx < ${#lines[@]}; ++idx )); do
|
|
[[ ${lines[$idx]} == *"$expected"* ]] && return 0
|
|
done
|
|
{ local -ar single=(
|
|
'substring' "$expected"
|
|
)
|
|
local -ar may_be_multi=(
|
|
'output' "$output"
|
|
)
|
|
local -ir width="$( batslib_get_max_single_line_key_width \
|
|
"${single[@]}" "${may_be_multi[@]}" )"
|
|
batslib_print_kv_single "$width" "${single[@]}"
|
|
batslib_print_kv_single_or_multi "$width" "${may_be_multi[@]}"
|
|
} | batslib_decorate 'no output line contains substring' \
|
|
| fail
|
|
else
|
|
local -i idx
|
|
for (( idx = 0; idx < ${#lines[@]}; ++idx )); do
|
|
[[ ${lines[$idx]} == "$expected" ]] && return 0
|
|
done
|
|
{ local -ar single=(
|
|
'line' "$expected"
|
|
)
|
|
local -ar may_be_multi=(
|
|
'output' "$output"
|
|
)
|
|
local -ir width="$( batslib_get_max_single_line_key_width \
|
|
"${single[@]}" "${may_be_multi[@]}" )"
|
|
batslib_print_kv_single "$width" "${single[@]}"
|
|
batslib_print_kv_single_or_multi "$width" "${may_be_multi[@]}"
|
|
} | batslib_decorate 'output does not contain line' \
|
|
| fail
|
|
fi
|
|
elif (( is_match_line )); then
|
|
# Specific line.
|
|
if (( is_mode_regex )); then
|
|
if ! [[ ${lines[$idx]} =~ $expected ]]; then
|
|
batslib_print_kv_single 5 \
|
|
'index' "$idx" \
|
|
'regex' "$expected" \
|
|
'line' "${lines[$idx]}" \
|
|
| batslib_decorate 'regular expression does not match line' \
|
|
| fail
|
|
fi
|
|
elif (( is_mode_partial )); then
|
|
if [[ ${lines[$idx]} != *"$expected"* ]]; then
|
|
batslib_print_kv_single 9 \
|
|
'index' "$idx" \
|
|
'substring' "$expected" \
|
|
'line' "${lines[$idx]}" \
|
|
| batslib_decorate 'line does not contain substring' \
|
|
| fail
|
|
fi
|
|
else
|
|
if [[ ${lines[$idx]} != "$expected" ]]; then
|
|
batslib_print_kv_single 8 \
|
|
'index' "$idx" \
|
|
'expected' "$expected" \
|
|
'actual' "${lines[$idx]}" \
|
|
| batslib_decorate 'line differs' \
|
|
| fail
|
|
fi
|
|
fi
|
|
else
|
|
# Entire output.
|
|
if (( is_mode_regex )); then
|
|
if ! [[ $output =~ $expected ]]; then
|
|
batslib_print_kv_single_or_multi 6 \
|
|
'regex' "$expected" \
|
|
'output' "$output" \
|
|
| batslib_decorate 'regular expression does not match output' \
|
|
| fail
|
|
fi
|
|
elif (( is_mode_partial )); then
|
|
if [[ $output != *"$expected"* ]]; then
|
|
batslib_print_kv_single_or_multi 9 \
|
|
'substring' "$expected" \
|
|
'output' "$output" \
|
|
| batslib_decorate 'output does not contain substring' \
|
|
| fail
|
|
fi
|
|
else
|
|
if [[ $output != "$expected" ]]; then
|
|
batslib_print_kv_single_or_multi 8 \
|
|
'expected' "$expected" \
|
|
'actual' "$output" \
|
|
| batslib_decorate 'output differs' \
|
|
| fail
|
|
fi
|
|
fi
|
|
fi
|
|
}
|
|
|
|
# Fail and display details if the unexpected matches the actual output
|
|
# or a fragment of it.
|
|
#
|
|
# By default, the entire output is matched. The assertion fails if the
|
|
# unexpected output equals `$output'. Details include `$output'.
|
|
#
|
|
# When `-l <index>' is used, only the <index>-th line is matched. The
|
|
# assertion fails if the unexpected line equals `${lines[<index>}'.
|
|
# Details include the compared line and <index>.
|
|
#
|
|
# When `-l' is used without the <index> argument, the output is searched
|
|
# for the unexpected line. The unexpected line is matched against each
|
|
# line in `${lines[<index>]}'. If a match is found the assertion fails.
|
|
# Details include the unexpected line, the index where it was found and
|
|
# `$output' (with the unexpected line highlighted in it if `$output` is
|
|
# longer than one line).
|
|
#
|
|
# By default, literal matching is performed. Options `-p' and `-r'
|
|
# enable partial (i.e. substring) and extended regular expression
|
|
# matching, respectively. On failure, the substring or the regular
|
|
# expression is added to the details (if not already displayed).
|
|
# Specifying an invalid extended regular expression with `-r' displays
|
|
# an error.
|
|
#
|
|
# Options `-p' and `-r' are mutually exclusive. When used
|
|
# simultaneously, an error is displayed.
|
|
#
|
|
# Globals:
|
|
# output
|
|
# lines
|
|
# Options:
|
|
# -l <index> - match against the <index>-th element of `${lines[@]}'
|
|
# -l - search `${lines[@]}' for the unexpected line
|
|
# -p - partial matching
|
|
# -r - extended regular expression matching
|
|
# Arguments:
|
|
# $1 - unexpected output
|
|
# Returns:
|
|
# 0 - unexpected matches the actual output
|
|
# 1 - otherwise
|
|
# Outputs:
|
|
# STDERR - details, on failure
|
|
# error message, on error
|
|
refute_output() {
|
|
local -i is_match_line=0
|
|
local -i is_match_contained=0
|
|
local -i is_mode_partial=0
|
|
local -i is_mode_regex=0
|
|
|
|
# Handle options.
|
|
while (( $# > 0 )); do
|
|
case "$1" in
|
|
-l)
|
|
if (( $# > 2 )) && [[ $2 =~ ^([0-9]|[1-9][0-9]+)$ ]]; then
|
|
is_match_line=1
|
|
local -ri idx="$2"
|
|
shift
|
|
else
|
|
is_match_contained=1;
|
|
fi
|
|
shift
|
|
;;
|
|
-L) is_match_contained=1; shift ;;
|
|
-p) is_mode_partial=1; shift ;;
|
|
-r) is_mode_regex=1; shift ;;
|
|
--) break ;;
|
|
*) break ;;
|
|
esac
|
|
done
|
|
|
|
if (( is_match_line )) && (( is_match_contained )); then
|
|
echo "\`-l' and \`-l <index>' are mutually exclusive" \
|
|
| batslib_decorate 'ERROR: refute_output' \
|
|
| fail
|
|
return $?
|
|
fi
|
|
|
|
if (( is_mode_partial )) && (( is_mode_regex )); then
|
|
echo "\`-p' and \`-r' are mutually exclusive" \
|
|
| batslib_decorate 'ERROR: refute_output' \
|
|
| fail
|
|
return $?
|
|
fi
|
|
|
|
# Arguments.
|
|
local -r unexpected="$1"
|
|
|
|
if (( is_mode_regex == 1 )) && [[ '' =~ $unexpected ]] || (( $? == 2 )); then
|
|
echo "Invalid extended regular expression: \`$unexpected'" \
|
|
| batslib_decorate 'ERROR: refute_output' \
|
|
| fail
|
|
return $?
|
|
fi
|
|
|
|
# Matching.
|
|
if (( is_match_contained )); then
|
|
# Line contained in output.
|
|
if (( is_mode_regex )); then
|
|
local -i idx
|
|
for (( idx = 0; idx < ${#lines[@]}; ++idx )); do
|
|
if [[ ${lines[$idx]} =~ $unexpected ]]; then
|
|
{ local -ar single=(
|
|
'regex' "$unexpected"
|
|
'index' "$idx"
|
|
)
|
|
local -a may_be_multi=(
|
|
'output' "$output"
|
|
)
|
|
local -ir width="$( batslib_get_max_single_line_key_width \
|
|
"${single[@]}" "${may_be_multi[@]}" )"
|
|
batslib_print_kv_single "$width" "${single[@]}"
|
|
if batslib_is_single_line "${may_be_multi[1]}"; then
|
|
batslib_print_kv_single "$width" "${may_be_multi[@]}"
|
|
else
|
|
may_be_multi[1]="$( printf '%s' "${may_be_multi[1]}" \
|
|
| batslib_prefix \
|
|
| batslib_mark '>' "$idx" )"
|
|
batslib_print_kv_multi "${may_be_multi[@]}"
|
|
fi
|
|
} | batslib_decorate 'no line should match the regular expression' \
|
|
| fail
|
|
return $?
|
|
fi
|
|
done
|
|
elif (( is_mode_partial )); then
|
|
local -i idx
|
|
for (( idx = 0; idx < ${#lines[@]}; ++idx )); do
|
|
if [[ ${lines[$idx]} == *"$unexpected"* ]]; then
|
|
{ local -ar single=(
|
|
'substring' "$unexpected"
|
|
'index' "$idx"
|
|
)
|
|
local -a may_be_multi=(
|
|
'output' "$output"
|
|
)
|
|
local -ir width="$( batslib_get_max_single_line_key_width \
|
|
"${single[@]}" "${may_be_multi[@]}" )"
|
|
batslib_print_kv_single "$width" "${single[@]}"
|
|
if batslib_is_single_line "${may_be_multi[1]}"; then
|
|
batslib_print_kv_single "$width" "${may_be_multi[@]}"
|
|
else
|
|
may_be_multi[1]="$( printf '%s' "${may_be_multi[1]}" \
|
|
| batslib_prefix \
|
|
| batslib_mark '>' "$idx" )"
|
|
batslib_print_kv_multi "${may_be_multi[@]}"
|
|
fi
|
|
} | batslib_decorate 'no line should contain substring' \
|
|
| fail
|
|
return $?
|
|
fi
|
|
done
|
|
else
|
|
local -i idx
|
|
for (( idx = 0; idx < ${#lines[@]}; ++idx )); do
|
|
if [[ ${lines[$idx]} == "$unexpected" ]]; then
|
|
{ local -ar single=(
|
|
'line' "$unexpected"
|
|
'index' "$idx"
|
|
)
|
|
local -a may_be_multi=(
|
|
'output' "$output"
|
|
)
|
|
local -ir width="$( batslib_get_max_single_line_key_width \
|
|
"${single[@]}" "${may_be_multi[@]}" )"
|
|
batslib_print_kv_single "$width" "${single[@]}"
|
|
if batslib_is_single_line "${may_be_multi[1]}"; then
|
|
batslib_print_kv_single "$width" "${may_be_multi[@]}"
|
|
else
|
|
may_be_multi[1]="$( printf '%s' "${may_be_multi[1]}" \
|
|
| batslib_prefix \
|
|
| batslib_mark '>' "$idx" )"
|
|
batslib_print_kv_multi "${may_be_multi[@]}"
|
|
fi
|
|
} | batslib_decorate 'line should not be in output' \
|
|
| fail
|
|
return $?
|
|
fi
|
|
done
|
|
fi
|
|
elif (( is_match_line )); then
|
|
# Specific line.
|
|
if (( is_mode_regex )); then
|
|
if [[ ${lines[$idx]} =~ $unexpected ]] || (( $? == 0 )); then
|
|
batslib_print_kv_single 5 \
|
|
'index' "$idx" \
|
|
'regex' "$unexpected" \
|
|
'line' "${lines[$idx]}" \
|
|
| batslib_decorate 'regular expression should not match line' \
|
|
| fail
|
|
fi
|
|
elif (( is_mode_partial )); then
|
|
if [[ ${lines[$idx]} == *"$unexpected"* ]]; then
|
|
batslib_print_kv_single 9 \
|
|
'index' "$idx" \
|
|
'substring' "$unexpected" \
|
|
'line' "${lines[$idx]}" \
|
|
| batslib_decorate 'line should not contain substring' \
|
|
| fail
|
|
fi
|
|
else
|
|
if [[ ${lines[$idx]} == "$unexpected" ]]; then
|
|
batslib_print_kv_single 5 \
|
|
'index' "$idx" \
|
|
'line' "${lines[$idx]}" \
|
|
| batslib_decorate 'line should differ' \
|
|
| fail
|
|
fi
|
|
fi
|
|
else
|
|
# Entire output.
|
|
if (( is_mode_regex )); then
|
|
if [[ $output =~ $unexpected ]] || (( $? == 0 )); then
|
|
batslib_print_kv_single_or_multi 6 \
|
|
'regex' "$unexpected" \
|
|
'output' "$output" \
|
|
| batslib_decorate 'regular expression should not match output' \
|
|
| fail
|
|
fi
|
|
elif (( is_mode_partial )); then
|
|
if [[ $output == *"$unexpected"* ]]; then
|
|
batslib_print_kv_single_or_multi 9 \
|
|
'substring' "$unexpected" \
|
|
'output' "$output" \
|
|
| batslib_decorate 'output should not contain substring' \
|
|
| fail
|
|
fi
|
|
else
|
|
if [[ $output == "$unexpected" ]]; then
|
|
batslib_print_kv_single_or_multi 6 \
|
|
'output' "$output" \
|
|
| batslib_decorate 'output equals, but it was expected to differ' \
|
|
| fail
|
|
fi
|
|
fi
|
|
fi
|
|
} |