Test Utilities

test_utils.bsh

Utilities to help in test verifications

assert_array_values

Arguments:

$1 - Array name
[$2…] - Array values

Output:

Return Value:

0 - Equal
1 - A value is not the same
2 - The array had less values than specified
3 - The array had more values than specified

Check array values for unit tests

See also

elements.bsh cmp_elements_a

assert_array_regex_values

Regex version of assert_array_values.

Only the values (RHS) may contain a bash regex.

assert_array_contiguous

Check array values are contiguous for unit tests

Arguments:

$1 - Array name to test

Output:

Return Value:

0 - Array is contiguous
1 - Array is not contiguous

Note

Uses eval

assert_array_eq

Checks if two arrays are identical, including their indicies. Also works on associative arrays.

Arguments:

$1 - Array name
$2 - Second array name

Output:

Return Value:

Same return values as assert_array_values

assert_str_eq

Checks if two strings are equal

Arguments:

$1 - First string
$2 - Second string

On failure, will print out the strings, coloring from the first diff to the last diff, to emphasize where the string is different.

assert_ansi_str_eq

Version os assert_str_eq where ANSI codes are stripped, and thus don’t count against a string matching

Arguments:

assert_test

Asserts that a test is true. The only real advantage to using this is a formatted error output.

Arguments:: $1… - Arguments to test aka [ ]

Example

assert_test 4 = 4
not assert_test 4 = 5
assert_test -z "${EMPTY_STRING}"
assert_test -d "${some dir}"

assert_sub_str

Asserts that a string is contained in another string.

Arguments:

$1 - The string
$2 - The substring being checked for

Equivalently checking [[ ${str} = *"${substr}"* ]] || false, with formatted error output

assert_starts_with

Asserts that a string starts with the second string

Arguments:

$1 - The string
$2 - The prefix being checked for

Equivalently checking [[ ${str} = "${substr}"* ]] || false, with formatted error output

assert_ends_with

Asserts that a string ends with the second string

Arguments:

$1 - The string
$2 - The suffix being checked for

Equivalently checking [[ ${str} = *"${substr}" ]] || false, with formatted error output

assert_regex_eq

Asserts that a string matches a regex

Arguments:

$1 - The string being checked
$2 - A regex string

Equivalently checking [[ ${str} =~ ${substr} ]] || false, with formatted error output

Example

assert_regex_eq "foo" 'o'
not assert_regex_eq "foo" '^o'
assert_regex_eq "foo" 'o$'
assert_regex_eq "foo" '^foo$'
assert_regex_eq 'a[]' '^a\[\]$'

assert_set

Asserts that a variable is set

Arguments:

$1 - The variable name being checked

Example

assert_unset a
a=15
assert_set a
a =(11 22 33)
assert_set a[0]
assert_set a[@]
unset a[0]
assert_unset a[0]
assert_set a[@]

Note

Checking assert_set a on an array is the same as a[0]. So you should use a[@] instead

assert_unset

Asserts that a variable is unset

Arguments:

$1 - The variable name being checked

Note

On bash 3.2, an empty variable is indistinguishable from a null variable, so assert_unset will return true when it is null.

not

Arguments:

$1… - Command and arguments

Output:

Return value

0 - On non-zero return code evaluation
1 - On zero return code

Returns true only when the command fails

Since ! is ignored by “set -e”, use not instead. This is just a helper to make unittests look nice and not need extra ifs everywhere

Example

# No good, always passes, even if ! true. If this is the last line of a
# function, you will be fooled into thinking it is working because
# functions return the return value of the last line, by default.
# The "!" does set a non-zero return value, but does not trigger set -e,
# similar to [[ ]] in older versions of bash.
! false

# good
not false
# equivalent to
if ! false; then
  true
else
  false
fi

Bugs

Complex statements do not work, e.g. [, [[ and ((, etc…: For example, you should use

[ ! -e "/test" ]

instead of

not [ -e "/test" ]

In cases where this is not easily worked around, you can use

not_s '[ -e "/test" ]'