The hu.dwim.stefil Reference Manual

1 Introduction
2 Systems
- 2.1 hu.dwim.stefil
3 Modules
- 3.1 hu.dwim.stefil/source
4 Files
- 4.1 Lisp
5 Packages
- 5.1 hu.dwim.stefil
6 Definitions
- 6.1 Exported definitions
- 6.2 Internal definitions
Appendix A Indexes

The hu.dwim.stefil Reference Manual

This is the hu.dwim.stefil Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Apr 28 12:02:44 2020 GMT+0.

1 Introduction

http://dwim.hu/project/hu.dwim.stefil


add 'are'? http://gist.github.com/638125
mattc in #dwim.hu
matt.r.curtis at gmail.com

there's a friendly fork: https://github.com/capitaomorte/fiasco
pre-fork discussion: https://github.com/luismbo/stefil/issues/9
in short: at this time i (attila) am not working actively on
hu.dwim.stefil, and IIRC the proposed changes were too divergent, so
we agreed to fork off fiasco from hu.dwim.stefil.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 `hu.dwim.stefil`

Description: A Simple Test Framework In Lisp.
Dependency: alexandria
Source: hu.dwim.stefil.asd (file)
Component: source (module)

3 Modules

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

3.1 `hu.dwim.stefil/source`

Parent

hu.dwim.stefil (system)

Location

source/

Components

asserts.lisp (file)
package.lisp (file)
duplicates.lisp (file)
fixture.lisp (file)
infrastructure.lisp (file)
test.lisp (file)
suite.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 `hu.dwim.stefil.asd`

Location: hu.dwim.stefil.asd
Systems: hu.dwim.stefil (system)

4.1.2 `hu.dwim.stefil/source/asserts.lisp`

Dependency

infrastructure.lisp (file)

Parent

source (module)

Location

source/asserts.lisp

Exported Definitions

finishes (macro)
is (macro)
not-signals (macro)
signals (macro)

Internal Definitions

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)

4.1.3 `hu.dwim.stefil/source/package.lisp`

Parent: source (module)
Location: source/package.lisp
Packages: hu.dwim.stefil

4.1.4 `hu.dwim.stefil/source/duplicates.lisp`

Dependency

package.lisp (file)

Parent

source (module)

Location

source/duplicates.lisp

Internal Definitions

define-dynamic-context (macro)
defprint-object (macro)
import-all-owned-symbols (function)
quoted-form? (function)

4.1.5 `hu.dwim.stefil/source/fixture.lisp`

Dependency

test.lisp (file)

Parent

source (module)

Location

source/fixture.lisp

Exported Definitions

defixture (macro)
with-fixture (macro)
with-fixtures (macro)

Internal Definitions

*fixture-body-aliases* (special variable)
fixture-function-name-for (function)

4.1.6 `hu.dwim.stefil/source/infrastructure.lisp`

Dependency

duplicates.lisp (file)

Parent

source (module)

Location

source/infrastructure.lisp

Exported Definitions

*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)
extract-test-run-statistics (function)
find-test (function)
(setf find-test) (function)
funcall-test-with-feedback-message (function)
run-failed-tests (macro)
runs-without-failure? (macro)
with-expected-failures (macro)
with-expected-failures* (macro)
without-debugging (macro)
without-test-progress-printing (macro)

Internal Definitions

