This is the cl-quickcheck Reference Manual, version 0.4, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jun 15 04:31:52 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-quickcheckCommon Lisp port of the QuickCheck unit test framework
Andrew Pennebaker <andrew.pennebaker@gmail.com>
MIT
0.4
cl-quickcheck.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-quickcheck/cl-quickcheck.lispcl-quickcheck (system).
*break-on-failure* (special variable).
*loud* (special variable).
*num-trials* (special variable).
*size* (special variable).
*testing* (special variable).
a-boolean (special variable).
a-char (function).
a-list (function).
a-member (function).
a-real (special variable).
a-string (function).
a-symbol (function).
a-tuple (function).
an-index (special variable).
an-integer (special variable).
collect-test-results (function).
define (macro).
for-all (macro).
generate (function).
is (macro).
is= (macro).
isnt (macro).
isnt= (macro).
k-generator (special variable).
m-generator (special variable).
n-generator (special variable).
named (macro).
only-if (macro).
pick-weighted (macro).
quickcheck (macro).
report (function).
should-signal (macro).
test (macro).
test (structure).
test-bindings (reader).
(setf test-bindings) (writer).
test-detail (reader).
(setf test-detail) (writer).
test-flopped (reader).
(setf test-flopped) (writer).
test-name (reader).
(setf test-name) (writer).
wrap-each (macro).
*logger* (special variable).
answer (function).
call-tester (function).
capture-stdout (macro).
classify (function).
collect-dups (function).
concat-symbol (function).
copy-test (function).
default-generator (function).
distribution (function).
hash-table-values (function).
intercept-errors (function).
is-macro (function).
judgedp (function).
let-dfv (macro).
make-test (function).
normalize-binding (function).
print-test (function).
random-element (function).
run-for-all (function).
run-is-tester (function).
run-named (function).
run-only-if (function).
run-quickcheck (function).
run-should-signal (function).
run-tester (function).
run-trial (function).
show-progress (function).
sort-out (function).
summarize-all (function).
summarize-test (function).
tally (function).
test-failed (function).
test-p (function).
test-passed (function).
test-skipped (function).
unique-names (function).
update-bindings (function).
update-name (function).
verdict (function).
Packages are listed by definition order.
cl-quickcheckcommon-lisp.
*break-on-failure* (special variable).
*loud* (special variable).
*num-trials* (special variable).
*size* (special variable).
*testing* (special variable).
a-boolean (special variable).
a-char (function).
a-list (function).
a-member (function).
a-real (special variable).
a-string (function).
a-symbol (function).
a-tuple (function).
an-index (special variable).
an-integer (special variable).
collect-test-results (function).
define (macro).
for-all (macro).
generate (function).
is (macro).
is= (macro).
isnt (macro).
isnt= (macro).
k-generator (special variable).
m-generator (special variable).
n-generator (special variable).
named (macro).
only-if (macro).
pick-weighted (macro).
quickcheck (macro).
report (function).
should-signal (macro).
test (macro).
test (structure).
test-bindings (reader).
(setf test-bindings) (writer).
test-detail (reader).
(setf test-detail) (writer).
test-flopped (reader).
(setf test-flopped) (writer).
test-name (reader).
(setf test-name) (writer).
wrap-each (macro).
*logger* (special variable).
answer (function).
call-tester (function).
capture-stdout (macro).
classify (function).
collect-dups (function).
concat-symbol (function).
copy-test (function).
default-generator (function).
distribution (function).
hash-table-values (function).
intercept-errors (function).
is-macro (function).
judgedp (function).
let-dfv (macro).
make-test (function).
normalize-binding (function).
print-test (function).
random-element (function).
run-for-all (function).
run-is-tester (function).
run-named (function).
run-only-if (function).
run-quickcheck (function).
run-should-signal (function).
run-tester (function).
run-trial (function).
show-progress (function).
sort-out (function).
summarize-all (function).
summarize-test (function).
tally (function).
test-failed (function).
test-p (function).
test-passed (function).
test-skipped (function).
unique-names (function).
update-bindings (function).
update-name (function).
verdict (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
When true, test failures jump us immediately into the debugger.
When true, we show progress as tests are run with dots to stdout.
Number of random trials we want to see pass in FOR-ALL tests.
Bounds the size of random test cases in a generator-dependent way.
When true, we’re in the dynamic extent of a quickcheck form.
Like Scheme’s top-level DEFINE, more or less.
Perform the test in BODY for random values of BINDINGS.
Test that FN applied to OPERANDS is true, with the failure message detailing the failing arguments.
Test that X is EQUAL to Y.
Test that FN applied to OPERANDS is false.
Test that X is not EQUAL to Y.
Perform the given TESTS with all the test names set to NAME.
Perform the TEST only if FLAG is true, otherwise return a SKIPPED test result whose name is TEST quoted.
Given CHOICES with constant weights, pick a random one at runtime.
Run BODY and report the results of any tests.
Test that evaluating BODY signals (a subtype of) CONDITION.
Test that FLAG is true.
Perform each of the WRAPPEES as if surrounded by WRAPPER (with
the literal symbol WRAPPEE inside WRAPPER being the hole where the
wrappee appears). This is useful for factoring out common setup/teardown
code for a sequence of tests without compromising their isolation.
Call FN with *TESTING* true, and return a list of the test results.
Ask GENERATOR to produce a value.
Print out the interesting test results in longer form.
name.
Function to do whatever’s appropriate with the result of each test as it completes.
Bind a dynamic function variable, with CALL-NEXT-FUNCTION in its body calling the same variable as bound in the enclosing dynamic scope.
Log a test outcome, with appropriate interactive side effects.
Call PASSP-FN and return whether it flopped.
Return a hashtable from names of elements of TESTS to lists of the elements with the same name.
Intern a symbol by catenating PARTS.
Give a generator expression for a name that’s missing an explicit one. You’ll have to define the meaning of this shorthand elsewhere.
Count test cases failed, skipped, passed, and total.
Return a list of TABLE’s values in arbitrary order.
OPT-COUNT describes a repeated test: NIL if it ever failed, otherwise a count of passed trials. Return true iff the test has either passed *NUM-TRIALS* times or failed at least once.
Return BINDING’s pair of name and generator expression.
Repeatedly call TEST-FN with VARS bound to values from GENERATORS.
Return a test outcome from the result of FN-FN, which returns a list of a function to call for the actual test, plus its arguments.
Behavior of the ONLY-IF macro.
Call FN to run a test suite, and report the result.
Test that calling FN signals (a subtype of) EXPECTED-CONDITION.
Return a test outcome from calling PASSP-FN.
Run one trial of a FOR-ALL test.
Write a single character as a bird’s-eye view of a test result.
Collect the test cases of TESTS into separate lists by name, and return them in order of the first appearance of a case with that name.
Report the results of the test cases of a test, if they’re interesting.
Return the test-names of TESTS, in order of first appearance.
Choose the most significant result from TESTS: failed, passed, or skipped, in that order.
| Jump to: | (
A C D F G H I J L M N O P Q R S T U V W |
|---|
| Jump to: | (
A C D F G H I J L M N O P Q R S T U V W |
|---|
| Jump to: | *
A B D F K M N S |
|---|
| Jump to: | *
A B D F K M N S |
|---|
| Jump to: | C F P S T |
|---|
| Jump to: | C F P S T |
|---|