This is the stefil Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri Sep 15 06:42:36 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
stefilStefil - Simple Test Framework In Lisp
Attila Lendvai <attila.lendvai@gmail.com>
Tamás Borbély <tomi.borbely@gmail.com>
Levente Mészáros <levente.meszaros@gmail.com>
Attila Lendvai <attila.lendvai@gmail.com>
Tamás Borbély <tomi.borbely@gmail.com>
Levente Mészáros <levente.meszaros@gmail.com>
BSD / Public domain
0.1
swank (system).
alexandria (system).
iterate (system).
metabang-bind (system).
package.lisp (file).
duplicates.lisp (file).
configuration.lisp (file).
stefil.lisp (file).
suite.lisp (file).
integration (module).
Modules are listed depth-first from the system components tree.
stefil/integrationsuite.lisp (file).
stefil (system).
swank-integration.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
stefil/stefil.asdstefil/package.lispstefil/duplicates.lispstefil/configuration.lispstefil/stefil.lispstefil/suite.lispstefil/integration/swank-integration.lispstefil/stefil.asdstefil (system).
*load-with-debug-p* (special variable).
perform (method).
local-cl-source-file (class).
stefil/duplicates.lisppackage.lisp (file).
stefil (system).
%enable-sharp-boolean-syntax (function).
aif (macro).
aprog1 (macro).
awhen (macro).
concatenate-symbol (function).
define-dynamic-context (macro).
defprint-object (macro).
enable-sharp-boolean-syntax (macro).
eval-always (macro).
if-bind (macro).
prog1-bind (macro).
rebind (macro).
when-bind (macro).
stefil/configuration.lispduplicates.lisp (file).
stefil (system).
debug-only (macro).
file-header (function).
setup-readtable (function).
stefil/stefil.lispconfiguration.lisp (file).
stefil (system).
*debug-on-assertion-failure* (special variable).
*debug-on-unexpected-error* (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).
defixture (macro).
deftest (macro).
describe-object (method).
describe-object (method).
find-test (function).
(setf find-test) (function).
finishes (macro).
funcall-test-with-feedback-message (function).
is (macro).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
run-failed-tests (macro).
runs-without-failure? (macro).
shared-initialize (method).
signals (macro).
with-expected-failures (macro).
with-fixture (macro).
with-fixtures (macro).
without-debugging (macro).
without-test-progress-printing (macro).
%run-failed-tests (function).
*compile-tests-before-run* (special variable).
*compile-tests-with-debug-level* (special variable).
*context* (special variable).
*failures-and-errors-are-expected* (special variable).
*global-context* (special variable).
*root-suite* (special variable).
*suite* (special variable).
*tests* (special variable).
assertion-count-of (reader method).
(setf assertion-count-of) (writer method).
assertion-failed (condition).
auto-call-p (reader method).
(setf auto-call-p) (writer method).
body-of (reader method).
(setf body-of) (writer method).
children-of (reader method).
(setf children-of) (writer method).
compile-before-run-p (reader method).
(setf compile-before-run-p) (writer method).
condition-of (reader method).
condition-of (reader method).
condition-of (reader method).
(setf condition-of) (writer method).
(setf condition-of) (writer method).
(setf condition-of) (writer method).
context (class).
count-tests (generic function).
current-context (function).
(setf current-context) (function).
current-global-context (function).
(setf current-global-context) (function).
current-test-of (reader method).
(setf current-test-of) (writer method).
debug-on-assertion-failure-p (reader method).
(setf debug-on-assertion-failure-p) (writer method).
debug-on-unexpected-error-p (reader method).
(setf debug-on-unexpected-error-p) (writer method).
declarations-of (reader method).
(setf declarations-of) (writer method).
documentation-of (reader method).
(setf documentation-of) (writer method).
ensure-context (macro).
ensure-global-context (macro).
error-in-teardown (condition).
expected-p (reader method).
(setf expected-p) (writer method).
extract-assert-expression-and-message (function).
failed-assertion (class).
failure-description (class).
failure-description-of (reader method).
(setf failure-description-of) (writer method).
failure-descriptions-of (reader method).
(setf failure-descriptions-of) (writer method).
fixture-of (reader method).
(setf fixture-of) (writer method).
form-of (reader method).
form-of (reader method).
(setf form-of) (writer method).
(setf form-of) (writer method).
format-arguments-of (reader method).
(setf format-arguments-of) (writer method).
format-control-of (reader method).
(setf format-control-of) (writer method).
get-test-lambda (generic function).
global-context (class).
has-context (function).
has-global-context (function).
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).
lambda-list-of (reader method).
lambda-list-of (reader method).
(setf lambda-list-of) (writer method).
(setf lambda-list-of) (writer method).
lambda-list-to-funcall-expression (function).
lambda-list-to-funcall-list (function).
lambda-list-to-lambda-list-with-quoted-defaults (function).
lambda-list-to-value-list-expression (function).
lambda-list-to-variable-name-list (function).
make-suite (function).
make-test (function).
missing-condition (class).
name-of (reader method).
(setf name-of) (writer method).
number-of-added-failure-descriptions-of (reader method).
(setf number-of-added-failure-descriptions-of) (writer method).
package-of (reader method).
(setf package-of) (writer method).
parent-context-of (reader method).
(setf parent-context-of) (writer method).
parent-of (reader method).
(setf parent-of) (writer method).
(setf parent-of) (method).
parse-lambda-list (function).
print-test-run-progress-p (reader method).
(setf print-test-run-progress-p) (writer method).
progress-char-count-of (reader method).
(setf progress-char-count-of) (writer method).
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).
record-failure (function).
record-failure* (function).
register-assertion (function).
register-assertion-was-successful (function).
register-test-being-run (function).
rem-test (function).
run-fixtures-of (reader method).
(setf run-fixtures-of) (writer method).
run-test-body (function).
run-test-body-in-handlers (function).
run-tests-of (reader method).
(setf run-tests-of) (writer method).
test (class).
test-arguments-of (reader method).
(setf test-arguments-of) (writer method).
test-context-backtrace-of (reader method).
(setf test-context-backtrace-of) (writer method).
test-lambdas-of (reader method).
(setf test-lambdas-of) (writer method).
test-of (reader method).
test-of (reader method).
(setf test-of) (writer method).
(setf test-of) (writer method).
test-related-condition (condition).
test-style-warning (condition).
test-was-run-p (function).
testable (class).
toplevel-context-of (reader method).
(setf toplevel-context-of) (writer method).
unexpected-error (class).
with-context (macro).
with-global-context (macro).
with-new-context (macro).
with-new-global-context (macro).
with-toplevel-restarts (macro).
write-progress-char (function).
stefil/suite.lispstefil.lisp (file).
stefil (system).
defsuite (macro).
defsuite* (macro).
in-root-suite (macro).
in-suite (macro).
%in-suite (function).
Packages are listed by definition order.
stefilalexandria.
common-lisp.
iterate.
metabang.bind.
stefil-system.
swank.
*debug-on-assertion-failure* (special variable).
*debug-on-unexpected-error* (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).
defixture (macro).
defsuite (macro).
defsuite* (macro).
deftest (macro).
find-test (function).
(setf find-test) (function).
finishes (macro).
funcall-test-with-feedback-message (function).
in-root-suite (macro).
in-suite (macro).
is (macro).
run-failed-tests (macro).
runs-without-failure? (macro).
signals (macro).
with-expected-failures (macro).
with-fixture (macro).
with-fixtures (macro).
without-debugging (macro).
without-test-progress-printing (macro).
%enable-sharp-boolean-syntax (function).
%in-suite (function).
%run-failed-tests (function).
*compile-tests-before-run* (special variable).
*compile-tests-with-debug-level* (special variable).
*context* (special variable).
*failures-and-errors-are-expected* (special variable).
*global-context* (special variable).
*root-suite* (special variable).
*suite* (special variable).
*tests* (special variable).
aif (macro).
aprog1 (macro).
assertion-count-of (generic reader).
(setf assertion-count-of) (generic writer).
assertion-failed (condition).
auto-call-p (generic reader).
(setf auto-call-p) (generic writer).
awhen (macro).
body-of (generic reader).
(setf body-of) (generic writer).
children-of (generic reader).
(setf children-of) (generic writer).
compile-before-run-p (generic reader).
(setf compile-before-run-p) (generic writer).
concatenate-symbol (function).
condition-of (generic reader).
(setf condition-of) (generic writer).
context (class).
count-tests (generic function).
current-context (function).
(setf current-context) (function).
current-global-context (function).
(setf current-global-context) (function).
current-test-of (generic reader).
(setf current-test-of) (generic writer).
debug-on-assertion-failure-p (generic reader).
(setf debug-on-assertion-failure-p) (generic writer).
debug-on-unexpected-error-p (generic reader).
(setf debug-on-unexpected-error-p) (generic writer).
debug-only (macro).
declarations-of (generic reader).
(setf declarations-of) (generic writer).
define-dynamic-context (macro).
defprint-object (macro).
documentation-of (generic reader).
(setf documentation-of) (generic writer).
enable-sharp-boolean-syntax (macro).
ensure-context (macro).
ensure-global-context (macro).
error-in-teardown (condition).
eval-always (macro).
expected-p (generic reader).
(setf expected-p) (generic writer).
extract-assert-expression-and-message (function).
failed-assertion (class).
failure-description (class).
failure-description-of (generic reader).
(setf failure-description-of) (generic writer).
failure-descriptions-of (generic reader).
(setf failure-descriptions-of) (generic writer).
file-header (function).
fixture-of (generic reader).
(setf fixture-of) (generic writer).
form-of (generic reader).
(setf form-of) (generic writer).
format-arguments-of (generic reader).
(setf format-arguments-of) (generic writer).
format-control-of (generic reader).
(setf format-control-of) (generic writer).
get-test-lambda (generic function).
global-context (class).
has-context (function).
has-global-context (function).
if-bind (macro).
illegal-lambda-list (function).
illegal-lambda-list (condition).
internal-realtime-spent-with-test-of (generic reader).
(setf internal-realtime-spent-with-test-of) (generic writer).
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-lambda-list-with-quoted-defaults (function).
lambda-list-to-value-list-expression (function).
lambda-list-to-variable-name-list (function).
make-suite (function).
make-test (function).
missing-condition (class).
name-of (generic reader).
(setf name-of) (generic writer).
number-of-added-failure-descriptions-of (generic reader).
(setf number-of-added-failure-descriptions-of) (generic writer).
package-of (generic reader).
(setf package-of) (generic writer).
parent-context-of (generic reader).
(setf parent-context-of) (generic writer).
parent-of (generic reader).
(setf parent-of) (generic function).
parse-lambda-list (function).
print-test-run-progress-p (generic reader).
(setf print-test-run-progress-p) (generic writer).
prog1-bind (macro).
progress-char-count-of (generic reader).
(setf progress-char-count-of) (generic writer).
progress-char-of (generic reader).
(setf progress-char-of) (generic writer).
real-time-spent-in-seconds (generic function).
rebind (macro).
record-failure (function).
record-failure* (function).
register-assertion (function).
register-assertion-was-successful (function).
register-test-being-run (function).
rem-test (function).
run-fixtures-of (generic reader).
(setf run-fixtures-of) (generic writer).
run-test-body (function).
run-test-body-in-handlers (function).
run-tests-of (generic reader).
(setf run-tests-of) (generic writer).
setup-readtable (function).
test (class).
test-arguments-of (generic reader).
(setf test-arguments-of) (generic writer).
test-context-backtrace-of (generic reader).
(setf test-context-backtrace-of) (generic writer).
test-lambdas-of (generic reader).
(setf test-lambdas-of) (generic writer).
test-of (generic reader).
(setf test-of) (generic writer).
test-related-condition (condition).
test-style-warning (condition).
test-was-run-p (function).
testable (class).
toplevel-context-of (generic reader).
(setf toplevel-context-of) (generic writer).
unexpected-error (class).
when-bind (macro).
with-context (macro).
with-global-context (macro).
with-new-context (macro).
with-new-global-context (macro).
with-toplevel-restarts (macro).
write-progress-char (function).
stefil-systemasdf/interface.
common-lisp.
*load-with-debug-p* (special variable).
local-cl-source-file (class).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Fixtures are defun’s that only execute the :setup part of their body once per test session if there is any at the time of calling.
Equivalent to (in-suite (defsuite ...)) which is the preferred way to define suites.
Used to reset the current suite to protect from other project’s last in-suite statement. Unfortunately there’s noone for us to rebind *suite* when a file is loaded, so we can’t behave exactly like *package* and in-package.
Any failure inside the dynamic extent of this block is registered as an expected failure.
Run the given test non-interactively and print the results to *standard-output*. This function is ideal for ASDF:TEST-OP’s.
failed-assertion) stream) ¶missing-condition) stream) ¶operation) (component local-cl-source-file)) ¶asdf/action.
failed-assertion) stream0) ¶unexpected-error) stream0) ¶global-context) stream0) ¶The purpose of this macro is to provide an easy way to access a group of related special variables. To do so, it generates with-NAME/in-NAME/current-NAME/has-NAME macros to access either a CLOS instance or a defstruct in a special variable. Optionally it can chain the "parent" bindings (use :CHAIN-PARENTS T and access with PARENT-CONTEXT-OF).
Define a print-object method using print-unreadable-object.
An example:
(defprint-object (self parenscript-dispatcher)
(when (cachep self)
(princ "cached")
(princ " "))
(princ (parenscript-file self)))
Copies *readtable* and enables #t and #f readers for t and nil in the copy.
A DWIM symbol concatenate: Args will be converted to string and be concatenated to form the resulting symbol with one exception: when a package is encountered then it is stored as the target package to use at intern. If there was no package among the args then the symbol-package of the first symbol encountered will be used. If there are neither packages nor symbols among the args then the result will be interned into the current package at the time of calling.
global-context)) ¶automatically generated reader method
global-context)) ¶automatically generated writer method
unexpected-error)) ¶automatically generated reader method
missing-condition)) ¶automatically generated reader method
error-in-teardown)) ¶unexpected-error)) ¶automatically generated writer method
missing-condition)) ¶automatically generated writer method
error-in-teardown)) ¶global-context)) ¶automatically generated reader method
global-context)) ¶automatically generated writer method
global-context)) ¶automatically generated reader method
global-context)) ¶automatically generated writer method
global-context)) ¶automatically generated reader method
global-context)) ¶automatically generated writer method
failure-description)) ¶automatically generated reader method
failure-description)) ¶automatically generated writer method
assertion-failed)) ¶assertion-failed)) ¶global-context)) ¶automatically generated reader method
global-context)) ¶automatically generated writer method
error-in-teardown)) ¶error-in-teardown)) ¶missing-condition)) ¶automatically generated reader method
form.
failed-assertion)) ¶automatically generated reader method
form.
missing-condition)) ¶automatically generated writer method
form.
failed-assertion)) ¶automatically generated writer method
form.
failed-assertion)) ¶automatically generated reader method
failed-assertion)) ¶automatically generated writer method
failed-assertion)) ¶automatically generated reader method
failed-assertion)) ¶automatically generated writer method
test) (context global-context)) ¶illegal-lambda-list)) ¶illegal-lambda-list)) ¶global-context)) ¶automatically generated reader method
global-context)) ¶automatically generated writer method
global-context)) ¶automatically generated reader method
global-context)) ¶automatically generated writer method
unexpected-error)) ¶automatically generated reader method
failure-description)) ¶automatically generated reader method
unexpected-error)) ¶automatically generated writer method
failure-description)) ¶automatically generated writer method
global-context)) ¶automatically generated reader method
global-context)) ¶automatically generated writer method
global-context)) ¶global-context)) ¶test -> context mapping
failure-description)) ¶automatically generated reader method
failure-description)) ¶automatically generated writer method
global-context)) ¶global-context)) ¶test -> compiled test lambda mapping for this test run
global-context)) ¶automatically generated reader method
global-context)) ¶automatically generated writer method
serious-condition.
test-related-condition.
:failure-description
error.
:lambda-list
condition.
(quote nil)
:test
simple-warning.
style-warning.
test-related-condition.
(setf internal-realtime-spent-with-test-of).
internal-realtime-spent-with-test-of.
(setf number-of-added-failure-descriptions-of).
number-of-added-failure-descriptions-of.
(setf parent-context-of).
parent-context-of.
print-object.
real-time-spent-in-seconds.
(setf test-arguments-of).
test-arguments-of.
(setf test-of).
test-of.
:test
:internal-realtime-spent-with-test
:test-arguments
0
:number-of-added-failure-descriptions
:test-context-backtrace
:class
#\x
:progress-char
boolean
stefil::*failures-and-errors-are-expected*
:expected
(setf assertion-count-of).
assertion-count-of.
(setf current-test-of).
current-test-of.
(setf debug-on-assertion-failure-p).
debug-on-assertion-failure-p.
(setf debug-on-unexpected-error-p).
debug-on-unexpected-error-p.
(setf failure-descriptions-of).
failure-descriptions-of.
get-test-lambda.
print-object.
(setf print-test-run-progress-p).
print-test-run-progress-p.
(setf progress-char-count-of).
progress-char-count-of.
(setf run-fixtures-of).
run-fixtures-of.
(setf run-tests-of).
run-tests-of.
(setf test-lambdas-of).
test-lambdas-of.
(setf toplevel-context-of).
toplevel-context-of.
(make-array 8 :adjustable t :fill-pointer 0)
:failure-descriptions
0
:assertion-count
0
:progress-char-count
boolean
stefil:*print-test-run-progress*
:print-test-run-progress-p
boolean
stefil:*debug-on-unexpected-error*
:debug-on-unexpected-error-p
boolean
stefil:*debug-on-assertion-failure*
:debug-on-assertion-failure-p
:toplevel-context
:current-test
test -> context mapping
(make-hash-table)
:run-tests
(make-hash-table)
:run-fixtures
test -> compiled test lambda mapping for this test run
(make-hash-table)
:test-lambdas
cl-source-file.
common-lisp.
:package
:lambda-list
boolean
t
:compile-before-run
:declarations
common-lisp.
:documentation
:body
test.
symbol
:name
(or null stefil::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 H I L M N P R S T W |
|---|
| Jump to: | %
(
A B C D E F G H I L M N P R S T W |
|---|
| Jump to: | *
A B C D E F I L N P R S T |
|---|
| Jump to: | *
A B C D E F I L N P R S T |
|---|
| Jump to: | A C D E F G I L M P S T U |
|---|
| Jump to: | A C D E F G I L M P S T U |
|---|