The testiere Reference Manual

This is the testiere Reference Manual, version 1.3.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 08 19:44:46 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 testiere

TDD system for Common Lisp

Author

Colin OKeefe <>

License

GPLv3

Version

1.3.0

Dependency

trivia (system).

Source

testiere.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 testiere/testiere.asd

Source

testiere.asd.

Parent Component

testiere (system).

ASDF Systems

testiere.


3.1.2 testiere/package.lisp

Source

testiere.asd.

Parent Component

testiere (system).

Packages

testiere.


3.1.3 testiere/testiere.lisp

Dependency

package.lisp (file).

Source

testiere.asd.

Parent Component

testiere (system).

Public Interface
Internals

3.1.4 testiere/standard-hooks.lisp

Dependency

testiere.lisp (file).

Source

testiere.asd.

Parent Component

testiere (system).

Internals

4 Packages

Packages are listed by definition order.


4.1 testiere

Source

package.lisp.

Use List

common-lisp.

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 Ordinary functions

Function: off ()
Package

testiere.

Source

testiere.lisp.

Function: on ()
Package

testiere.

Source

testiere.lisp.

Function: register-hook (macro extractor form-key-fn &optional restarts-expander)

Register a new hook for use with testiere.

MACRO is a symbol naming a macro-function

EXTRACTOR is a function of one argument, FORM representing the &WHOLE of the macro-function call. It returns two values: a modified s form identical with FORM except (:tests ...) forms have been
removed. The second value should be the conatenation of the CDRs of these (:tests ...) forms.

RESTARTS-EXPANDER is an optional functionof one argument. It returns the restart handler clauses of a RESTART-CASE form. These are the restarts to try when tests fail.

Package

testiere.

Source

testiere.lisp.

Function: run-suites (&key packages automatic-continue require-all)

PACKAGES is a list of pacakge designators. Attempts to run test suites named in PACKAGES. If PACKAGES is NIL, then all known test suites are run.

If AUTOMATIC-CONTINUE is T then all TEST-FAILURE-ERRORs will be handled by printing a test failure before continuing with the suite.

If REQUIRE-ALL is T then an error will be signalled if no suite exists for one of the members of PACKAGES.

Package

testiere.

Source

testiere.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *cached-macroexpand-hook*
Package

testiere.

Source

testiere.lisp.

Special Variable: *suite-dict*

PACKAGE -> {FORM-KEY -> TEST-LAMBDA}

Package

testiere.

Source

testiere.lisp.

Special Variable: *testiere-hooks*

Registry of macro functions and testiere-hook

Package

testiere.

Source

testiere.lisp.


5.2.2 Ordinary functions

Function: add-test-to-package-suite (form-key test-thunk)
Package

testiere.

Source

testiere.lisp.

Function: copy-testiere-hook (instance)
Package

testiere.

Source

testiere.lisp.

Function: defclass-restarts-expander (form)
Package

testiere.

Source

standard-hooks.lisp.

Function: defun-restarts-expander (form)
Package

testiere.

Source

standard-hooks.lisp.

Function: expand-defun-stubs (key defs body)
Package

testiere.

Source

testiere.lisp.

Function: expand-generic-stub (key name method-stubs body)
Package

testiere.

Source

testiere.lisp.

Function: expand-test-form (key form)
Package

testiere.

Source

testiere.lisp.

Function: expand-test-forms (key forms)
Package

testiere.

Source

testiere.lisp.

Function: failed (test reason-fmt &rest fmt-args)

Signal a TEST-FAILURE-ERROR. TEST is a deignator for the
test. REASON-FMT is a format string and FMT-ARGS are arguments to that string, to be processed by CL:FORMAT.

Package

testiere.

Source

testiere.lisp.

Function: make-testiere-hook (&key extractor restarts-expander form-key-fn)
Package

testiere.

Source

testiere.lisp.

Function: report (fmt-string &rest args)
Package

testiere.

Source

testiere.lisp.

Function: report-and-continue-tests (e)
Package

testiere.

Source

testiere.lisp.

Function: run-package-suite (package &optional required)
Package

testiere.

Source

testiere.lisp.

Function: run-test (key thunk)
Package

testiere.

Source

testiere.lisp.

Function: standard-extractor (orig-form)

A somewhat naive default test form extractor. Returns two values, orig-form without test forms included, and a collection of test forms.

Package

testiere.

Source

standard-hooks.lisp.

Function: standard-form-key (form)

The first is a list (MACRO NAME) that uniquely identifies the form form which tests are being defined. NAME’s package is the suite to which the tests of FORM will be be added.

