The fiveam Reference Manual

Table of Contents

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

The fiveam Reference Manual

This is the fiveam Reference Manual, version 1.4.1, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:53:39 2018 GMT+0.


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

1 Introduction

This is FiveAM, a common lisp testing framework.

The documentation can be found in the docstrings, start with the
package :it.bese.fiveam (nicknamed 5AM).

The mailing list for FiveAM is fiveam-devel@common-lisp.net

All the code is Copyright (C) 2002-2006 Edward Marco Baringer.


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

2 Systems

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


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

2.1 fiveam

Author

Edward Marco Baringer <mb@bese.it>

License

BSD

Description

A simple regression testing framework

Version

1.4.1

Dependencies
Source

fiveam.asd (file)

Components

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

3 Files

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


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

3.1 Lisp


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

3.1.1 fiveam.asd

Location

/home/quickbuilder/quicklisp/dists/quicklisp/software/fiveam-v1.4.1/fiveam.asd

Systems

fiveam (system)


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

3.1.2 fiveam/package.lisp

Parent

fiveam (system)

Location

package.lisp

Packages

it.bese.fiveam


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

3.1.3 fiveam/utils.lisp

Dependency

package.lisp (file)

Parent

fiveam (system)

Location

utils.lisp

Internal Definitions

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

3.1.4 fiveam/check.lisp

Dependencies
Parent

fiveam (system)

Location

check.lisp

Exported Definitions
Internal Definitions

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

3.1.5 fiveam/fixture.lisp

Dependency

package.lisp (file)

Parent

fiveam (system)

Location

fixture.lisp

Exported Definitions
Internal Definitions

*fixture* (special variable)


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

3.1.6 fiveam/classes.lisp

Dependency

package.lisp (file)

Parent

fiveam (system)

Location

classes.lisp

Internal Definitions

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

3.1.7 fiveam/random.lisp

Dependencies
Parent

fiveam (system)

Location

random.lisp

Exported Definitions
Internal Definitions

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

3.1.8 fiveam/test.lisp

Dependencies
Parent

fiveam (system)

Location

test.lisp

Exported Definitions
Internal Definitions

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

3.1.9 fiveam/explain.lisp

Dependencies
Parent

fiveam (system)

Location

explain.lisp

Exported Definitions
Internal Definitions

partition-results (function)


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

3.1.10 fiveam/suite.lisp

Dependencies
Parent

fiveam (system)

Location

suite.lisp

Exported Definitions
Internal Definitions

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

3.1.11 fiveam/run.lisp

Dependencies
Parent

fiveam (system)

Location

run.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 it.bese.fiveam

Source

package.lisp (file)

Nicknames
Use List
Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Special variables

Special Variable: *debug-on-error*

T if we should drop into the debugger on error, NIL otherwise. OBSOLETE: superseded by *ON-ERROR*

Package

it.bese.fiveam

Source

run.lisp (file)

Special Variable: *debug-on-failure*

T if we should drop into the debugger on a failing check, NIL otherwise. OBSOLETE: superseded by *ON-FAILURE*

Package

it.bese.fiveam

Source

run.lisp (file)

Special Variable: *default-test-compilation-time*
Package

it.bese.fiveam

Source

test.lisp (file)

Special Variable: *max-trials*

Number of total times we attempt to run the body of the FOR-ALL test including when the body is skipped due to failed guard conditions.

Since we have guard conditions we may get into infinite loops where the test code is never run due to the guards never returning true. This second run limit prevents that.

Package

it.bese.fiveam

Source

random.lisp (file)

Special Variable: *num-trials*

Number of times we attempt to run the body of the FOR-ALL test.

Package

it.bese.fiveam

Source

random.lisp (file)

Special Variable: *on-error*

The action to perform on error:
- :DEBUG if we should drop into the debugger - :BACKTRACE to print a backtrace
- NIL to simply continue

Package

it.bese.fiveam

Source

run.lisp (file)

Special Variable: *on-failure*

The action to perform on check failure: - :DEBUG if we should drop into the debugger - :BACKTRACE to print a backtrace
- NIL to simply continue

Package

it.bese.fiveam

Source

run.lisp (file)

Special Variable: *print-names*

T if we should print test running progress, NIL otherwise.

Package

it.bese.fiveam

Source

run.lisp (file)

Special Variable: *run-test-when-defined*

When non-NIL tests are run as soon as they are defined.

Package

it.bese.fiveam

Source

test.lisp (file)

Special Variable: *test-dribble*
Package

it.bese.fiveam

Source

check.lisp (file)

Special Variable: *verbose-failures*

T if we should print the expression failing, NIL otherwise.

Package

it.bese.fiveam

Source

explain.lisp (file)


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

5.1.2 Macros

Macro: def-fixture NAME (&rest ARGS) &body BODY

Defines a fixture named NAME. A fixture is very much like a macro but is used only for simple templating. A fixture created with DEF-FIXTURE is a macro which can use the special macrolet &BODY to specify where the body should go.

See Also: WITH-FIXTURE

Package

it.bese.fiveam

Source

fixture.lisp (file)

Macro: def-suite NAME &key DESCRIPTION IN

Define a new test-suite named NAME.

IN (a symbol), if provided, causes this suite te be nested in the suite named by IN. NB: This macro is built on top of make-suite, as such it, like make-suite, will overrwrite any existing suite named NAME.

Package

it.bese.fiveam

Source

suite.lisp (file)

Macro: def-suite* NAME &rest DEF-SUITE-ARGS
Package

it.bese.fiveam

Source

suite.lisp (file)

Macro: def-test NAME (&key DEPENDS-ON SUITE FIXTURE COMPILE-AT PROFILE) &body BODY

Create a test named NAME.

NAME is the symbol which names the test.

DEPENDS-ON is a list of the form:

(AND . test-names) - This test is run only if all of the tests in TEST-NAMES have passed, otherwise a single test-skipped result is generated.

(OR . test-names) - If any of TEST-NAMES has passed this test is run, otherwise a test-skipped result is generated.

(NOT test-name) - This is test is run only if TEST-NAME failed.

AND, OR and NOT can be combined to produce complex dependencies.

If DEPENDS-ON is a symbol it is interpreted as ‘(AND ,depends-on), this is accomadate the common case of one test depending on another.

FIXTURE specifies a fixture to wrap the body in.

If PROFILE is T profiling information will be collected as well.

Package

it.bese.fiveam

Source

test.lisp (file)

Macro: fail &rest MESSAGE-ARGS

Simply generate a FAIL.

Package

it.bese.fiveam

Source

check.lisp (file)

Macro: finishes &body BODY

Generates a pass if BODY executes to normal completion. In other words if body does signal, return-from or throw this test fails.

Package

it.bese.fiveam

Source

check.lisp (file)

Macro: for-all BINDINGS &body BODY

Bind BINDINGS to random variables and test BODY *num-trials* times.

BINDINGS is a list of binding forms, each element is a list
of (BINDING VALUE &optional GUARD). Value, which is evaluated once when the for-all is evaluated, must return a generator which be called each time BODY is evaluated. BINDING is either a symbol or a list which will be passed to destructuring-bind. GUARD is a form which, if present, stops BODY from executing when IT returns NIL. The GUARDS are evaluated after all the random data has been generated and they can refer to the current value of any binding. NB: Generator forms, unlike guard forms, can not contain references to the bound variables.

