This is the eos Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jul 13 20:19:54 2025 GMT+0.
The main system appears first, followed by any subsystem dependency.
Modules are listed depth-first from the system components tree.
eos/srceos (system).
package.lisp (file).
utils.lisp (file).
classes.lisp (file).
check.lisp (file).
test.lisp (file).
explain.lisp (file).
suite.lisp (file).
run.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
eos/eos.asdeos/src/package.lispeos/src/utils.lispeos/src/classes.lispeos/src/check.lispeos/src/test.lispeos/src/explain.lispeos/src/suite.lispeos/src/run.lispeos/src/utils.lisppackage.lisp (file).
src (module).
acond2 (macro).
aif (macro).
binding (function).
collect (macro).
ensure-list (function).
find-vars (function).
fun (macro).
list-match (function).
list-match-case (macro).
varsymp (function).
with-gensyms (macro).
eos/src/classes.lisppackage.lisp (file).
src (module).
print-object (method).
depends-on (reader method).
(setf depends-on) (writer method).
description (reader method).
(setf description) (writer method).
detailed-text-explainer (class).
explainer (class).
name (reader method).
(setf name) (writer method).
runtime-package (reader method).
(setf runtime-package) (writer method).
simple-text-explainer (class).
status (reader method).
(setf status) (writer method).
test-case (class).
test-lambda (reader method).
(setf test-lambda) (writer method).
test-suite (class).
testable-object (class).
tests (reader method).
(setf tests) (writer method).
text-explainer (class).
eos/src/check.lisputils.lisp (file).
src (module).
actual-condition (reader method).
(setf actual-condition) (writer method).
add-result (function).
bind-run-state (macro).
check-failure (condition).
process-failure (macro).
reason (reader method).
reason (reader method).
(setf reason) (writer method).
(setf reason) (writer method).
test-case (reader method).
test-case (reader method).
(setf test-case) (writer method).
(setf test-case) (writer method).
test-expr (reader method).
test-expr (reader method).
(setf test-expr) (writer method).
(setf test-expr) (writer method).
test-failure (class).
test-failure-p (generic function).
test-passed (class).
test-passed-p (generic function).
test-result (class).
test-skipped (class).
test-skipped-p (generic function).
unexpected-test-failure (class).
with-*test-dribble* (macro).
with-run-state (macro).
eos/src/test.lispclasses.lisp (file).
src (module).
*run-test-when-defined* (special variable).
get-test (function).
(setf get-test) (function).
rem-test (function).
test (macro).
test-names (function).
*test* (special variable).
eos/src/explain.lispclasses.lisp (file).
check.lisp (file).
src (module).
*verbose-failures* (special variable).
explain (generic function).
partition-results (function).
eos/src/suite.lisptest.lisp (file).
utils.lisp (file).
src (module).
def-suite (macro).
in-suite (macro).
in-suite* (macro).
make-suite (function).
%in-suite (macro).
*suite* (special variable).
def-suite* (macro).
eos/src/run.lispsuite.lisp (file).
check.lisp (file).
src (module).
! (function).
!! (function).
!!! (function).
*debug-on-error* (special variable).
*debug-on-failure* (special variable).
debug! (function).
explain! (function).
results-status (function).
run (function).
run! (function).
%run (generic function).
*!!!* (special variable).
*!!* (special variable).
*!* (special variable).
*initial-!* (special variable).
*run-queue* (special variable).
circular-dependency (condition).
import-testing-symbols (function).
resolve-dependencies (generic function).
return-result-list (function).
run-resolving-dependencies (generic function).
run-test-lambda (generic function).
Packages are listed by definition order.
eoscommon-lisp.
! (function).
!! (function).
!!! (function).
*debug-on-error* (special variable).
*debug-on-failure* (special variable).
*run-test-when-defined* (special variable).
*test-dribble* (special variable).
*verbose-failures* (special variable).
debug! (function).
def-suite (macro).
explain (generic function).
explain! (function).
fail (macro).
finishes (macro).
get-test (function).
(setf get-test) (function).
in-suite (macro).
in-suite* (macro).
is (macro).
is-false (macro).
is-true (macro).
make-suite (function).
pass (macro).
rem-test (function).
results-status (function).
run (function).
run! (function).
signals (macro).
skip (macro).
test (macro).
test-names (function).
%in-suite (macro).
%run (generic function).
*!!!* (special variable).
*!!* (special variable).
*!* (special variable).
*initial-!* (special variable).
*run-queue* (special variable).
*suite* (special variable).
*test* (special variable).
acond2 (macro).
actual-condition (generic reader).
(setf actual-condition) (generic writer).
add-result (function).
aif (macro).
bind-run-state (macro).
binding (function).
check-failure (condition).
circular-dependency (condition).
collect (macro).
def-suite* (macro).
depends-on (generic reader).
(setf depends-on) (generic writer).
description (generic reader).
(setf description) (generic writer).
detailed-text-explainer (class).
ensure-list (function).
explainer (class).
find-vars (function).
fun (macro).
import-testing-symbols (function).
list-match (function).
list-match-case (macro).
name (generic reader).
(setf name) (generic writer).
partition-results (function).
process-failure (macro).
reason (generic reader).
(setf reason) (generic writer).
resolve-dependencies (generic function).
return-result-list (function).
run-resolving-dependencies (generic function).
run-test-lambda (generic function).
runtime-package (generic reader).
(setf runtime-package) (generic writer).
simple-text-explainer (class).
status (generic reader).
(setf status) (generic writer).
test-case (generic reader).
(setf test-case) (generic writer).
test-case (class).
test-expr (generic reader).
(setf test-expr) (generic writer).
test-failure (class).
test-failure-p (generic function).
test-lambda (generic reader).
(setf test-lambda) (generic writer).
test-passed (class).
test-passed-p (generic function).
test-result (class).
test-skipped (class).
test-skipped-p (generic function).
test-suite (class).
testable-object (class).
tests (generic reader).
(setf tests) (generic writer).
text-explainer (class).
unexpected-test-failure (class).
varsymp (function).
with-*test-dribble* (macro).
with-gensyms (macro).
with-run-state (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
T if we should drop into a debugger on error, NIL otherwise.
T if we should drop into a debugger on a failing check, NIL otherwise.
When non-NIL tests are run as soon as they are defined.
T if we should print the expression failing, NIL otherwise.
eos.
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.
eos.
Generates a pass if BODY executes to normal completion. In other words if body does signal, return-from or throw this test fails.
eos.
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*
eos.
Just like in-suite, but silently creates missing suites.
eos.
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 preducse a negated reason string.
eos.
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
eos.
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.
eos.
Generates a pass if BODY signals a condition of type CONDITION. BODY is evaluated in a block named NIL, CONDITION is not evaluated.
eos.
Create a test named NAME. If NAME is a list it must be of the
form:
(name &key depends-on suite fixture compile-at)
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 fixtrue to wrap the body in.
Rerun the most recently run test and explain the results.
Rerun the second most recently run test and explain the results.
Rerun the third most recently run test and explain the results.
Calls (run! test-spec) but enters the debugger if any kind of error happens.
Explain the results of RESULT-LIST using a detailed-text-explainer with output going to *test-dribble*
Create a new test suite object.
Overides any existing suite named NAME.
eos.
Given a list of test results (generated while running a test) return true if all of the results are of type TEST-PASSED, faile otherwise.
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.
Equivalent to (explain (run TEST-SPEC)).
eos.
detailed-text-explainer) results &optional stream recursive-depth) ¶simple-text-explainer) results &optional stream recursive-depth) ¶Table containing all test and test suite objects.
This is a simple WITH-GENSYMS, similar to the one presented in PCL.
eos.
Create a TEST-RESULT object of type RESULT-TYPE passing it the initialize args MAKE-INSTANCE-ARGS and adds the resulting object to the list of test results.
eos.
Run the test function TEST-LAMBDA and return a list of all test results generated, does not modify the special environment variable RESULT-LIST.
Internal method for running a test. Does not update
the status of the tests nor the special vairables !, !!, or !!!
eos.
unexpected-test-failure)) ¶automatically generated reader method
eos.
unexpected-test-failure)) ¶automatically generated writer method
eos.
testable-object)) ¶testable-object)) ¶The list of AND, OR, NOT forms specifying when to run this test.
eos.
testable-object)) ¶testable-object)) ¶The textual description of this test object.
eos.
testable-object)) ¶testable-object)) ¶A symbol naming this test object.
name.
eos.
check-failure)) ¶test-result)) ¶automatically generated reader method
eos.
check-failure)) ¶test-result)) ¶automatically generated writer method
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.
eos.
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
eos.
check-failure)) ¶test-result)) ¶automatically generated reader method
eos.
check-failure)) ¶test-result)) ¶automatically generated writer method
eos.
check-failure)) ¶test-result)) ¶automatically generated reader method
eos.
check-failure)) ¶test-result)) ¶automatically generated writer method
eos.
test-failure)) ¶eos.
test-passed)) ¶eos.
test-skipped)) ¶eos.
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.
Signaled when a check fails.
Condition signaled when a circular dependency between test-cases has been detected.
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.
Class for unsuccessful checks.
eos.
Class for successful checks.
eos.
All checking macros will generate an object of type TEST-RESULT.
A test which was not run. Usually this is due
to unsatisfied dependencies, but users can decide to skip test
when appropiate.
eos.
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.
eos.
The textual description of this test object.
:description
The list of AND, OR, NOT forms specifying when to run this test.
:depends-on
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
:unknown
:status
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.
| Jump to: | !
%
(
A B C D E F G I L M N P R S T V W |
|---|
| Jump to: | !
%
(
A B C D E F G I L M N P R S T V W |
|---|
| Jump to: | *
A D N R S T |
|---|
| Jump to: | *
A D N R S T |
|---|
| Jump to: | C D E F M P R S T U |
|---|
| Jump to: | C D E F M P R S T U |
|---|