The prove Reference Manual

This is the prove Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 06:35:36 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 prove

Author

Eitaro Fukamachi

License

MIT

Version

1.0.0

Dependencies
  • cl-ppcre (system).
  • cl-ansi-text (system).
  • cl-colors (system).
  • alexandria (system).
  • uiop (system).
Source

prove.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 prove/src

Source

prove.asd.

Parent Component

prove (system).

Child Components

3.2 prove/src/reporter-components

Dependencies
Source

prove.asd.

Parent Component

src (module).

Child Components

4 Files

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


4.1 Lisp


4.1.1 prove/prove.asd

Source

prove.asd.

Parent Component

prove (system).

ASDF Systems

prove.


4.1.2 prove/src/prove.lisp

Dependencies
Source

prove.asd.

Parent Component

src (module).

Packages

prove.


4.1.3 prove/src/test.lisp

Dependencies
Source

prove.asd.

Parent Component

src (module).

Packages

prove.test.

Public Interface
Internals

4.1.4 prove/src/report.lisp

Source

prove.asd.

Parent Component

src (module).

Packages

prove.report.

Public Interface

4.1.5 prove/src/reporter.lisp

Dependencies
Source

prove.asd.

Parent Component

src (module).

Packages

prove.reporter.

Public Interface
Internals

4.1.6 prove/src/reporter-components/tap.lisp

Source

prove.asd.

Parent Component

reporter-components (module).

Packages

prove.reporter.tap.

Public Interface
Internals

tap-reporter (class).


4.1.7 prove/src/reporter-components/fiveam.lisp

Source

prove.asd.

Parent Component

reporter-components (module).

Packages

prove.reporter.fiveam.

Public Interface
Internals

fiveam-reporter (class).


4.1.8 prove/src/reporter-components/list.lisp

Source

prove.asd.

Parent Component

reporter-components (module).

Packages

prove.reporter.list.

Public Interface
Internals

4.1.9 prove/src/reporter-components/dot.lisp

Dependency

list.lisp (file).

Source

prove.asd.

Parent Component

reporter-components (module).

Packages

prove.reporter.dot.

Public Interface
Internals

dot-reporter (class).


4.1.10 prove/src/suite.lisp

Dependencies
Source

prove.asd.

Parent Component

src (module).

Packages

prove.suite.

Public Interface
Internals

4.1.11 prove/src/asdf.lisp

Dependencies
Source

prove.asd.

Parent Component

src (module).

Packages

prove.asdf.

Public Interface
Internals

4.1.12 prove/src/color.lisp

Source

prove.asd.

Parent Component

src (module).

Packages

prove.color.

Public Interface
Internals

with-gray (macro).


4.1.13 prove/src/output.lisp

Source

prove.asd.

Parent Component

src (module).

Packages

prove.output.

Public Interface

5 Packages

Packages are listed by definition order.


5.1 prove

Source

prove.lisp.

Nicknames
  • cl-test-more
  • test-more
Use List

common-lisp.


5.2 prove.report

Source

report.lisp.

Use List

common-lisp.

Used By List
Public Interface

5.3 prove.reporter.list

Source

list.lisp.

Use List
Used By List

prove.reporter.dot.

Public Interface
Internals

5.4 prove.reporter

Source

reporter.lisp.

Use List

common-lisp.

Used By List
Public Interface
Internals

5.5 prove.color

Source

color.lisp.

Use List

common-lisp.

Used By List

prove.reporter.dot.

Public Interface
Internals

with-gray (macro).


5.6 prove.reporter.dot

Source

dot.lisp.

Use List
Internals

dot-reporter (class).


5.7 prove.reporter.fiveam

Source

fiveam.lisp.

Use List
Internals

fiveam-reporter (class).


5.8 prove.test

Source

test.lisp.

Use List

common-lisp.

Public Interface
Internals

5.9 prove.reporter.tap

Source

tap.lisp.

Use List
Internals

tap-reporter (class).


5.10 prove.suite

Source

suite.lisp.

Use List

common-lisp.

Public Interface
Internals

5.11 prove.output

Source

output.lisp.

Use List

common-lisp.

Public Interface

5.12 prove.asdf

Source

asdf.lisp.

Nickname

prove-asdf

Use List
  • asdf/interface.
  • common-lisp.
Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Special variables

Special Variable: *debug-on-error*
Package

prove.test.

Source

test.lisp.

Special Variable: *default-reporter*
Package

prove.output.

Source

output.lisp.

Special Variable: *default-slow-threshold*
Package

prove.suite.

Source

suite.lisp.

Special Variable: *default-test-function*
Package

prove.test.

Source

test.lisp.

