The tap-unit-test Reference Manual

This is the tap-unit-test Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 06:16:06 2022 GMT+0.

1 Introduction

TAP-unit-test
=============
Simple unit tests in Common Lisp.

Chris Riesbeck offers an excellent :lisp-unit package at
http://www.cs.northwestern.edu/academics/courses/325/programs/lisp-unit.lisp
under an MIT license.  It is quite simple to use.

The tap-unit-test package reformats the reporting slightly
for TAP output:  http://en.wikipedia.org/wiki/Test_Anything_Protocol
and makes the code available via GitHub.com and QuickLisp.org.

  --John Hanley, July 2011

2 Systems

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

tap-unit-test

2.1 `tap-unit-test`

Test Anything Protocol reporting for Chris Riesbeck’s excellent and very simple lisp-unit package.

Author

Chris Riesbeck, <c-riesbeck@northwestern.edu>

License

MIT license

Source

tap-unit-test.asd.

Child Components

package.lisp (file).
tap-unit-test.lisp (file).

3 Files

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

Lisp

3.1.1 `tap-unit-test/tap-unit-test.asd`

Source: tap-unit-test.asd.
Parent Component: tap-unit-test (system).
ASDF Systems: tap-unit-test.

3.1.2 `tap-unit-test/package.lisp`

Source: tap-unit-test.asd.
Parent Component: tap-unit-test (system).
Packages: tap-unit-test.

3.1.3 `tap-unit-test/tap-unit-test.lisp`

Dependency

package.lisp (file).

Source

tap-unit-test.asd.

Parent Component

tap-unit-test (system).

Public Interface

assert-eq (macro).
assert-eql (macro).
assert-equal (macro).
assert-equality (macro).
assert-equalp (macro).
assert-error (macro).
assert-expands (macro).
assert-false (macro).
assert-prints (macro).
assert-true (macro).
define-test (macro).
fail (function).
get-test-code (function).
get-tests (function).
logically-equal (function).
remove-all-tests (function).
remove-tests (function).
run-all-tests (macro).
run-tests (macro).
set-equal (function).
unordered-equal (function).
use-debugger (function).
with-test-listener (macro).

Internals

*pass-count* (special variable).
*test-count* (special variable).
*test-listener* (special variable).
*test-name* (special variable).
*tests* (special variable).
*use-debugger* (special variable).
check-results (function).
collect-form-values (function).
default-listener (function).
expand-assert (function).
expand-error-form (function).
expand-extras (function).
expand-macro-form (function).
expand-output-form (function).
get-failure-message (function).
get-package-table (function).
get-test-name (function).
get-test-thunk (function).
get-test-thunks (function).
internal-assert (function).
package-names (function).
record-result (function).
run-test-thunk (function).
run-test-thunks (function).
show-failure (function).
show-summary (function).
store-test-code (function).
test-failure (condition).
test-failure-message (reader method).
test-passed-p (function).
use-debugger-p (function).

4 Packages

Packages are listed by definition order.

tap-unit-test

4.1 `tap-unit-test`

Source

package.lisp.

Use List

common-lisp.

Public Interface

assert-eq (macro).
assert-eql (macro).
assert-equal (macro).
assert-equality (macro).
assert-equalp (macro).
assert-error (macro).
assert-expands (macro).
assert-false (macro).
assert-prints (macro).
assert-true (macro).
define-test (macro).
fail (function).
get-test-code (function).
get-tests (function).
logically-equal (function).
remove-all-tests (function).
remove-tests (function).
run-all-tests (macro).
run-tests (macro).
set-equal (function).
unordered-equal (function).
use-debugger (function).
with-test-listener (macro).

Internals

*pass-count* (special variable).
*test-count* (special variable).
*test-listener* (special variable).
*test-name* (special variable).
*tests* (special variable).
*use-debugger* (special variable).
check-results (function).
collect-form-values (function).
default-listener (function).
expand-assert (function).
expand-error-form (function).
expand-extras (function).
expand-macro-form (function).
expand-output-form (function).
get-failure-message (function).
get-package-table (function).
get-test-name (function).
get-test-thunk (function).
get-test-thunks (function).
internal-assert (function).
package-names (function).
record-result (function).
run-test-thunk (function).
run-test-thunks (function).
show-failure (function).
show-summary (function).
store-test-code (function).
test-failure (condition).
test-failure-message (generic reader).
test-passed-p (function).
use-debugger-p (function).

5 Definitions

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

Public Interface
Internals

5.1 Public Interface

Macros
Ordinary functions

5.1.1 Macros

Macro: assert-eq (expected form &rest extras) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Macro: assert-eql (expected form &rest extras) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Macro: assert-equal (expected form &rest extras) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Macro: assert-equality (test expected form &rest extras) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Macro: assert-equalp (expected form &rest extras) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Macro: assert-error (condition form &rest extras) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Macro: assert-expands (expansion form &rest extras) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Macro: assert-false (form &rest extras) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Macro: assert-prints (output form &rest extras) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Macro: assert-true (form &rest extras) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Macro: define-test (name &body body) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Macro: run-all-tests (&optional package &rest tests) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Macro: run-tests (&rest names) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Macro: with-test-listener (listener &body body) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

