Executable Specifications

Ensure

allows the actor to make an assertion

fails the actor flow when the assertion is not met

provides a description of the assertion being made

provides a description of the assertion being made, while correctly cleaning the output from new line characters

complains when given an Expectation that doesn't conform to the interface

when emitting an artifact

custom errors

allows the actor to fail the flow with a custom RuntimeError, embedding the original error

allows the actor to fail the flow with a custom RuntimeError with a custom error message

Expectation

allows to easily define an assertion, which

allows the actor flow to continue when the assertion passes

stops the actor flow when the assertion fails

allows to alias an expectation, so that the alias

contributes to a human-readable description

provides a precise failure message when the expectation is not met

allows to override the description of an expectation, so that the new version

replaces the old description

provides a precise failure message when the expectation is not met

and

allows for the actor flow to continue when the "actual" meets all the expectations

breaks the actor flow when "actual"

does not meet the first expectation

does not meet the second expectation

contributes to a human-readable description

contain

allows for the actor flow to continue when the "actual" contains the "expected" text

breaks the actor flow when "actual" does not contain the "expected" text

contributes to a human-readable description

containAtLeastOneItemThat

allows for the actor flow to continue when the "actual" includes at least one item that meets the expectation

breaks the actor flow when "actual" does not include at least one item that meets the expectation

breaks the actor flow when "actual" is an empty list

contributes to a human-readable description

containItemsWhereEachItem

allows for the actor flow to continue when the "actual" includes only those items that meet the expectation

breaks the actor flow when "actual" contains at least one item that does not meet the expectation

breaks the actor flow when "actual" is an empty list

contributes to a human-readable description

endsWith

allows for the actor flow to continue when the "actual" ends with "expected"

breaks the actor flow when "actual" does not end with "expected"

contributes to a human-readable description

equals

breaks the actor flow when the values of "actual" and "expected" don't match

contributes to a human-readable description

includes

allows for the actor flow to continue when the "actual" includes the "expected" text

breaks the actor flow when "actual" does not include the "expected" text

contributes to a human-readable description

isAfter

allows for the actor flow to continue when the "actual" is after the "expected"

breaks the actor flow when "actual" is not after the "expected"

contributes to a human-readable description

isBefore

allows for the actor flow to continue when the "actual" is before the "expected"

breaks the actor flow when "actual" is not before the "expected"

contributes to a human-readable description

isFalse

allows for the actor flow to continue when the "actual" is false

breaks the actor flow when "actual" is not false

contributes to a human-readable description

isGreaterThan

allows for the actor flow to continue when the "actual" is greater than "expected"

breaks the actor flow when "actual" is not greater than "expected"

contributes to a human-readable description

isLessThan

allows for the actor flow to continue when the "actual" is less than "expected"

breaks the actor flow when "actual" is not less than "expected"

contributes to a human-readable description

isTrue

allows for the actor flow to continue when the "actual" is true

breaks the actor flow when "actual" is not true

contributes to a human-readable description

matches

allows for the actor flow to continue when the "actual" matches the "expected"

breaks the actor flow when "actual" does not match the "expected"

contributes to a human-readable description

not

allows for the actor flow to continue when the "actual" meets the expectation

breaks the actor flow when "actual" does not meet the expectation

contributes to a human-readable description

flips the outcome of an assertion, but doesn't hide any errors that might have happened while making it

double negative

contributes to a human-readable description

when combined with other assertions, such as

and,

produces a sensible error message

contributes to a human-readable description

contains,

produces a sensible error message

contributes to a human-readable description

containAtLeastOneItemThat,

produces a sensible error message

contributes to a human-readable description

endsWith,

produces a sensible error message

contributes to a human-readable description

equals,

produces a sensible error message

contributes to a human-readable description

isTrue,

produces a sensible error message

contributes to a human-readable description

isFalse,

produces a sensible error message

contributes to a human-readable description

includes,

produces a sensible error message

contributes to a human-readable description

isGreaterThan,

produces a sensible error message

contributes to a human-readable description

isLessThan,

produces a sensible error message

contributes to a human-readable description

or,

produces a sensible error message

contributes to a human-readable description

startsWith,

produces a sensible error message

contributes to a human-readable description

or

allows for the actor flow to continue when the "actual"

meets all the expectations

meets at least one expectation

breaks the actor flow when "actual" does meets none of the expectations

contributes to a human-readable description

hasProperty

allows for the actor flow to continue when the "actual" has a property that meets the expectation

breaks the actor flow when "actual" does not have a property that meets the expectation

contributes to a human-readable description

startsWith

allows for the actor flow to continue when the "actual" starts with "expected"

breaks the actor flow when "actual" does not start with "expected"

contributes to a human-readable description