Special Variable: *enable-colors*

Flag whether colorize a test report. The default is T except on Emacs (SLIME).

Package

prove.color.

Source

color.lisp.

Special Variable: *gensym-prefix*
Package

prove.test.

Source

test.lisp.

Special Variable: *indent-level*

Level for nested test-cases output.
Number of spaces, added for each indentation level
is described in reporter’s indent-space slot.

Also, macro shift-indent could be used to slightly
indent content inside the main indentation level.

full-indent = indent-space * indent-level + additional-indent

Here is an example of the output:

1| x Blah minor.
2| Next line of description:
3|
4| x Nested test.
5| Also has multiline description.

In this example, indent-space is 4, that is why
text on lines 1 and 4 have 4 spaces between the ’x’ horizontally.

Outputting the first line " x ", reporter sets *additional-indent* to 4. That is why these additional
4 lines are prepended to the rest lines of the main
test case description.

When inner testcase runs, it increments *indent-level*, which shifts output to another 4 spaces (indent-space)
to the right, simultaneously resetting *additional-indent* to zero.

For nested test, reporter writes " x " and again,
sets *additional-indent* to 4 and every other lines now shifted by 1 * 4 + 4 = 8 spaces.

Package

prove.reporter.

Source

reporter.lisp.

Special Variable: *last-suite-report*
Package

prove.asdf.

Source

asdf.lisp.

Special Variable: *suite*
Package

prove.suite.

Source

suite.lisp.

Special Variable: *test-result-output*
Package

prove.output.

Source

output.lisp.


6.1.2 Macros

Macro: deftest (name &body test-forms)
Package

prove.test.

Source

test.lisp.

Macro: is (got expected &rest args)
Package

prove.test.

Source

test.lisp.

Macro: is-condition (form condition &optional desc)
Package

prove.test.

Source

test.lisp.

Macro: is-error (form condition &optional desc)
Package

prove.test.

Alias for

is-condition.

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

prove.test.

Source

test.lisp.

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

prove.test.

Source

test.lisp.

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

prove.test.

Source

test.lisp.

Macro: is-values (got expected &rest args)
Package

prove.test.

Source

test.lisp.

Macro: isnt (got expected &rest args)
Package

prove.test.

Source

test.lisp.

Macro: like (got regex &optional desc)
Package

prove.test.

Source

test.lisp.

Macro: ok (test &optional desc)
Package

prove.test.

Source

test.lisp.

Macro: subtest (desc &body body)
Package

prove.test.

Source

test.lisp.

Macro: with-additional-indent ((reporter stream control-string &rest format-arguments) &body body)
Package

prove.reporter.

Source

reporter.lisp.

Macro: with-color ((color &rest args) &body body)
Package

prove.color.

Source

color.lisp.


6.1.3 Ordinary functions

Function: add-report (report suite)
Package

prove.suite.

Source

suite.lisp.

Function: current-suite ()
Package

prove.suite.

Source

suite.lisp.

Function: diag (desc)
Package

prove.test.

Source

test.lisp.

Function: error-report-p (report)
Package

prove.report.

Source

report.lisp.

Function: fail (desc)
Package

prove.test.

Source

test.lisp.

Function: failed-report-p (report)
Package

prove.report.

Source

report.lisp.

Function: finalize (&optional suite)
Package

prove.suite.

Source

suite.lisp.

Function: format/indent (reporter stream control-string &rest format-arguments)

Writes a text to given stream with indentation, dictated by *indent-level* and *additional-indent*.

If first line start with ~&, then output will start from a fresh line. Otherwise, all lines except the first one are indented.

Package

prove.reporter.

Source

reporter.lisp.

Function: pass (desc)
Package

prove.test.

Source

test.lisp.

Function: passed-report-p (report)
Package

prove.report.

Source

report.lisp.

Function: plan (num)
Package

prove.suite.

Source

suite.lisp.

Function: remove-test (name)
Package

prove.test.

Source

test.lisp.

Function: remove-test-all ()
Package

prove.test.

Source

test.lisp.

Function: run (object &key reporter)

Runs a test. OBJECT can be one of a file pathname, a directory pathname or an ASDF system name.
Returns 3 multiple-values, a flag if the tests passed as T or NIL, passed test files as a list and failed test files also as a list.