%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 (method)
(setf assertion-count-of) (method)
assertion-failed (condition)
auto-call? (method)
(setf auto-call?) (method)
children-of (method)
(setf children-of) (method)
condition-of (method)
(setf condition-of) (method)
condition-of (method)
(setf condition-of) (method)
context (class)
count-tests (generic function)
count-tests (method)
current-context (function)
(setf current-context) (function)
current-global-context (function)
(setf current-global-context) (function)
current-test-of (method)
(setf current-test-of) (method)
debug-on-assertion-failure-p (method)
(setf debug-on-assertion-failure-p) (method)
debug-on-unexpected-error-p (method)
(setf debug-on-unexpected-error-p) (method)
delete-test (function)
ensure-context (macro)
ensure-global-context (macro)
expected-p (method)
(setf expected-p) (method)
extra-condition (class)
failed-assertion (class)
failure-description (class)
failure-description-of (method)
(setf failure-description-of) (method)
failure-description/condition (class)
failure-descriptions-of (method)
(setf failure-descriptions-of) (method)
form-of (method)
(setf form-of) (method)
form-of (method)
(setf form-of) (method)
form-of (method)
(setf form-of) (method)
format-arguments-of (method)
(setf format-arguments-of) (method)
format-control-of (method)
(setf format-control-of) (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 (method)
(setf internal-realtime-spent-with-test-of) (method)
lambda-list-of (method)
(setf lambda-list-of) (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 (method)
(setf name-of) (method)
number-of-added-failure-descriptions-of (method)
(setf number-of-added-failure-descriptions-of) (method)
parent-context-of (method)
(setf parent-context-of) (method)
parent-of (method)
(setf parent-of) (method)
(setf parent-of) (method)
parse-lambda-list (function)
print-test-run-progress-p (method)
(setf print-test-run-progress-p) (method)
progress-char-count-of (method)
(setf progress-char-count-of) (method)
progress-char-of (method)
(setf progress-char-of) (method)
progress-char-of (method)
(setf progress-char-of) (method)
real-time-spent-in-seconds (generic function)
real-time-spent-in-seconds (method)
record-success-descriptions-p (method)
(setf record-success-descriptions-p) (method)
register-test-being-run (function)
run-fixtures-of (method)
(setf run-fixtures-of) (method)
run-tests-of (method)
(setf run-tests-of) (method)
succeeded-assertion (class)
success-descriptions-of (method)
(setf success-descriptions-of) (method)
test-arguments-of (method)
(setf test-arguments-of) (method)
test-context-backtrace-of (method)
(setf test-context-backtrace-of) (method)
test-lambdas-of (method)
(setf test-lambdas-of) (method)
test-of (method)
(setf test-of) (method)
test-of (method)
(setf test-of) (method)
test-related-condition (condition)
test-style-warning (condition)
test-was-run-p (function)
testable (class)
toplevel-context-of (method)
(setf toplevel-context-of) (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)

4.1.7 `hu.dwim.stefil/source/test.lisp`

Dependency

infrastructure.lisp (file)

Parent

source (module)

Location

source/test.lisp

Exported Definitions

deftest (macro)

Internal Definitions

body-of (method)
(setf body-of) (method)
call-with-test-handlers (function)
compile-before-run-p (method)
(setf compile-before-run-p) (method)
declarations-of (method)
(setf declarations-of) (method)
documentation-of (method)
(setf documentation-of) (method)
ensure-test (function)
ensure-test-lambda (function)
lambda-list-of (method)
(setf lambda-list-of) (method)
package-of (method)
(setf package-of) (method)
run-test-body (function)
run-test-body-in-handlers (function)
test (class)

4.1.8 `hu.dwim.stefil/source/suite.lisp`

Dependencies

infrastructure.lisp (file)
test.lisp (file)

Parent

source (module)

Location

source/suite.lisp

Exported Definitions

defsuite (macro)
defsuite* (macro)
in-suite (macro)

Internal Definitions

%in-suite (function)
in-root-suite (macro)
make-suite (function)

5 Packages

Packages are listed by definition order.

5.1 `hu.dwim.stefil`

Source

package.lisp (file)

Use List

common-lisp
alexandria

Exported Definitions

*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)

Internal Definitions

%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 function)
assertion-count-of (method)
(setf assertion-count-of) (method)
(setf assertion-count-of) (generic function)
assertion-failed (condition)
auto-call? (generic function)
auto-call? (method)
(setf auto-call?) (method)
(setf auto-call?) (generic function)
body-of (generic function)
body-of (method)
(setf body-of) (method)
(setf body-of) (generic function)
call-with-test-handlers (function)
children-of (generic function)
children-of (method)
(setf children-of) (method)
(setf children-of) (generic function)
compile-before-run-p (generic function)
compile-before-run-p (method)
(setf compile-before-run-p) (method)
(setf compile-before-run-p) (generic function)
condition-of (generic function)
condition-of (method)
(setf condition-of) (method)
condition-of (method)
(setf condition-of) (method)
(setf condition-of) (generic function)
context (class)
count-tests (generic function)
count-tests (method)
current-context (function)
(setf current-context) (function)
current-global-context (function)
(setf current-global-context) (function)
current-test-of (generic function)
current-test-of (method)
(setf current-test-of) (method)
(setf current-test-of) (generic function)
debug-on-assertion-failure-p (generic function)
debug-on-assertion-failure-p (method)
(setf debug-on-assertion-failure-p) (method)
(setf debug-on-assertion-failure-p) (generic function)
debug-on-unexpected-error-p (generic function)
debug-on-unexpected-error-p (method)
(setf debug-on-unexpected-error-p) (method)
(setf debug-on-unexpected-error-p) (generic function)
declarations-of (generic function)
declarations-of (method)
(setf declarations-of) (method)
(setf declarations-of) (generic function)
define-dynamic-context (macro)
defprint-object (macro)
delete-test (function)
documentation-of (generic function)
documentation-of (method)
(setf documentation-of) (method)
(setf documentation-of) (generic function)
ensure-context (macro)
ensure-global-context (macro)
ensure-test (function)
ensure-test-lambda (function)
expected-p (generic function)
expected-p (method)
(setf expected-p) (method)
(setf expected-p) (generic function)
extra-condition (class)
extract-assert-expression-and-message (function)
failed-assertion (class)
failure-description (class)
failure-description-of (generic function)
failure-description-of (method)
(setf failure-description-of) (method)
(setf failure-description-of) (generic function)
failure-description/condition (class)
failure-descriptions-of (generic function)
failure-descriptions-of (method)
(setf failure-descriptions-of) (method)
(setf failure-descriptions-of) (generic function)
fixture-function-name-for (function)
form-of (generic function)
form-of (method)
(setf form-of) (method)
form-of (method)
(setf form-of) (method)
form-of (method)
(setf form-of) (method)
(setf form-of) (generic function)
format-arguments-of (generic function)
format-arguments-of (method)
(setf format-arguments-of) (method)
(setf format-arguments-of) (generic function)
format-control-of (generic function)
format-control-of (method)
(setf format-control-of) (method)
(setf format-control-of) (generic function)
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 function)
internal-realtime-spent-with-test-of (method)
(setf internal-realtime-spent-with-test-of) (method)
(setf internal-realtime-spent-with-test-of) (generic function)
lambda-list-of (generic function)
lambda-list-of (method)
(setf lambda-list-of) (method)
lambda-list-of (method)
(setf lambda-list-of) (method)
(setf lambda-list-of) (generic function)
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 function)
name-of (method)
(setf name-of) (method)
(setf name-of) (generic function)
number-of-added-failure-descriptions-of (generic function)
number-of-added-failure-descriptions-of (method)
(setf number-of-added-failure-descriptions-of) (method)
(setf number-of-added-failure-descriptions-of) (generic function)
package-of (generic function)
package-of (method)
(setf package-of) (method)
(setf package-of) (generic function)
parent-context-of (generic function)
parent-context-of (method)
(setf parent-context-of) (method)
(setf parent-context-of) (generic function)
parent-of (generic function)
parent-of (method)
(setf parent-of) (method)
(setf parent-of) (generic function)
(setf parent-of) (method)
parse-lambda-list (function)
print-test-run-progress-p (generic function)
print-test-run-progress-p (method)
(setf print-test-run-progress-p) (method)
(setf print-test-run-progress-p) (generic function)
progress-char-count-of (generic function)
progress-char-count-of (method)
(setf progress-char-count-of) (method)
(setf progress-char-count-of) (generic function)
progress-char-of (generic function)
progress-char-of (method)
(setf progress-char-of) (method)
progress-char-of (method)
(setf progress-char-of) (method)
(setf progress-char-of) (generic function)
quoted-form? (function)
real-time-spent-in-seconds (generic function)
real-time-spent-in-seconds (method)
record-success-descriptions-p (generic function)
record-success-descriptions-p (method)
(setf record-success-descriptions-p) (method)
(setf record-success-descriptions-p) (generic function)
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 function)
run-fixtures-of (method)
(setf run-fixtures-of) (method)
(setf run-fixtures-of) (generic function)
run-test-body (function)
run-test-body-in-handlers (function)
run-tests-of (generic function)
run-tests-of (method)
(setf run-tests-of) (method)
(setf run-tests-of) (generic function)
succeeded-assertion (class)
success-descriptions-of (generic function)
success-descriptions-of (method)
(setf success-descriptions-of) (method)
(setf success-descriptions-of) (generic function)
test (class)
test-arguments-of (generic function)
test-arguments-of (method)
(setf test-arguments-of) (method)
(setf test-arguments-of) (generic function)
test-context-backtrace-of (generic function)
test-context-backtrace-of (method)
(setf test-context-backtrace-of) (method)
(setf test-context-backtrace-of) (generic function)
test-lambdas-of (generic function)
test-lambdas-of (method)
(setf test-lambdas-of) (method)
(setf test-lambdas-of) (generic function)
test-of (generic function)
test-of (method)
(setf test-of) (method)
test-of (method)
(setf test-of) (method)
(setf test-of) (generic function)
test-related-condition (condition)
test-style-warning (condition)
test-was-run-p (function)
testable (class)
toplevel-context-of (generic function)
toplevel-context-of (method)
(setf toplevel-context-of) (method)
(setf toplevel-context-of) (generic function)
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)

