The tap-unit-test Reference Manual

This is the tap-unit-test Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Oct 13 12:41:16 2021 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.

2.1 `tap-unit-test`

Author

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

License

MIT license

Description

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

Source

tap-unit-test.asd (file)

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.

3.1 Lisp

3.1.1 `tap-unit-test.asd`

Location: tap-unit-test.asd
Systems: tap-unit-test (system)

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

Parent: tap-unit-test (system)
Location: package.lisp
Packages: tap-unit-test

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

Dependency

package.lisp (file)

Parent

tap-unit-test (system)

Location

tap-unit-test.lisp

Exported Definitions

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)

Internal Definitions

*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 (method)
test-passed-p (function)
use-debugger-p (function)

4 Packages

Packages are listed by definition order.

4.1 `tap-unit-test`

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

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)

Internal Definitions

*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 function)
test-failure-message (method)
test-passed-p (function)
use-debugger-p (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Macros

Macro: assert-eq EXPECTED FORM &rest EXTRAS

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Macro: assert-eql EXPECTED FORM &rest EXTRAS

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Macro: assert-equal EXPECTED FORM &rest EXTRAS

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Macro: assert-equality TEST EXPECTED FORM &rest EXTRAS

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Macro: assert-equalp EXPECTED FORM &rest EXTRAS

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Macro: assert-error CONDITION FORM &rest EXTRAS

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Macro: assert-expands EXPANSION FORM &rest EXTRAS

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Macro: assert-false FORM &rest EXTRAS

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Macro: assert-prints OUTPUT FORM &rest EXTRAS

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Macro: assert-true FORM &rest EXTRAS

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Macro: define-test NAME &body BODY

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Macro: run-all-tests &optional PACKAGE &rest TESTS

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Macro: run-tests &rest NAMES

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Macro: with-test-listener LISTENER &body BODY

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

5.1.2 Functions

Function: fail STR &rest ARGS

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: get-test-code NAME &optional PACKAGE

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: get-tests &optional PACKAGE

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: logically-equal X Y

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: remove-all-tests &optional PACKAGE

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: remove-tests NAMES &optional PACKAGE

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: set-equal L1 L2 &key TEST

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: unordered-equal L1 L2 &key TEST

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: use-debugger &optional FLAG

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *pass-count*

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Special Variable: *test-count*

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Special Variable: *test-listener*

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Special Variable: *test-name*

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Special Variable: *tests*

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Special Variable: *use-debugger*

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

5.2.2 Functions

Function: check-results TYPE FORM EXPECTED ACTUAL EXTRAS TEST

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: collect-form-values FORM VALUES

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: default-listener PASSED TYPE NAME FORM EXPECTED ACTUAL EXTRAS TEST-COUNT PASS-COUNT

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: expand-assert TYPE FORM BODY EXPECTED EXTRAS &key TEST

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: expand-error-form FORM

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: expand-extras EXTRAS

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: expand-macro-form FORM ENV

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: expand-output-form FORM

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: get-failure-message TYPE

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: get-package-table PACKAGE &key CREATE

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: get-test-name FORM

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: get-test-thunk NAME PACKAGE

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: get-test-thunks NAMES &optional PACKAGE

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: internal-assert TYPE FORM CODE-THUNK EXPECTED-THUNK EXTRAS TEST

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

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 (file)

Function: record-result PASSED TYPE FORM EXPECTED ACTUAL EXTRAS

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: run-test-thunk *TEST-NAME* THUNK

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: run-test-thunks TEST-THUNKS

Run test-thunks and report results in TAP format.

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: show-failure TYPE MSG NAME FORM EXPECTED ACTUAL EXTRAS

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: show-summary NAME TEST-COUNT PASS-COUNT &optional ERROR-COUNT

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: store-test-code NAME CODE &optional PACKAGE

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: test-passed-p TYPE EXPECTED ACTUAL TEST

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

Function: use-debugger-p E

Package: tap-unit-test
Source: tap-unit-test.lisp (file)

5.2.3 Generic functions

Generic Function: test-failure-message CONDITION

Package

tap-unit-test

Methods

Method: test-failure-message (CONDITION test-failure)

Source: tap-unit-test.lisp (file)

5.2.4 Conditions

Condition: test-failure ()

Package

tap-unit-test

Source

tap-unit-test.lisp (file)

Direct superclasses

condition (condition)

Direct methods

test-failure-message (method)

Direct slots

Slot: message

Initargs: :message
Readers: test-failure-message (generic function)

Appendix A Indexes

A.1 Concepts

Jump to:	F L T

	Index Entry	Section

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

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

T
	`tap-unit-test.asd`:	The tap-unit-test․asd file
	`tap-unit-test/package.lisp`:	The tap-unit-test/package․lisp file
	`tap-unit-test/tap-unit-test.lisp`:	The tap-unit-test/tap-unit-test․lisp file

Jump to:	F L T

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`:	Exported macros
	`assert-eql`:	Exported macros
	`assert-equal`:	Exported macros
	`assert-equality`:	Exported macros
	`assert-equalp`:	Exported macros
	`assert-error`:	Exported macros
	`assert-expands`:	Exported macros
	`assert-false`:	Exported macros
	`assert-prints`:	Exported macros
	`assert-true`:	Exported macros

C
	`check-results`:	Internal functions
	`collect-form-values`:	Internal functions

D
	`default-listener`:	Internal functions
	`define-test`:	Exported macros

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

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

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

I
	`internal-assert`:	Internal functions

L
	`logically-equal`:	Exported functions

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

P
	`package-names`:	Internal functions

R
	`record-result`:	Internal functions
	`remove-all-tests`:	Exported functions
	`remove-tests`:	Exported functions
	`run-all-tests`:	Exported macros
	`run-test-thunk`:	Internal functions
	`run-test-thunks`:	Internal functions
	`run-tests`:	Exported macros

S
	`set-equal`:	Exported functions
	`show-failure`:	Internal functions
	`show-summary`:	Internal functions
	`store-test-code`:	Internal functions

T
	`test-failure-message`:	Internal generic functions
	`test-failure-message`:	Internal generic functions
	`test-passed-p`:	Internal functions

U
	`unordered-equal`:	Exported functions
	`use-debugger`:	Exported functions
	`use-debugger-p`:	Internal functions

W
	`with-test-listener`:	Exported 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`:	Internal special variables
	`test-count`:	Internal special variables
	`test-listener`:	Internal special variables
	`test-name`:	Internal special variables
	`tests`:	Internal special variables
	`use-debugger`:	Internal special variables

M
	`message`:	Internal conditions

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

Jump to:	* M S

A.4 Data types

Jump to:	C P S T

	Index Entry	Section

C
	`Condition, test-failure`:	Internal conditions

P
	`Package, tap-unit-test`:	The tap-unit-test package

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
	`test-failure`:	Internal conditions

Jump to:	C P S T

• Introduction		What tap-unit-test is all about
• Systems		The systems documentation
• Files		The files documentation
• Packages		The packages documentation
• Definitions		The symbols documentation
• Indexes		Concepts, functions, variables and data types

• Internal special variables
• Internal functions
• Internal generic functions
• Internal conditions

• Concept index
• Function index
• Variable index
• Data type index

• The tap-unit-test.asd file
• The tap-unit-test/package.lisp file
• The tap-unit-test/tap-unit-test.lisp file

The tap-unit-test Reference Manual

Table of Contents

The tap-unit-test Reference Manual

1 Introduction

2 Systems

2.1 tap-unit-test

3 Files

3.1 Lisp

3.1.1 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 Exported definitions

5.1.1 Macros

5.1.2 Functions

5.2 Internal definitions

5.2.1 Special variables

5.2.2 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.asd`

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

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

4.1 `tap-unit-test`