The test-utils Reference Manual

This is the test-utils Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 18:04:24 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 test-utils

Convenience functions and macros for testing Common Lisp applications via Prove and Quickcheck

Author

inaimathi <>

License

MIT Expat <http://directory.fsf.org/wiki/License:Expat>

Dependencies
  • alexandria (system).
  • prove (system).
  • cl-quickcheck (system).
  • agnostic-lizard (system).
Source

test-utils.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 test-utils/test-utils.asd

Source

test-utils.asd.

Parent Component

test-utils (system).

ASDF Systems

test-utils.


3.1.2 test-utils/package.lisp

Source

test-utils.asd.

Parent Component

test-utils (system).

Packages

test-utils.


3.1.3 test-utils/test-utils.lisp

Dependency

package.lisp (file).

Source

test-utils.asd.

Parent Component

test-utils (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 test-utils

Source

package.lisp.

Use List
  • cl-quickcheck.
  • common-lisp.
  • prove.
Public Interface
Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Special variables

Special Variable: a-keyword
Package

test-utils.

Source

test-utils.lisp.

Special Variable: a-number
Package

test-utils.

Source

test-utils.lisp.

Special Variable: a-ratio
Package

test-utils.

Source

test-utils.lisp.

Special Variable: a-value
Package

test-utils.

Source

test-utils.lisp.

Special Variable: an-atom
Package

test-utils.

Source

test-utils.lisp.


5.1.2 Macros

Macro: for-all ((&rest bindings) test &optional message)
Package

test-utils.

Source

test-utils.lisp.

Macro: is-expand (got expected &optional desc)
Package

test-utils.

Source

test-utils.lisp.

Macro: qchecks (quickcheck-test &optional message)

Form for calling quickcheck tests from a prove test (this lets you easily execute :quickcheck properties as part of a prove:run)

Package

test-utils.

Source

test-utils.lisp.

Macro: quiet-check (&body body)

Like :quickcheck, but squelches the initial seed reporting. Useful for running quickcheck properties in the middle of :prove suites.

Package

test-utils.

Source

test-utils.lisp.

Macro: tests (&rest forms)

This hacks around :prove’s requirement that a number of forms be provided, and #’prove:finalze be called around each set of :prove tests. Pointed out at https://github.com/fukamachi/prove/issues/14, but not yet addressed.

Package

test-utils.

Source

test-utils.lisp.


5.1.3 Ordinary functions

Function: a-hash (key-generator value-generator)
Package

test-utils.

Source

test-utils.lisp.

Function: a-pair (a-generator b-generator)
Package

test-utils.

Source

test-utils.lisp.

Function: a-specific-alist (&rest k/gen-pairs)
Package

test-utils.

Source

test-utils.lisp.

Function: a-specific-hash (&rest k/gen-pairs)
Package

test-utils.

Source

test-utils.lisp.

Function: a-specific-plist (&rest k/gen-pairs)
Package

test-utils.

Source

test-utils.lisp.

Function: a-vector (generator)
Package

test-utils.

Source

test-utils.lisp.

Function: one-of (&rest elems)
Package

test-utils.

Source

test-utils.lisp.


5.2 Internals


5.2.1 Ordinary functions

Function: a-plist (key-generator value-generator)
Package

test-utils.

Source

test-utils.lisp.

Function: an-alist (key-generator value-generator)
Package

test-utils.

Source

test-utils.lisp.

Function: an-array (dimensions generator)
Package

test-utils.

Source

test-utils.lisp.

Function: an-improper-list (generator)
Package

test-utils.

Source

test-utils.lisp.


Appendix A Indexes


A.1 Concepts