This form key function is sutable for Common Lisp definition macros.

Package

testiere.

Source

standard-hooks.lisp.

Function: testiere-hook (expander form environment)
Package

testiere.

Source

testiere.lisp.

Reader: testiere-hook-extractor (instance)
Writer: (setf testiere-hook-extractor) (instance)
Package

testiere.

Source

testiere.lisp.

Target Slot

extractor.

Reader: testiere-hook-form-key-fn (instance)
Writer: (setf testiere-hook-form-key-fn) (instance)
Package

testiere.

Source

testiere.lisp.

Target Slot

form-key-fn.

Function: testiere-hook-p (object)
Package

testiere.

Source

testiere.lisp.

Reader: testiere-hook-restarts-expander (instance)
Writer: (setf testiere-hook-restarts-expander) (instance)
Package

testiere.

Source

testiere.lisp.

Target Slot

restarts-expander.


5.2.3 Conditions

Condition: test-failure-error
Package

testiere.

Source

testiere.lisp.

Direct superclasses

testiere-error.

Direct slots
Slot: test
Initargs

:test

Condition: testiere-error
Package

testiere.

Source

testiere.lisp.

Direct superclasses

error.

Direct subclasses

test-failure-error.

Direct slots
Slot: reason
Initargs

:reason


5.2.4 Structures

Structure: testiere-hook
Package

testiere.

Source

testiere.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: extractor
Initform

(error "required")

Readers

testiere-hook-extractor.

Writers

(setf testiere-hook-extractor).

Slot: restarts-expander
Readers

testiere-hook-restarts-expander.

Writers

(setf testiere-hook-restarts-expander).

Slot: form-key-fn
Initform

(error "required")

Readers

testiere-hook-form-key-fn.

Writers

(setf testiere-hook-form-key-fn).


Appendix A Indexes


A.1 Concepts


A.2 Functions

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

(
(setf testiere-hook-extractor): Private ordinary functions
(setf testiere-hook-form-key-fn): Private ordinary functions
(setf testiere-hook-restarts-expander): Private ordinary functions

A
add-test-to-package-suite: Private ordinary functions

C
copy-testiere-hook: Private ordinary functions

D
defclass-restarts-expander: Private ordinary functions
defun-restarts-expander: Private ordinary functions

E
expand-defun-stubs: Private ordinary functions
expand-generic-stub: Private ordinary functions
expand-test-form: Private ordinary functions
expand-test-forms: Private ordinary functions

F
failed: Private ordinary functions
Function, (setf testiere-hook-extractor): Private ordinary functions
Function, (setf testiere-hook-form-key-fn): Private ordinary functions
Function, (setf testiere-hook-restarts-expander): Private ordinary functions
Function, add-test-to-package-suite: Private ordinary functions
Function, copy-testiere-hook: Private ordinary functions
Function, defclass-restarts-expander: Private ordinary functions
Function, defun-restarts-expander: Private ordinary functions
Function, expand-defun-stubs: Private ordinary functions
Function, expand-generic-stub: Private ordinary functions
Function, expand-test-form: Private ordinary functions
Function, expand-test-forms: Private ordinary functions
Function, failed: Private ordinary functions
Function, make-testiere-hook: Private ordinary functions
Function, off: Public ordinary functions
Function, on: Public ordinary functions
Function, register-hook: Public ordinary functions
Function, report: Private ordinary functions
Function, report-and-continue-tests: Private ordinary functions
Function, run-package-suite: Private ordinary functions
Function, run-suites: Public ordinary functions
Function, run-test: Private ordinary functions
Function, standard-extractor: Private ordinary functions
Function, standard-form-key: Private ordinary functions
Function, testiere-hook: Private ordinary functions
Function, testiere-hook-extractor: Private ordinary functions
Function, testiere-hook-form-key-fn: Private ordinary functions
Function, testiere-hook-p: Private ordinary functions
Function, testiere-hook-restarts-expander: Private ordinary functions

M
make-testiere-hook: Private ordinary functions

O
off: Public ordinary functions
on: Public ordinary functions

R
register-hook: Public ordinary functions
report: Private ordinary functions
report-and-continue-tests: Private ordinary functions
run-package-suite: Private ordinary functions
run-suites: Public ordinary functions
run-test: Private ordinary functions

S
standard-extractor: Private ordinary functions
standard-form-key: Private ordinary functions

T
testiere-hook: Private ordinary functions
testiere-hook-extractor: Private ordinary functions
testiere-hook-form-key-fn: Private ordinary functions
testiere-hook-p: Private ordinary functions
testiere-hook-restarts-expander: Private ordinary functions