The eos Reference Manual

Table of Contents

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

The eos Reference Manual

This is the eos Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 08:36:40 2018 GMT+0.


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

1 Introduction

Eos was a unit testing library for Common Lisp.

It began as a fork of FiveAM; however, FiveAM development has continued, while that of Eos has not. Thus, Eos is now deprecated in favor of FiveAM.


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 eos

Author

Adlai Chandrasekhar

License

MIT

Description

UNMAINTAINED fork of 5AM, a test framework

Source

eos.asd (file)

Component

src (module)


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

3 Modules

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


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

3.1 eos/src

Parent

eos (system)

Location

src/

Components

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

4 Files

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


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

4.1 Lisp


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

4.1.1 eos.asd

Location

eos.asd

Systems

eos (system)


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

4.1.2 eos/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

eos


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

4.1.3 eos/src/utils.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/utils.lisp

Internal Definitions

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

4.1.4 eos/src/classes.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/classes.lisp

Internal Definitions

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

4.1.5 eos/src/check.lisp

Dependency

utils.lisp (file)

Parent

src (module)

Location

src/check.lisp

Exported Definitions
Internal Definitions

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

4.1.6 eos/src/test.lisp

Dependency

classes.lisp (file)

Parent

src (module)

Location

src/test.lisp

Exported Definitions
Internal Definitions

*test* (special variable)


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

4.1.7 eos/src/explain.lisp

Dependencies
Parent

src (module)

Location

src/explain.lisp

Exported Definitions
Internal Definitions

partition-results (function)


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

4.1.8 eos/src/suite.lisp

Dependencies
Parent

src (module)

Location

src/suite.lisp

Exported Definitions
Internal Definitions

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

4.1.9 eos/src/run.lisp

Dependencies
Parent

src (module)

Location

src/run.lisp

Exported Definitions
Internal Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 eos

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

6 Definitions

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


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

6.1 Exported definitions


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

6.1.1 Special variables

Special Variable: *debug-on-error*

T if we should drop into a debugger on error, NIL otherwise.

Package

eos

Source

run.lisp (file)

Special Variable: *debug-on-failure*

T if we should drop into a debugger on a failing check, NIL otherwise.

Package

eos

Source

run.lisp (file)

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

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

Package

eos

Source

test.lisp (file)

Special Variable: *test-dribble*
Package

eos

Source

check.lisp (file)

Special Variable: *verbose-failures*

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

Package

eos

Source

explain.lisp (file)


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

6.1.2 Macros

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

eos

Source

suite.lisp (file)

Macro: fail &rest MESSAGE-ARGS

Simply generate a FAIL.

Package

eos

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

eos

Source

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

eos

Source

suite.lisp (file)

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

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

Package

eos

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 preducse a negated reason string.

Package

eos

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

eos

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

eos

Source

check.lisp (file)

Macro: pass &rest MESSAGE-ARGS

Simply generate a PASS.

Package

eos

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

eos

Source

check.lisp (file)

Macro: skip &rest REASON

Generates a TEST-SKIPPED result.

Package

eos

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)

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.

Package

eos

Source

test.lisp (file)


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

6.1.3 Functions

Function: ! ()

Rerun the most recently run test and explain the results.

Package

eos

Source

run.lisp (file)

Function: !! ()

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

Package

eos

Source

run.lisp (file)

Function: !!! ()

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

Package

eos

Source

run.lisp (file)

Function: debug! &optional TEST-SPEC

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

Package

eos

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*

Package

eos

Source

run.lisp (file)

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

eos

Source

test.lisp (file)

Function: make-suite NAME &key DESCRIPTION IN

Create a new test suite object.

Overides any existing suite named NAME.

Package

eos

Source

suite.lisp (file)

Function: rem-test KEY
Package

eos

Source

test.lisp (file)

Function: results-status RESULT-LIST

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.

Package

eos

Source

run.lisp (file)

Function: run TEST-SPEC

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

eos

Source

run.lisp (file)

Function: run! &optional TEST-SPEC

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

Package

eos

Source

run.lisp (file)

Function: test-names ()
Package

eos

Source

test.lisp (file)


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

6.1.4 Generic functions

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

eos

Source

explain.lisp (file)

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

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

6.2 Internal definitions


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

6.2.1 Special variables

Special Variable: *!!!*
Package

eos

Source

run.lisp (file)

Special Variable: *!!*
Package

eos

Source

run.lisp (file)

Special Variable: *!*
Package

eos

Source