6 Definitions

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

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *debug-on-assertion-failure*

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Special Variable: *debug-on-unexpected-error*

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Special Variable: *last-test-result*

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Special Variable: *print-test-run-progress*

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Special Variable: *test-progress-print-right-margin*

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Special Variable: *test-result-history*

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

6.1.2 Macros

Macro: defixture NAME &body BODY

Package: hu.dwim.stefil
Source: fixture.lisp (file)

Macro: defsuite NAME-OR-NAME-WITH-ARGS &optional ARGS &body BODY

Package: hu.dwim.stefil
Source: suite.lisp (file)

Macro: defsuite* NAME-OR-NAME-WITH-ARGS &optional ARGS &body BODY

Equivalent to (in-suite (defsuite ...)) which is the preferred way to define suites.

Package: hu.dwim.stefil
Source: suite.lisp (file)

Macro: deftest NAME ARGS &body BODY

Package: hu.dwim.stefil
Source: test.lisp (file)

Macro: finishes &body BODY

Package: hu.dwim.stefil
Source: asserts.lisp (file)

Macro: in-suite NAME

Package: hu.dwim.stefil
Source: suite.lisp (file)

Macro: is FORM &optional MESSAGE &rest MESSAGE-ARGS

Package: hu.dwim.stefil
Source: asserts.lisp (file)

