The testiere Reference Manual

This is the testiere Reference Manual, version 1.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 07:06:52 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.0.1

Dependency

trivia (system).

Source

testiere.asd.

Child Components

3 Modules

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


3.1 testiere/legacy

Source

testiere.asd.

Parent Component

testiere (system).

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

Source

testiere.asd.

Parent Component

testiere (system).

ASDF Systems

testiere.


4.1.2 testiere/legacy/package.lisp

Source

testiere.asd.

Parent Component

legacy (module).

Packages

testiere.legacy.


4.1.3 testiere/legacy/testiere.lisp

Dependency

package.lisp (file).

Source

testiere.asd.

Parent Component

legacy (module).

Public Interface
Internals

4.1.4 testiere/package.lisp

Dependency

legacy (module).

Source

testiere.asd.

Parent Component

testiere (system).

Packages

testiere.


4.1.5 testiere/testiere.lisp

Dependency

package.lisp (file).

Source

testiere.asd.

Parent Component

testiere (system).

Public Interface
Internals

4.1.6 testiere/standard-hooks.lisp

Dependency

testiere.lisp (file).

Source

testiere.asd.

Parent Component

testiere (system).

Internals

5 Packages

Packages are listed by definition order.


5.1 testiere

Source

package.lisp.

Use List
Public Interface
Internals

5.2 testiere.legacy

Source

package.lisp.

Use List

common-lisp.

Used By List

testiere.

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 Macros

Macro: defun/t (name lambda-list &body body)

Like regular DEFUN, but with embedded unit tests. If those tests would fail, the function fails to be defined.

Package

testiere.legacy.

Source

testiere.lisp.

Macro: with-stub ((name lambda-list &body body) &body forms)

Runs forms in a context where NAME is temporarily rebound to a different function. If NAME is not FBOUNDP then it is temporarily defined.

Package

testiere.legacy.

Source

testiere.lisp.

Macro: with-stubs (redefinitions &body forms)

Like WITH-STUB, but REDEFINITIONS is a list of (NAME LAMBDA-LIST . BODY) list, suitable for defining a function.

Package

testiere.legacy.

Source

testiere.lisp.


6.1.2 Ordinary functions

Function: off ()
Package

testiere.

Source

testiere.lisp.

Function: on ()
Package

testiere.

Source

testiere.lisp.

Function: register-hook (macro extractor &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.


6.2 Internals


6.2.1 Special variables

Special Variable: *cached-macroexpand-hook*
Package

testiere.

Source

testiere.lisp.

Special Variable: *testiere-hooks*

Registry of macro functions and testiere-hook

Package

testiere.

Source

testiere.lisp.


6.2.2 Ordinary functions

Function: build-test (name spec)
Package

testiere.legacy.

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 (defs body)
Package

testiere.

Source

testiere.lisp.

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

testiere.

Source

testiere.lisp.

Function: expand-test-form (form)
Package

testiere.

Source

testiere.lisp.

Function: expand-test-forms (forms)
Package

testiere.

Source

testiere.lisp.

Function: extract-tests (name body)
Package

testiere.legacy.

Source

testiere.lisp.

Function: make-testiere-hook (&key extractor restarts-expander)
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

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

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.


6.2.3 Structures

Structure: testiere-hook
Package

testiere.

Source

testiere.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: extractor
Readers

testiere-hook-extractor.

Writers

(setf testiere-hook-extractor).

Slot: restarts-expander
Readers

testiere-hook-restarts-expander.

Writers

(setf testiere-hook-restarts-expander).


Appendix A Indexes


A.1 Concepts


A.2 Functions

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

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

B
build-test: Private ordinary functions

C
copy-testiere-hook: Private ordinary functions

D
defclass-restarts-expander: Private ordinary functions
defun-restarts-expander: Private ordinary functions
defun/t: Public macros

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
extract-tests: Private ordinary functions

F
Function, (setf testiere-hook-extractor): Private ordinary functions
Function, (setf testiere-hook-restarts-expander): Private ordinary functions
Function, build-test: 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, extract-tests: 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, standard-extractor: Private ordinary functions
Function, testiere-hook: Private ordinary functions
Function, testiere-hook-extractor: Private ordinary functions
Function, testiere-hook-p: Private ordinary functions
Function, testiere-hook-restarts-expander: Private ordinary functions

M
Macro, defun/t: Public macros
Macro, with-stub: Public macros
Macro, with-stubs: Public macros
make-testiere-hook: Private ordinary functions

O
off: Public ordinary functions
on: Public ordinary functions

R
register-hook: Public ordinary functions

S
standard-extractor: Private ordinary functions

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

W
with-stub: Public macros
with-stubs: Public macros