| Overview |  |
Copyright © Quviq AB, 2004-2015
Version: 2.01.0
prop_reverse() ->
?FORALL(Xs,list(int()),
lists:reverse(lists:reverse(Xs)) == Xs).
Generators are defined using the module eqc_gen.
abstract datatype: counterexample()
A counter-example to a QuickCheck property, which can be obtained
using counterexample/0 or counterexample/1, and used to repeat a test,
or test a different property in the same case. Counterexamples are represented by the values
bound by ?FORALL--for the counterexample to make sense independently, it's important that
these were generated without side-effects.
print_method() = fun(([term()]) -> any())
A function for
printing statistics, which is passed a list of samples and is
expected to print statistical information about them. Print methods
are used by collect/3 and aggregate/3.
abstract datatype: property()
QuickCheck properties, which can either be boolean
expressions, or constructed using the functions in this module.
QuickCheck properties are tested using quickcheck/1.
| aggregate/2 | A property logically equivalent to Prop, but which collects a list of values in each test, and displays the distribution of these values once testing is complete. |
| aggregate/3 | Like aggregate/2, but allows the user to specify how
the collected values should be printed. |
| check/1 | Equivalent to check(Prop, eqc:current_counterexample()). |
| check/2 | Tests the property in the case given. |
| classify/3 | Property which is logically equivalent to Prop, but also classifies test cases and displays the distribution of test case classes when testing is complete. |
| collect/2 | Equivalent to aggregate([S], Prop). |
| collect/3 | Equivalent to aggregate(PrintMethod, [S], Prop). |
| counterexample/0 | Returns the last counter-example found. |
| counterexample/1 | Tests the property in the same way as quickcheck/1, but if
a test fails, then the failing test case is returned as a counterexample. |
| counterexamples/0 | Returns a list of the counterexamples found by the last call
of eqc:module, paired with the name of the property that failed. |
| equals/2 | A property which holds if X and Y are equal... |
| fails/1 | A property which succeeds when its argument fails. |
| format/2 | Can be used in place of io:format/2 inside ?WHENFAIL to allow the output to be captured by on_output/2. |
| measure/3 | Collects the values of X while testing Prop, and if all tests pass, displays statistics such as the minimum, average, and maximum values, identified by the name Name. |
| module/1 | Tests all the properties exported from a module, given the module name. |
| modules/0 | |
| numtests/2 | Property which is logically equivalent to Prop, but is tested N times rather than 100. |
| on_output/2 | Supplies an output function to be used instead of io:format when QuickCheck generates output. |
| on_test/2 | Attaches a function to a property which is called every time a test passes or fails. |
| only_top/1 | A printing method for discarding all but the top N collected values. |
| only_top/2 | A printing method for discarding all but the top N collected values. |
| quickcheck/1 | Tests the property in 100 random cases, printing a counter-example if one is found. |
| recheck/1 | Tests the property with the same random number seed as
the last failing call of quickcheck/1. |
| start/0 | Starts the QuickCheck server. |
| start/1 | Equivalent to start(). |
| stop/0 | Stops the QuickCheck server. |
| version/0 | Returns the version number of this version of QuickCheck. |
| with_title/1 | A printing method for collected data, which displays a title before the percentages of each value in the data. |
aggregate(L::[term()], Prop::property()) -> property()
A property logically equivalent to Prop, but which collects a list of values in
each test, and displays the distribution of these values once
testing is complete. A typical use would be to aggregate the list of command names generated
by eqc_statem:commands/1, in order to see how often each individual
command appeared in generated tests:
aggregate(command_names(Cmds), ...)
See also aggregate/3.
aggregate(PrintMethod::fun(([{term(), int()}]) -> any()), L::[term()], Prop::property()) -> property()
Like aggregate/2, but allows the user to specify how
the collected values should be printed. The PrintMethod parameter
is called with a list of the collected data and the number of occurrences of each datum as an argument,
and is expected to print some statistics. A predefined printing
methods is provided to add a title to the statistics:
aggregate(with_title(T),L,Prop).This is useful when a property contains several calls to aggregate or collect.
check(Prop) -> any()
Equivalent to check(Prop, eqc:current_counterexample()).
check(Prop::property(), Values::counterexample()) -> bool()
Tests the property in the case given. Counterexamples are generated by testing a
property using counterexample/1 or counterexample/0, and contain a list
of the values bound by ?FORALL. A property tested by check should begin with the same
sequence of ?FORALL s as the property from which the counterexample was generated, otherwise
the results will be unpredictable. In particular, there is no check that the values
in the counterexample could actually have been generated by the ?FORALL s in the property under
test.
check/2 can be used without a QuickCheck licence, allowing anyone to run
tests that a licenced user has generated.
classify(B::bool(), S::term(), Prop::property()) -> property()
Property which is logically equivalent to Prop, but also
classifies test cases and displays the distribution of test case classes
when testing is complete. If the boolean is true then the current test case is
labelled with the term S,
and, after testing is complete, QuickCheck prints out the percentage of
test cases carrying each label. This can be used to check that the space
of possible test cases has been covered reasonably well. For example,
classifying test cases according to the length of a list enables one to
see whether unreasonably many lists were short. Classifying
test cases is a way to discover skewed distributions, such as can arise
from using ?IMPLIES. It is good practice to check the distribution
of test data using classify or collect/2, at least while
properties are being developed.
Each test case can be labelled with any number of labels: QuickCheck then displays the percentage of each label in the generated test data.
Calls of classify or collect can be nested, in which case each call generates its own table of distributions.
collect(S::term(), Prop::property()) -> property()
Equivalent to aggregate([S], Prop).
collect(PrintMethod::fun(([{term(), int()}]) -> any()), S::term(), Prop::property()) -> property()
Equivalent to aggregate(PrintMethod, [S], Prop).
counterexample() -> undefined | counterexample()
Returns the last counter-example found. See counterexample/1.
counterexample(P::property()) -> true | counterexample()
Tests the property in the same way as quickcheck/1, but if
a test fails, then the failing test case is returned as a counterexample.
counterexamples() -> [{atom(), counterexample()}]
Returns a list of the counterexamples found by the last call
of eqc:module, paired with the name of the property that failed.
equals(X::any(), Y::any()) -> property()
A property which holds if X and Y are equal... and displays their values when a test fails.
fails(Prop::property()) -> property()
A property which succeeds when its argument fails. Sometimes it is useful to write down properties which do not hold (even though one might expect them to). This can help prevent misconceptions. fails(P) is tested in the same way as P, but fails only if P succeeds 100 times. Thus fails(P) declares that QuickCheck should be able to find a counter-example to property P.
format(Fmt::string(), Args::[term()]) -> ok
Can be used in place of io:format/2 inside ?WHENFAIL to allow the output to be captured by on_output/2.
measure(Name::atom() | string(), X::number() | [number()], Prop::property()) -> property()
Collects the values of X while testing Prop, and if all tests pass, displays statistics such as the minimum, average, and maximum values, identified by the name Name. X can also be a list of values, in which case all of them are included in the measurements.
module(Mod::atom()) -> [atom()]
Tests all the properties exported from a module, given the module name.
Any function with arity zero whose name begins with "prop_" is treated as a
property. The result is a list of the names of the properties that
failed. See also module/2.
modules() -> any()
numtests(N::nat(), Prop::property()) -> property()
Property which is logically equivalent to Prop, but is tested N times rather than 100.
It is also possible to specify {min,N} or
{max,N} as the number of tests, in which case we run
at least N tests, or at most
N tests, but otherwise according to the time limits or
numtests/2 specified in the rest of the property.
on_output(Fun::fun((string(), [term()]) -> any()), Prop::property()) -> property()
Supplies an output function to be used instead of io:format when QuickCheck generates output. All output generated by QuickCheck is passed to Fun, in the form of a format string and a list of terms--the same arguments expected by io:format. By supplying a function which does nothing, QuickCheck can be run silently. By supplying a function which writes to a file, all QuickCheck output can be saved.
Note that output generated by user code is not passed to this output function. For example, calls to io:format in the property, or in the code under test, will generate output in the shell as usual. This applies even to calls inside a ?WHENFAIL, although this output can be redirected by replacing calls to io:format by calls to eqc:format/2. If you want to redirect output outside of ?WHENFAIL, then you need to modify your own code appropriately.
The reason that Fun is passed a format string and arguments, rather than an already formatted string, is to make it easier to extract information from the output without parsing it. However, there is no guarantee that different versions of QuickCheck will use the same format strings and term lists--you use this information at your own risk, in other words.
on_test(Fun::fun((counterexample(), bool()) -> any()), Prop::property()) -> property()
Attaches a function to a property which is called every time a test passes or fails. The arguments are the test case (a list of values), and a boolean indicating whether or not the test passed. Tests which are skipped (because of an ?IMPLIES(false,...)) are not included.
only_top(N::integer()) -> print_method()
A printing method for discarding all but the top N collected values.
Discared values are grouped together into an entry labelled '...'. The
resulting print method is intended to be passed to collect/3 or
aggregate/3.
only_top(N::integer(), F::print_method()) -> print_method()
A printing method for discarding all but the top N collected values.
Discared values are grouped together into an entry labelled '...'. The
second argument is a print method for the pruned data, such as with_title/1. The resulting print method is intended to be passed to collect/3 or aggregate/3.
quickcheck(P::property()) -> bool()
Tests the property in 100 random cases, printing a counter-example
if one is found. Initially small test cases are generated, then the
size increases as testing progresses (see eqc_gen, ?SIZED,
eqc_gen:resize/2 for the way size affects test data generation).
The result is true if all tests succeeded (or if one failed,
and failure was expected). On success, quickcheck analyses
the distribution of test case labels. On failure, quickcheck
tries to simplify the counter-example found as far as possible (see
shrinking, described in eqc_gen).
recheck(Prop::property()) -> bool()
Tests the property with the same random number seed as
the last failing call of quickcheck/1. If the property is
the same as in that last call, then the same test case will be
generated. Note that recheck repeats the test and its
shrinking. This can be used to adjust the shrinking strategy in
the property, then reshrink the same counterexample, perhaps to a
better result. If you just
want to repeat the shrunk test, then use
eqc:check(Prop,eqc:counterexample())instead.
Note: the type and behaviour of recheck changed in version 1.19.
start() -> pid()
Starts the QuickCheck server. If it is already running on this node, nothing is done.
Each user can run only one instance of the QuickCheck server at a time. If the server is already running on another Erlang node, it will be terminated automatically.start(Dummy) -> any()
Equivalent to start().
stop() -> any()
Stops the QuickCheck server. QuickCheck properties are tested in the QuickCheck server process, which is spawned automatically when quickcheck is first called. Usually there is no need to stop the QuickCheck server explicitly, but if a need does arise then this function can be used.
version() -> any()
Returns the version number of this version of QuickCheck.
with_title(Title::atom() | string()) -> print_method()
A printing method for collected data, which displays a title
before
the percentages of each value in the data. It is intended to be
passed to collect/3 or aggregate/3.
Generated by EDoc, Sep 2 2015, 11:03:36.