run.lisp (file)

Special Variable: *initial-!*
Package

eos

Source

run.lisp (file)

Special Variable: *run-queue*

List of test waiting to be run.

Package

eos

Source

run.lisp (file)

Special Variable: *suite*

The current test suite object

Package

eos

Source

suite.lisp (file)

Special Variable: *test*

Table containing all test and test suite objects.

Package

eos

Source

test.lisp (file)


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

6.2.2 Macros

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

eos

Source

suite.lisp (file)

Macro: acond2 &rest CLAUSES
Package

eos

Source

utils.lisp (file)

Macro: aif TEST TRUE &optional FALSE
Package

eos

Source

utils.lisp (file)

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

eos

Source

check.lisp (file)

Macro: collect NAMES &body BODY
Package

eos

Source

utils.lisp (file)

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

eos

Source

suite.lisp (file)

Macro: fun &body BODY
Package

eos

Source

utils.lisp (file)

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

eos

Source

utils.lisp (file)

Macro: process-failure &rest ARGS
Package

eos

Source

check.lisp (file)

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

eos

Source

check.lisp (file)

Macro: with-gensyms (&rest SYMS) &body BODY

This is a simple WITH-GENSYMS, similar to the one presented in PCL.

Package

eos

Source

utils.lisp (file)

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

eos

Source

check.lisp (file)


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

6.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 adds the resulting object to the list of test results.

Package

eos

Source

check.lisp (file)

Function: binding X BINDS
Package

eos

Source

utils.lisp (file)

Function: ensure-list X
Package

eos

Source

utils.lisp (file)

Function: find-vars SPEC ACC
Package

eos

Source

utils.lisp (file)

Function: import-testing-symbols PACKAGE-DESIGNATOR
Package

eos

Source

run.lisp (file)

Function: list-match X Y &optional BINDS
Package

eos

Source

utils.lisp (file)

Function: partition-results RESULTS-LIST
Package

eos

Source

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

eos

Source

run.lisp (file)

Function: varsymp X
Package

eos

Source

utils.lisp (file)


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

6.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 vairables !, !!, or !!!

Package

eos

Source

run.lisp (file)

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

eos

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: depends-on OBJECT
Generic Function: (setf depends-on) NEW-VALUE OBJECT
Package

eos

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

eos

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: name OBJECT
Generic Function: (setf name) NEW-VALUE OBJECT
Package

eos

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: reason OBJECT
Generic Function: (setf reason) NEW-VALUE OBJECT
Package

eos

Methods
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

eos

Source

run.lisp (file)

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

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

Method: resolve-dependencies (DEPENDS-ON list)

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

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

eos

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

eos

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

eos

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

eos

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: test-case OBJECT
Generic Function: (setf test-case) NEW-VALUE OBJECT
Package

eos

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

eos

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

eos

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

eos

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

eos

Source

check.lisp (file)

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

eos

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

eos

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]

6.2.5 Conditions

Condition: check-failure ()

Signaled when a check fails.

Package

eos

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

eos

Source

run.lisp (file)

Direct superclasses

error (condition)

Direct slots
Slot: test-case
Initargs

:test-case


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

6.2.6 Classes

Class: detailed-text-explainer ()
Package

eos

Source

classes.lisp (file)

Direct superclasses

text-explainer (class)

Direct methods

explain (method)

Class: explainer ()
Package

eos

Source

classes.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

text-explainer (class)

Class: simple-text-explainer ()
Package

eos

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

eos

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

eos

Source

check.lisp (file)

Direct superclasses

test-result (class)

Direct subclasses

unexpected-test-failure (class)

Direct methods

test-failure-p (method)

Class: test-passed ()

Class for successful checks.

Package

eos

Source

check.lisp (file)

Direct superclasses

test-result (class)

Direct methods

test-passed-p (method)

Class: test-result ()

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

Package

eos

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 test when appropiate.

Package

eos

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

eos

Source

classes.lisp (file)

Direct superclasses

testable-object (class)

Direct methods
  • %run (method)
  • tests (method)
  • tests (method)
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

eos

Source

classes.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
  • print-object (method)
  • status (method)
  • status (method)
  • depends-on (method)
  • depends-on (method)
  • description (method)
  • description (method)
  • name (method)
  • name (method)
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)

Class: text-explainer ()
Package

eos

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

eos

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: Top   [Contents][Index]

Appendix A Indexes


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

A.1 Concepts

Jump to:   E   F   L   M  
Index Entry  Section