Examples:

(for-all ((a (gen-integer)))
(is (integerp a)))

(for-all ((a (gen-integer) (plusp a)))
(is (integerp a))
(is (plusp a)))

(for-all ((less (gen-integer))
(more (gen-integer) (< less more)))
(is (<= less more)))

(for-all (((a b) (gen-two-integers)))
(is (integerp a))
(is (integerp b)))

Package

it.bese.fiveam

Source

random.lisp (file)

Macro: in-suite SUITE-NAME

Set the *suite* special variable so that all tests defined after the execution of this form are, unless specified otherwise, in the test-suite named SUITE-NAME.

See also: DEF-SUITE *SUITE*

Package

it.bese.fiveam

Source

suite.lisp (file)

Macro: in-suite* SUITE-NAME &key IN

Just like in-suite, but silently creates missing suites.

Package

it.bese.fiveam

Source

suite.lisp (file)

Macro: is TEST &rest REASON-ARGS

The DWIM checking operator.

If TEST returns a true value a test-passed result is generated, otherwise a test-failure result is generated. The reason, unless REASON-ARGS is provided, is generated based on the form of TEST:

(predicate expected actual) - Means that we want to check whether, according to PREDICATE, the ACTUAL value is
in fact what we EXPECTED.

(predicate value) - Means that we want to ensure that VALUE satisfies PREDICATE.

Wrapping the TEST form in a NOT simply produces a negated reason string.

Package

it.bese.fiveam

Source

check.lisp (file)

Macro: is-every PREDICATE &body CLAUSES

The input is either a list of lists, or a list of pairs. Generates (is (,predicate ,expr ,value)) for each pair of elements or (is (,predicate ,expr ,value) ,@reason) for each list.

Package

it.bese.fiveam

Source

check.lisp (file)

Macro: is-false CONDITION &rest REASON-ARGS

Generates a pass if CONDITION returns false, generates a failure otherwise. Like IS-TRUE, and unlike IS, IS-FALSE does not inspect CONDITION to determine what reason to give it case of test failure

Package

it.bese.fiveam

Source

check.lisp (file)

Macro: is-true CONDITION &rest REASON-ARGS

Like IS this check generates a pass if CONDITION returns true and a failure if CONDITION returns false. Unlike IS this check does not inspect CONDITION to determine how to report the failure.

Package

it.bese.fiveam

Source

check.lisp (file)

Macro: pass &rest MESSAGE-ARGS

Simply generate a PASS.

Package

it.bese.fiveam

Source

check.lisp (file)

Macro: signals CONDITION-SPEC &body BODY

Generates a pass if BODY signals a condition of type CONDITION. BODY is evaluated in a block named NIL, CONDITION is not evaluated.

Package

it.bese.fiveam

Source

check.lisp (file)

Macro: skip &rest REASON

Generates a TEST-SKIPPED result.

Package

it.bese.fiveam

Source

check.lisp (file)

Macro: test NAME &body BODY

Create a test named NAME. If NAME is a list it must be of the form:

(name &key depends-on suite fixture compile-at profile)

NAME is the symbol which names the test.

DEPENDS-ON is a list of the form:

(AND . test-names) - This test is run only if all of the tests in TEST-NAMES have passed, otherwise a single test-skipped result is generated.

(OR . test-names) - If any of TEST-NAMES has passed this test is run, otherwise a test-skipped result is generated.

(NOT test-name) - This is test is run only if TEST-NAME failed.

AND, OR and NOT can be combined to produce complex dependencies.

If DEPENDS-ON is a symbol it is interpreted as ‘(AND ,depends-on), this is accomadate the common case of one test depending on another.

FIXTURE specifies a fixture to wrap the body in.

If PROFILE is T profiling information will be collected as well.

Package

it.bese.fiveam

Source

test.lisp (file)

Macro: with-fixture FIXTURE-NAME (&rest ARGS) &body BODY

Insert BODY into the fixture named FIXTURE-NAME.

See Also: DEF-FIXTURE

Package

it.bese.fiveam

Source

fixture.lisp (file)


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

5.1.3 Functions

Function: ! ()

Rerun the most recently run test and explain the results.

Package

it.bese.fiveam

Source

run.lisp (file)

Function: !! ()

Rerun the second most recently run test and explain the results.

Package

it.bese.fiveam

Source

run.lisp (file)

Function: !!! ()

Rerun the third most recently run test and explain the results.

Package

it.bese.fiveam

Source

run.lisp (file)

Function: debug! &optional TEST-SPEC

Calls (run! test-spec) but enters the debugger if any kind of error happens.

Package

it.bese.fiveam

Source

run.lisp (file)

Function: explain! RESULT-LIST

Explain the results of RESULT-LIST using a detailed-text-explainer with output going to *test-dribble*. Return a boolean indicating whether no tests failed.

Package

it.bese.fiveam

Source

run.lisp (file)

Function: gen-buffer &key LENGTH ELEMENT-TYPE ELEMENTS
Package

it.bese.fiveam

Source

random.lisp (file)

Function: gen-character &key CODE-LIMIT CODE ALPHANUMERICP

Returns a generator of characters.

CODE must be a generator of random integers. ALPHANUMERICP, if non-NIL, limits the returned chars to those which pass alphanumericp.

Package

it.bese.fiveam

Source

random.lisp (file)

Function: gen-float &key BOUND TYPE

Returns a generator which produces floats of type TYPE. BOUND, if specified, constrains the results to be in the range (-BOUND, BOUND).

Package

it.bese.fiveam

Source

random.lisp (file)

Function: gen-integer &key MAX MIN

Returns a generator which produces random integers greater than or equal to MIN and less than or equal to MAX.

Package

it.bese.fiveam

Source

random.lisp (file)

Function: gen-list &key LENGTH ELEMENTS

Returns a generator which produces random lists. LENGTH must be an integer generator and ELEMENTS must be a generator which produces objects.

Package

it.bese.fiveam

Source

random.lisp (file)

Function: gen-one-element &rest ELEMENTS
Package

it.bese.fiveam

Source

random.lisp (file)

Function: gen-string &key LENGTH ELEMENTS ELEMENT-TYPE

Returns a generator which produces random strings. LENGTH must be a generator which produces integers, ELEMENTS must be a generator which produces characters of type ELEMENT-TYPE.

Package

it.bese.fiveam

Source

random.lisp (file)

Function: gen-tree &key SIZE ELEMENTS

Returns a generator which produces random trees. SIZE controls the approximate size of the tree, but don’t try anything above 30, you have been warned. ELEMENTS must be a generator which will produce the elements.

Package

it.bese.fiveam

Source

random.lisp (file)

Function: get-fixture KEY &optional DEFAULT
Function: (setf get-fixture) VALUE KEY
Package

it.bese.fiveam

Source

fixture.lisp (file)

Function: get-test KEY &optional DEFAULT
Function: (setf get-test) VALUE KEY
Package

it.bese.fiveam

Source

test.lisp (file)

Function: make-suite NAME &key DESCRIPTION (IN PARENT-SUITE)

Create a new test suite object.