Macro: not-signals WHAT &body BODY

Package: hu.dwim.stefil
Source: asserts.lisp (file)

Macro: run-failed-tests &optional TEST-RESULT-PLACE

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Macro: runs-without-failure? &body BODY

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Macro: signals WHAT &body BODY

Package: hu.dwim.stefil
Source: asserts.lisp (file)

Macro: with-expected-failures &body BODY

Any failure inside the dynamic extent of this block is registered as an expected failure.

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Macro: with-expected-failures* CONDITION &body BODY

Any failure inside the dynamic extent of this block is registered as an expected failure when CONDITION evaluates to true.

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Macro: with-fixture NAME &body BODY

Package: hu.dwim.stefil
Source: fixture.lisp (file)

Macro: with-fixtures FIXTURES &body BODY

Package: hu.dwim.stefil
Source: fixture.lisp (file)

Macro: without-debugging &body BODY

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Macro: without-test-progress-printing &body BODY

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

6.1.3 Functions

Function: extract-test-run-statistics GLOBAL-CONTEXT

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Function: find-test NAME &key OTHERWISE

Function: (setf find-test) NEW-VALUE KEY

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Function: funcall-test-with-feedback-message TEST-FUNCTION &rest ARGS

Run the given test non-interactively and print the results to *standard-output*. This function is ideal for ASDF:TEST-OP’s.

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *compile-tests-before-run*

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Special Variable: *compile-tests-with-debug-level*

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Special Variable: *context*

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Special Variable: *failures-and-errors-are-expected*

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Special Variable: *fixture-body-aliases*

This is a kludge to overcome some package/dependency issues between -body- in hu.dwim.def and hu.dwim.stefil without a shared dependency.

Package: hu.dwim.stefil
Source: fixture.lisp (file)

Special Variable: *global-context*

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Special Variable: *root-suite*

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Special Variable: *suite*

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Special Variable: *test-run-standard-output*

*STANDARD-OUTPUT* is bound to (eval *test-run-standard-output*) at the toplevel entry point to any test.

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Special Variable: *tests*

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

6.2.2 Macros

Macro: define-dynamic-context NAME DIRECT-SLOTS &key DIRECT-SUPERCLASSES EXPORT-SYMBOLS CLASS-NAME CHAIN-PARENTS CREATE-STRUCT CREATE-CLASS STRUCT-OPTIONS DEFCLASS-MACRO-NAME

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

Package: hu.dwim.stefil
Source: duplicates.lisp (file)

