The monkeylib-test-framework Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The monkeylib-test-framework Reference Manual

This is the monkeylib-test-framework Reference Manual, version 1.0, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 04:20:11 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Systems

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


Previous: , Up: Systems   [Contents][Index]

1.1 com.gigamonkeys.test-framework

Maintainer

Peter Seibel <peter@gigamonkeys.com>

Author

Peter Seibel <peter@gigamonkeys.com>

License

BSD

Description

Simple unit test framework for Common Lisp

Long Description
Version

1.0

Dependency

com.gigamonkeys.macro-utilities

Source

com.gigamonkeys.test-framework.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

2 Files

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


Previous: , Up: Files   [Contents][Index]

2.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.1 com.gigamonkeys.test-framework.asd

Location

com.gigamonkeys.test-framework.asd

Systems

com.gigamonkeys.test-framework (system)

Packages

com.gigamonkeys.test-system


Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.2 com.gigamonkeys.test-framework/packages.lisp

Parent

com.gigamonkeys.test-framework (system)

Location

packages.lisp

Packages

Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.3 com.gigamonkeys.test-framework/test.lisp

Dependency

packages.lisp (file)

Parent

com.gigamonkeys.test-framework (system)

Location

test.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

2.1.4 com.gigamonkeys.test-framework/tests.lisp

Dependencies
Parent

com.gigamonkeys.test-framework (system)

Location

tests.lisp


Previous: , Up: Lisp files   [Contents][Index]

2.1.5 com.gigamonkeys.test-framework/test-tests.lisp

Dependencies
Parent

com.gigamonkeys.test-framework (system)

Location

test-tests.lisp

Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

3 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

3.1 com.gigamonkeys.test-system

Source

com.gigamonkeys.test-framework.asd

Use List

Next: , Previous: , Up: Packages   [Contents][Index]

3.2 com.gigamonkeys.test-tests

Source

packages.lisp (file)

Use List

common-lisp

Internal Definitions

Previous: , Up: Packages   [Contents][Index]

3.3 com.gigamonkeys.test

Source

packages.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

4.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.1 Special variables

Special Variable: *debug*

If true, then the Lisp debugger is invoked when an unexpected condition is signalled during testing. See also: *debug-on-fail*.

Package

com.gigamonkeys.test

Source

test.lisp (file)

Special Variable: *debug-on-fail*

If true, then the Lisp debugger is invoked when a test fails. See also: *debug*.

Package

com.gigamonkeys.test

Source

test.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

4.1.2 Macros

Macro: check &body FORMS

Run each expression in ‘forms’ as a test case.

Package

com.gigamonkeys.test

Source

test.lisp (file)

Macro: deftest NAME PARAMETERS &body BODY

Define a test function. Within a test function we can call other test functions or use ‘check’ to run individual test cases.

Package

com.gigamonkeys.test

Source

test.lisp (file)

Macro: expect CONDITION-TYPE FORM

Pass iff a condition of the given type is signaled while executing form.

Package

com.gigamonkeys.test

Source

test.lisp (file)

Macro: test NAME &rest ARGUMENTS

Run a named test.

Package

com.gigamonkeys.test

Source

test.lisp (file)

Macro: with-test-cases (&rest PARAMETERS) TEST-FORM &rest TEST-CASES

Check a single test form with multple test cases.

Package

com.gigamonkeys.test

Source

test.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

4.1.3 Functions

Function: clear-package-tests &key PACKAGE
Package

com.gigamonkeys.test

Source

test.lisp (file)

Function: remove-test-function SYMBOL
Package

com.gigamonkeys.test

Source

test.lisp (file)

Function: test-package &key PRINT SUMMARY PACKAGE
Package

com.gigamonkeys.test

Source

test.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

4.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.1 Special variables

Special Variable: *report-passes*
Package

com.gigamonkeys.test

Source

test.lisp (file)

Special Variable: *test-name*
Package