Overrides any existing suite named NAME.

Package

it.bese.fiveam

Source

suite.lisp (file)

Function: rem-fixture KEY
Package

it.bese.fiveam

Source

fixture.lisp (file)

Function: rem-test KEY
Package

it.bese.fiveam

Source

test.lisp (file)

Function: results-status RESULT-LIST

Given a list of test results (generated while running a test) return true if no results are of type TEST-FAILURE. Returns second and third values, which are the set of failed tests and skipped tests respectively.

Package

it.bese.fiveam

Source

run.lisp (file)

Function: run TEST-SPEC &key (PRINT-NAMES *PRINT-NAMES*)

Run the test specified by TEST-SPEC.

TEST-SPEC can be either a symbol naming a test or test suite, or a testable-object object. This function changes the operations performed by the !, !! and !!! functions.

Package

it.bese.fiveam

Source

run.lisp (file)

Function: run! &optional TEST-SPEC &key (PRINT-NAMES *PRINT-NAMES*)

Equivalent to (explain! (run TEST-SPEC)).

Package

it.bese.fiveam

Source

run.lisp (file)

Function: run-all-tests &key SUMMARY

Runs all defined test suites, T if all tests passed and NIL otherwise. SUMMARY can be :END to print a summary at the end, :SUITE to print it after each suite or NIL to skip explanations.

Package

it.bese.fiveam

Source

run.lisp (file)

Function: test-names ()
Package

it.bese.fiveam

Source

test.lisp (file)


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

5.1.4 Generic functions

Generic Function: explain EXPLAINER RESULTS &optional STREAM RECURSIVE-DEPTH

Given a list of test results report write to stream detailed human readable statistics regarding the results.

Package

it.bese.fiveam

Source

explain.lisp (file)

Methods
Method: explain (EXP simple-text-explainer) RESULTS &optional STREAM RECURSIVE-DEPTH
Method: explain (EXP detailed-text-explainer) RESULTS &optional STREAM RECURSIVE-DEPTH

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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *!!!*
Package

it.bese.fiveam

Source

run.lisp (file)

Special Variable: *!!*
Package

it.bese.fiveam

Source

run.lisp (file)

Special Variable: *!*
Package

it.bese.fiveam

Source

run.lisp (file)

Special Variable: *fixture*

Lookup table mapping fixture names to fixture objects.

Package

it.bese.fiveam

Source

fixture.lisp (file)

Special Variable: *initial-!*
Package

it.bese.fiveam

Source

run.lisp (file)

Special Variable: *run-queue*

List of test waiting to be run.

Package

it.bese.fiveam

Source

run.lisp (file)

Special Variable: *suite*

The current test suite object

Package

it.bese.fiveam

Source

suite.lisp (file)

Special Variable: *test*

Lookup table mapping test (and test suite) names to objects.

Package

it.bese.fiveam

Source

test.lisp (file)

Special Variable: *test-dribble-indent*

Used to indent tests and test suites in their parent suite

Package

it.bese.fiveam

Source

run.lisp (file)

Special Variable: *toplevel-suites*
Package

it.bese.fiveam

Source

suite.lisp (file)


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

5.2.2 Macros

Macro: %in-suite SUITE-NAME &key FAIL-ON-ERROR IN
Package

it.bese.fiveam

Source

suite.lisp (file)

Macro: acond2 &rest CLAUSES
Package

it.bese.fiveam

Source

utils.lisp (file)

Macro: aif TEST THEN &optional ELSE

Just like IF-BIND but the var is always IT.

Package

it.bese.fiveam

Source

utils.lisp (file)

Macro: bind-run-state REQUESTED-VARS &body BODY
Package

it.bese.fiveam

Source

check.lisp (file)

Macro: bind-run-state* REQUESTED-VARS &body BODY
Package

it.bese.fiveam

Source

check.lisp (file)

Macro: def-special-environment NAME (&key ACCESSOR BINDER BINDER*) &rest VARS

Define two macros for dealing with groups or related special variables.

ACCESSOR is defined as a macro: (defmacro ACCESSOR (VARS &rest BODY)). Each element of VARS will be bound to the
current (dynamic) value of the special variable.

BINDER is defined as a macro for introducing (and binding new) special variables. It is basically a readable LET form with the prorpe declarations appended to the body. The first argument to BINDER must be a form suitable as the first argument to LET.

ACCESSOR defaults to a new symbol in the same package as NAME
which is the concatenation of "WITH-" NAME. BINDER is built as "BIND-" and BINDER* is BINDER "*".

Package

it.bese.fiveam

Source

utils.lisp (file)

Macro: dolist* (ITERATOR LIST &optional RETURN-VALUE) &body BODY

Like DOLIST but destructuring-binds the elements of LIST.

If ITERATOR is a symbol then dolist* is just like dolist EXCEPT that it creates a fresh binding.

Package

it.bese.fiveam

Source

utils.lisp (file)

Macro: if-bind VAR TEST &body THEN/ELSE

Anaphoric IF control structure.

VAR (a symbol) will be bound to the primary value of TEST. If TEST returns a true value then THEN will be executed, otherwise ELSE will be executed.

Package

it.bese.fiveam

Source

utils.lisp (file)

Macro: list-match-case TARGET &body CLAUSES
Package

it.bese.fiveam

Source

utils.lisp (file)

Macro: with-*test-dribble* STREAM &body BODY
Package

it.bese.fiveam

Source

check.lisp (file)

Macro: with-run-state REQUESTED-VARS &body BODY
Package

it.bese.fiveam

Source

check.lisp (file)


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

5.2.3 Functions

Function: add-result RESULT-TYPE &rest MAKE-INSTANCE-ARGS

Create a TEST-RESULT object of type RESULT-TYPE passing it the initialize args MAKE-INSTANCE-ARGS and add the resulting object to the list of test results.

Package

it.bese.fiveam

Source

check.lisp (file)

Function: binding X BINDS
Package

it.bese.fiveam

Source

utils.lisp (file)

Function: check-required NAME VARS REQUIRED
Package

it.bese.fiveam

Source

utils.lisp (file)

Function: import-testing-symbols PACKAGE-DESIGNATOR
Package

it.bese.fiveam

Source

run.lisp (file)

Function: list-all-suites ()

Returns an unordered LIST of all suites.

Package

it.bese.fiveam

Source

suite.lisp (file)

Function: list-match X Y &optional BINDS
Package

it.bese.fiveam

Source

utils.lisp (file)

Function: make-collector &optional INITIAL-VALUE

Create a collector function.

A Collector function will collect, into a list, all the values passed to it in the order in which they were passed. If the callector function is called without arguments it returns the current list of values.

Package

it.bese.fiveam

Source

utils.lisp (file)

Function: partition-results RESULTS-LIST
Package

it.bese.fiveam

Source

explain.lisp (file)

Function: partitionx LIST &rest LAMBDAS
Package

it.bese.fiveam

Source

utils.lisp (file)

Function: perform-random-testing GENERATORS BODY
Package

it.bese.fiveam

Source

random.lisp (file)

Function: perform-random-testing/run-once GENERATORS BODY
Package

it.bese.fiveam

Source

random.lisp (file)

Function: process-failure TEST-EXPR &optional REASON-FORMAT &rest FORMAT-ARGS
Package