5.1.2 Ordinary functions

Function: fail (str &rest args) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: get-test-code (name &optional package) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: get-tests (&optional package) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: logically-equal (x y) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: remove-all-tests (&optional package) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: remove-tests (names &optional package) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: set-equal (l1 l2 &key test) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: unordered-equal (l1 l2 &key test) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: use-debugger (&optional flag) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

5.2 Internals

Special variables
Ordinary functions
Generic functions
Conditions

5.2.1 Special variables

Special Variable: *pass-count* ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Special Variable: *test-count* ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Special Variable: *test-listener* ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Special Variable: *test-name* ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Special Variable: *tests* ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Special Variable: *use-debugger* ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

5.2.2 Ordinary functions

Function: check-results (type form expected actual extras test) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: collect-form-values (form values) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: default-listener (passed type name form expected actual extras test-count pass-count) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: expand-assert (type form body expected extras &key test) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: expand-error-form (form) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: expand-extras (extras) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: expand-macro-form (form env) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: expand-output-form (form) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: get-failure-message (type) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: get-package-table (package &key create) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: get-test-name (form) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: get-test-thunk (name package) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: get-test-thunks (names &optional package) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: internal-assert (type form code-thunk expected-thunk extras test) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: package-names (test-thunks) ¶

Turns union of packages that defined tests into a string like ’pkg1_pkg2’.

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: record-result (passed type form expected actual extras) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: run-test-thunk (*test-name* thunk) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: run-test-thunks (test-thunks) ¶

Run test-thunks and report results in TAP format.

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: show-failure (type msg name form expected actual extras) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: show-summary (name test-count pass-count &optional error-count) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: store-test-code (name code &optional package) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: test-passed-p (type expected actual test) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

Function: use-debugger-p (e) ¶

Package: tap-unit-test.
Source: tap-unit-test.lisp.

5.2.3 Generic functions

Generic Reader: test-failure-message (condition) ¶

Package

tap-unit-test.

Methods

Reader Method: test-failure-message ((condition test-failure)) ¶

Source: tap-unit-test.lisp.
Target Slot: message.

5.2.4 Conditions

Condition: test-failure ¶

Package

tap-unit-test.

Source

tap-unit-test.lisp.

Direct superclasses

condition.

Direct methods

test-failure-message.

Direct slots

Slot: message ¶

Initargs: :message
Readers: test-failure-message.
Writers: This slot is read-only.

Appendix A Indexes

Concepts
Functions
Variables
Data types

A.1 Concepts

A.2 Functions

Jump to:	A C D E F G I L M P R S T U W

	Index Entry	Section

A
	`assert-eq`:	Public macros
	`assert-eql`:	Public macros
	`assert-equal`:	Public macros
	`assert-equality`:	Public macros
	`assert-equalp`:	Public macros
	`assert-error`:	Public macros
	`assert-expands`:	Public macros
	`assert-false`:	Public macros
	`assert-prints`:	Public macros
	`assert-true`:	Public macros

C
	`check-results`:	Private ordinary functions
	`collect-form-values`:	Private ordinary functions

D
	`default-listener`:	Private ordinary functions
	`define-test`:	Public macros

E
	`expand-assert`:	Private ordinary functions
	`expand-error-form`:	Private ordinary functions
	`expand-extras`:	Private ordinary functions
	`expand-macro-form`:	Private ordinary functions
	`expand-output-form`:	Private ordinary functions

F
	`fail`:	Public ordinary functions
	`Function, check-results`:	Private ordinary functions
	`Function, collect-form-values`:	Private ordinary functions
	`Function, default-listener`:	Private ordinary functions
	`Function, expand-assert`:	Private ordinary functions
	`Function, expand-error-form`:	Private ordinary functions
	`Function, expand-extras`:	Private ordinary functions
	`Function, expand-macro-form`:	Private ordinary functions
	`Function, expand-output-form`:	Private ordinary functions
	`Function, fail`:	Public ordinary functions
	`Function, get-failure-message`:	Private ordinary functions
	`Function, get-package-table`:	Private ordinary functions
	`Function, get-test-code`:	Public ordinary functions
	`Function, get-test-name`:	Private ordinary functions
	`Function, get-test-thunk`:	Private ordinary functions
	`Function, get-test-thunks`:	Private ordinary functions
	`Function, get-tests`:	Public ordinary functions
	`Function, internal-assert`:	Private ordinary functions
	`Function, logically-equal`:	Public ordinary functions
	`Function, package-names`:	Private ordinary functions
	`Function, record-result`:	Private ordinary functions
	`Function, remove-all-tests`:	Public ordinary functions
	`Function, remove-tests`:	Public ordinary functions
	`Function, run-test-thunk`:	Private ordinary functions
	`Function, run-test-thunks`:	Private ordinary functions
	`Function, set-equal`:	Public ordinary functions
	`Function, show-failure`:	Private ordinary functions
	`Function, show-summary`:	Private ordinary functions
	`Function, store-test-code`:	Private ordinary functions
	`Function, test-passed-p`:	Private ordinary functions
	`Function, unordered-equal`:	Public ordinary functions
	`Function, use-debugger`:	Public ordinary functions
	`Function, use-debugger-p`:	Private ordinary functions