com.gigamonkeys.test

Source

test.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.2 Macros

Macro: eval-with-values FORM

Transform ‘form’ into an equivalent form to be evaluated and an alist of sub-forms and their values.

Package

com.gigamonkeys.test

Source

test.lisp (file)

Macro: ignore-results &body BODY

Ignore results signaled in ‘body’. This is, at the very least, handy when writing tests for the test framework itself.

Package

com.gigamonkeys.test

Source

test.lisp (file)

Macro: with-test-results (&key PRINT SUMMARY) &body BODY

Collect test results signaled in ‘body’ (except from forms in the dynamic extent of an IGNORE-RESULTS.

Package

com.gigamonkeys.test

Source

test.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.3 Functions

Function: function-name-p NAME
Package

com.gigamonkeys.test

Source

test.lisp (file)

Function: ignore-result &optional CONDITION
Package

com.gigamonkeys.test

Source

test.lisp (file)

Function: listify THING
Package

com.gigamonkeys.test

Source

test.lisp (file)

Function: print-result-summary OK PASSES FAILURES ABORTS
Package

com.gigamonkeys.test

Source

test.lisp (file)

Function: proceed &optional CONDITION
Package

com.gigamonkeys.test

Source

test.lisp (file)

Function: process SEXP VARS
Package

com.gigamonkeys.test

Source

test.lisp (file)

Function: report-abort MESSAGE
Package

com.gigamonkeys.test

Source

test.lisp (file)

Function: report-result RESULT FORM SUB-FORMS

Report the results of a single test case. Called by ‘check’.

Package

com.gigamonkeys.test

Source

test.lisp (file)

Function: test-function SYMBOL
Package

com.gigamonkeys.test

Source

test.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

4.2.4 Generic functions

Generic Function: form CONDITION
Package

com.gigamonkeys.test

Methods
Method: form (CONDITION test-result)
Source

test.lisp (file)

Generic Function: name CONDITION
Package

com.gigamonkeys.test

Methods
Method: name (CONDITION test-result)
Source

test.lisp (file)

Generic Function: print-result RESULT
Package

com.gigamonkeys.test

Source

test.lisp (file)

Methods
Method: print-result (RESULT test-fail)
Method: print-result (RESULT test-result)
Generic Function: process-for-op OP SEXP VARS

Define special processing for macros and
special operators which would otherwise be opaque. It is important to preserve the proper evaluation of the subforms.

Package

com.gigamonkeys.test

Source

test.lisp (file)

Methods
Method: process-for-op (OP (eql if)) SEXP VARS
Method: process-for-op OP SEXP VARS
Generic Function: report-unexpected-error ERROR
Package

com.gigamonkeys.test

Source

test.lisp (file)

Methods
Method: report-unexpected-error (ERROR error)
Method: report-unexpected-error (ERROR cell-error)
Method: report-unexpected-error ERROR around
Generic Function: result CONDITION
Package

com.gigamonkeys.test

Methods
Method: result (CONDITION test-result)
Source

test.lisp (file)

Generic Function: run-test THING &rest ARGUMENTS
Package

com.gigamonkeys.test

Source

test.lisp (file)

Methods
Method: run-test (NAME symbol) &rest ARGUMENTS
Generic Function: sub-forms CONDITION
Package

com.gigamonkeys.test

Methods
Method: sub-forms (CONDITION test-result)
Source

test.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

4.2.5 Conditions

Condition: foo-condition ()
Package

com.gigamonkeys.test-tests

Source

test-tests.lisp (file)

Direct superclasses

condition (condition)

Condition: foo-error ()
Package

com.gigamonkeys.test-tests

Source

test-tests.lisp (file)

Direct superclasses

error (condition)

Condition: test-abort ()
Package

com.gigamonkeys.test

Source

test.lisp (file)

Direct superclasses

test-result (condition)

Condition: test-fail ()
Package

com.gigamonkeys.test

Source

test.lisp (file)

Direct superclasses

test-result (condition)

Direct methods
Condition: test-pass ()
Package

com.gigamonkeys.test

Source

test.lisp (file)

Direct superclasses

test-result (condition)

Condition: test-result ()
Package

com.gigamonkeys.test

Source

test.lisp (file)

Direct superclasses

condition (condition)

Direct subclasses
Direct methods
Direct slots
Slot: result
Initargs

:result

Readers

result (generic function)

Slot: name
Initargs

:name

Readers

name (generic function)

Slot: form
Initargs

:form

Readers

form (generic function)

Slot: sub-forms
Initargs

:sub-forms

Readers

sub-forms (generic function)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
com.gigamonkeys.test-framework.asd: The com<dot>gigamonkeys<dot>test-framework<dot>asd file
com.gigamonkeys.test-framework/packages.lisp: The com<dot>gigamonkeys<dot>test-framework/packages<dot>lisp file
com.gigamonkeys.test-framework/test-tests.lisp: The com<dot>gigamonkeys<dot>test-framework/test-tests<dot>lisp file
com.gigamonkeys.test-framework/test.lisp: The com<dot>gigamonkeys<dot>test-framework/test<dot>lisp file
com.gigamonkeys.test-framework/tests.lisp: The com<dot>gigamonkeys<dot>test-framework/tests<dot>lisp file

F
File, Lisp, com.gigamonkeys.test-framework.asd: The com<dot>gigamonkeys<dot>test-framework<dot>asd file
File, Lisp, com.gigamonkeys.test-framework/packages.lisp: The com<dot>gigamonkeys<dot>test-framework/packages<dot>lisp file
File, Lisp, com.gigamonkeys.test-framework/test-tests.lisp: The com<dot>gigamonkeys<dot>test-framework/test-tests<dot>lisp file
File, Lisp, com.gigamonkeys.test-framework/test.lisp: The com<dot>gigamonkeys<dot>test-framework/test<dot>lisp file
File, Lisp, com.gigamonkeys.test-framework/tests.lisp: The com<dot>gigamonkeys<dot>test-framework/tests<dot>lisp file

L
Lisp File, com.gigamonkeys.test-framework.asd: The com<dot>gigamonkeys<dot>test-framework<dot>asd file
Lisp File, com.gigamonkeys.test-framework/packages.lisp: The com<dot>gigamonkeys<dot>test-framework/packages<dot>lisp file
Lisp File, com.gigamonkeys.test-framework/test-tests.lisp: The com<dot>gigamonkeys<dot>test-framework/test-tests<dot>lisp file
Lisp File, com.gigamonkeys.test-framework/test.lisp: The com<dot>gigamonkeys<dot>test-framework/test<dot>lisp file
Lisp File, com.gigamonkeys.test-framework/tests.lisp: The com<dot>gigamonkeys<dot>test-framework/tests<dot>lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

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

C
check: Exported macros
clear-package-tests: Exported functions

D
deftest: Exported macros

E
eval-with-values: Internal macros
expect: Exported macros

F
form: Internal generic functions
form: Internal generic functions
Function, clear-package-tests: Exported functions
Function, function-name-p: Internal functions
Function, ignore-result: Internal functions
Function, listify: Internal functions
Function, print-result-summary: Internal functions
Function, proceed: Internal functions
Function, process: Internal functions
Function, remove-test-function: Exported functions
Function, report-abort: Internal functions
Function, report-result: Internal functions
Function, test-function: Internal functions
Function, test-package: Exported functions
function-name-p: Internal functions

G
Generic Function, form: Internal generic functions
Generic Function, name: Internal generic functions
Generic Function, print-result: Internal generic functions
Generic Function, process-for-op: Internal generic functions
Generic Function, report-unexpected-error: Internal generic functions
Generic Function, result: Internal generic functions
Generic Function, run-test: Internal generic functions
Generic Function, sub-forms: Internal generic functions

I
ignore-result: Internal functions
ignore-results: Internal macros

L
listify: Internal functions

M
Macro, check: Exported macros
Macro, deftest: Exported macros
Macro, eval-with-values: Internal macros
Macro, expect: Exported macros
Macro, ignore-results: Internal macros
Macro, test: Exported macros
Macro, with-test-cases: Exported macros
Macro, with-test-results: Internal macros
Method, form: Internal generic functions
Method, name: Internal generic functions
Method, print-result: Internal generic functions
Method, print-result: Internal generic functions
Method, process-for-op: Internal generic functions
Method, process-for-op: Internal generic functions
Method, report-unexpected-error: Internal generic functions
Method, report-unexpected-error: Internal generic functions
Method, report-unexpected-error: Internal generic functions
Method, result: Internal generic functions
Method, run-test: Internal generic functions
Method, sub-forms: Internal generic functions

N
name: Internal generic functions
name: Internal generic functions

P
print-result: Internal generic functions
print-result: Internal generic functions
print-result: Internal generic functions
print-result-summary: Internal functions
proceed: Internal functions
process: Internal functions
process-for-op: Internal generic functions
process-for-op: Internal generic functions
process-for-op: Internal generic functions

R
remove-test-function: Exported functions
report-abort: Internal functions
report-result: Internal functions
report-unexpected-error: Internal generic functions
report-unexpected-error: Internal generic functions
report-unexpected-error: Internal generic functions
report-unexpected-error: Internal generic functions
result: Internal generic functions
result: Internal generic functions
run-test: Internal generic functions
run-test: Internal generic functions

S
sub-forms: Internal generic functions
sub-forms: Internal generic functions

T
test: Exported macros
test-function: Internal functions
test-package: Exported functions

W
with-test-cases: Exported macros
with-test-results: Internal macros

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

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
F   N   R   S  
Index Entry  Section

*
*debug*: Exported special variables
*debug-on-fail*: Exported special variables
*report-passes*: Internal special variables
*test-name*: Internal special variables

F
form: Internal conditions

N
name: Internal conditions

R
result: Internal conditions

S
Slot, form: Internal conditions
Slot, name: Internal conditions
Slot, result: Internal conditions
Slot, sub-forms: Internal conditions
Special Variable, *debug*: Exported special variables
Special Variable, *debug-on-fail*: Exported special variables
Special Variable, *report-passes*: Internal special variables
Special Variable, *test-name*: Internal special variables
sub-forms: Internal conditions

Jump to:   *  
F   N   R   S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   F   P   S   T  
Index Entry  Section

C
com.gigamonkeys.test: The com<dot>gigamonkeys<dot>test package
com.gigamonkeys.test-framework: The com<dot>gigamonkeys<dot>test-framework system
com.gigamonkeys.test-system: The com<dot>gigamonkeys<dot>test-system package
com.gigamonkeys.test-tests: The com<dot>gigamonkeys<dot>test-tests package
Condition, foo-condition: Internal conditions
Condition, foo-error: Internal conditions
Condition, test-abort: Internal conditions
Condition, test-fail: Internal conditions
Condition, test-pass: Internal conditions
Condition, test-result: Internal conditions

F
foo-condition: Internal conditions
foo-error: Internal conditions

P
Package, com.gigamonkeys.test: The com<dot>gigamonkeys<dot>test package
Package, com.gigamonkeys.test-system: The com<dot>gigamonkeys<dot>test-system package
Package, com.gigamonkeys.test-tests: The com<dot>gigamonkeys<dot>test-tests package

S
System, com.gigamonkeys.test-framework: The com<dot>gigamonkeys<dot>test-framework system

T
test-abort: Internal conditions
test-fail: Internal conditions
test-pass: Internal conditions
test-result: Internal conditions

Jump to:   C   F   P   S   T