it.bese.fiveam

Source

check.lisp (file)

Function: register-test NAME DESCRIPTION BODY SUITE DEPENDS-ON COMPILE-AT PROFILE
Package

it.bese.fiveam

Source

test.lisp (file)

Function: return-result-list TEST-LAMBDA

Run the test function TEST-LAMBDA and return a list of all test results generated, does not modify the special environment variable RESULT-LIST.

Package

it.bese.fiveam

Source

run.lisp (file)

Function: vars MATCH-SPEC
Package

it.bese.fiveam

Source

utils.lisp (file)

Function: varsymp X
Package

it.bese.fiveam

Source

utils.lisp (file)


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

5.2.4 Generic functions

Generic Function: %run TEST-SPEC

Internal method for running a test. Does not
update the status of the tests nor the special variables !, !!, !!!

Package

it.bese.fiveam

Source

run.lisp (file)

Methods
Method: %run (TEST-NAME symbol)
Method: %run (SUITE test-suite)
Method: %run (TESTS list)
Method: %run (TEST test-case)
Generic Function: actual-condition OBJECT
Generic Function: (setf actual-condition) NEW-VALUE OBJECT
Package

it.bese.fiveam

Methods
Method: actual-condition (UNEXPECTED-TEST-FAILURE unexpected-test-failure)

automatically generated reader method

Source

check.lisp (file)

Method: (setf actual-condition) NEW-VALUE (UNEXPECTED-TEST-FAILURE unexpected-test-failure)

automatically generated writer method

Source

check.lisp (file)

Generic Function: collect-profiling-info OBJECT
Generic Function: (setf collect-profiling-info) NEW-VALUE OBJECT
Package

it.bese.fiveam

Methods
Method: collect-profiling-info (TESTABLE-OBJECT testable-object)
Method: (setf collect-profiling-info) NEW-VALUE (TESTABLE-OBJECT testable-object)

When T profiling
information will be collected when the test is run.

Source

classes.lisp (file)

Generic Function: depends-on OBJECT
Generic Function: (setf depends-on) NEW-VALUE OBJECT
Package

it.bese.fiveam

Methods
Method: depends-on (TESTABLE-OBJECT testable-object)
Method: (setf depends-on) NEW-VALUE (TESTABLE-OBJECT testable-object)

The list of AND, OR, NOT forms specifying when to run this test.

Source

classes.lisp (file)

Generic Function: description OBJECT
Generic Function: (setf description) NEW-VALUE OBJECT
Package

it.bese.fiveam

Methods
Method: description (TESTABLE-OBJECT testable-object)
Method: (setf description) NEW-VALUE (TESTABLE-OBJECT testable-object)

The textual description of this test object.

Source

classes.lisp (file)

Generic Function: for-all-test-failed-p OBJECT
Package

it.bese.fiveam

Source

random.lisp (file)

Methods
Method: for-all-test-failed-p (OBJECT for-all-test-failed)
Method: for-all-test-failed-p OBJECT
Generic Function: name OBJECT
Generic Function: (setf name) NEW-VALUE OBJECT
Package

it.bese.fiveam

Methods
Method: name (TESTABLE-OBJECT testable-object)
Method: (setf name) NEW-VALUE (TESTABLE-OBJECT testable-object)

A symbol naming this test object.

Source

classes.lisp (file)

Generic Function: profiling-info OBJECT
Generic Function: (setf profiling-info) NEW-VALUE OBJECT
Package

it.bese.fiveam

Methods
Method: profiling-info (TESTABLE-OBJECT testable-object)
Method: (setf profiling-info) NEW-VALUE (TESTABLE-OBJECT testable-object)

An object representing how
much time and memory where used by the test.

Source

classes.lisp (file)

Generic Function: reason OBJECT
Generic Function: (setf reason) NEW-VALUE OBJECT
Package

it.bese.fiveam

Methods
Method: reason (RESULT for-all-test-failed)
Source

random.lisp (file)

Method: reason (CONDITION check-failure)
Method: (setf reason) NEW-VALUE (CONDITION check-failure)
Source

check.lisp (file)

Method: reason (TEST-RESULT test-result)

automatically generated reader method

Source

check.lisp (file)

Method: (setf reason) NEW-VALUE (TEST-RESULT test-result)

automatically generated writer method

Source

check.lisp (file)

Generic Function: resolve-dependencies DEPENDS-ON
Package

it.bese.fiveam

Source

run.lisp (file)

Methods
Method: resolve-dependencies (DEPENDS-ON list)

Return true if the dependency spec DEPENDS-ON is satisfied, nil otherwise.

Method: resolve-dependencies (DEPENDS-ON symbol)

A test which depends on a symbol is interpreted as ‘(AND ,DEPENDS-ON).

Generic Function: run-resolving-dependencies TEST

Given a dependency spec determine if the spec
is satisfied or not, this will generally involve running other tests. If the dependency spec can be satisfied the test is also run.

Package

it.bese.fiveam

Source

run.lisp (file)

Methods
Method: run-resolving-dependencies (TEST test-case)

Return true if this test, and its dependencies, are satisfied, NIL otherwise.

Generic Function: run-test-lambda TEST
Package

it.bese.fiveam

Source

run.lisp (file)

Methods
Method: run-test-lambda (TEST test-case)
Generic Function: runtime-package OBJECT
Generic Function: (setf runtime-package) NEW-VALUE OBJECT
Package

it.bese.fiveam

Methods
Method: runtime-package (TEST-CASE test-case)
Method: (setf runtime-package) NEW-VALUE (TEST-CASE test-case)

By default it stores *package* from the time this test was defined (macroexpanded).

Source

classes.lisp (file)

Generic Function: status OBJECT
Generic Function: (setf status) NEW-VALUE OBJECT
Package

it.bese.fiveam

Methods
Method: status (TESTABLE-OBJECT testable-object)
Method: (setf status) NEW-VALUE (TESTABLE-OBJECT testable-object)

