assert Action
Last updated
Was this helpful?
Last updated
Was this helpful?
Used in to assert expected results.
The body is a JSON array of assertions. An assertion is an array itself, with up to three values:
Expression: as string (see ); (required)
Expected result: a literal value (string, number, boolean, or null
) or an object with compare flags (see below); (optional, default: true
)
Message: String literal to be included in output of failed tests; (optional)
Note that the expression must be a string. You can use template syntax, but the resulting array of assertions must still contain a string as the expression parameter.
The expected value (second value) can be an object that defines one or more compare flags:
file
: read wanted text from a golden file
mode
: either text
or json
. json
mode validates JSON syntax in both expected and actual result; compares JSON in compact (un-pretty) formatting.
contains
: a string that must be contained in the expression result
pattern
: a regular expression pattern (with delimiters and optional modifiers) that the expression result must match.
The recipe provides a full example.
(cookbook)
(cookbook)
(reference)