View Source Moar.Assertions (Moar v0.1.0)
Some ExUnit assertions
Link to this section Summary
Functions
Asserts that the left
and right
values are equal. Returns the left
value unless the assertion fails,
or if the :returning
option is used. Uses assert left == right
under the hood, but works nicely in a pipeline.
Asserts that a pre-condition and a post-condition are true after performing an action.
Link to this section Types
@type assert_eq_opts() :: {:ignore_order, boolean()} | {:returning, any()} | {:within, number() | {number(), Moar.Duration.time_unit()}}
Link to this section Functions
@spec assert_eq(left :: any(), right :: any(), opts :: [assert_eq_opts()]) :: any()
Asserts that the left
and right
values are equal. Returns the left
value unless the assertion fails,
or if the :returning
option is used. Uses assert left == right
under the hood, but works nicely in a pipeline.
Options:
ignore_order: boolean
- if theleft
andright
values are lists, ignores the order when checking equality.returning: value
- returnsvalue
if the assertion passes, rather than returning theleft
value.within: delta
- asserts that theleft
andright
values are withindelta
of each other rather than strictly equal.within: {delta, time_unit}
- likewithin: delta
but performs time comparisons in the specifiedtime_unit
. Ifleft
andright
are strings, they are parsed as ISO8601 dates.
@spec assert_that(any(), [{:changes, any()} | {:from, any()} | {:to, any()}, ...]) :: {:__block__, [], [...]}
Asserts that a pre-condition and a post-condition are true after performing an action.
examples
Examples
{:ok, agent} = Agent.start(fn -> 0 end)
assert_that(Agent.update(agent, fn s -> s + 1 end),
changes: Agent.get(agent, fn s -> s end),
from: 0,
to: 1
)