A symbol specifying the current status
of this test. Either: T - this test (and all its dependencies, have passed. NIL - this test
failed (either it failed or its dependecies weren’t met. :circular this test has a circular dependency and was skipped. Or :depends-not-satisfied or :resolving

Source

classes.lisp (file)

Generic Function: suite-emptyp SUITE
Package

it.bese.fiveam

Source

suite.lisp (file)

Methods
Method: suite-emptyp (SUITE symbol)
Method: suite-emptyp (SUITE test-suite)
Generic Function: test-case OBJECT
Generic Function: (setf test-case) NEW-VALUE OBJECT
Package

it.bese.fiveam

Methods
Method: test-case (CONDITION check-failure)
Method: (setf test-case) NEW-VALUE (CONDITION check-failure)
Source

check.lisp (file)

Method: test-case (TEST-RESULT test-result)

automatically generated reader method

Source

check.lisp (file)

Method: (setf test-case) NEW-VALUE (TEST-RESULT test-result)

automatically generated writer method

Source

check.lisp (file)

Generic Function: test-expr OBJECT
Generic Function: (setf test-expr) NEW-VALUE OBJECT
Package

it.bese.fiveam

Methods
Method: test-expr (CONDITION check-failure)
Method: (setf test-expr) NEW-VALUE (CONDITION check-failure)
Source

check.lisp (file)

Method: test-expr (TEST-RESULT test-result)

automatically generated reader method

Source

check.lisp (file)

Method: (setf test-expr) NEW-VALUE (TEST-RESULT test-result)

automatically generated writer method

Source

check.lisp (file)

Generic Function: test-failure-p OBJECT
Package

it.bese.fiveam

Source

check.lisp (file)

Methods
Method: test-failure-p O
Method: test-failure-p (O test-failure)
Generic Function: test-lambda OBJECT
Generic Function: (setf test-lambda) NEW-VALUE OBJECT
Package

it.bese.fiveam

Methods
Method: test-lambda (TEST-CASE test-case)
Method: (setf test-lambda) NEW-VALUE (TEST-CASE test-case)

The function to run.

Source

classes.lisp (file)

Generic Function: test-passed-p OBJECT
Package

it.bese.fiveam

Source

check.lisp (file)

Methods
Method: test-passed-p O
Method: test-passed-p (O test-passed)
Generic Function: test-skipped-p OBJECT
Package

it.bese.fiveam

Source

check.lisp (file)

Methods
Method: test-skipped-p O
Method: test-skipped-p (O test-skipped)
Generic Function: tests OBJECT
Generic Function: (setf tests) NEW-VALUE OBJECT
Package

it.bese.fiveam

Methods
Method: tests (TEST-SUITE test-suite)
Method: (setf tests) NEW-VALUE (TEST-SUITE test-suite)

The hash table mapping names to test
objects in this suite. The values in this hash table can be either test-cases or other test-suites.

Source

classes.lisp (file)


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

5.2.5 Conditions

Condition: check-failure ()

Signaled when a check fails.

Package

it.bese.fiveam

Source

check.lisp (file)

Direct superclasses

error (condition)

Direct methods
Direct slots
Slot: reason
Initargs

:reason

Initform

(quote "no reason given")

Readers

reason (generic function)

Writers

(setf reason) (generic function)

Slot: test-case
Initargs

:test-case

Readers

test-case (generic function)

Writers

(setf test-case) (generic function)

Slot: test-expr
Initargs

:test-expr

Readers

test-expr (generic function)

Writers

(setf test-expr) (generic function)

Condition: circular-dependency ()

Condition signaled when a circular dependency between test-cases has been detected.

Package

it.bese.fiveam

Source

run.lisp (file)

Direct superclasses

error (condition)

Direct slots
Slot: test-case
Initargs

:test-case


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

5.2.6 Classes

Class: detailed-text-explainer ()
Package

it.bese.fiveam

Source

classes.lisp (file)

Direct superclasses

text-explainer (class)

Direct methods

explain (method)

Class: explainer ()
Package

it.bese.fiveam

Source

classes.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

text-explainer (class)

Class: for-all-test-failed ()
Package

it.bese.fiveam

Source

random.lisp (file)

Direct superclasses
Direct methods
Direct slots
Slot: failure-values
Initargs

:failure-values

Slot: result-list
Initargs

:result-list

Class: for-all-test-never-run ()
Package

it.bese.fiveam

Source

random.lisp (file)

Direct superclasses
Class: for-all-test-no-tests ()
Package

it.bese.fiveam

Source

random.lisp (file)

Direct superclasses
Class: for-all-test-passed ()
Package

it.bese.fiveam

Source

random.lisp (file)

Direct superclasses
Class: for-all-test-result ()
Package

it.bese.fiveam

Source

random.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct slots
Slot: random-state
Initargs

:random-state

Class: simple-text-explainer ()
Package

it.bese.fiveam

Source

classes.lisp (file)

Direct superclasses

text-explainer (class)

Direct methods

explain (method)

Class: test-case ()

A test case is a single, named, collection of
checks.

A test case is the smallest organizational element which can be run individually. Every test case has a name, which is a symbol, a description and a test lambda. The test lambda is a regular funcall’able function which should use the various checking macros to collect results.

Every test case is part of a suite, when a suite is not explicitly specified (either via the :SUITE parameter to the TEST macro or the global variable *SUITE*) the test is inserted into the global suite named NIL.

Sometimes we want to run a certain test only if another test has passed. FiveAM allows us to specify the ways in which one test is dependent on another.

- AND Run this test only if all the named tests passed.

- OR Run this test if at least one of the named tests passed.

- NOT Run this test only if another test has failed.

FiveAM considers a test to have passed if all the checks executed were successful, otherwise we consider the test a failure.

When a test is not run due to it’s dependencies having failed a test-skipped result is added to the results.

Package

it.bese.fiveam

Source

classes.lisp (file)

Direct superclasses

testable-object (class)

Direct methods
Direct slots
Slot: test-lambda

The function to run.

Initargs

:test-lambda

Readers

test-lambda (generic function)

Writers

(setf test-lambda) (generic function)

Slot: runtime-package

By default it stores *package* from the time this test was defined (macroexpanded).

Initargs

:runtime-package

Readers

runtime-package (generic function)

Writers

(setf runtime-package) (generic function)

Class: test-failure ()

Class for unsuccessful checks.

Package

it.bese.fiveam

Source

check.lisp (file)

Direct superclasses

test-result (class)

Direct subclasses
Direct methods

test-failure-p (method)

Class: test-passed ()

Class for successful checks.

Package

it.bese.fiveam

Source

check.lisp (file)

Direct superclasses

test-result (class)

Direct subclasses

for-all-test-passed (class)

Direct methods

test-passed-p (method)

Class: test-result ()

All checking macros will generate an object of type TEST-RESULT.

Package

it.bese.fiveam

Source

check.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: reason
Initargs

:reason

Initform

"no reason given"

Readers

reason (generic function)

Writers

(setf reason) (generic function)

Slot: test-case
Initargs

:test-case

Readers

test-case (generic function)

Writers

(setf test-case) (generic function)

Slot: test-expr
Initargs

:test-expr

Readers

test-expr (generic function)

Writers

(setf test-expr) (generic function)

Class: test-skipped ()

A test which was not run. Usually this is due to
unsatisfied dependencies, but users can decide to skip the test when appropriate.

Package

it.bese.fiveam

Source

check.lisp (file)

Direct superclasses

test-result (class)

Direct methods

test-skipped-p (method)

Class: test-suite ()

A test suite is a collection of tests or test suites.

Test suites serve to organize tests into groups so that the developer can chose to run some tests and not just one or all. Like tests test suites have a name and a description.

Test suites, like tests, can be part of other test suites, this allows the developer to create a hierarchy of tests where sub trees can be singularly run.

Running a test suite has the effect of running every test (or suite) in the suite.

Package

it.bese.fiveam

Source

classes.lisp (file)

Direct superclasses

testable-object (class)

Direct methods
Direct slots
Slot: tests

The hash table mapping names to test
objects in this suite. The values in this hash table can be either test-cases or other test-suites.

Initform

(make-hash-table :test (quote eql))

Readers

tests (generic function)

Writers

(setf tests) (generic function)

Class: testable-object ()
Package

it.bese.fiveam

Source

classes.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: name

A symbol naming this test object.

Initargs

:name

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: description

The textual description of this test object.

Initargs

:description

Readers

description (generic function)

Writers

(setf description) (generic function)

Slot: depends-on

The list of AND, OR, NOT forms specifying when to run this test.

Initargs

:depends-on

Readers

depends-on (generic function)

Writers

(setf depends-on) (generic function)

Slot: status

A symbol specifying the current status
of this test. Either: T - this test (and all its dependencies, have passed. NIL - this test
failed (either it failed or its dependecies weren’t met. :circular this test has a circular dependency and was skipped. Or :depends-not-satisfied or :resolving

Initargs

:status

Initform

:unknown

Readers

status (generic function)

Writers

(setf status) (generic function)

Slot: profiling-info

An object representing how
much time and memory where used by the test.

Readers

profiling-info (generic function)

Writers

(setf profiling-info) (generic function)

Slot: collect-profiling-info

When T profiling
information will be collected when the test is run.

Initargs

:collect-profiling-info

Readers

collect-profiling-info (generic function)

Writers

(setf collect-profiling-info) (generic function)

Class: text-explainer ()
Package

it.bese.fiveam

Source

classes.lisp (file)

Direct superclasses

explainer (class)

Direct subclasses
Class: unexpected-test-failure ()

Represents the result of a test which neither
passed nor failed, but signaled an error we couldn’t deal with.

Note: This is very different than a SIGNALS check which instead creates a TEST-PASSED or TEST-FAILURE object.

Package

it.bese.fiveam

Source

check.lisp (file)

Direct superclasses

test-failure (class)

Direct methods
Direct slots
Slot: actual-condition
Initargs

:condition

Readers

actual-condition (generic function)

Writers

(setf actual-condition) (generic function)


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

5.2.7 Types

Type: on-problem-action ()
Package

it.bese.fiveam

Source

run.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L  
Index Entry  Section

F
File, Lisp, fiveam.asd: The fiveam<dot>asd file
File, Lisp, fiveam/check.lisp: The fiveam/check<dot>lisp file
File, Lisp, fiveam/classes.lisp: The fiveam/classes<dot>lisp file
File, Lisp, fiveam/explain.lisp: The fiveam/explain<dot>lisp file
File, Lisp, fiveam/fixture.lisp: The fiveam/fixture<dot>lisp file
File, Lisp, fiveam/package.lisp: The fiveam/package<dot>lisp file
File, Lisp, fiveam/random.lisp: The fiveam/random<dot>lisp file
File, Lisp, fiveam/run.lisp: The fiveam/run<dot>lisp file
File, Lisp, fiveam/suite.lisp: The fiveam/suite<dot>lisp file
File, Lisp, fiveam/test.lisp: The fiveam/test<dot>lisp file
File, Lisp, fiveam/utils.lisp: The fiveam/utils<dot>lisp file
fiveam.asd: The fiveam<dot>asd file
fiveam/check.lisp: The fiveam/check<dot>lisp file
fiveam/classes.lisp: The fiveam/classes<dot>lisp file
fiveam/explain.lisp: The fiveam/explain<dot>lisp file
fiveam/fixture.lisp: The fiveam/fixture<dot>lisp file
fiveam/package.lisp: The fiveam/package<dot>lisp file
fiveam/random.lisp: The fiveam/random<dot>lisp file
fiveam/run.lisp: The fiveam/run<dot>lisp file
fiveam/suite.lisp: The fiveam/suite<dot>lisp file
fiveam/test.lisp: The fiveam/test<dot>lisp file
fiveam/utils.lisp: The fiveam/utils<dot>lisp file

L
Lisp File, fiveam.asd: The fiveam<dot>asd file
Lisp File, fiveam/check.lisp: The fiveam/check<dot>lisp file
Lisp File, fiveam/classes.lisp: The fiveam/classes<dot>lisp file
Lisp File, fiveam/explain.lisp: The fiveam/explain<dot>lisp file
Lisp File, fiveam/fixture.lisp: The fiveam/fixture<dot>lisp file
Lisp File, fiveam/package.lisp: The fiveam/package<dot>lisp file
Lisp File, fiveam/random.lisp: The fiveam/random<dot>lisp file
Lisp File, fiveam/run.lisp: The fiveam/run<dot>lisp file
Lisp File, fiveam/suite.lisp: The fiveam/suite<dot>lisp file
Lisp File, fiveam/test.lisp: The fiveam/test<dot>lisp file
Lisp File, fiveam/utils.lisp: The fiveam/utils<dot>lisp file

Jump to:   F   L  

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

A.2 Functions

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

!
!: Exported functions
!!: Exported functions
!!!: Exported functions

%
%in-suite: Internal macros
%run: Internal generic functions
%run: Internal generic functions
%run: Internal generic functions
%run: Internal generic functions
%run: Internal generic functions

(
(setf actual-condition): Internal generic functions
(setf actual-condition): Internal generic functions
(setf collect-profiling-info): Internal generic functions
(setf collect-profiling-info): Internal generic functions
(setf depends-on): Internal generic functions
(setf depends-on): Internal generic functions
(setf description): Internal generic functions
(setf description): Internal generic functions
(setf get-fixture): Exported functions
(setf get-test): Exported functions
(setf name): Internal generic functions
(setf name): Internal generic functions
(setf profiling-info): Internal generic functions
(setf profiling-info): Internal generic functions
(setf reason): Internal generic functions
(setf reason): Internal generic functions
(setf reason): Internal generic functions
(setf runtime-package): Internal generic functions
(setf runtime-package): Internal generic functions
(setf status): Internal generic functions
(setf status): Internal generic functions
(setf test-case): Internal generic functions
(setf test-case): Internal generic functions
(setf test-case): Internal generic functions
(setf test-expr): Internal generic functions
(setf test-expr): Internal generic functions
(setf test-expr): Internal generic functions
(setf test-lambda): Internal generic functions
(setf test-lambda): Internal generic functions
(setf tests): Internal generic functions
(setf tests): Internal generic functions

A
acond2: Internal macros
actual-condition: Internal generic functions
actual-condition: Internal generic functions
add-result: Internal functions
aif: Internal macros

B
bind-run-state: Internal macros
bind-run-state*: Internal macros
binding: Internal functions

C
check-required: Internal functions
collect-profiling-info: Internal generic functions
collect-profiling-info: Internal generic functions

D
debug!: Exported functions
def-fixture: Exported macros
def-special-environment: Internal macros
def-suite: Exported macros
def-suite*: Exported macros
def-test: Exported macros
depends-on: Internal generic functions
depends-on: Internal generic functions
description: Internal generic functions
description: Internal generic functions
dolist*: Internal macros

E
explain: Exported generic functions
explain: Exported generic functions
explain: Exported generic functions
explain!: Exported functions

F
fail: Exported macros
finishes: Exported macros
for-all: Exported macros
for-all-test-failed-p: Internal generic functions
for-all-test-failed-p: Internal generic functions
for-all-test-failed-p: Internal generic functions
Function, !: Exported functions
Function, !!: Exported functions
Function, !!!: Exported functions
Function, (setf get-fixture): Exported functions
Function, (setf get-test): Exported functions
Function, add-result: Internal functions
Function, binding: Internal functions
Function, check-required: Internal functions
Function, debug!: Exported functions
Function, explain!: Exported functions
Function, gen-buffer: Exported functions
Function, gen-character: Exported functions
Function, gen-float: Exported functions
Function, gen-integer: Exported functions
Function, gen-list: Exported functions
Function, gen-one-element: Exported functions
Function, gen-string: Exported functions
Function, gen-tree: Exported functions
Function, get-fixture: Exported functions
Function, get-test: Exported functions
Function, import-testing-symbols: Internal functions
Function, list-all-suites: Internal functions
Function, list-match: Internal functions
Function, make-collector: Internal functions
Function, make-suite: Exported functions
Function, partition-results: Internal functions
Function, partitionx: Internal functions
Function, perform-random-testing: Internal functions
Function, perform-random-testing/run-once: Internal functions
Function, process-failure: Internal functions
Function, register-test: Internal functions
Function, rem-fixture: Exported functions
Function, rem-test: Exported functions
Function, results-status: Exported functions
Function, return-result-list: Internal functions
Function, run: Exported functions
Function, run!: Exported functions
Function, run-all-tests: Exported functions
Function, test-names: Exported functions
Function, vars: Internal functions
Function, varsymp: Internal functions

G
gen-buffer: Exported functions
gen-character: Exported functions
gen-float: Exported functions
gen-integer: Exported functions
gen-list: Exported functions
gen-one-element: Exported functions
gen-string: Exported functions
gen-tree: Exported functions
Generic Function, %run: Internal generic functions
Generic Function, (setf actual-condition): Internal generic functions
Generic Function, (setf collect-profiling-info): Internal generic functions
Generic Function, (setf depends-on): Internal generic functions
Generic Function, (setf description): Internal generic functions
Generic Function, (setf name): Internal generic functions
Generic Function, (setf profiling-info): Internal generic functions
Generic Function, (setf reason): Internal generic functions
Generic Function, (setf runtime-package): Internal generic functions
Generic Function, (setf status): Internal generic functions
Generic Function, (setf test-case): Internal generic functions
Generic Function, (setf test-expr): Internal generic functions
Generic Function, (setf test-lambda): Internal generic functions
Generic Function, (setf tests): Internal generic functions
Generic Function, actual-condition: Internal generic functions
Generic Function, collect-profiling-info: Internal generic functions
Generic Function, depends-on: Internal generic functions
Generic Function, description: Internal generic functions
Generic Function, explain: Exported generic functions
Generic Function, for-all-test-failed-p: Internal generic functions
Generic Function, name: Internal generic functions
Generic Function, profiling-info: Internal generic functions
Generic Function, reason: Internal generic functions
Generic Function, resolve-dependencies: Internal generic functions
Generic Function, run-resolving-dependencies: Internal generic functions
Generic Function, run-test-lambda: Internal generic functions
Generic Function, runtime-package: Internal generic functions
Generic Function, status: Internal generic functions
Generic Function, suite-emptyp: Internal generic functions
Generic Function, test-case: Internal generic functions
Generic Function, test-expr: Internal generic functions
Generic Function, test-failure-p: Internal generic functions
Generic Function, test-lambda: Internal generic functions
Generic Function, test-passed-p: Internal generic functions
Generic Function, test-skipped-p: Internal generic functions
Generic Function, tests: Internal generic functions
get-fixture: Exported functions
get-test: Exported functions

I
if-bind: Internal macros
import-testing-symbols: Internal functions
in-suite: Exported macros
in-suite*: Exported macros
is: Exported macros
is-every: Exported macros
is-false: Exported macros
is-true: Exported macros

L
list-all-suites: Internal functions
list-match: Internal functions
list-match-case: Internal macros

M
Macro, %in-suite: Internal macros
Macro, acond2: Internal macros
Macro, aif: Internal macros
Macro, bind-run-state: Internal macros
Macro, bind-run-state*: Internal macros
Macro, def-fixture: Exported macros
Macro, def-special-environment: Internal macros
Macro, def-suite: Exported macros
Macro, def-suite*: Exported macros
Macro, def-test: Exported macros
Macro, dolist*: Internal macros
Macro, fail: Exported macros
Macro, finishes: Exported macros
Macro, for-all: Exported macros
Macro, if-bind: Internal macros
Macro, in-suite: Exported macros
Macro, in-suite*: Exported macros
Macro, is: Exported macros
Macro, is-every: Exported macros
Macro, is-false: Exported macros
Macro, is-true: Exported macros
Macro, list-match-case: Internal macros
Macro, pass: Exported macros
Macro, signals: Exported macros
Macro, skip: Exported macros
Macro, test: Exported macros
Macro, with-*test-dribble*: Internal macros
Macro, with-fixture: Exported macros
Macro, with-run-state: Internal macros
make-collector: Internal functions
make-suite: Exported functions
Method, %run: Internal generic functions
Method, %run: Internal generic functions
Method, %run: Internal generic functions
Method, %run: Internal generic functions
Method, (setf actual-condition): Internal generic functions
Method, (setf collect-profiling-info): Internal generic functions
Method, (setf depends-on): Internal generic functions
Method, (setf description): Internal generic functions
Method, (setf name): Internal generic functions
Method, (setf profiling-info): Internal generic functions
Method, (setf reason): Internal generic functions
Method, (setf reason): Internal generic functions
Method, (setf runtime-package): Internal generic functions
Method, (setf status): Internal generic functions
Method, (setf test-case): Internal generic functions
Method, (setf test-case): Internal generic functions
Method, (setf test-expr): Internal generic functions
Method, (setf test-expr): Internal generic functions
Method, (setf test-lambda): Internal generic functions
Method, (setf tests): Internal generic functions
Method, actual-condition: Internal generic functions
Method, collect-profiling-info: Internal generic functions
Method, depends-on: Internal generic functions
Method, description: Internal generic functions
Method, explain: Exported generic functions
Method, explain: Exported generic functions
Method, for-all-test-failed-p: Internal generic functions
Method, for-all-test-failed-p: Internal generic functions
Method, name: Internal generic functions
Method, profiling-info: Internal generic functions
Method, reason: Internal generic functions
Method, reason: Internal generic functions
Method, reason: Internal generic functions
Method, resolve-dependencies: Internal generic functions
Method, resolve-dependencies: Internal generic functions
Method, run-resolving-dependencies: Internal generic functions
Method, run-test-lambda: Internal generic functions
Method, runtime-package: Internal generic functions
Method, status: Internal generic functions
Method, suite-emptyp: Internal generic functions
Method, suite-emptyp: Internal generic functions
Method, test-case: Internal generic functions
Method, test-case: Internal generic functions
Method, test-expr: Internal generic functions
Method, test-expr: Internal generic functions
Method, test-failure-p: Internal generic functions
Method, test-failure-p: Internal generic functions
Method, test-lambda: Internal generic functions
Method, test-passed-p: Internal generic functions
Method, test-passed-p: Internal generic functions
Method, test-skipped-p: Internal generic functions
Method, test-skipped-p: Internal generic functions
Method, tests: Internal generic functions

N
name: Internal generic functions
name: Internal generic functions

P
partition-results: Internal functions
partitionx: Internal functions
pass: Exported macros
perform-random-testing: Internal functions
perform-random-testing/run-once: Internal functions
process-failure: Internal functions
profiling-info: Internal generic functions
profiling-info: Internal generic functions

R
reason: Internal generic functions
reason: Internal generic functions
reason: Internal generic functions
reason: Internal generic functions
register-test: Internal functions
rem-fixture: Exported functions
rem-test: Exported functions
resolve-dependencies: Internal generic functions
resolve-dependencies: Internal generic functions
resolve-dependencies: Internal generic functions
results-status: Exported functions
return-result-list: Internal functions
run: Exported functions
run!: Exported functions
run-all-tests: Exported functions
run-resolving-dependencies: Internal generic functions
run-resolving-dependencies: Internal generic functions
run-test-lambda: Internal generic functions
run-test-lambda: Internal generic functions
runtime-package: Internal generic functions
runtime-package: Internal generic functions

S
signals: Exported macros
skip: Exported macros
status: Internal generic functions
status: Internal generic functions
suite-emptyp: Internal generic functions
suite-emptyp: Internal generic functions
suite-emptyp: Internal generic functions

T
test: Exported macros
test-case: Internal generic functions
test-case: Internal generic functions
test-case: Internal generic functions
test-expr: Internal generic functions
test-expr: Internal generic functions
test-expr: Internal generic functions
test-failure-p: Internal generic functions
test-failure-p: Internal generic functions
test-failure-p: Internal generic functions
test-lambda: Internal generic functions
test-lambda: Internal generic functions
test-names: Exported functions
test-passed-p: Internal generic functions
test-passed-p: Internal generic functions
test-passed-p: Internal generic functions
test-skipped-p: Internal generic functions
test-skipped-p: Internal generic functions
test-skipped-p: Internal generic functions
tests: Internal generic functions
tests: Internal generic functions

V
vars: Internal functions
varsymp: Internal functions

W
with-*test-dribble*: Internal macros
with-fixture: Exported macros
with-run-state: Internal macros

Jump to:   !   %   (  
A   B   C   D   E   F   G   I   L   M   N   P   R   S   T   V   W  

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

A.3 Variables

Jump to:   *  
A   C   D   F   N   P   R   S   T  
Index Entry  Section

*
*!!!*: Internal special variables
*!!*: Internal special variables
*!*: Internal special variables
*debug-on-error*: Exported special variables
*debug-on-failure*: Exported special variables
*default-test-compilation-time*: Exported special variables
*fixture*: Internal special variables
*initial-!*: Internal special variables
*max-trials*: Exported special variables
*num-trials*: Exported special variables
*on-error*: Exported special variables
*on-failure*: Exported special variables
*print-names*: Exported special variables
*run-queue*: Internal special variables
*run-test-when-defined*: Exported special variables
*suite*: Internal special variables
*test*: Internal special variables
*test-dribble*: Exported special variables
*test-dribble-indent*: Internal special variables
*toplevel-suites*: Internal special variables
*verbose-failures*: Exported special variables

A
actual-condition: Internal classes

C
collect-profiling-info: Internal classes

D
depends-on: Internal classes
description: Internal classes

F
failure-values: Internal classes

N
name: Internal classes

P
profiling-info: Internal classes

R
random-state: Internal classes
reason: Internal conditions
reason: Internal classes
result-list: Internal classes
runtime-package: Internal classes

S
Slot, actual-condition: Internal classes
Slot, collect-profiling-info: Internal classes
Slot, depends-on: Internal classes
Slot, description: Internal classes
Slot, failure-values: Internal classes
Slot, name: Internal classes
Slot, profiling-info: Internal classes
Slot, random-state: Internal classes
Slot, reason: Internal conditions
Slot, reason: Internal classes
Slot, result-list: Internal classes
Slot, runtime-package: Internal classes
Slot, status: Internal classes
Slot, test-case: Internal conditions
Slot, test-case: Internal conditions
Slot, test-case: Internal classes
Slot, test-expr: Internal conditions
Slot, test-expr: Internal classes
Slot, test-lambda: Internal classes
Slot, tests: Internal classes
Special Variable, *!!!*: Internal special variables
Special Variable, *!!*: Internal special variables
Special Variable, *!*: Internal special variables
Special Variable, *debug-on-error*: Exported special variables
Special Variable, *debug-on-failure*: Exported special variables
Special Variable, *default-test-compilation-time*: Exported special variables
Special Variable, *fixture*: Internal special variables
Special Variable, *initial-!*: Internal special variables
Special Variable, *max-trials*: Exported special variables
Special Variable, *num-trials*: Exported special variables
Special Variable, *on-error*: Exported special variables
Special Variable, *on-failure*: Exported special variables
Special Variable, *print-names*: Exported special variables
Special Variable, *run-queue*: Internal special variables
Special Variable, *run-test-when-defined*: Exported special variables
Special Variable, *suite*: Internal special variables
Special Variable, *test*: Internal special variables
Special Variable, *test-dribble*: Exported special variables
Special Variable, *test-dribble-indent*: Internal special variables
Special Variable, *toplevel-suites*: Internal special variables
Special Variable, *verbose-failures*: Exported special variables
status: Internal classes

T
test-case: Internal conditions
test-case: Internal conditions
test-case: Internal classes
test-expr: Internal conditions
test-expr: Internal classes
test-lambda: Internal classes
tests: Internal classes

Jump to:   *  
A   C   D   F   N   P   R   S   T  

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

A.4 Data types

Jump to:   C   D   E   F   I   O   P   S   T   U  
Index Entry  Section

C
check-failure: Internal conditions
circular-dependency: Internal conditions
Class, detailed-text-explainer: Internal classes
Class, explainer: Internal classes
Class, for-all-test-failed: Internal classes
Class, for-all-test-never-run: Internal classes
Class, for-all-test-no-tests: Internal classes
Class, for-all-test-passed: Internal classes
Class, for-all-test-result: Internal classes
Class, simple-text-explainer: Internal classes
Class, test-case: Internal classes
Class, test-failure: Internal classes
Class, test-passed: Internal classes
Class, test-result: Internal classes
Class, test-skipped: Internal classes
Class, test-suite: Internal classes
Class, testable-object: Internal classes
Class, text-explainer: Internal classes
Class, unexpected-test-failure: Internal classes
Condition, check-failure: Internal conditions
Condition, circular-dependency: Internal conditions

D
detailed-text-explainer: Internal classes

E
explainer: Internal classes

F
fiveam: The fiveam system
for-all-test-failed: Internal classes
for-all-test-never-run: Internal classes
for-all-test-no-tests: Internal classes
for-all-test-passed: Internal classes
for-all-test-result: Internal classes

I
it.bese.fiveam: The it<dot>bese<dot>fiveam package

O
on-problem-action: Internal types

P
Package, it.bese.fiveam: The it<dot>bese<dot>fiveam package

S
simple-text-explainer: Internal classes
System, fiveam: The fiveam system

T
test-case: Internal classes
test-failure: Internal classes
test-passed: Internal classes
test-result: Internal classes
test-skipped: Internal classes
test-suite: Internal classes
testable-object: Internal classes
text-explainer: Internal classes
Type, on-problem-action: Internal types

U
unexpected-test-failure: Internal classes

Jump to:   C   D   E   F   I   O   P   S   T   U