This is the fiasco Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 05:10:25 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
fiascoA Common Lisp test framework that treasures your failures, logical continuation of Stefil.
João Távora
BSD 2-clause
alexandria (system).
trivial-gray-streams (system).
src (module).
Modules are listed depth-first from the system components tree.
fiasco/srcfiasco (system).
package.lisp (file).
streams.lisp (file).
infrastructure.lisp (file).
asserts.lisp (file).
test.lisp (file).
suite.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
fiasco/fiasco.asdfiasco/src/package.lispfiasco/src/streams.lispfiasco/src/infrastructure.lispfiasco/src/asserts.lispfiasco/src/test.lispfiasco/src/suite.lispfiasco/src/streams.lisppackage.lisp (file).
src (module).
stream-line-column (method).
stream-start-line-p (method).
stream-write-char (method).
stream-write-sequence (method).
column-counting-output-stream (class).
output-column (reader method).
(setf output-column) (writer method).
fiasco/src/infrastructure.lispstreams.lisp (file).
src (module).
*always-show-failed-sexp* (special variable).
*debug-on-assertion-failure* (special variable).
*debug-on-unexpected-error* (special variable).
*ignore-package-suite-mismatch* (special variable).
*last-test-result* (special variable).
*print-test-run-progress* (special variable).
*test-progress-print-right-margin* (special variable).
*test-result-history* (special variable).
*warn-about-test-redefinitions* (special variable).
describe-object (method).
describe-object (method).
describe-object (method).
describe-object (method).
extract-test-run-statistics (function).
find-test (function).
(setf find-test) (function).
funcall-test-with-feedback-message (function).
initialize-instance (method).
print-object (method).
print-object (method).
print-object (method).
run-failed-tests (function).
shared-initialize (method).
shared-initialize (method).
with-expected-failures (macro).
without-debugging (macro).
without-test-progress-printing (macro).
*context* (special variable).
*current-test* (special variable).
*failures-and-errors-are-expected* (special variable).
*package-bound-suites* (special variable).
*root-suite* (special variable).
*suite* (special variable).
*test-run-standard-output* (special variable).
*tests* (special variable).
actual-test-arguments-of (reader method).
(setf actual-test-arguments-of) (writer method).
all-test-runs-of (function).
assertions-of (generic function).
auto-call? (reader method).
(setf auto-call?) (writer method).
check-required (macro).
children-contexts-of (reader method).
(setf children-contexts-of) (writer method).
children-of (reader method).
(setf children-of) (writer method).
context (class).
context-of (reader method).
(setf context-of) (writer method).
count-tests (generic function).
delete-test (function).
error-of (reader method).
(setf error-of) (writer method).
expected-condition-type-of (reader method).
expected-condition-type-of (reader method).
expected-condition-type-of (reader method).
expected-condition-type-of (reader method).
(setf expected-condition-type-of) (writer method).
(setf expected-condition-type-of) (writer method).
(setf expected-condition-type-of) (writer method).
(setf expected-condition-type-of) (writer method).
expected-p (reader method).
(setf expected-p) (writer method).
failed-assertion (condition).
failure (condition).
failures-of (generic function).
finishes-assertion (condition).
form-of (reader method).
form-of (reader method).
form-of (reader method).
form-of (reader method).
(setf form-of) (writer method).
(setf form-of) (writer method).
(setf form-of) (writer method).
(setf form-of) (writer method).
illegal-lambda-list (function).
illegal-lambda-list (condition).
internal-realtime-spent-with-test-of (reader method).
(setf internal-realtime-spent-with-test-of) (writer method).
is-assertion (condition).
lambda-list-of (reader method).
(setf lambda-list-of) (writer method).
lambda-list-to-funcall-expression (function).
lambda-list-to-funcall-list (function).
lambda-list-to-value-list-expression (function).
lambda-list-to-variable-name-list (function).
message-args-of (reader method).
(setf message-args-of) (writer method).
message-of (reader method).
(setf message-of) (writer method).
missing-condition (condition).
name-of (reader method).
(setf name-of) (writer method).
not-signals-assertion (condition).
observed-condition-of (reader method).
(setf observed-condition-of) (writer method).
parent-context-of (reader method).
(setf parent-context-of) (writer method).
(setf parent-context-of) (method).
(setf parent-context-of) (method).
parent-of (reader method).
(setf parent-of) (writer method).
(setf parent-of) (method).
parse-lambda-list (function).
progress-char-of (reader method).
progress-char-of (reader method).
(setf progress-char-of) (writer method).
(setf progress-char-of) (writer method).
real-time-spent-in-seconds (generic function).
signals-assertion (condition).
skipped-p (reader method).
(setf skipped-p) (writer method).
skips-of (generic function).
test-assertion (condition).
test-of (reader method).
test-of (reader method).
(setf test-of) (writer method).
(setf test-of) (writer method).
test-related-condition (condition).
test-skipped (condition).
test-started (condition).
test-style-warning (condition).
testable (class).
unexpected-error (condition).
unwanted-condition (condition).
with-expected-failures* (macro).
with-toplevel-restarts (macro).
fiasco/src/asserts.lispinfrastructure.lisp (file).
src (module).
finishes (macro).
is (macro).
not-signals (macro).
signals (macro).
skip (function).
skip-unless (macro).
*progress-char-count* (special variable).
extract-assert-expression-and-message (function).
record-failure (function).
register-assertion-was-successful (function).
write-progress-char (function).
fiasco/src/test.lispasserts.lisp (file).
src (module).
deftest (macro).
*run-test-function* (special variable).
body-of (reader method).
(setf body-of) (writer method).
call-with-test-handlers (function).
compile-before-run-p (reader method).
(setf compile-before-run-p) (writer method).
declarations-of (reader method).
(setf declarations-of) (writer method).
documentation-of (reader method).
(setf documentation-of) (writer method).
ensure-test (function).
lambda-list-of (reader method).
(setf lambda-list-of) (writer method).
package-of (reader method).
(setf package-of) (writer method).
run-test-body-in-handlers (function).
test (class).
fiasco/src/suite.lisptest.lisp (file).
src (module).
all-tests (function).
define-test-package (macro).
defsuite (macro).
describe-failed-tests (function).
run-package-tests (function).
run-suite-tests (function).
run-tests (function).
*pretty-log-stream* (special variable).
*pretty-log-verbose-p* (special variable).
*within-non-suite-test* (special variable).
all-tests (function).
find-suite-for-package (function).
indented-format (function).
make-suite (function).
pretty-run-test (function).
Packages are listed by definition order.
fiasco-suites~
Namespace for Fiasco suites defined via DEFINE-TEST-PACKAGE.
all-tests (function).
fiascoalexandria.
common-lisp.
*always-show-failed-sexp* (special variable).
*debug-on-assertion-failure* (special variable).
*debug-on-unexpected-error* (special variable).
*ignore-package-suite-mismatch* (special variable).
*last-test-result* (special variable).
*print-test-run-progress* (special variable).
*test-progress-print-right-margin* (special variable).
*test-result-history* (special variable).
*warn-about-test-redefinitions* (special variable).
all-tests (function).
define-test-package (macro).
defsuite (macro).
deftest (macro).
describe-failed-tests (function).
extract-test-run-statistics (function).
find-test (function).
(setf find-test) (function).
finishes (macro).
funcall-test-with-feedback-message (function).
is (macro).
not-signals (macro).
run-failed-tests (function).
run-package-tests (function).
run-suite-tests (function).
run-tests (function).
signals (macro).
skip (function).
skip-unless (macro).
with-expected-failures (macro).
without-debugging (macro).
without-test-progress-printing (macro).
*context* (special variable).
*current-test* (special variable).
*failures-and-errors-are-expected* (special variable).
*package-bound-suites* (special variable).
*pretty-log-stream* (special variable).
*pretty-log-verbose-p* (special variable).
*progress-char-count* (special variable).
*root-suite* (special variable).
*run-test-function* (special variable).
*suite* (special variable).
*test-run-standard-output* (special variable).
*tests* (special variable).
*within-non-suite-test* (special variable).
actual-test-arguments-of (generic reader).
(setf actual-test-arguments-of) (generic writer).
all-test-runs-of (function).
assertions-of (generic function).
auto-call? (generic reader).
(setf auto-call?) (generic writer).
body-of (generic reader).
(setf body-of) (generic writer).
call-with-test-handlers (function).
check-required (macro).
children-contexts-of (generic reader).
(setf children-contexts-of) (generic writer).
children-of (generic reader).
(setf children-of) (generic writer).
column-counting-output-stream (class).
compile-before-run-p (generic reader).
(setf compile-before-run-p) (generic writer).
context (class).
context-of (generic reader).
(setf context-of) (generic writer).
count-tests (generic function).
declarations-of (generic reader).
(setf declarations-of) (generic writer).
delete-test (function).
documentation-of (generic reader).
(setf documentation-of) (generic writer).
ensure-test (function).
error-of (generic reader).
(setf error-of) (generic writer).
expected-condition-type-of (generic reader).
(setf expected-condition-type-of) (generic writer).
expected-p (generic reader).
(setf expected-p) (generic writer).
extract-assert-expression-and-message (function).
failed-assertion (condition).
failure (condition).
failures-of (generic function).
find-suite-for-package (function).
finishes-assertion (condition).
form-of (generic reader).
(setf form-of) (generic writer).
illegal-lambda-list (function).
illegal-lambda-list (condition).
indented-format (function).
internal-realtime-spent-with-test-of (generic reader).
(setf internal-realtime-spent-with-test-of) (generic writer).
is-assertion (condition).
lambda-list-of (generic reader).
(setf lambda-list-of) (generic writer).
lambda-list-to-funcall-expression (function).
lambda-list-to-funcall-list (function).
lambda-list-to-value-list-expression (function).
lambda-list-to-variable-name-list (function).
make-suite (function).
message-args-of (generic reader).
(setf message-args-of) (generic writer).
message-of (generic reader).
(setf message-of) (generic writer).
missing-condition (condition).
name-of (generic reader).
(setf name-of) (generic writer).
not-signals-assertion (condition).
observed-condition-of (generic reader).
(setf observed-condition-of) (generic writer).
output-column (generic reader).
(setf output-column) (generic writer).
package-of (generic reader).
(setf package-of) (generic writer).
parent-context-of (generic reader).
(setf parent-context-of) (generic function).
parent-of (generic reader).
(setf parent-of) (generic function).
parse-lambda-list (function).
pretty-run-test (function).
progress-char-of (generic reader).
(setf progress-char-of) (generic writer).
real-time-spent-in-seconds (generic function).
record-failure (function).
register-assertion-was-successful (function).
run-test-body-in-handlers (function).
signals-assertion (condition).
skipped-p (generic reader).
(setf skipped-p) (generic writer).
skips-of (generic function).
test (class).
test-assertion (condition).
test-of (generic reader).
(setf test-of) (generic writer).
test-related-condition (condition).
test-skipped (condition).
test-started (condition).
test-style-warning (condition).
testable (class).
unexpected-error (condition).
unwanted-condition (condition).
with-expected-failures* (macro).
with-toplevel-restarts (macro).
write-progress-char (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Defines a new package and binds to it a new test suite.
The binding between package and suite means that tests defined while
inside this package are automatically added to the associated
suite. Inside the new package, the function RUN-PACKAGE-TESTS is the
preferred way to execute the suite. To run the tests from outside, use
RUN-TESTS.
NAME-OR-NAME-WITH-ARGS names the package and suite to create. It is
either a single symbol NAME, or a list (NAME :IN PARENT-SUITE) where
PARENT-SUITE designated the Fiasco suite previously created with
DEFSUITE that should parent the newly created suite.
Package NAME is defined via normal ‘defpackage’, and in addition to processing PACKAGE-OPTIONS, automatically USES the :FIASCO and :CL packages.
Run BODY registering failured conditions as expected failures.
Run all currently defined tests.
Prints out a report for RESULT in STREAM.
RESULT defaults to ‘*last-test-result*’ and STREAM defaults to t
Find and return test associated with NAME.
If no such thing is found, OTHERWISE says what do to: if :ERROR, signal error; if a function, call it; else return OTHERWISE.
Run TEST non-interactively and print results to *STANDARD-OUTPUT*. This function is ideal for ASDF:TEST-OP’s.
Execute test suite(s) associated with PACKAGE or PACKAGES.
PACKAGE defaults to the current package. Don’t supply both both
PACKAGE and PACKAGES.
See RUN-TESTS for the meaning of the remaining keyword arguments.
Execute tests designated by TESTABLE.
Returns two values:
1. A boolean indicating whether all tests were successful, and
2. A list of objects containing test results for each executed suite.
TESTABLE can be a test or suite designator as accepted by
FIND-TEST, or a package designator for a package associated with a
test suite, or a list composed of any combination of the above.
With optional INTERACTIVE, run tests interactively, i.e. break on
errors and unexpected assertion failures.
With optional DESCRIBE-FAILURES, T by default, describe failures to
optional STREAM, which defaults to *STANDARD-OUTPUT*.
With optional VERBOSE print more information about each test run, like its docstring.
missing-condition) stream) ¶failed-assertion) stream) ¶unexpected-error) stream) ¶unwanted-condition) stream) ¶unexpected-error) stream) ¶column-counting-output-stream)) ¶Tell column number that stream S is currently at.
sb-gray.
column-counting-output-stream)) ¶Tell if stream S is already at start of fresh new line.
sb-gray.
column-counting-output-stream) char) ¶Write CHAR to stream S.
sb-gray.
column-counting-output-stream) seq start end &key) ¶Write SEQ to stream S.
trivial-gray-streams.
Status and progress info for a particular test run.
Current singleton instance of TEST executing its associated DEFTEST lambda.
*STANDARD-OUTPUT* is bound to (eval *test-run-standard-output*) at the toplevel entry point to any test.
True within the scope of a non-suite test. Used to suppress printing test status for recursive test calls.
Run BODY and registering failure conditions as expected failure iff CONDITION.
unexpected-error)) ¶unexpected-error)) ¶unwanted-condition)) ¶unwanted-condition)) ¶missing-condition)) ¶missing-condition)) ¶not-signals-assertion)) ¶not-signals-assertion)) ¶signals-assertion)) ¶signals-assertion)) ¶unwanted-condition)) ¶unwanted-condition)) ¶form.
missing-condition)) ¶missing-condition)) ¶form.
failed-assertion)) ¶failed-assertion)) ¶form.
is-assertion)) ¶is-assertion)) ¶form.
test)) ¶automatically generated reader method
illegal-lambda-list)) ¶test)) ¶automatically generated writer method
illegal-lambda-list)) ¶is-assertion)) ¶is-assertion)) ¶is-assertion)) ¶is-assertion)) ¶unwanted-condition)) ¶unwanted-condition)) ¶column-counting-output-stream)) ¶automatically generated reader method
column-counting-output-stream)) ¶automatically generated writer method
unexpected-error)) ¶unexpected-error)) ¶:form
simple-condition.
Might perfectly well be NIL
(quote fiasco::*context*)
:class
(quote #\x)
:progress-char
(quote fiasco::*failures-and-errors-are-expected*)
:expected
error.
:lambda-list
(quote (fiasco::check-required (quote fiasco::form)))
:form
(quote (fiasco::check-required (quote fiasco::message)))
:message
(quote (fiasco::check-required (quote fiasco::message-args)))
:message-args
:expected-condition-type
:expected-condition-type
Signalled when an assertion such as IS is encountered
warning.
condition.
(quote (fiasco::check-required (quote fiasco::test)))
:test
Signalled when test is skipped
warning.
simple-warning.
style-warning.
test-related-condition.
(setf actual-test-arguments-of).
actual-test-arguments-of.
assertions-of.
(setf children-contexts-of).
children-contexts-of.
failures-of.
initialize-instance.
(setf internal-realtime-spent-with-test-of).
internal-realtime-spent-with-test-of.
(setf parent-context-of).
(setf parent-context-of).
(setf parent-context-of).
parent-context-of.
print-object.
real-time-spent-in-seconds.
shared-initialize.
(setf skipped-p).
skipped-p.
skips-of.
(setf test-of).
test-of.
:test
:internal-realtime-spent-with-test
(fiasco::check-required (quote fiasco::actual-test-arguments))
:actual-test-arguments
:parent-context
common-lisp.
:package
:lambda-list
boolean
t
:compile-before-run
:declarations
common-lisp.
:documentation
:body
test.
symbol
:name
(or null fiasco::testable)
A mapping from testable names to testables
(make-hash-table)
:children
Controls whether to automatically call
this test when its parent suite is invoked. Enabled by default.
boolean
t
:auto-call
| Jump to: | (
A B C D E F G I L M N O P R S T W |
|---|
| Jump to: | (
A B C D E F G I L M N O P R S T W |
|---|
| Jump to: | *
A B C D E F I L M N O P S T U |
|---|
| Jump to: | *
A B C D E F I L M N O P S T U |
|---|
| Jump to: | A C F I M N P S T U |
|---|
| Jump to: | A C F I M N P S T U |
|---|