This is the hu.dwim.stefil Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 16:43:04 2024 GMT+0.
hu.dwim.stefil/hu.dwim.stefil.asdhu.dwim.stefil/source/asserts.lisphu.dwim.stefil/source/package.lisphu.dwim.stefil/source/duplicates.lisphu.dwim.stefil/source/fixture.lisphu.dwim.stefil/source/infrastructure.lisphu.dwim.stefil/source/test.lisphu.dwim.stefil/source/suite.lispThe main system appears first, followed by any subsystem dependency.
hu.dwim.stefilA Simple Test Framework In Lisp.
alexandria (system).
source (module).
Modules are listed depth-first from the system components tree.
hu.dwim.stefil/sourcehu.dwim.stefil (system).
asserts.lisp (file).
package.lisp (file).
duplicates.lisp (file).
fixture.lisp (file).
infrastructure.lisp (file).
test.lisp (file).
suite.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
hu.dwim.stefil/hu.dwim.stefil.asdhu.dwim.stefil/source/asserts.lisphu.dwim.stefil/source/package.lisphu.dwim.stefil/source/duplicates.lisphu.dwim.stefil/source/fixture.lisphu.dwim.stefil/source/infrastructure.lisphu.dwim.stefil/source/test.lisphu.dwim.stefil/source/suite.lisphu.dwim.stefil/hu.dwim.stefil.asdhu.dwim.stefil (system).
hu.dwim.stefil/source/asserts.lispinfrastructure.lisp (file).
source (module).
finishes (macro).
is (macro).
not-signals (macro).
signals (macro).
%finishes (function).
extract-assert-expression-and-message (function).
record/assertion-begins (function).
record/assertion-was-successful (function).
record/failure (function).
record/failure* (function).
record/unexpected-error (function).
write-progress-char (function).
hu.dwim.stefil/source/duplicates.lisppackage.lisp (file).
source (module).
define-dynamic-context (macro).
defprint-object (macro).
import-all-owned-symbols (function).
quoted-form? (function).
hu.dwim.stefil/source/fixture.lisptest.lisp (file).
source (module).
defixture (macro).
with-fixture (macro).
with-fixtures (macro).
*fixture-body-aliases* (special variable).
fixture-function-name-for (function).
hu.dwim.stefil/source/infrastructure.lispduplicates.lisp (file).
source (module).
*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).
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).
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).
with-expected-failures (macro).
with-expected-failures* (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).
*test-run-standard-output* (special variable).
*tests* (special variable).
assertion-count-of (reader method).
(setf assertion-count-of) (writer method).
assertion-failed (condition).
auto-call? (reader method).
(setf auto-call?) (writer method).
children-of (reader method).
(setf children-of) (writer method).
condition-of (reader method).
condition-of (reader 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).
delete-test (function).
ensure-context (macro).
ensure-global-context (macro).
expected-p (reader method).
(setf expected-p) (writer method).
extra-condition (class).
failed-assertion (class).
failure-description (class).
failure-description-of (reader method).
(setf failure-description-of) (writer method).
failure-description/condition (class).
failure-descriptions-of (reader method).
(setf failure-descriptions-of) (writer 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).
format-arguments-of (reader method).
(setf format-arguments-of) (writer method).
format-control-of (reader method).
(setf format-control-of) (writer method).
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).
(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).
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).
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-success-descriptions-p (reader method).
(setf record-success-descriptions-p) (writer method).
register-test-being-run (function).
run-fixtures-of (reader method).
(setf run-fixtures-of) (writer method).
run-tests-of (reader method).
(setf run-tests-of) (writer method).
succeeded-assertion (class).
success-descriptions-of (reader method).
(setf success-descriptions-of) (writer method).
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-new-global-context* (macro).
with-toplevel-restarts (macro).
hu.dwim.stefil/source/test.lispinfrastructure.lisp (file).
source (module).
deftest (macro).
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).
ensure-test-lambda (function).
lambda-list-of (reader method).
(setf lambda-list-of) (writer method).
package-of (reader method).
(setf package-of) (writer method).
run-test-body (function).
run-test-body-in-handlers (function).
test (class).
hu.dwim.stefil/source/suite.lispinfrastructure.lisp (file).
test.lisp (file).
source (module).
%in-suite (function).
in-root-suite (macro).
make-suite (function).
Packages are listed by definition order.
hu.dwim.stefilalexandria.
common-lisp.
*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).
extract-test-run-statistics (function).
find-test (function).
(setf find-test) (function).
finishes (macro).
funcall-test-with-feedback-message (function).
in-suite (macro).
is (macro).
not-signals (macro).
run-failed-tests (macro).
runs-without-failure? (macro).
signals (macro).
with-expected-failures (macro).
with-expected-failures* (macro).
with-fixture (macro).
with-fixtures (macro).
without-debugging (macro).
without-test-progress-printing (macro).
%finishes (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).
*fixture-body-aliases* (special variable).
*global-context* (special variable).
*root-suite* (special variable).
*suite* (special variable).
*test-run-standard-output* (special variable).
*tests* (special variable).
assertion-count-of (generic reader).
(setf assertion-count-of) (generic writer).
assertion-failed (condition).
auto-call? (generic reader).
(setf auto-call?) (generic writer).
body-of (generic reader).
(setf body-of) (generic writer).
call-with-test-handlers (function).
children-of (generic reader).
(setf children-of) (generic writer).
compile-before-run-p (generic reader).
(setf compile-before-run-p) (generic writer).
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).
declarations-of (generic reader).
(setf declarations-of) (generic writer).
define-dynamic-context (macro).
defprint-object (macro).
delete-test (function).
documentation-of (generic reader).
(setf documentation-of) (generic writer).
ensure-context (macro).
ensure-global-context (macro).
ensure-test (function).
ensure-test-lambda (function).
expected-p (generic reader).
(setf expected-p) (generic writer).
extra-condition (class).
extract-assert-expression-and-message (function).
failed-assertion (class).
failure-description (class).
failure-description-of (generic reader).
(setf failure-description-of) (generic writer).
failure-description/condition (class).
failure-descriptions-of (generic reader).
(setf failure-descriptions-of) (generic writer).
fixture-function-name-for (function).
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).
global-context (class).
has-context (function).
has-global-context (function).
illegal-lambda-list (function).
illegal-lambda-list (condition).
import-all-owned-symbols (function).
in-root-suite (macro).
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-value-list-expression (function).
lambda-list-to-variable-name-list (function).
make-suite (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).
progress-char-count-of (generic reader).
(setf progress-char-count-of) (generic writer).
progress-char-of (generic reader).
(setf progress-char-of) (generic writer).
quoted-form? (function).
real-time-spent-in-seconds (generic function).
record-success-descriptions-p (generic reader).
(setf record-success-descriptions-p) (generic writer).
record/assertion-begins (function).
record/assertion-was-successful (function).
record/failure (function).
record/failure* (function).
record/unexpected-error (function).
register-test-being-run (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).
succeeded-assertion (class).
success-descriptions-of (generic reader).
(setf success-descriptions-of) (generic writer).
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).
with-context (macro).
with-global-context (macro).
with-new-context (macro).
with-new-global-context (macro).
with-new-global-context* (macro).
with-toplevel-restarts (macro).
write-progress-char (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Equivalent to (in-suite (defsuite ...)) which is the preferred way to define suites.
Any failure inside the dynamic extent of this block is registered as an expected failure.
Any failure inside the dynamic extent of this block is registered as an expected failure when CONDITION evaluates to true.
Run the given test non-interactively and print the results to *standard-output*. This function is ideal for ASDF:TEST-OP’s.
extra-condition) stream) ¶failed-assertion) stream) ¶missing-condition) stream) ¶unexpected-error) stream0) ¶failed-assertion) stream0) ¶global-context) stream0) ¶This is a kludge to overcome some package/dependency issues between -body- in hu.dwim.def and hu.dwim.stefil without a shared dependency.
*STANDARD-OUTPUT* is bound to (eval *test-run-standard-output*) at the toplevel entry point to any test.
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)))
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.
Look into the expression and try to extract a more descriptive failure message; e.g. in case of (= A B) bind A and B to a temp variable and print their values in case the assertion fails.
Returns as values: (bindings expression message message-args)
global-context)) ¶automatically generated reader method
global-context)) ¶automatically generated writer method
unexpected-error)) ¶automatically generated reader method
failure-description/condition)) ¶automatically generated reader method
unexpected-error)) ¶automatically generated writer method
failure-description/condition)) ¶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
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
failure-description/condition)) ¶automatically generated reader method
form.
succeeded-assertion)) ¶automatically generated reader method
form.
failed-assertion)) ¶automatically generated reader method
form.
failure-description/condition)) ¶automatically generated writer method
form.
succeeded-assertion)) ¶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)) ¶automatically generated reader method
illegal-lambda-list)) ¶test)) ¶automatically generated writer method
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)) ¶automatically generated reader method
global-context)) ¶automatically generated writer method
global-context)) ¶global-context)) ¶test -> context mapping
global-context)) ¶automatically generated reader method
global-context)) ¶automatically generated writer method
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
: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
hu.dwim.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.
print-object.
(setf print-test-run-progress-p).
print-test-run-progress-p.
(setf progress-char-count-of).
progress-char-count-of.
(setf record-success-descriptions-p).
record-success-descriptions-p.
(setf run-fixtures-of).
run-fixtures-of.
(setf run-tests-of).
run-tests-of.
(setf success-descriptions-of).
success-descriptions-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
(make-array 8 :adjustable t :fill-pointer 0)
:success-descriptions
0
:assertion-count
0
:progress-char-count
boolean
hu.dwim.stefil:*print-test-run-progress*
:print-test-run-progress-p
boolean
hu.dwim.stefil:*debug-on-unexpected-error*
:debug-on-unexpected-error-p
boolean
hu.dwim.stefil:*debug-on-assertion-failure*
:debug-on-assertion-failure-p
boolean
:record-success-descriptions-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
:form
common-lisp.
:package
:lambda-list
boolean
t
:compile-before-run
:declarations
common-lisp.
:documentation
:body
test.
symbol
:name
(or null hu.dwim.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 Q R S T W |
|---|
| Jump to: | %
(
A B C D E F G H I L M N P Q 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 H I M P S T U |
|---|
| Jump to: | A C D E F G H I M P S T U |
|---|