Macro: defprint-object (SELF CLASS-NAME &key IDENTITY TYPE WITH-PACKAGE MUFFLE-ERRORS) &body BODY

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)))

Package: hu.dwim.stefil
Source: duplicates.lisp (file)

Macro: ensure-context (&rest INITARGS) &body FORMS

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Macro: ensure-global-context (&rest INITARGS) &body FORMS

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Macro: in-root-suite ()

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.

Package: hu.dwim.stefil
Source: suite.lisp (file)

Macro: with-context CONTEXT &body FORMS

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Macro: with-global-context CONTEXT &body FORMS

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Macro: with-new-context (&rest INITARGS) &body FORMS

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Macro: with-new-global-context (&rest INITARGS) &body FORMS

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Macro: with-new-global-context* (&rest INITARGS) &body FORMS

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Macro: with-toplevel-restarts &body BODY

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

6.2.3 Functions

Function: %in-suite NAME

Package: hu.dwim.stefil
Source: suite.lisp (file)

Function: %run-failed-tests GLOBAL-CONTEXT-TO-BE-PROCESSED

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Function: call-with-test-handlers FUNCTION

Package: hu.dwim.stefil
Source: test.lisp (file)

Function: current-context ()

Function: (setf current-context) VALUE

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Function: current-global-context ()

Function: (setf current-global-context) VALUE

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Function: delete-test NAME &rest ARGS

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Function: ensure-test NAME &rest ARGS &key &allow-other-keys

Package: hu.dwim.stefil
Source: test.lisp (file)

Function: ensure-test-lambda TEST CONTEXT

Package: hu.dwim.stefil
Source: test.lisp (file)

Function: extract-assert-expression-and-message INPUT-FORM

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)

Package: hu.dwim.stefil
Source: asserts.lisp (file)

Function: fixture-function-name-for NAME

Package: hu.dwim.stefil
Source: fixture.lisp (file)

Function: has-context ()

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Function: has-global-context ()

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Function: illegal-lambda-list LAMBDA-LIST

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Function: import-all-owned-symbols SOURCE-PACKAGE TARGET-PACKAGE &key OVERWRITE

Package: hu.dwim.stefil
Source: duplicates.lisp (file)

Function: lambda-list-to-funcall-expression FUNCTION ARGS

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Function: lambda-list-to-funcall-list ARGS

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Function: lambda-list-to-value-list-expression ARGS

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Function: lambda-list-to-variable-name-list ARGS &key MACRO INCLUDE-SPECIALS

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Function: make-suite NAME &rest ARGS &key &allow-other-keys

Package: hu.dwim.stefil
Source: suite.lisp (file)

Function: parse-lambda-list LAMBDA-LIST VISITOR &key MACRO

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Function: quoted-form? THING

Package: hu.dwim.stefil
Source: duplicates.lisp (file)

Function: record/assertion-begins ()

Package: hu.dwim.stefil
Source: asserts.lisp (file)

Function: record/assertion-was-successful FORM

Package: hu.dwim.stefil
Source: asserts.lisp (file)

Function: record/failure FAILURE-DESCRIPTION-TYPE &rest ARGS

Package: hu.dwim.stefil
Source: asserts.lisp (file)

Function: record/failure* FAILURE-DESCRIPTION-TYPE &key SIGNAL-ASSERTION-FAILED DESCRIPTION-INITARGS

Package: hu.dwim.stefil
Source: asserts.lisp (file)

Function: record/unexpected-error CONDITION

Package: hu.dwim.stefil
Source: asserts.lisp (file)

Function: register-test-being-run TEST

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Function: run-test-body TEST FUNCTION ARGUMENTS TOPLEVEL-P TIMEOUT

Package: hu.dwim.stefil
Source: test.lisp (file)

Function: run-test-body-in-handlers TEST FUNCTION

Package: hu.dwim.stefil
Source: test.lisp (file)

Function: test-was-run-p TEST

Package: hu.dwim.stefil
Source: infrastructure.lisp (file)

Function: write-progress-char CHAR

Package: hu.dwim.stefil
Source: asserts.lisp (file)

6.2.4 Generic functions

Generic Function: assertion-count-of OBJECT

Generic Function: (setf assertion-count-of) NEW-VALUE OBJECT

Package

• Introduction		What hu.dwim.stefil is all about
• Systems		The systems documentation
• Modules		The modules documentation
• Files		The files documentation
• Packages		The packages documentation
• Definitions		The symbols documentation
• Indexes		Concepts, functions, variables and data types

