This is the xlunit Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 07:09:15 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
xlunitExtreme Lisp Testing Suite
Kevin M. Rosenberg <kmr@debian.org>
Kevin Rosenberg based on work by Craig Brozensky
BSD
The XLUnit package is toolkit for building test suites. It is based on the XPTest package by Craig Brozensky and the JUnit package by Kent Beck.
package.lisp (file).
assert.lisp (file).
tcase.lisp (file).
listener.lisp (file).
result.lisp (file).
suite.lisp (file).
textui.lisp (file).
printer.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
xlunit/xlunit.asdxlunit/package.lispxlunit/assert.lispxlunit/tcase.lispxlunit/listener.lispxlunit/result.lispxlunit/suite.lispxlunit/textui.lispxlunit/printer.lispxlunit/assert.lisppackage.lisp (file).
xlunit (system).
assert-condition (macro).
assert-eql (function).
assert-equal (function).
assert-false (macro).
assert-not-eql (function).
assert-true (macro).
failure (function).
print-object (method).
assert-not-condition (macro).
assertion-failed (condition).
failure-message (function).
message (reader method).
(setf message) (writer method).
xlunit/tcase.lispassert.lisp (file).
xlunit (system).
initialize-instance (method).
run (method).
run-on-test-results (method).
run-test (method).
set-up (generic function).
suite (reader method).
(setf suite) (writer method).
tear-down (generic function).
test (class).
test-case (class).
description (reader method).
existing-suites (reader method).
(setf existing-suites) (writer method).
method-body (reader method).
(setf method-body) (writer method).
name (reader method).
run-base (method).
run-protected (method).
xlunit/listener.lisptcase.lisp (file).
xlunit (system).
end-test (method).
start-test (method).
test-listener (class).
xlunit/result.lisplistener.lisp (file).
xlunit (system).
make-test-results (function).
print-object (method).
test-results (class).
was-successful (method).
add-error (method).
add-failure (method).
add-listener (method).
end-test (method).
error-count (method).
errors (reader method).
(setf errors) (writer method).
failed-test (reader method).
failure-count (method).
failures (reader method).
(setf failures) (writer method).
is-failure (method).
listeners (reader method).
(setf listeners) (writer method).
make-test-failure (function).
result-test (reader method).
run-tests (reader method).
(setf run-tests) (writer method).
start-test (method).
stop (reader method).
(setf stop) (writer method).
test-failure (class).
thrown-condition (reader method).
xlunit/suite.lispresult.lisp (file).
xlunit (system).
add-test (method).
def-test-method (macro).
get-suite (macro).
named-test (method).
remove-test (method).
run-on-test-results (method).
test-suite (class).
tests (reader method).
(setf tests) (writer method).
description (reader method).
find-test-generic-functions (function).
test-suite-name (reader method).
xlunit/textui.lispsuite.lisp (file).
xlunit (system).
textui-test-run (method).
add-error (method).
add-failure (method).
ostream (reader method).
(setf ostream) (writer method).
start-test (method).
textui-test-runner (class).
xlunit/printer.lisptextui.lisp (file).
xlunit (system).
summary (generic function).
print-defects (method).
print-footer (method).
print-header (method).
print-results (method).
Packages are listed by definition order.
xlunitThis is the XLUnit Framework.
common-lisp.
add-test (generic function).
assert-condition (macro).
assert-eql (function).
assert-equal (function).
assert-false (macro).
assert-not-eql (function).
assert-true (macro).
def-test-method (macro).
failure (function).
get-suite (macro).
make-test-results (function).
named-test (generic function).
remove-test (generic function).
run (generic function).
run-on-test-results (generic function).
run-test (generic function).
set-up (generic function).
suite (generic reader).
(setf suite) (generic writer).
summary (generic function).
tear-down (generic function).
test (class).
test-case (class).
test-results (class).
test-suite (class).
tests (generic reader).
(setf tests) (generic writer).
textui-test-run (generic function).
was-successful (generic function).
add-error (generic function).
add-failure (generic function).
add-listener (generic function).
assert-not-condition (macro).
assertion-failed (condition).
description (generic reader).
end-test (generic function).
error-count (generic function).
errors (generic reader).
(setf errors) (generic writer).
existing-suites (generic reader).
(setf existing-suites) (generic writer).
failed-test (generic reader).
failure-count (generic function).
failure-message (function).
failures (generic reader).
(setf failures) (generic writer).
find-test-generic-functions (function).
is-failure (generic function).
listeners (generic reader).
(setf listeners) (generic writer).
make-test-failure (function).
message (generic reader).
(setf message) (generic writer).
method-body (generic reader).
(setf method-body) (generic writer).
name (generic reader).
ostream (generic reader).
(setf ostream) (generic writer).
print-defects (generic function).
print-footer (generic function).
print-header (generic function).
print-results (generic function).
result-test (generic reader).
run-base (generic function).
run-protected (generic function).
run-tests (generic reader).
(setf run-tests) (generic writer).
start-test (generic function).
stop (generic reader).
(setf stop) (generic writer).
test-failure (class).
test-listener (class).
test-suite-name (generic reader).
textui-test-runner (class).
thrown-condition (generic reader).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Signal a test failure and exit the test.
test-suite) (new-test test)) ¶test-suite)) ¶test) (suite test-suite)) ¶test-suite) (result test-results) &key handle-errors) ¶Method called before performing a test, should set up the environment the test-case needs to operate in.
test-results)) ¶Method called after performing a test. Should reverse everything that the setup method did for this instance.
test-suite)) ¶automatically generated reader method
test-suite)) ¶automatically generated writer method
test-results)) ¶Returns T if a result has no failures or errors
assertion-failed) stream) ¶test-failure) stream) ¶Base class for test-cases.
test.
:class
A function designator which will be applied to this instance to perform that test-case.
:method-body
The name of this test-case, used in reports.
""
:name
name.
This slot is read-only.
Short description of this test-case, uses in reports
:description
This slot is read-only.
:suite
Results of running test(s)
:test
This slot is read-only.
common-lisp.
0
:failures
:errors
test.
""
:name
This slot is read-only.
:tests
"no description."
:description
This slot is read-only.
Signal a test failure and exit the test.
Return a list of symbols for generic functions specialized on the class of an instance and whose name begins with the string ’test-’. This is used to dynamically generate a list of tests for a fixture.
textui-test-runner) test-case condition) ¶test-results) (tcase test-case) condition) ¶textui-test-runner) test-case condition) ¶test-results) (tcase test-case) condition) ¶test-results) (listener test-listener)) ¶test-suite)) ¶automatically generated reader method
test) (res test-results)) ¶test-listener) tcase) ¶test-results)) ¶test-results)) ¶automatically generated reader method
test-results)) ¶automatically generated writer method
test-failure)) ¶automatically generated reader method
test-results)) ¶test-results)) ¶automatically generated reader method
test-results)) ¶automatically generated writer method
test-failure)) ¶Returns T if a failure was a test-failure condition
test-results)) ¶automatically generated reader method
test-results)) ¶automatically generated writer method
assertion-failed)) ¶assertion-failed)) ¶textui-test-runner)) ¶automatically generated reader method
textui-test-runner)) ¶automatically generated writer method
textui-test-runner) defects title) ¶textui-test-runner) result seconds) ¶textui-test-runner) result seconds) ¶test-results)) ¶automatically generated reader method
test.
test-results)) ¶automatically generated reader method
test-results)) ¶automatically generated writer method
textui-test-runner) test-case) ¶test) (res test-results)) ¶test-listener) tcase) ¶test-results)) ¶automatically generated reader method
stop.
test-results)) ¶automatically generated writer method
stop.
test-suite)) ¶automatically generated reader method
name.
test-failure)) ¶automatically generated reader method
Base class for all test failures.
simple-condition.
(quote nil)
:message
Stored failures/errors in test-results slots
| Initarg | Value |
|---|---|
:ostream | *standard-output* |
:ostream
| Jump to: | (
A D E F G I L M N O P R S T W |
|---|
| Jump to: | (
A D E F G I L M N O P R S T W |
|---|
| Jump to: | C D E F L M N O S T |
|---|
| Jump to: | C D E F L M N O S T |
|---|
| Jump to: | A C F L P R S T X |
|---|
| Jump to: | A C F L P R S T X |
|---|