EQC

Repeat a property several times.

Usage:

always n do
  prop
end

The property succeeds if all n tests of prop succeed.

In Erlang: ?ALWAYS(N, Prop).

A property combinator to obtain test statistics

Usage: collect KeywordList, in: prop

Example: forall {m, n} <- {int, int} do collect m: m, n: n, in: length(Enum.to_list(m .. n)) == abs(n - m) + 1 end

A property checking an operation and prints when relation is violated

Usage:

ensure t1 == t2
ensure t1 > t2

In Erlang ?WHENFAILS(eqc:format("not ensured: ~p ~p ~p ",[T1, Operator, T2]), T1 Operator T2).

A property that should hold for all values generated by a generator.

Usage:

forall pat <- gen do
  prop
end

The variables of pat are bound in prop.

In Erlang: ?FORALL(Pat, Gen, Prop).

Add a precondition to a property.

Usage:

implies pre do
  prop
end

Any test case not satisfying the precondition will be discarded.

In Erlang: ?IMPLIES(Pre, Prop).

Make a generator lazy.

Usage:

lazy do: gen

The generator is not evaluated until a value is generated from it. Crucial when building recursive generators.

In Erlang: ?LAZY(Gen).

Bind a generated value for use by another generator.

Usage:

let pat <- gen1 do
  gen_a
end

let [pat1 <- gen1, pat2 <- gen2] do
  gen_b
end

In the first example, the variables of pat are bound in gen_a. In the second example, the variables of pat1 scope over both gen2 and gen_b.

In Erlang: ?LET(Pat, Gen1, Gen2).

Like let/2 but adds shrinking behaviour.

Usage:

let_shrink pat <- gen1 do
  gen2
end

Here gen1 must generate a list of values, each of which is added as a possible shrinking of the result.

In Erlang: ?LETSHRINK(Pat, Gen1, Gen2).

A property that is only executed once for each test case.

Usage:

once_only do
  prop
end

Repeated tests are generated but not run, and shows up as xs in the test output. Useful if running tests is very expensive.

In Erlang: ?ONCEONLY(Prop).

Setup for a test run.

Usage:

setup function do
  prop
end

Performs setup before a test run (default 100 tests) without teardown function after the test run.

In Erlang: ?SETUP(fun() -> X = Setup, fun() -> ok end, Prop).

Setup and tear-down for a test run.

Usage:

setup_teardown(setup) do
  prop
after
  x -> teardown
end

Performs setup before a test run (default 100 tests) and teardown after the test run. The result of setup is bound to x in teardown, allowing passing resources allocated in setup to teardown. The after argument is optional.

In Erlang: ?SETUP(fun() -> X = Setup, fun() -> Teardown end, Prop).

Add shrinking behaviour to a generator.

Usage:

shrink g, gs

Generates a value from g that can shrink to a value generated by any of the generators in gs.

In Erlang: ?SHRINK(G, Gs).

Bind the current size parameter.

Usage:

sized n, do: prop

In prop, n is bound to the current size.

In Erlang: ?SIZED(N, Prop)

Repeat a property several times, failing only if the property fails every time.

Usage:

sometimes n do
  prop
end

The property succeeds if any of the n tests of prop succeed.

In Erlang: ?SOMETIMES(N, Prop).

Generate a value that satisfies a given predicate.

Throws an exception if no value is found after 100 attempts. Usage:

such_that pat <- gen, do: pred

The variables of pat are bound in pred.

In Erlang: ?SUCHTHAT(Pat, Gen, Pred).

Generate a value that satisfies a given predicate, or false if no value is found.

Usage:

such_that_maybe pat <- gen, do: pred

The variables of pat are bound in pred.

In Erlang: ?SUCHTHATMAYBE(Pat, Gen, Pred).

Set a time limit on a property.

Usage:

timeout limit do
  prop
end

Causes the property to fail if it doesn't complete within the time limit.

In Erlang: ?TIMEOUT(Limit, Prop).

Run a property in a separate process and trap exits.

Usage:

trap_exit do
  prop
end

Prevents a property from crashing if a linked process exits.

In Erlang: ?TRAPEXIT(Prop).

Perform an action when a test fails.

Usage:

when_fail(action) do
  prop
end

Typically the action will be printing some diagnostic information.

In Erlang: ?WHENFAIL(Action, Prop).