• The hu.dwim.stefil.asd file
• The hu.dwim.stefil/source/asserts.lisp file
• The hu.dwim.stefil/source/package.lisp file
• The hu.dwim.stefil/source/duplicates.lisp file
• The hu.dwim.stefil/source/fixture.lisp file
• The hu.dwim.stefil/source/infrastructure.lisp file
• The hu.dwim.stefil/source/test.lisp file
• The hu.dwim.stefil/source/suite.lisp file

• Exported special variables
• Exported macros
• Exported functions

• Internal special variables
• Internal macros
• Internal functions
• Internal generic functions
• Internal conditions
• Internal classes

• Concept index
• Function index
• Variable index
• Data type index

	Index Entry	Section

F
	File, Lisp, `hu.dwim.stefil.asd`:	The hu․dwim․stefil․asd file
	File, Lisp, `hu.dwim.stefil/source/asserts.lisp`:	The hu․dwim․stefil/source/asserts․lisp file
	File, Lisp, `hu.dwim.stefil/source/duplicates.lisp`:	The hu․dwim․stefil/source/duplicates․lisp file
	File, Lisp, `hu.dwim.stefil/source/fixture.lisp`:	The hu․dwim․stefil/source/fixture․lisp file
	File, Lisp, `hu.dwim.stefil/source/infrastructure.lisp`:	The hu․dwim․stefil/source/infrastructure․lisp file
	File, Lisp, `hu.dwim.stefil/source/package.lisp`:	The hu․dwim․stefil/source/package․lisp file
	File, Lisp, `hu.dwim.stefil/source/suite.lisp`:	The hu․dwim․stefil/source/suite․lisp file
	File, Lisp, `hu.dwim.stefil/source/test.lisp`:	The hu․dwim․stefil/source/test․lisp file

H
	`hu.dwim.stefil.asd`:	The hu․dwim․stefil․asd file
	`hu.dwim.stefil/source`:	The hu․dwim․stefil/source module
	`hu.dwim.stefil/source/asserts.lisp`:	The hu․dwim․stefil/source/asserts․lisp file
	`hu.dwim.stefil/source/duplicates.lisp`:	The hu․dwim․stefil/source/duplicates․lisp file
	`hu.dwim.stefil/source/fixture.lisp`:	The hu․dwim․stefil/source/fixture․lisp file
	`hu.dwim.stefil/source/infrastructure.lisp`:	The hu․dwim․stefil/source/infrastructure․lisp file
	`hu.dwim.stefil/source/package.lisp`:	The hu․dwim․stefil/source/package․lisp file
	`hu.dwim.stefil/source/suite.lisp`:	The hu․dwim․stefil/source/suite․lisp file
	`hu.dwim.stefil/source/test.lisp`:	The hu․dwim․stefil/source/test․lisp file

L
	Lisp File, `hu.dwim.stefil.asd`:	The hu․dwim․stefil․asd file
	Lisp File, `hu.dwim.stefil/source/asserts.lisp`:	The hu․dwim․stefil/source/asserts․lisp file
	Lisp File, `hu.dwim.stefil/source/duplicates.lisp`:	The hu․dwim․stefil/source/duplicates․lisp file
	Lisp File, `hu.dwim.stefil/source/fixture.lisp`:	The hu․dwim․stefil/source/fixture․lisp file
	Lisp File, `hu.dwim.stefil/source/infrastructure.lisp`:	The hu․dwim․stefil/source/infrastructure․lisp file
	Lisp File, `hu.dwim.stefil/source/package.lisp`:	The hu․dwim․stefil/source/package․lisp file
	Lisp File, `hu.dwim.stefil/source/suite.lisp`:	The hu․dwim․stefil/source/suite․lisp file
	Lisp File, `hu.dwim.stefil/source/test.lisp`:	The hu․dwim․stefil/source/test․lisp file

M
	Module, `hu.dwim.stefil/source`:	The hu․dwim․stefil/source module

	Index Entry	Section