Example:
(prove:run :myapp-test)
(prove:run #P"myapp/tests/")
(prove:run #P"myapp/tests/01-main.lisp")

Package

prove.asdf.

Source

asdf.lisp.

Function: run-test (name)
Package

prove.test.

Source

test.lisp.

Function: run-test-all ()
Package

prove.test.

Source

test.lisp.

Function: run-test-package (package-designator)
Package

prove.test.

Source

test.lisp.

Function: run-test-system (system-designator)

Runs a testing ASDF system.

Package

prove.asdf.

Source

asdf.lisp.

Function: skip (how-many why &rest format-args)
Package

prove.test.

Source

test.lisp.

Function: skipped-report-p (report)
Package

prove.report.

Source

report.lisp.

Function: slow-threshold (&optional new-threshold)
Package

prove.suite.

Source

suite.lisp.

Function: test-report-p (report)
Package

prove.report.

Source

report.lisp.


6.1.4 Generic functions

Generic Reader: failed (object)
Package

prove.suite.

Methods
Reader Method: failed ((suite suite))

automatically generated reader method

Source

suite.lisp.

Target Slot

failed.

Generic Writer: (setf failed) (object)
Package

prove.suite.

Methods
Writer Method: (setf failed) ((suite suite))

automatically generated writer method

Source

suite.lisp.

Target Slot

failed.

Generic Function: format-report (stream reporter report &rest args &key count)
Package

prove.reporter.

Source

reporter.lisp.

Methods
Method: format-report (stream (reporter dot-reporter) (report test-report) &rest args)
Source

dot.lisp.

Method: format-report (stream (reporter dot-reporter) (report comment-report) &rest args)
Source

dot.lisp.

Method: format-report (stream (reporter list-reporter) (report composed-test-report) &rest args)
Source

list.lisp.

Method: format-report (stream (reporter list-reporter) (report error-test-report) &rest args)
Source

list.lisp.

Method: format-report (stream (reporter list-reporter) (report failed-test-report) &rest args)
Source

list.lisp.

Method: format-report (stream (reporter list-reporter) (report skipped-test-report) &rest args)
Source

list.lisp.

Method: format-report (stream (reporter list-reporter) (report normal-test-report) &rest args)
Source

list.lisp.

Method: format-report (stream (reporter list-reporter) (report comment-report) &rest args)
Source

list.lisp.

Method: format-report (stream (reporter fiveam-reporter) (report test-report) &rest args)
Source

fiveam.lisp.

Method: format-report (stream (reporter fiveam-reporter) (report comment-report) &rest args)
Source

fiveam.lisp.

Method: format-report (stream (reporter tap-reporter) (report skipped-test-report) &key count)
Source

tap.lisp.

Method: format-report (stream (reporter tap-reporter) (report test-report) &key count)
Source

tap.lisp.

Method: format-report (stream (reporter tap-reporter) (report comment-report) &rest args)
Source

tap.lisp.

Method: format-report (stream (reporter null) (report report) &rest args)
Method: format-report (stream (reporter reporter) (report report) &rest args)
Generic Function: print-error-report (reporter report stream)
Package

prove.reporter.

Source

reporter.lisp.

Methods
Method: print-error-report ((reporter fiveam-reporter) (report comment-report) stream)
Source

fiveam.lisp.

Method: print-error-report ((reporter fiveam-reporter) (report composed-test-report) stream)
Source

fiveam.lisp.

Method: print-error-report ((reporter fiveam-reporter) (report failed-test-report) stream)
Source

fiveam.lisp.

Method: print-error-report ((reporter tap-reporter) (report failed-test-report) stream)
Source

tap.lisp.

Method: print-error-report ((reporter reporter) (report report) stream)
Method: print-error-report ((reporter null) (report test-report) stream)
Generic Function: print-finalize-report (reporter plan reports stream)
Package

prove.reporter.

Source

reporter.lisp.

Methods
Method: print-finalize-report :after ((reporter dot-reporter) plan reports stream)
Source

dot.lisp.

Method: print-finalize-report :before ((reporter dot-reporter) plan reports stream)
Source

dot.lisp.

Method: print-finalize-report ((reporter list-reporter) plan reports stream)
Source

list.lisp.

Method: print-finalize-report ((reporter fiveam-reporter) plan reports stream)
Source

fiveam.lisp.

Method: print-finalize-report ((reporter tap-reporter) plan reports stream)
Source

tap.lisp.

Method: print-finalize-report ((reporter null) plan reports stream)
Generic Function: print-plan-report (reporter num stream)
Package

prove.reporter.

Source

reporter.lisp.

Methods
Method: print-plan-report ((reporter list-reporter) num stream)
Source

list.lisp.

Method: print-plan-report ((reporter tap-reporter) num stream)
Source

tap.lisp.

Method: print-plan-report ((reporter null) num stream)
Method: print-plan-report (reporter num stream)
Generic Function: report-expected-line (report)

Reports about failed or passed test.
Should return a string with description of what have happened.

Package

prove.reporter.list.

Source

list.lisp.

Methods
Method: report-expected-line ((report normal-test-report))
Generic Reader: reports (object)
Package

prove.suite.

Methods
Reader Method: reports ((suite suite))

automatically generated reader method

Source

suite.lisp.

Target Slot

reports.

Generic Writer: (setf reports) (object)
Package

prove.suite.

Methods
Writer Method: (setf reports) ((suite suite))

automatically generated writer method

Source

suite.lisp.

Target Slot

reports.

Generic Reader: suite-plan (object)
Package

prove.suite.

Methods
Reader Method: suite-plan ((suite suite))

automatically generated reader method

Source

suite.lisp.

Target Slot

plan.

Generic Writer: (setf suite-plan) (object)
Package

prove.suite.

Methods
Writer Method: (setf suite-plan) ((suite suite))

automatically generated writer method

Source

suite.lisp.

Target Slot

plan.

Generic Reader: test-count (object)
Package

prove.suite.

Methods
Reader Method: test-count ((suite suite))

automatically generated reader method

Source

suite.lisp.

Target Slot

test-count.

Generic Writer: (setf test-count) (object)
Package

prove.suite.

Methods
Writer Method: (setf test-count) ((suite suite))

automatically generated writer method

Source

suite.lisp.

Target Slot

test-count.


6.1.5 Standalone methods

Method: compute-action-stamp :around (plan (o operation) (c test-file) &key just-done)
Package

asdf/action.

Source

asdf.lisp.

Method: perform ((op load-op) (c test-file))
Package

asdf/action.

Source

asdf.lisp.

Method: perform ((op compile-op) (c test-file))
Package

asdf/action.

Source

asdf.lisp.

Method: print-object ((report normal-test-report) stream)
Source

report.lisp.


6.1.6 Classes

Class: comment-report
Package

prove.report.

Source

report.lisp.

Direct superclasses

report.

Direct methods
Class: composed-test-report
Package

prove.report.

Source

report.lisp.

Direct superclasses

test-report.

Direct methods
Direct slots
Slot: plan
Initargs

:plan

Slot: children
Initform

(make-array 0 :adjustable t :fill-pointer 0)

Initargs

:children

Class: error-test-report
Package

prove.report.

Source

report.lisp.

Direct superclasses

failed-test-report.

Direct methods

format-report.

Class: failed-test-report
Package

prove.report.

Source

report.lisp.

Direct superclasses

normal-test-report.

Direct subclasses

error-test-report.

Direct methods
Class: list-reporter
Package

prove.reporter.list.

Source

list.lisp.

Direct superclasses

reporter.

Direct subclasses

dot-reporter.

Direct methods
Class: normal-test-report
Package

prove.report.

Source

report.lisp.

Direct superclasses

test-report.

Direct subclasses
Direct methods
Direct slots
Slot: test-function
Type

(or function symbol)

Initargs

:test-function

Slot: notp
Type

boolean

Initargs

:notp

Slot: got
Initform

(error ":got is required")

Initargs

:got

Slot: got-form
Initform

(quote #:unbound)

Initargs

:got-form

Slot: expected
Initform

(error ":expected is required")

Initargs

:expected

Slot: report-expected-label
Type

(or null string)

Initargs

:report-expected-label

Class: package-suite
Package

prove.suite.

Source

suite.lisp.

Direct superclasses

suite.

Class: passed-test-report
Package

prove.report.

Source

report.lisp.

Direct superclasses

normal-test-report.

Class: report
Package

prove.report.

Source

report.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: description
Type

(or null string)

Initargs

:description

Class: reporter
Package

prove.reporter.

Source

reporter.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: indent-space
Initform

2

Class: skipped-test-report
Package

prove.report.

Source

report.lisp.

Direct superclasses

normal-test-report.

Direct methods
Class: suite
Package

prove.suite.

Source

suite.lisp.

Direct subclasses

package-suite.

Direct methods
Direct slots
Slot: plan
Initform

:unspecified

Initargs

:plan

Readers

suite-plan.

Writers

(setf suite-plan).

Slot: slow-threshold
Initform

prove.suite:*default-slow-threshold*

Initargs

:slow-threshold

Slot: test-count
Initform

0

Readers

test-count.

Writers

(setf test-count).

Slot: failed
Initform

0

Readers

failed.

Writers

(setf failed).

Slot: reports
Initform

(make-array 0 :adjustable t :fill-pointer 0)

Readers

reports.

Writers

(setf reports).

Class: test-file
Package

prove.asdf.

Source

asdf.lisp.

Direct superclasses

cl-source-file.

Direct methods
Class: test-report
Package

prove.report.

Source

report.lisp.

Direct superclasses

report.

Direct subclasses
Direct methods
Direct slots
Slot: duration
Initargs

:duration

Slot: slow-threshold
Initargs

:slow-threshold

Slot: print-error-detail
Type

boolean

Initform

t

Initargs

:print-error-detail


6.2 Internals


6.2.1 Special variables

Special Variable: *additional-indent*

Number of spaces to add to each line. see *indent-level* docstring for full description.

Package

prove.reporter.

Source

reporter.lisp.

Special Variable: *debug-indentation*

If True, then indentation will have ’=’ and ’-’ symbols for main indentaion and additional, instead of spaces.

Package

prove.reporter.

Source

reporter.lisp.

Special Variable: *defined-suites*
Package

prove.suite.

Source

suite.lisp.

Special Variable: *gensym-alist*
Package

prove.test.

Source

test.lisp.

Special Variable: *package-tests*
Package

prove.test.

Source

test.lisp.

Special Variable: *system-test-files*
Package

prove.asdf.

Source

asdf.lisp.


6.2.2 Macros

Macro: with-catching-errors ((&key description expected) &body body)
Package

prove.test.

Source

test.lisp.

Macro: with-duration (((duration result) form) &body body)
Package

prove.test.

Source

test.lisp.

Macro: with-gray (stream &body body)
Package

prove.color.

Source

color.lisp.


6.2.3 Ordinary functions

Function: %subtest (desc body-fn)
Package

prove.test.

Source

test.lisp.

Function: escape-tildes (text)
Package

prove.reporter.list.

Source

list.lisp.

Function: find-package-suite (package-designator)
Package

prove.suite.

Source

suite.lisp.

Function: find-reporter (name)
Package

prove.reporter.

Source

reporter.lisp.

Function: gensymp (val)
Package

prove.test.

Source

test.lisp.

Function: indent (space &optional count)

Creates a string with a number of spaces to indent new line of a test report.

Package

prove.reporter.

Source

reporter.lisp.

Function: omit-long-value (value)
Package

prove.reporter.list.

Source

list.lisp.

Function: parse-description-and-test (args)
Package

prove.test.

Source

test.lisp.

Function: possible-report-description (report)
Package

prove.reporter.list.

Source

list.lisp.

Function: print-duration (stream duration &optional slow-threshold)
Package

prove.reporter.list.

Source

list.lisp.

Function: reset-suite (suite)
Package

prove.suite.

Source

suite.lisp.

Function: test (got expected args &key notp duration got-form test-fn passed-report-class failed-report-class report-expected-label print-error-detail output)
Package

prove.test.

Source

test.lisp.

Function: test-files-in-directory (directory)
Package

prove.asdf.

Source

asdf.lisp.


6.2.4 Generic functions

Generic Function: gensym-tree-equal (x y)
Package

prove.test.

Source

test.lisp.

Methods
Method: gensym-tree-equal (x y)
Method: gensym-tree-equal ((x cons) (y cons))

6.2.5 Classes

Class: dot-reporter
Package

prove.reporter.dot.

Source

dot.lisp.

Direct superclasses

list-reporter.

Direct methods
Class: fiveam-reporter
Package

prove.reporter.fiveam.

Source

fiveam.lisp.

Direct superclasses

reporter.

Direct methods
Class: tap-reporter
Package

prove.reporter.tap.

Source

tap.lisp.

Direct superclasses

reporter.

Direct methods
Direct slots
Slot: indent-space
Package

prove.reporter.

Initform

4


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
A   C   D   E   F   G   I   L   M   O   P   R   S   T   W  
Index Entry  Section

%
%subtest: Private ordinary functions

(
(setf failed): Public generic functions
(setf failed): Public generic functions
(setf reports): Public generic functions
(setf reports): Public generic functions
(setf suite-plan): Public generic functions
(setf suite-plan): Public generic functions
(setf test-count): Public generic functions
(setf test-count): Public generic functions

A
add-report: Public ordinary functions

C
compute-action-stamp: Public standalone methods
current-suite: Public ordinary functions

D
deftest: Public macros
diag: Public ordinary functions

E
error-report-p: Public ordinary functions
escape-tildes: Private ordinary functions

F
fail: Public ordinary functions
failed: Public generic functions
failed: Public generic functions
failed-report-p: Public ordinary functions
finalize: Public ordinary functions
find-package-suite: Private ordinary functions
find-reporter: Private ordinary functions
format-report: Public generic functions
format-report: Public generic functions
format-report: Public generic functions
format-report: Public generic functions
format-report: Public generic functions
format-report: Public generic functions
format-report: Public generic functions
format-report: Public generic functions
format-report: Public generic functions
format-report: Public generic functions
format-report: Public generic functions
format-report: Public generic functions
format-report: Public generic functions
format-report: Public generic functions
format-report: Public generic functions
format-report: Public generic functions
format/indent: Public ordinary functions
Function, %subtest: Private ordinary functions
Function, add-report: Public ordinary functions
Function, current-suite: Public ordinary functions
Function, diag: Public ordinary functions
Function, error-report-p: Public ordinary functions
Function, escape-tildes: Private ordinary functions
Function, fail: Public ordinary functions
Function, failed-report-p: Public ordinary functions
Function, finalize: Public ordinary functions
Function, find-package-suite: Private ordinary functions
Function, find-reporter: Private ordinary functions
Function, format/indent: Public ordinary functions
Function, gensymp: Private ordinary functions
Function, indent: Private ordinary functions
Function, omit-long-value: Private ordinary functions
Function, parse-description-and-test: Private ordinary functions
Function, pass: Public ordinary functions
Function, passed-report-p: Public ordinary functions
Function, plan: Public ordinary functions
Function, possible-report-description: Private ordinary functions
Function, print-duration: Private ordinary functions
Function, remove-test: Public ordinary functions
Function, remove-test-all: Public ordinary functions
Function, reset-suite: Private ordinary functions
Function, run: Public ordinary functions
Function, run-test: Public ordinary functions
Function, run-test-all: Public ordinary functions
Function, run-test-package: Public ordinary functions
Function, run-test-system: Public ordinary functions
Function, skip: Public ordinary functions
Function, skipped-report-p: Public ordinary functions
Function, slow-threshold: Public ordinary functions
Function, test: Private ordinary functions
Function, test-files-in-directory: Private ordinary functions
Function, test-report-p: Public ordinary functions

G
Generic Function, (setf failed): Public generic functions
Generic Function, (setf reports): Public generic functions
Generic Function, (setf suite-plan): Public generic functions
Generic Function, (setf test-count): Public generic functions
Generic Function, failed: Public generic functions
Generic Function, format-report: Public generic functions
Generic Function, gensym-tree-equal: Private generic functions
Generic Function, print-error-report: Public generic functions
Generic Function, print-finalize-report: Public generic functions
Generic Function, print-plan-report: Public generic functions
Generic Function, report-expected-line: Public generic functions
Generic Function, reports: Public generic functions
Generic Function, suite-plan: Public generic functions
Generic Function, test-count: Public generic functions
gensym-tree-equal: Private generic functions
gensym-tree-equal: Private generic functions
gensym-tree-equal: Private generic functions
gensymp: Private ordinary functions

I
indent: Private ordinary functions
is: Public macros
is-condition: Public macros
is-error: Public macros
is-expand: Public macros
is-print: Public macros
is-type: Public macros
is-values: Public macros
isnt: Public macros

L
like: Public macros

M
Macro, deftest: Public macros
Macro, is: Public macros
Macro, is-condition: Public macros
Macro, is-error: Public macros
Macro, is-expand: Public macros
Macro, is-print: Public macros
Macro, is-type: Public macros
Macro, is-values: Public macros
Macro, isnt: Public macros
Macro, like: Public macros
Macro, ok: Public macros
Macro, subtest: Public macros
Macro, with-additional-indent: Public macros
Macro, with-catching-errors: Private macros
Macro, with-color: Public macros
Macro, with-duration: Private macros
Macro, with-gray: Private macros
Method, (setf failed): Public generic functions
Method, (setf reports): Public generic functions
Method, (setf suite-plan): Public generic functions
Method, (setf test-count): Public generic functions
Method, compute-action-stamp: Public standalone methods
Method, failed: Public generic functions
Method, format-report: Public generic functions
Method, format-report: Public generic functions
Method, format-report: Public generic functions
Method, format-report: Public generic functions
Method, format-report: Public generic functions
Method, format-report: Public generic functions
Method, format-report: Public generic functions
Method, format-report: Public generic functions
Method, format-report: Public generic functions
Method, format-report: Public generic functions
Method, format-report: Public generic functions
Method, format-report: Public generic functions
Method, format-report: Public generic functions
Method, format-report: Public generic functions
Method, format-report: Public generic functions
Method, gensym-tree-equal: Private generic functions
Method, gensym-tree-equal: Private generic functions
Method, perform: Public standalone methods
Method, perform: Public standalone methods
Method, print-error-report: Public generic functions
Method, print-error-report: Public generic functions
Method, print-error-report: Public generic functions
Method, print-error-report: Public generic functions
Method, print-error-report: Public generic functions
Method, print-error-report: Public generic functions
Method, print-finalize-report: Public generic functions
Method, print-finalize-report: Public generic functions
Method, print-finalize-report: Public generic functions
Method, print-finalize-report: Public generic functions
Method, print-finalize-report: Public generic functions
Method, print-finalize-report: Public generic functions
Method, print-object: Public standalone methods
Method, print-plan-report: Public generic functions
Method, print-plan-report: Public generic functions
Method, print-plan-report: Public generic functions
Method, print-plan-report: Public generic functions
Method, report-expected-line: Public generic functions
Method, reports: Public generic functions
Method, suite-plan: Public generic functions
Method, test-count: Public generic functions

O
ok: Public macros
omit-long-value: Private ordinary functions

P
parse-description-and-test: Private ordinary functions
pass: Public ordinary functions
passed-report-p: Public ordinary functions
perform: Public standalone methods
perform: Public standalone methods
plan: Public ordinary functions
possible-report-description: Private ordinary functions
print-duration: Private ordinary functions
print-error-report: Public generic functions
print-error-report: Public generic functions
print-error-report: Public generic functions
print-error-report: Public generic functions
print-error-report: Public generic functions
print-error-report: Public generic functions
print-error-report: Public generic functions
print-finalize-report: Public generic functions
print-finalize-report: Public generic functions
print-finalize-report: Public generic functions
print-finalize-report: Public generic functions
print-finalize-report: Public generic functions
print-finalize-report: Public generic functions
print-finalize-report: Public generic functions
print-object: Public standalone methods
print-plan-report: Public generic functions
print-plan-report: Public generic functions
print-plan-report: Public generic functions
print-plan-report: Public generic functions
print-plan-report: Public generic functions

R
remove-test: Public ordinary functions
remove-test-all: Public ordinary functions
report-expected-line: Public generic functions
report-expected-line: Public generic functions
reports: Public generic functions
reports: Public generic functions
reset-suite: Private ordinary functions
run: Public ordinary functions
run-test: Public ordinary functions
run-test-all: Public ordinary functions
run-test-package: Public ordinary functions
run-test-system: Public ordinary functions

S
skip: Public ordinary functions
skipped-report-p: Public ordinary functions
slow-threshold: Public ordinary functions
subtest: Public macros
suite-plan: Public generic functions
suite-plan: Public generic functions

T
test: Private ordinary functions
test-count: Public generic functions
test-count: Public generic functions
test-files-in-directory: Private ordinary functions
test-report-p: Public ordinary functions

W
with-additional-indent: Public macros
with-catching-errors: Private macros
with-color: Public macros
with-duration: Private macros
with-gray: Private macros


A.3 Variables

Jump to:   *  
C   D   E   F   G   I   N   P   R   S   T  
Index Entry  Section

*
*additional-indent*: Private special variables
*debug-indentation*: Private special variables
*debug-on-error*: Public special variables
*default-reporter*: Public special variables
*default-slow-threshold*: Public special variables
*default-test-function*: Public special variables
*defined-suites*: Private special variables
*enable-colors*: Public special variables
*gensym-alist*: Private special variables
*gensym-prefix*: Public special variables
*indent-level*: Public special variables
*last-suite-report*: Public special variables
*package-tests*: Private special variables
*suite*: Public special variables
*system-test-files*: Private special variables
*test-result-output*: Public special variables

C
children: Public classes

D
description: Public classes
duration: Public classes

E
expected: Public classes

F
failed: Public classes

G
got: Public classes
got-form: Public classes

I
indent-space: Public classes
indent-space: Private classes

N
notp: Public classes

P
plan: Public classes
plan: Public classes
print-error-detail: Public classes

R
report-expected-label: Public classes
reports: Public classes

S
Slot, children: Public classes
Slot, description: Public classes
Slot, duration: Public classes
Slot, expected: Public classes
Slot, failed: Public classes
Slot, got: Public classes
Slot, got-form: Public classes
Slot, indent-space: Public classes
Slot, indent-space: Private classes
Slot, notp: Public classes
Slot, plan: Public classes
Slot, plan: Public classes
Slot, print-error-detail: Public classes
Slot, report-expected-label: Public classes
Slot, reports: Public classes
Slot, slow-threshold: Public classes
Slot, slow-threshold: Public classes
Slot, test-count: Public classes
Slot, test-function: Public classes
slow-threshold: Public classes
slow-threshold: Public classes
Special Variable, *additional-indent*: Private special variables
Special Variable, *debug-indentation*: Private special variables
Special Variable, *debug-on-error*: Public special variables
Special Variable, *default-reporter*: Public special variables
Special Variable, *default-slow-threshold*: Public special variables
Special Variable, *default-test-function*: Public special variables
Special Variable, *defined-suites*: Private special variables
Special Variable, *enable-colors*: Public special variables
Special Variable, *gensym-alist*: Private special variables
Special Variable, *gensym-prefix*: Public special variables
Special Variable, *indent-level*: Public special variables
Special Variable, *last-suite-report*: Public special variables
Special Variable, *package-tests*: Private special variables
Special Variable, *suite*: Public special variables
Special Variable, *system-test-files*: Private special variables
Special Variable, *test-result-output*: Public special variables

T
test-count: Public classes
test-function: Public classes


A.4 Data types

Jump to:   A   C   D   E   F   L   M   N   O   P   R   S   T  
Index Entry  Section

A
asdf.lisp: The prove/src/asdf․lisp file

C
Class, comment-report: Public classes
Class, composed-test-report: Public classes
Class, dot-reporter: Private classes
Class, error-test-report: Public classes
Class, failed-test-report: Public classes
Class, fiveam-reporter: Private classes
Class, list-reporter: Public classes
Class, normal-test-report: Public classes
Class, package-suite: Public classes
Class, passed-test-report: Public classes
Class, report: Public classes
Class, reporter: Public classes
Class, skipped-test-report: Public classes
Class, suite: Public classes
Class, tap-reporter: Private classes
Class, test-file: Public classes
Class, test-report: Public classes
color.lisp: The prove/src/color․lisp file
comment-report: Public classes
composed-test-report: Public classes

D
dot-reporter: Private classes
dot.lisp: The prove/src/reporter-components/dot․lisp file

E
error-test-report: Public classes

F
failed-test-report: Public classes
File, asdf.lisp: The prove/src/asdf․lisp file
File, color.lisp: The prove/src/color․lisp file
File, dot.lisp: The prove/src/reporter-components/dot․lisp file
File, fiveam.lisp: The prove/src/reporter-components/fiveam․lisp file
File, list.lisp: The prove/src/reporter-components/list․lisp file
File, output.lisp: The prove/src/output․lisp file
File, prove.asd: The prove/prove․asd file
File, prove.lisp: The prove/src/prove․lisp file
File, report.lisp: The prove/src/report․lisp file
File, reporter.lisp: The prove/src/reporter․lisp file
File, suite.lisp: The prove/src/suite․lisp file
File, tap.lisp: The prove/src/reporter-components/tap․lisp file
File, test.lisp: The prove/src/test․lisp file
fiveam-reporter: Private classes
fiveam.lisp: The prove/src/reporter-components/fiveam․lisp file

L
list-reporter: Public classes
list.lisp: The prove/src/reporter-components/list․lisp file

M
Module, reporter-components: The prove/src/reporter-components module
Module, src: The prove/src module

N
normal-test-report: Public classes

O
output.lisp: The prove/src/output․lisp file

P
Package, prove: The prove package
Package, prove.asdf: The prove․asdf package
Package, prove.color: The prove․color package
Package, prove.output: The prove․output package
Package, prove.report: The prove․report package
Package, prove.reporter: The prove․reporter package
Package, prove.reporter.dot: The prove․reporter․dot package
Package, prove.reporter.fiveam: The prove․reporter․fiveam package
Package, prove.reporter.list: The prove․reporter․list package
Package, prove.reporter.tap: The prove․reporter․tap package
Package, prove.suite: The prove․suite package
Package, prove.test: The prove․test package
package-suite: Public classes
passed-test-report: Public classes
prove: The prove system
prove: The prove package
prove.asd: The prove/prove․asd file
prove.asdf: The prove․asdf package
prove.color: The prove․color package
prove.lisp: The prove/src/prove․lisp file
prove.output: The prove․output package
prove.report: The prove․report package
prove.reporter: The prove․reporter package
prove.reporter.dot: The prove․reporter․dot package
prove.reporter.fiveam: The prove․reporter․fiveam package
prove.reporter.list: The prove․reporter․list package
prove.reporter.tap: The prove․reporter․tap package
prove.suite: The prove․suite package
prove.test: The prove․test package

R
report: Public classes
report.lisp: The prove/src/report․lisp file
reporter: Public classes
reporter-components: The prove/src/reporter-components module
reporter.lisp: The prove/src/reporter․lisp file

S
skipped-test-report: Public classes
src: The prove/src module
suite: Public classes
suite.lisp: The prove/src/suite․lisp file
System, prove: The prove system

T
tap-reporter: Private classes
tap.lisp: The prove/src/reporter-components/tap․lisp file
test-file: Public classes
test-report: Public classes
test.lisp: The prove/src/test․lisp file