G
	`Generic Function, test-failure-message`:	Private generic functions
	`get-failure-message`:	Private ordinary functions
	`get-package-table`:	Private ordinary functions
	`get-test-code`:	Public ordinary functions
	`get-test-name`:	Private ordinary functions
	`get-test-thunk`:	Private ordinary functions
	`get-test-thunks`:	Private ordinary functions
	`get-tests`:	Public ordinary functions

I
	`internal-assert`:	Private ordinary functions

L
	`logically-equal`:	Public ordinary functions

M
	`Macro, assert-eq`:	Public macros
	`Macro, assert-eql`:	Public macros
	`Macro, assert-equal`:	Public macros
	`Macro, assert-equality`:	Public macros
	`Macro, assert-equalp`:	Public macros
	`Macro, assert-error`:	Public macros
	`Macro, assert-expands`:	Public macros
	`Macro, assert-false`:	Public macros
	`Macro, assert-prints`:	Public macros
	`Macro, assert-true`:	Public macros
	`Macro, define-test`:	Public macros
	`Macro, run-all-tests`:	Public macros
	`Macro, run-tests`:	Public macros
	`Macro, with-test-listener`:	Public macros
	`Method, test-failure-message`:	Private generic functions

P
	`package-names`:	Private ordinary functions

R
	`record-result`:	Private ordinary functions
	`remove-all-tests`:	Public ordinary functions
	`remove-tests`:	Public ordinary functions
	`run-all-tests`:	Public macros
	`run-test-thunk`:	Private ordinary functions
	`run-test-thunks`:	Private ordinary functions
	`run-tests`:	Public macros

S
	`set-equal`:	Public ordinary functions
	`show-failure`:	Private ordinary functions
	`show-summary`:	Private ordinary functions
	`store-test-code`:	Private ordinary functions

T
	`test-failure-message`:	Private generic functions
	`test-failure-message`:	Private generic functions
	`test-passed-p`:	Private ordinary functions

U
	`unordered-equal`:	Public ordinary functions
	`use-debugger`:	Public ordinary functions
	`use-debugger-p`:	Private ordinary functions

W
	`with-test-listener`:	Public macros

Jump to:	A C D E F G I L M P R S T U W

A.3 Variables

Jump to:	* M S

	Index Entry	Section

*
	`pass-count`:	Private special variables
	`test-count`:	Private special variables
	`test-listener`:	Private special variables
	`test-name`:	Private special variables
	`tests`:	Private special variables
	`use-debugger`:	Private special variables

M
	`message`:	Private conditions

S
	`Slot, message`:	Private conditions
	`Special Variable, pass-count`:	Private special variables
	`Special Variable, test-count`:	Private special variables
	`Special Variable, test-listener`:	Private special variables
	`Special Variable, test-name`:	Private special variables
	`Special Variable, tests`:	Private special variables
	`Special Variable, use-debugger`:	Private special variables

Jump to:	* M S

A.4 Data types

Jump to:	C F P S T

	Index Entry	Section

C
	`Condition, test-failure`:	Private conditions

F
	`File, package.lisp`:	The tap-unit-test/package․lisp file
	`File, tap-unit-test.asd`:	The tap-unit-test/tap-unit-test․asd file
	`File, tap-unit-test.lisp`:	The tap-unit-test/tap-unit-test․lisp file

P
	`Package, tap-unit-test`:	The tap-unit-test package
	`package.lisp`:	The tap-unit-test/package․lisp file

S
	`System, tap-unit-test`:	The tap-unit-test system

T
	`tap-unit-test`:	The tap-unit-test system
	`tap-unit-test`:	The tap-unit-test package
	`tap-unit-test.asd`:	The tap-unit-test/tap-unit-test․asd file
	`tap-unit-test.lisp`:	The tap-unit-test/tap-unit-test․lisp file
	`test-failure`:	Private conditions

Jump to:	C F P S T

The tap-unit-test Reference Manual

The tap-unit-test Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 tap-unit-test

3 Files

3.1 Lisp

3.1.1 tap-unit-test/tap-unit-test.asd

3.1.2 tap-unit-test/package.lisp

3.1.3 tap-unit-test/tap-unit-test.lisp

4 Packages

4.1 tap-unit-test

5 Definitions

5.1 Public Interface

5.1.1 Macros

5.1.2 Ordinary functions

5.2 Internals

5.2.1 Special variables

5.2.2 Ordinary functions

5.2.3 Generic functions

5.2.4 Conditions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `tap-unit-test`

3.1.1 `tap-unit-test/tap-unit-test.asd`

3.1.2 `tap-unit-test/package.lisp`

3.1.3 `tap-unit-test/tap-unit-test.lisp`

4.1 `tap-unit-test`