*
	`compile-tests-before-run`:	Internal special variables
	`compile-tests-with-debug-level`:	Internal special variables
	`context`:	Internal special variables
	`debug-on-assertion-failure`:	Exported special variables
	`debug-on-unexpected-error`:	Exported special variables
	`failures-and-errors-are-expected`:	Internal special variables
	`fixture-body-aliases`:	Internal special variables
	`global-context`:	Internal special variables
	`last-test-result`:	Exported special variables
	`print-test-run-progress`:	Exported special variables
	`root-suite`:	Internal special variables
	`suite`:	Internal special variables
	`test-progress-print-right-margin`:	Exported special variables
	`test-result-history`:	Exported special variables
	`test-run-standard-output`:	Internal special variables
	`tests`:	Internal special variables

A
	`assertion-count`:	Internal classes
	`auto-call`:	Internal classes

B
	`body`:	Internal classes

C
	`children`:	Internal classes
	`compile-before-run`:	Internal classes
	`condition`:	Internal classes
	`condition`:	Internal classes
	`current-test`:	Internal classes

D
	`debug-on-assertion-failure-p`:	Internal classes
	`debug-on-unexpected-error-p`:	Internal classes
	`declarations`:	Internal classes
	`documentation`:	Internal classes

E
	`expected`:	Internal classes

F
	`failure-description`:	Internal conditions
	`failure-descriptions`:	Internal classes
	`form`:	Internal classes
	`form`:	Internal classes
	`form`:	Internal classes
	`format-arguments`:	Internal classes
	`format-control`:	Internal classes

I
	`internal-realtime-spent-with-test`:	Internal classes

L
	`lambda-list`:	Internal conditions
	`lambda-list`:	Internal classes

N
	`name`:	Internal classes
	`number-of-added-failure-descriptions`:	Internal classes

P
	`package`:	Internal classes
	`parent`:	Internal classes
	`parent-context`:	Internal classes
	`print-test-run-progress-p`:	Internal classes
	`progress-char`:	Internal classes
	`progress-char`:	Internal classes
	`progress-char-count`:	Internal classes

R
	`record-success-descriptions-p`:	Internal classes
	`run-fixtures`:	Internal classes
	`run-tests`:	Internal classes

S
	`Slot, assertion-count`:	Internal classes
	`Slot, auto-call`:	Internal classes
	`Slot, body`:	Internal classes
	`Slot, children`:	Internal classes
	`Slot, compile-before-run`:	Internal classes
	`Slot, condition`:	Internal classes
	`Slot, condition`:	Internal classes
	`Slot, current-test`:	Internal classes
	`Slot, debug-on-assertion-failure-p`:	Internal classes
	`Slot, debug-on-unexpected-error-p`:	Internal classes
	`Slot, declarations`:	Internal classes
	`Slot, documentation`:	Internal classes
	`Slot, expected`:	Internal classes
	`Slot, failure-description`:	Internal conditions
	`Slot, failure-descriptions`:	Internal classes
	`Slot, form`:	Internal classes
	`Slot, form`:	Internal classes
	`Slot, form`:	Internal classes
	`Slot, format-arguments`:	Internal classes
	`Slot, format-control`:	Internal classes
	`Slot, internal-realtime-spent-with-test`:	Internal classes
	`Slot, lambda-list`:	Internal conditions
	`Slot, lambda-list`:	Internal classes
	`Slot, name`:	Internal classes
	`Slot, number-of-added-failure-descriptions`:	Internal classes
	`Slot, package`:	Internal classes
	`Slot, parent`:	Internal classes
	`Slot, parent-context`:	Internal classes
	`Slot, print-test-run-progress-p`:	Internal classes
	`Slot, progress-char`:	Internal classes
	`Slot, progress-char`:	Internal classes
	`Slot, progress-char-count`:	Internal classes
	`Slot, record-success-descriptions-p`:	Internal classes
	`Slot, run-fixtures`:	Internal classes
	`Slot, run-tests`:	Internal classes
	`Slot, success-descriptions`:	Internal classes
	`Slot, test`:	Internal conditions
	`Slot, test`:	Internal classes
	`Slot, test-arguments`:	Internal classes
	`Slot, test-context-backtrace`:	Internal classes
	`Slot, test-lambdas`:	Internal classes
	`Slot, toplevel-context`:	Internal classes
	`Special Variable, compile-tests-before-run`:	Internal special variables
	`Special Variable, compile-tests-with-debug-level`:	Internal special variables
	`Special Variable, context`:	Internal special variables
	`Special Variable, debug-on-assertion-failure`:	Exported special variables
	`Special Variable, debug-on-unexpected-error`:	Exported special variables
	`Special Variable, failures-and-errors-are-expected`:	Internal special variables
	`Special Variable, fixture-body-aliases`:	Internal special variables
	`Special Variable, global-context`:	Internal special variables
	`Special Variable, last-test-result`:	Exported special variables
	`Special Variable, print-test-run-progress`:	Exported special variables
	`Special Variable, root-suite`:	Internal special variables
	`Special Variable, suite`:	Internal special variables
	`Special Variable, test-progress-print-right-margin`:	Exported special variables
	`Special Variable, test-result-history`:	Exported special variables
	`Special Variable, test-run-standard-output`:	Internal special variables
	`Special Variable, tests`:	Internal special variables
	`success-descriptions`:	Internal classes