E
eos.asd: The eos<dot>asd file
eos/src: The eos/src module
eos/src/check.lisp: The eos/src/check<dot>lisp file
eos/src/classes.lisp: The eos/src/classes<dot>lisp file
eos/src/explain.lisp: The eos/src/explain<dot>lisp file
eos/src/package.lisp: The eos/src/package<dot>lisp file
eos/src/run.lisp: The eos/src/run<dot>lisp file
eos/src/suite.lisp: The eos/src/suite<dot>lisp file
eos/src/test.lisp: The eos/src/test<dot>lisp file
eos/src/utils.lisp: The eos/src/utils<dot>lisp file

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

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

M
Module, eos/src: The eos/src module

Jump to:   E   F   L   M  

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 depends-on): Internal generic functions
(setf depends-on): Internal generic functions
(setf description): Internal generic functions
(setf description): Internal generic functions
(setf get-test): Exported functions
(setf name): Internal generic functions
(setf name): 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
binding: Internal functions

C
collect: Internal macros

D
debug!: Exported functions
def-suite: Exported macros
def-suite*: Internal macros
depends-on: Internal generic functions
depends-on: Internal generic functions
description: Internal generic functions
description: Internal generic functions

E
ensure-list: Internal functions
explain: Exported generic functions
explain: Exported generic functions
explain: Exported generic functions
explain!: Exported functions

F
fail: Exported macros
find-vars: Internal functions
finishes: Exported macros
fun: Internal macros
Function, !: Exported functions
Function, !!: Exported functions
Function, !!!: Exported functions
Function, (setf get-test): Exported functions
Function, add-result: Internal functions
Function, binding: Internal functions
Function, debug!: Exported functions
Function, ensure-list: Internal functions
Function, explain!: Exported functions
Function, find-vars: Internal functions
Function, get-test: Exported functions
Function, import-testing-symbols: Internal functions
Function, list-match: Internal functions
Function, make-suite: Exported functions
Function, partition-results: Internal 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, test-names: Exported functions
Function, varsymp: Internal functions

G
Generic Function, %run: Internal generic functions
Generic Function, (setf actual-condition): 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 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, depends-on: Internal generic functions
Generic Function, description: Internal generic functions
Generic Function, explain: Exported generic functions
Generic Function, name: 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, 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-test: Exported functions

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

L
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, collect: Internal macros
Macro, def-suite: Exported macros
Macro, def-suite*: Internal macros
Macro, fail: Exported macros
Macro, finishes: Exported macros
Macro, fun: Internal macros
Macro, in-suite: Exported macros
Macro, in-suite*: Exported macros
Macro, is: Exported macros
Macro, is-false: Exported macros
Macro, is-true: Exported macros
Macro, list-match-case: Internal macros
Macro, pass: Exported macros
Macro, process-failure: Internal macros
Macro, signals: Exported macros
Macro, skip: Exported macros
Macro, test: Exported macros
Macro, with-*test-dribble*: Internal macros
Macro, with-gensyms: Internal macros
Macro, with-run-state: Internal macros
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 depends-on): Internal generic functions
Method, (setf description): Internal generic functions
Method, (setf name): 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, depends-on: Internal generic functions
Method, description: Internal generic functions
Method, explain: Exported generic functions
Method, explain: Exported generic functions
Method, name: 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, 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
pass: Exported macros
process-failure: Internal macros

R
reason: Internal generic functions
reason: Internal generic functions
reason: Internal generic 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-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

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
varsymp: Internal functions

W
with-*test-dribble*: Internal macros
with-gensyms: Internal 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   D   N   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
*initial-!*: Internal 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
*verbose-failures*: Exported special variables

A
actual-condition: Internal classes

D
depends-on: Internal classes
description: Internal classes

N
name: Internal classes

R
reason: Internal conditions
reason: Internal classes
runtime-package: Internal classes

S
Slot, actual-condition: Internal classes
Slot, depends-on: Internal classes
Slot, description: Internal classes
Slot, name: Internal classes
Slot, reason: Internal conditions
Slot, reason: 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, *initial-!*: Internal 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, *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   D   N   R   S   T  

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

A.4 Data types

Jump to:   C   D   E   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, 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
eos: The eos system
eos: The eos package
explainer: Internal classes

P
Package, eos: The eos package

S
simple-text-explainer: Internal classes
System, eos: The eos 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

U
unexpected-test-failure: Internal classes

Jump to:   C   D   E   P   S   T   U