T
	`test`:	Internal conditions
	`test`:	Internal classes
	`test-arguments`:	Internal classes
	`test-context-backtrace`:	Internal classes
	`test-lambdas`:	Internal classes
	`toplevel-context`:	Internal classes

	Index Entry	Section

A
	`assertion-failed`:	Internal conditions

C
	`Class, context`:	Internal classes
	`Class, extra-condition`:	Internal classes
	`Class, failed-assertion`:	Internal classes
	`Class, failure-description`:	Internal classes
	`Class, failure-description/condition`:	Internal classes
	`Class, global-context`:	Internal classes
	`Class, missing-condition`:	Internal classes
	`Class, succeeded-assertion`:	Internal classes
	`Class, test`:	Internal classes
	`Class, testable`:	Internal classes
	`Class, unexpected-error`:	Internal classes
	`Condition, assertion-failed`:	Internal conditions
	`Condition, illegal-lambda-list`:	Internal conditions
	`Condition, test-related-condition`:	Internal conditions
	`Condition, test-style-warning`:	Internal conditions
	`context`:	Internal classes

E
	`extra-condition`:	Internal classes

F
	`failed-assertion`:	Internal classes
	`failure-description`:	Internal classes
	`failure-description/condition`:	Internal classes

G
	`global-context`:	Internal classes

H
	`hu.dwim.stefil`:	The hu․dwim․stefil system
	`hu.dwim.stefil`:	The hu․dwim․stefil package

I
	`illegal-lambda-list`:	Internal conditions

M
	`missing-condition`:	Internal classes

P
	`Package, hu.dwim.stefil`:	The hu․dwim․stefil package

S
	`succeeded-assertion`:	Internal classes
	`System, hu.dwim.stefil`:	The hu․dwim․stefil system

T
	`test`:	Internal classes
	`test-related-condition`:	Internal conditions
	`test-style-warning`:	Internal conditions
	`testable`:	Internal classes

U
	`unexpected-error`:	Internal classes

The hu.dwim.stefil Reference Manual

Table of Contents

The hu.dwim.stefil Reference Manual

1 Introduction

2 Systems

2.1 hu.dwim.stefil

3 Modules

3.1 hu.dwim.stefil/source

4 Files

4.1 Lisp

4.1.1 hu.dwim.stefil.asd

4.1.2 hu.dwim.stefil/source/asserts.lisp

4.1.3 hu.dwim.stefil/source/package.lisp

4.1.4 hu.dwim.stefil/source/duplicates.lisp

4.1.5 hu.dwim.stefil/source/fixture.lisp

4.1.6 hu.dwim.stefil/source/infrastructure.lisp

4.1.7 hu.dwim.stefil/source/test.lisp

4.1.8 hu.dwim.stefil/source/suite.lisp

5 Packages

5.1 hu.dwim.stefil

6 Definitions

6.1 Exported definitions

6.1.1 Special variables

6.1.2 Macros

6.1.3 Functions

6.2 Internal definitions

6.2.1 Special variables

6.2.2 Macros

6.2.3 Functions

6.2.4 Generic functions

6.2.5 Conditions

6.2.6 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `hu.dwim.stefil`

3.1 `hu.dwim.stefil/source`

4.1.1 `hu.dwim.stefil.asd`

4.1.2 `hu.dwim.stefil/source/asserts.lisp`

4.1.3 `hu.dwim.stefil/source/package.lisp`

4.1.4 `hu.dwim.stefil/source/duplicates.lisp`

4.1.5 `hu.dwim.stefil/source/fixture.lisp`

4.1.6 `hu.dwim.stefil/source/infrastructure.lisp`

4.1.7 `hu.dwim.stefil/source/test.lisp`

4.1.8 `hu.dwim.stefil/source/suite.lisp`

5.1 `hu.dwim.stefil`