The clunit2 Reference Manual

4.1.1 clunit2/clunit2.asd

Source

clunit2.asd.

Parent Component

clunit2 (system).

ASDF Systems

clunit2.

4.1.2 clunit2/src/package.lisp

Source

clunit2.asd.

Parent Component

src (module).

Packages

clunit.

4.1.3 clunit2/src/specials.lisp

Dependency

package.lisp (file).

Source

clunit2.asd.

Parent Component

src (module).

Public Interface

• *clunit-equality-test* (special variable).
• *clunit-report-format* (special variable).
• *test-output-stream* (special variable).

Internals

• *clunit-report* (special variable).
• *clunit-test-report* (special variable).
• *last-clunit-report* (special variable).
• *queued-test-reports* (special variable).
• *report-progress* (special variable).
• *stop-on-fail* (special variable).
• *suite-name* (special variable).
• *tab-width* (special variable).
• *test-case-hashtable* (special variable).
• *test-name* (special variable).
• *test-suite-alist* (special variable).
• *test-suite-hashtable* (special variable).
• *use-debugger* (special variable).

4.1.4 clunit2/src/classes/assertion-conditions.lisp

Source

clunit2.asd.

Parent Component

classes (module).

Internals

• assertion-condition (condition).
• assertion-error (condition).
• assertion-fail-forced (condition).
• assertion-failed (condition).
• assertion-passed (condition).

4.1.5 clunit2/src/classes/test-suite-failure-conditions.lisp

Source

clunit2.asd.

Parent Component

classes (module).

Internals

• test-suite-failure (condition).
• test-suite-failure-condition (condition).

4.1.6 clunit2/src/classes/clunit-report.lisp

Source

clunit2.asd.

Parent Component

classes (module).

Public Interface

• clunit-report (class).
• test-reports (reader method).
• (setf test-reports) (writer method).

Internals

• errors (reader method).
• (setf errors) (writer method).
• failed (reader method).
• (setf failed) (writer method).
• passed (reader method).
• (setf passed) (writer method).
• skipped (reader method).
• (setf skipped) (writer method).

4.1.7 clunit2/src/classes/clunit-test-case.lisp

Source

clunit2.asd.

Parent Component

classes (module).

Internals

• clunit-test-case (class).
• dependencies (reader method).
• (setf dependencies) (writer method).
• name (reader method).
• (setf name) (writer method).
• named-class (class).
• test-function (reader method).
• (setf test-function) (writer method).

4.1.8 clunit2/src/classes/clunit-test-suite.lisp

Source

clunit2.asd.

Parent Component

classes (module).

Internals

• child-suites (reader method).
• (setf child-suites) (writer method).
• clunit-test-suite (class).
• collect-suite-dependencies (function).
• test-cases (reader method).
• (setf test-cases) (writer method).

4.1.9 clunit2/src/classes/clunit-test-report.lisp

Source

clunit2.asd.

Parent Component

classes (module).

Public Interface

• clunit-test-report (class).
• test-report-name (reader method).
• (setf test-report-name) (writer method).
• test-report-passed-p (reader method).

Internals

• +assertion-conditions-reserved-size+ (constant).
• assertion-conditions (reader method).
• (setf assertion-conditions) (writer method).
• skipped-p (reader method).
• (setf skipped-tests) (writer method).
• suite-list (reader method).
• (setf suite-list) (writer method).
• (setf test-report-passed) (writer method).

4.1.10 clunit2/src/functions/utilities.lisp

Source

clunit2.asd.

Parent Component

functions (module).

Internals

• all-symbols-p (function).
• deftest-declaration-dependencies (function).
• ensure-dependency-exists (function).

4.1.11 clunit2/src/functions/prepare-specials.lisp

Source

clunit2.asd.

Parent Component

functions (module).

Internals

with-prepare-specials-for-testing (macro).

4.1.12 clunit2/src/functions/assertion-functions.lisp

Source

clunit2.asd.

Parent Component

functions (module).

Internals

• handle-assertion (function).
• handle-error (function).
• signal-assertion (function).

4.1.13 clunit2/src/functions/generic-functions.lisp

Source

clunit2.asd.

Parent Component

functions (module).

Internals

• expand-fixture (generic function).
• print-format (generic function).

4.1.14 clunit2/src/functions/test-case-functions.lisp

Source

clunit2.asd.

Parent Component

functions (module).

Public Interface

• defined-test-p (function).
• get-defined-tests (function).
• run-test (function).

Internals

• add-test-case (function).
• delete-test-case (function).
• execute-test-case (function).
• get-test-case (function).
• process-queued-tests (function).
• queue-test-case (function).
• skip-test-case (function).
• test-case-execution-action (function).

4.1.15 clunit2/src/functions/test-suite-functions.lisp

Source

clunit2.asd.

Parent Component

functions (module).

Public Interface

• defined-suite-p (function).
• get-child-suites (function).
• get-child-tests (function).
• get-defined-suites (function).
• run-suite (function).

Internals

• delete-test-suite (function).
• execute-test-suite (function).
• get-test-suite (function).
• (setf get-test-suite) (function).

4.1.16 clunit2/src/functions/rerun-failed-tests.lisp

Source

clunit2.asd.

Parent Component

functions (module).

Public Interface

rerun-failed-tests (function).

4.1.17 clunit2/src/functions/progress-report-functions.lisp

Source

clunit2.asd.

Parent Component

functions (module).

Internals

• report-assertion-progress (function).
• report-suite-progress (function).
• report-test-progress (function).

4.1.18 clunit2/src/report-formats/report-format-default.lisp

Source

clunit2.asd.

Parent Component

report-formats (module).

Internals

• print-format (method).
• print-format (method).
• print-format (method).
• print-format (method).
• print-format (method).
• print-format (method).

4.1.19 clunit2/src/report-formats/report-format-tap.lisp

Source

clunit2.asd.

Parent Component

report-formats (module).

Internals

• *tap-test-num* (special variable).
• print-format (method).
• print-format (method).
• print-format (method).
• print-format (method).
• print-format (method).

4.1.20 clunit2/src/report-formats/print-object.lisp

Source

clunit2.asd.

Parent Component

report-formats (module).

Public Interface

• print-object (method).
• print-object (method).
• print-object (method).

4.1.21 clunit2/src/macros/utility-macros.lisp

Source

clunit2.asd.

Parent Component

macros (module).

Internals

• with-assert-restart (macro).
• with-gensyms (macro).
• with-test-restart (macro).

4.1.22 clunit2/src/macros/assertion-macros.lisp

Dependency

utility-macros.lisp (file).

Source

clunit2.asd.

Parent Component

macros (module).

Public Interface

• assert-condition (macro).
• assert-eq (macro).
• assert-eql (macro).
• assert-equal (macro).
• assert-equality (macro).
• assert-equality* (macro).
• assert-equalp (macro).
• assert-expands (macro).
• assert-fail (function).
• assert-false (macro).
• assert-true (macro).

Internals

• assertion-expander (function).
• form-expander (function).
• gen-test-form (macro).

4.1.23 clunit2/src/macros/deffixture.lisp

Dependency

assertion-macros.lisp (file).

Source

clunit2.asd.

Parent Component

macros (module).

Public Interface

• deffixture (macro).
• undeffixture (macro).

4.1.24 clunit2/src/macros/defsuite.lisp

Dependency

deffixture.lisp (file).

Source

clunit2.asd.

Parent Component

macros (module).

Public Interface

• defsuite (macro).
• undefsuite (macro).

4.1.25 clunit2/src/macros/deftest.lisp

Dependency

defsuite.lisp (file).

Source

clunit2.asd.

Parent Component

macros (module).

Public Interface

• deftest (macro).
• undeftest (macro).

Internals

collect-all-suite-dependencies (function).

6.1.1 Special variables

Special Variable: *clunit-equality-test* ¶

Holds the equality test used to compare values by the ASSERT-EQUALITY macro.<br/> The default value <em>#’equalp</em> is reset at the end of each test/suite run.

Package

clunit.

Source

specials.lisp.

Special Variable: *clunit-report-format* ¶

Controls the output format of the unit test results. Possible values are :default, :tap or NIL.

Package

clunit.

Source

specials.lisp.

Special Variable: *test-output-stream* ¶

The stream where the output made by tests is printed (default to ‘*standard-output*’)

Package

clunit.

Source

specials.lisp.

6.1.2 Macros

Macro: assert-condition (condition expression &body forms) ¶

Evaluates EXPRESSION as an assertion, an assertion passes if EXPRESSION signals CONDITION. FORMS and their values are printed if the test fails.

Example:

(assert-condition arithmetic-error (/ 1 0)) ; This assertion passes.

Package

clunit.

Source

assertion-macros.lisp.

Macro: assert-eq (value expression &body forms) ¶

Evaluates EXPRESSION as an assertion, an assertion passes if (EQ VALUE EXPRESSION) values non nil. FORMS and their values are printed if the test fails.

Package

clunit.

Source

assertion-macros.lisp.

Macro: assert-eql (value expression &body forms) ¶

Evaluates EXPRESSION as an assertion, an assertion passes if (EQL VALUE EXPRESSION) values non nil. FORMS and their values are printed if the test fails.

Package

clunit.

Source

assertion-macros.lisp.

Macro: assert-equal (value expression &body forms) ¶

Evaluates EXPRESSION as an assertion, an assertion passes if (EQUAL VALUE EXPRESSION) values non nil. FORMS and their values are printed if the test fails.

example
(let ((q (+ 2 -2)))
(assert-equal 4 q q))
;; This assertion fails and prints the message below with ;; *clunit-report-format* set to :DEFAULT.
Expression: (EQUAL 4 Q)
Expected: 4
Returned: 0
Q => 0

Package

clunit.

Source

assertion-macros.lisp.

Macro: assert-equality (test value expression &body forms) ¶

Evaluates EXPRESSION as an assertion, an assertion passes
if (FUNCALL TEST VALUE EXPRESSION) values non nil. FORMS and their
values are printed if the test fails.

Example:

(assert-equality #’string= "some string" "another string") ; This assertion fails.

Package

clunit.

Source

assertion-macros.lisp.

Macro: assert-equality* (value expression &body forms) ¶

Evaluates EXPRESSION as an assertion, an assertion passes
if (FUNCALL *clunit-equality-test* VALUE EXPRESSION) returns
true. FORMS and their values are printed if the test fails.

Example:

(let ((*clunit-equality-test* #’string=))
(assert-equality* "some string" "another string")) ; This assertion fails

Package

clunit.

Source

assertion-macros.lisp.

Macro: assert-equalp (value expression &body forms) ¶

Evaluates EXPRESSION as an assertion, an assertion passes if (EQUALP VALUE EXPRESSION) values non nil. FORMS and their values are printed if the test fails.

Package

clunit.

Source

assertion-macros.lisp.

Macro: assert-expands (expansion expression &body forms) ¶

Evaluates EXPRESSION as an assertion, an assertion passes if (EQUALP EXPANSION (MACROEXPAND-1 EXPRESSION)) values non nil. FORMS and their values are printed if the test fails.

Package

clunit.

Source

assertion-macros.lisp.

Macro: assert-false (expression &body forms) ¶

Evaluates EXPRESSION as an assertion, an assertion passes if it returns nil. FORMS and their values are printed if the test fails.

example:

(assert-false (= 1 2)) ; This assertion passes.

Package

clunit.

Source

assertion-macros.lisp.

Macro: assert-true (expression &body forms) ¶

Evaluates EXPRESSION as an assertion, an assertion passes if it returns any non-NIL value. FORMS and their values are printed if the test fails. Remember in Common Lisp any non-NIL value is true, if you want a strict binary assertion test use (assert-eq t expression) instead.

Example:

(assert-true (= 1 1)) ; This assertion passes.

Package

clunit.

Source

assertion-macros.lisp.

Macro: deffixture (suite (plug) &body body) ¶

A fixture defines a code template that is wrapped around the code of each test case and test suite that are executed by test suite SUITE at runtime.. The test case body is plugged into the template at the position identified by PLUG.

Fixtures are expanded at compile time.

Example:

(deffixture arithmetic (@body) ; @body is the plug
(let ((x 0) (y 1) (z 2))
@body))

Package

clunit.

Source

deffixture.lisp.

Macro: defsuite (name parents) ¶

Defines a test suite called NAME. If PARENTS is non-NIL the test suite is defined as a sub-suite of each of the test suites in PARENTS.

Example:

(defsuite arithmetic ())

(defsuite arithmetic-+ (arithmetic))

Package

clunit.

Source

defsuite.lisp.

Macro: deftest (name declarations &body body) ¶

Defines a test case called NAME. DECLARATIONS declares which test
suites this test case is associated with as well as any other test
cases that it depends on. The test case body is revaluated on each
run, so any redefinition of macros and inline functions will be automatically visible without having to redefine the test.

A test case will be queued until all tests cases it depends on have been run.
If all the test cases pass the queued test is executed otherwise its skipped.

The DEFTEST macro has three possible forms:

- Define a test case not associated with any test suite and with no dependencies.<br/> (deftest name () . body)

- Define a test case which is associated with test suites: suite1 ... suiteN. (deftest name (suite1 suite2 ... suiteN) . body)

- Define a test case associated with test suites: suite1 ... suiteN and
depends on tests: test1 ... testN

(deftest name ((suite1 suite2 ... suiteN) (test1 test2 ... testN)) . body)

Package

clunit.

Source

deftest.lisp.

Macro: undeffixture (name) ¶

Remove a fixture definition.

Package

clunit.

Source

deffixture.lisp.

Macro: undefsuite (name) ¶

Package

clunit.

Source

defsuite.lisp.

Macro: undeftest (name) ¶

Package

clunit.

Source

deftest.lisp.

6.1.3 Ordinary functions

Function: assert-fail (format-string &rest args) ¶

Calling this function is equivalent to signalling a failed assertion. The FORMAT-STRING and ARGS are used to print the failure message as follows:

(format stream "~?" format-string args)

If you want to achieve a nice looking output message, use pretty printing directives in the format string e.g. "~:@_" instead of "%".

Package

clunit.

Source

assertion-macros.lisp.

Function: defined-suite-p (suite-name) ¶

Returns non-nil if a test suite called SUITE-NAME is defined, otherwise returns NIL.

Package

clunit.

Source

test-suite-functions.lisp.

Function: defined-test-p (test-name) ¶

Returns non-nil if a test case called TEST-NAME is defined, otherwise returns NIL.

Package

clunit.

Source

test-case-functions.lisp.

Function: get-child-suites (suite-name) ¶

Returns a list of all test suite names that are children of the suite called SUITE-NAME.

Package

clunit.

Source

test-suite-functions.lisp.

Function: get-child-tests (suite-name) ¶

Returns a list of all test case names that are children of the suite called SUITE-NAME.

Package

clunit.

Source

test-suite-functions.lisp.

Function: get-defined-suites () ¶

Returns a list of all defined test suite names.

Package

clunit.

Source

test-suite-functions.lisp.

Function: get-defined-tests () ¶

Returns a list of all defined test case names.

Package

clunit.

Source

test-case-functions.lisp.

Function: rerun-failed-tests (&key use-debugger report-progress stop-on-fail last-report print-results-summary) ¶

Reruns all failed tests recorded in LAST-REPORT which defaults to the report of the previous test run. If REPORT-PROGRESS is non-NIL, the test progress is reported. If USE-DEBUGGER is non-NIL, the debugger is invoked whenever an assertion fails.

If STOP-ON-FAIL is non-NIL, the rest of the unit test is cancelled when any assertion fails or an error occurs.

If PRINT-RESULTS-SUMMARY is non nil the summary results of tests is printed on the standard output.

Package

clunit.

Source

rerun-failed-tests.lisp.

Function: run-suite (suite &key use-debugger report-progress stop-on-fail signal-condition-on-fail print-results-summary) ¶

Executes a test case called SUITE. If REPORT-PROGRESS is non-NIL, the test progress is reported.

If USE-DEBUGGER is non-NIL, the debugger is invoked whenever an assertion fails.

If STOP-ON-FAIL is non-NIL, the rest of the unit test is cancelled when any assertion fails or an error occurs.

if PRINT-RESULTS-SUMMARY is non nil the summary results of tests is printed on the standard output.

Package

clunit.

Source

test-suite-functions.lisp.

Function: run-test (test &key use-debugger report-progress stop-on-fail print-results-summary) ¶

Executes a test case called ‘test’.

If REPORT-PROGRESS is non-NIL, the test progress is reported.

If USE-DEBUGGER is non-NIL, the debugger is invoked whenever an assertion fails.

If STOP-ON-FAIL is non-NIL, the rest of the unit test is cancelled when any assertion fails or an error occurs.

If PRINT-RESULTS-SUMMARY is non nil the summary results of tests is printed on the standard output.

Package

clunit.

Source

test-case-functions.lisp.

6.1.4 Generic functions

Generic Reader: test-report-name (object) ¶

Generic Writer: (setf test-report-name) (object) ¶

Package

clunit.

Methods

Reader Method: test-report-name ((clunit-test-report clunit-test-report)) ¶

Writer Method: (setf test-report-name) ((clunit-test-report clunit-test-report)) ¶

the reader function is used in test-case-execution-action (see utility functions)

Source

clunit-test-report.lisp.

Target Slot

test-name.

Generic Reader: test-report-passed-p (object) ¶

Package

clunit.

Methods

Reader Method: test-report-passed-p ((clunit-test-report clunit-test-report)) ¶

Non-nil if the report passed

Source

clunit-test-report.lisp.

Target Slot

passed-p.

Generic Reader: test-reports (object) ¶

Generic Writer: (setf test-reports) (object) ¶

Package

clunit.

Methods

Reader Method: test-reports ((clunit-report clunit-report)) ¶

Writer Method: (setf test-reports) ((clunit-report clunit-report)) ¶

A list of ‘cl-test-report’ that contains all the test’s reports

Source

clunit-report.lisp.

Target Slot

test-reports.

6.1.5 Standalone methods

Method: print-object ((clunit-report clunit-report) stream) ¶

Source

print-object.lisp.

Method: print-object ((clunit-test-report clunit-test-report) stream) ¶

Source

print-object.lisp.

Method: print-object ((assertion-condition assertion-condition) stream) ¶

Source

print-object.lisp.

6.1.6 Classes

Class: clunit-report ¶

the clunit-report instance is used to store the
aggregated reports of all executed test cases (returned by ‘run-test’ and ‘rerun-failed-tests’.

Package

clunit.

Source

clunit-report.lisp.

Direct methods

• (setf errors).
• errors.
• (setf failed).
• failed.
• (setf passed).
• passed.
• print-format.
• print-format.
• print-object.
• (setf skipped).
• skipped.
• (setf test-reports).
• test-reports.

Direct slots

Slot: errors ¶

The number of tests that signalled an error condition during test executions.

Initform

0

Initargs

:errors

Readers

errors.

Writers

(setf errors).

Slot: failed ¶

The number of tests failed during test executions.

Initform

0

Initargs

:failed

Readers

failed.

Writers

(setf failed).

Slot: passed ¶

The number of tests that passed during test executions.

Initform

0

Initargs

:passed

Readers

passed.

Writers

(setf passed).

Slot: skipped ¶

The number of tests that was skipped during test executions.

Initform

0

Initargs

:skipped

Readers

skipped.

Writers

(setf skipped).

Slot: test-reports ¶

A list of ‘cl-test-report’ that contains all the test’s reports

Readers

test-reports.

Writers

(setf test-reports).

Class: clunit-test-report ¶

Package

clunit.

Source

clunit-test-report.lisp.

Direct methods

• (setf assertion-conditions).
• assertion-conditions.
• print-format.
• print-format.
• print-object.
• skipped-p.
• (setf skipped-tests).
• (setf suite-list).
• suite-list.
• (setf test-report-name).
• test-report-name.
• (setf test-report-passed).
• test-report-passed-p.

Direct slots

Slot: test-name ¶

the reader function is used in test-case-execution-action (see utility functions)

Initargs

:test-name

Readers

test-report-name.

Writers

(setf test-report-name).

Slot: passed-p ¶

Non-nil if the report passed

Initform

t

Initargs

:passed-p

Readers

test-report-passed-p.

Writers

(setf test-report-passed).

Slot: skipped-p ¶

Non-nil if the test was skipped

Initargs

:skipped-p

Readers

skipped-p.

Writers

(setf skipped-tests).

Slot: suite-list ¶

A list of the suites this test belong.

Initargs

:suite-list

Readers

suite-list.

Writers

(setf suite-list).

Slot: assertion-conditions ¶

the clunit-test-report instance is used to store the report information for each executed test case.

Initform

(make-array clunit::+assertion-conditions-reserved-size+ :adjustable t :fill-pointer 0)

Readers

assertion-conditions.

Writers

(setf assertion-conditions).

6.2.1 Constants

Constant: +assertion-conditions-reserved-size+ ¶

Package

clunit.

Source

clunit-test-report.lisp.

6.2.2 Special variables

Special Variable: *clunit-report* ¶

Holds a CLUNIT-REPORT object during a test run, used to store aggregated test reports.

Package

clunit.

Source

specials.lisp.

Special Variable: *clunit-test-report* ¶

Holds a CLUNIT-TEST-REPORT object for each executing test case.

Package

clunit.

Source

specials.lisp.

Special Variable: *last-clunit-report* ¶

Holds the last returned CLUNIT-REPORT object. Default optional argument to the function RERUN-FAILED-TESTS.

Package

clunit.

Source

specials.lisp.

Special Variable: *queued-test-reports* ¶

A list of queued CLUNIT-TEST-REPORT objects whose test case execution has been deferred until their dependencies requirements are met.

Package

clunit.

Source

specials.lisp.

Special Variable: *report-progress* ¶

This variable switches on progress reporting if set to true.

Package

clunit.

Source

specials.lisp.

Special Variable: *stop-on-fail* ¶

If any assertion fails or an error condition occurs, stop the unit test.

Package

clunit.

Source

specials.lisp.

Special Variable: *suite-name* ¶

Holds a list of suite symbol names in their current calling order. First called suite at the front, currently executing suite at the back.

Package

clunit.

Source

specials.lisp.

Special Variable: *tab-width* ¶

Number of tab columns to use for indentation (in the reporting functions).

Package

clunit.

Source

specials.lisp.

Special Variable: *tap-test-num* ¶

Counter used in these printing functions

Package

clunit.

Source

report-format-tap.lisp.

Special Variable: *test-case-hashtable* ¶

Holds CLUNIT-TEST-CASE instances. The key of each test case object is the symbol name.

Package

clunit.

Source

specials.lisp.

Special Variable: *test-name* ¶

Holds the name of the test currently executing.

Package

clunit.

Source

specials.lisp.

Special Variable: *test-suite-alist* ¶

Holds CLUNIT-TEST-SUITE instances. The car of each test suite object is the symbol name.

Package

clunit.

Source

specials.lisp.

Special Variable: *test-suite-hashtable* ¶

Holds CLUNIT-TEST-SUITE instances. The key of each test suite object is the symbol name.

Package

clunit.

Source

specials.lisp.

Special Variable: *use-debugger* ¶

If set to true, the debugger is invoked whenever an assertion fails.

Package

clunit.

Source

specials.lisp.

6.2.3 Macros

Macro: gen-test-form (predicate values results) ¶

Package

clunit.

Source

assertion-macros.lisp.

Macro: with-assert-restart (&body body) ¶

WITH-ASSERT-RESTART places a restart called SKIP-ASSERTION around an assertion form.

Package

clunit.

Source

utility-macros.lisp.

Macro: with-gensyms (syms &body body) ¶

WITH-GENSYMS takes a list of symbols SYM and a list of body forms. It returns a LET clause with each symbol in SYM bound to a gensymbol and the body forms as the body of the let clause.

Package

clunit.

Source

utility-macros.lisp.

Macro: with-prepare-specials-for-testing ((report-progress use-debugger stop-on-fail) &body body) ¶

Set some common special variables to meaningful values to prepare for running tests or suite

Package

clunit.

Source

prepare-specials.lisp.

Macro: with-test-restart (&body body) ¶

Package

clunit.

Source

utility-macros.lisp.

6.2.4 Ordinary functions

Function: add-test-case (name new-test-case) ¶

Adds NEW-TEST-CASE in the hash table *TEST-CASES* under the key NAME.

Package

clunit.

Source

test-case-functions.lisp.

Function: all-symbols-p (list error-control-message) ¶

Ensures ‘list’ is a list of symbols.

In deftest ‘declarations’ can be a list of suites or a list of two elements, the first a list of suites and the second a list of tests, each memebre of said list must be a symbol.

Package

clunit.

Source

utilities.lisp.

Function: assertion-expander (&key result test result-expression report-expression expected forms) ¶

Expands an assertion macro call.

Package

clunit.

Source

assertion-macros.lisp.

Function: collect-all-suite-dependencies (direct-dependency-list) ¶

Package

clunit.

Source

deftest.lisp.

Function: collect-suite-dependencies (start &key symbol-suite-only) ¶

Package

clunit.

Source

clunit-test-suite.lisp.

Function: deftest-declaration-dependencies (declarations) ¶

When ‘declarations’ comes from the ‘deftest’ macro returns the dependencies (suites and optionally tests)

Package

clunit.

Source

utilities.lisp.

Function: delete-test-case (name) ¶

Deletes the TEST-CASE instance associated with the key NAME in the hash table *TEST-CASES*

Package

clunit.

Source

test-case-functions.lisp.

Function: delete-test-suite (name) ¶

Deletes the TEST-SUITE instance associated with the key NAME in the hash table *test-suite-hashtable*

Package

clunit.

Source

test-suite-functions.lisp.

Function: ensure-dependency-exists (name list predicate control-message) ¶

Package

clunit.

Source

utilities.lisp.

Function: execute-test-case (test-case) ¶

Package

clunit.

Source

test-case-functions.lisp.

Function: execute-test-suite (test-suite) ¶

Package

clunit.

Source

test-suite-functions.lisp.

Function: form-expander (forms) ¶

FORM-EXPANDER manipulates the list of forms provided to an assertion form, e.g. (defmacro assert-false (expression &rest forms) . body)

The members of the forms list are printed out when an assertion test fails. The example below, shows the debug output when an assertion form fails.

(let ((x 1) (y 2) (z 3))
;;forms = ’(x y "Comment: This is meant to fail." z) (assert-true (= x y z) x y "Comment: This is meant to fail." z))

======== Debug output ===========
Expression: (= x y z)
Expected: T
Returned: NIL
x => 1
y => 2
Comment: This is meant to fail.
z => 3
==================================
As you can see, the reporting is somehow able to differentiate between the symbols x, y, z and the string comment.
This is achieved by expanding ’(x y "Comment..." z) => (T ’x x T ’y y NIL "Comment..." T ’z z)
The T or NIL symbol tells the reporting function whether to report the next two values as a pair or not.
I went at great lengths to explain this because WHAT the function does is straight forward from the code, but WHY it does it
isn’t too obvious unless someone tells you :o)

Package

clunit.

Source

assertion-macros.lisp.

Function: get-test-case (name) ¶

Retrieves the TEST-CASE instance associated with the key NAME in the hash table *TEST-CASES*

Package

clunit.

Source

test-case-functions.lisp.

Function: get-test-suite (name) ¶

Retrieves the TEST-SUITE instance associated with the key NAME in the hash table *test-suite-hashtable*

Package

clunit.

Source

test-suite-functions.lisp.

Function: (setf get-test-suite) (name) ¶

Adds NEW-TEST-SUITE in the hash table *test-suite-hashtable* and *test-suite-alist* under the key NAME.

Package

clunit.

Source

test-suite-functions.lisp.

Function: handle-assertion (condition) ¶

Records the result of assertion tests and records any errors that occur.

Package

clunit.

Source

assertion-functions.lisp.

Function: handle-error (error) ¶

Package

clunit.

Source

assertion-functions.lisp.

Function: process-queued-tests () ¶

Package

clunit.

Source

test-case-functions.lisp.

Function: queue-test-case () ¶

Enqueue a test.

Package

clunit.

Source

test-case-functions.lisp.

Function: report-assertion-progress (type) ¶

Package

clunit.

Source

progress-report-functions.lisp.

Function: report-suite-progress (suite suite-list) ¶

Package

clunit.

Source

progress-report-functions.lisp.

Function: report-test-progress (test-name suite-list) ¶

Package

clunit.

Source

progress-report-functions.lisp.

Function: signal-assertion (type &key expression expected returned forms message format-string args) ¶

Package

clunit.

Source

assertion-functions.lisp.

Function: skip-test-case () ¶

Skip a test.

Package

clunit.

Source

test-case-functions.lisp.

Function: test-case-execution-action (test-case) ¶

Determines the execution action for TEST-CASE. If test case has no dependencies or pending dependencies, then :RUN is returned.

If test case has another test case it depends on that failed or was skipped, then :SKIP is returned.

If test case depends on test cases that have not yet run or are also queued, then :QUEUE is returned.

Package

clunit.

Source

test-case-functions.lisp.

6.2.5 Generic functions

Generic Reader: assertion-conditions (object) ¶

Generic Writer: (setf assertion-conditions) (object) ¶

Package

clunit.

Methods

Reader Method: assertion-conditions ((clunit-test-report clunit-test-report)) ¶

Writer Method: (setf assertion-conditions) ((clunit-test-report clunit-test-report)) ¶

the clunit-test-report instance is used to store the report information for each executed test case.

Source

clunit-test-report.lisp.

Target Slot

assertion-conditions.

Generic Reader: child-suites (object) ¶

Package

clunit.

Methods

Reader Method: child-suites ((clunit-test-suite clunit-test-suite)) ¶

automatically generated reader method

Source

clunit-test-suite.lisp.

Target Slot

child-suites.

Generic Writer: (setf child-suites) (object) ¶

Package

clunit.

Methods

Writer Method: (setf child-suites) ((clunit-test-suite clunit-test-suite)) ¶

automatically generated writer method

Source

clunit-test-suite.lisp.

Target Slot

child-suites.

Generic Reader: dependencies (object) ¶

Generic Writer: (setf dependencies) (object) ¶

Package

clunit.

Methods

Reader Method: dependencies ((clunit-test-case clunit-test-case)) ¶

Writer Method: (setf dependencies) ((clunit-test-case clunit-test-case)) ¶

The DEPENDENCIES slot holds the names of the test cases that
this test case depends on. Using an indirect reference like this allows us to easily undefine a test case without much cleaning up.

When we execute a test case and we resolve the references of the tests it depends on. If the object is not found it means the reference is now stale, so we remove the name from the list.

Source

clunit-test-case.lisp.

Target Slot

dependencies.

Generic Reader: errors (object) ¶

Generic Writer: (setf errors) (object) ¶

Package

clunit.

Methods

Reader Method: errors ((clunit-report clunit-report)) ¶

Writer Method: (setf errors) ((clunit-report clunit-report)) ¶

The number of tests that signalled an error condition during test executions.

Source

clunit-report.lisp.

Target Slot

errors.

Generic Function: expand-fixture (suite body) ¶

Expands out a fixture body for the given test suite.

Package

clunit.

Source

generic-functions.lisp.

Methods

Method: expand-fixture (suite body) ¶

Generic Reader: failed (object) ¶

Generic Writer: (setf failed) (object) ¶

Package

clunit.

Methods

Reader Method: failed ((clunit-report clunit-report)) ¶

Writer Method: (setf failed) ((clunit-report clunit-report)) ¶

The number of tests failed during test executions.

Source

clunit-report.lisp.

Target Slot

failed.

Generic Reader: name (object) ¶

Package

clunit.

Methods

Reader Method: name ((named-class named-class)) ¶

automatically generated reader method

Source

clunit-test-case.lisp.

Target Slot

name.

Generic Writer: (setf name) (object) ¶

Package

clunit.

Methods

Writer Method: (setf name) ((named-class named-class)) ¶

automatically generated writer method

Source

clunit-test-case.lisp.

Target Slot

name.

Generic Reader: passed (object) ¶

Generic Writer: (setf passed) (object) ¶

Package

clunit.

Methods

Reader Method: passed ((clunit-report clunit-report)) ¶

Writer Method: (setf passed) ((clunit-report clunit-report)) ¶

The number of tests that passed during test executions.

Source

clunit-report.lisp.

Target Slot

passed.

Generic Function: print-format (object format stream) ¶

Outputs the OBJECT report to STREAM in the given FORMAT. FORMAT can be :default, :tap or NIL.

Package

clunit.

Source

generic-functions.lisp.

Methods

Method: print-format ((condition assertion-fail-forced) (format (eql :tap)) stream) ¶

Source

report-format-tap.lisp.

Method: print-format ((condition assertion-failed) (format (eql :tap)) stream) ¶

Source

report-format-tap.lisp.

Method: print-format ((condition assertion-error) (format (eql :tap)) stream) ¶

Source

report-format-tap.lisp.

Method: print-format ((report clunit-test-report) (format (eql :tap)) stream) ¶

Source

report-format-tap.lisp.

Method: print-format ((clunit-report clunit-report) (format (eql :tap)) stream) ¶

Source

report-format-tap.lisp.

Method: print-format ((condition test-suite-failure-condition) (format (eql :default)) stream) ¶

Source

report-format-default.lisp.

Method: print-format ((condition assertion-fail-forced) (format (eql :default)) stream) ¶

Source

report-format-default.lisp.

Method: print-format ((condition assertion-failed) (format (eql :default)) stream) ¶

Source

report-format-default.lisp.

Method: print-format ((condition assertion-error) (format (eql :default)) stream) ¶

Source

report-format-default.lisp.

Method: print-format ((report clunit-test-report) (format (eql :default)) stream) ¶

Source

report-format-default.lisp.

Method: print-format ((clunit-report clunit-report) (format (eql :default)) stream) ¶

Source

report-format-default.lisp.

Generic Reader: skipped (object) ¶

Generic Writer: (setf skipped) (object) ¶

Package

clunit.

Methods

Reader Method: skipped ((clunit-report clunit-report)) ¶

Writer Method: (setf skipped) ((clunit-report clunit-report)) ¶

The number of tests that was skipped during test executions.

Source

clunit-report.lisp.

Target Slot

skipped.

Generic Reader: skipped-p (object) ¶

Package

clunit.

Methods

Reader Method: skipped-p ((clunit-test-report clunit-test-report)) ¶

Non-nil if the test was skipped

Source

clunit-test-report.lisp.

Target Slot

skipped-p.

Generic Writer: (setf skipped-tests) (object) ¶

Package

clunit.

Methods

Writer Method: (setf skipped-tests) ((clunit-test-report clunit-test-report)) ¶

Non-nil if the test was skipped

Source

clunit-test-report.lisp.

Target Slot

skipped-p.

Generic Reader: suite-list (object) ¶

Generic Writer: (setf suite-list) (object) ¶

Package

clunit.

Methods

Reader Method: suite-list ((clunit-test-report clunit-test-report)) ¶

Writer Method: (setf suite-list) ((clunit-test-report clunit-test-report)) ¶

A list of the suites this test belong.

Source

clunit-test-report.lisp.

Target Slot

suite-list.

Generic Reader: test-cases (object) ¶

Generic Writer: (setf test-cases) (object) ¶

Package

clunit.

Methods

Reader Method: test-cases ((clunit-test-suite clunit-test-suite)) ¶

Writer Method: (setf test-cases) ((clunit-test-suite clunit-test-suite)) ¶

The tests that belongs to this suite (list of symbols)

Source

clunit-test-suite.lisp.

Target Slot

test-cases.

Generic Reader: test-function (object) ¶

Generic Writer: (setf test-function) (object) ¶

Package

clunit.

Methods

Reader Method: test-function ((clunit-test-case clunit-test-case)) ¶

Writer Method: (setf test-function) ((clunit-test-case clunit-test-case)) ¶

The actual test, a function with no arguments that returns non nil if the test passed

Source

clunit-test-case.lisp.

Target Slot

test-function.

Generic Writer: (setf test-report-passed) (object) ¶

Package

clunit.

Methods

Writer Method: (setf test-report-passed) ((clunit-test-report clunit-test-report)) ¶

Non-nil if the report passed

Source

clunit-test-report.lisp.

Target Slot

passed-p.

6.2.6 Conditions

Condition: assertion-condition ¶

Package

clunit.

Source

assertion-conditions.lisp.

Direct superclasses

condition.

Direct subclasses

• assertion-error.
• assertion-fail-forced.
• assertion-failed.
• assertion-passed.

Direct methods

print-object.

Condition: assertion-error ¶

Package

clunit.

Source

assertion-conditions.lisp.

Direct superclasses

assertion-condition.

Direct methods

• print-format.
• print-format.

Direct slots

Slot: message ¶

this is a special case, if an unexpected condition
is signalled outside an assertion test, store the condition description here.

Initform

(quote "")

Initargs

:message

Condition: assertion-fail-forced ¶

Package

clunit.

Source

assertion-conditions.lisp.

Direct superclasses

assertion-condition.

Direct methods

• print-format.
• print-format.

Direct slots

Slot: format-string ¶

the format string argument passed to format.

Initform

(quote "")

Initargs

:format-string

Slot: args ¶

the format string arguments.

Initform

(quote "")

Initargs

:args

Condition: assertion-failed ¶

Package

clunit.

Source

assertion-conditions.lisp.

Direct superclasses

assertion-condition.

Direct methods

• print-format.
• print-format.

Direct slots

Slot: expression ¶

the expression that was tested.

Initform

(quote nil)

Initargs

:expression

Slot: forms ¶

holds a list of form-value pairs, see function expand-forms for more detail.

Initform

(quote nil)

Initargs

:forms

Slot: expected ¶

the value the expression was expected to return.

Initform

(quote nil)

Initargs

:expected

Slot: returned ¶

the result that was returned from evaluating the expression.

Initform

(quote nil)

Initargs

:returned

Condition: assertion-passed ¶

Package

clunit.

Source

assertion-conditions.lisp.

Direct superclasses

assertion-condition.

Condition: test-suite-failure ¶

Package

clunit.

Source

test-suite-failure-conditions.lisp.

Direct superclasses

test-suite-failure-condition.

Direct slots

Slot: test-errors ¶

The number of tests with errors.

Initform

(quote nil)

Initargs

:test-errors

Slot: test-failed ¶

The number of tests that failed.

Initform

(quote nil)

Initargs

:test-fails

Slot: total-tests ¶

The total number of tests.

Initform

(quote nil)

Initargs

:total-tests

Condition: test-suite-failure-condition ¶

Package

clunit.

Source

test-suite-failure-conditions.lisp.

Direct superclasses

condition.

Direct subclasses

test-suite-failure.

Direct methods

print-format.

6.2.7 Classes

Class: clunit-test-case ¶

Package

clunit.

Source

clunit-test-case.lisp.

Direct superclasses

named-class.

Direct methods

• (setf dependencies).
• dependencies.
• (setf test-function).
• test-function.

Direct slots

Slot: dependencies ¶

The DEPENDENCIES slot holds the names of the test cases that
this test case depends on. Using an indirect reference like this allows us to easily undefine a test case without much cleaning up.

When we execute a test case and we resolve the references of the tests it depends on. If the object is not found it means the reference is now stale, so we remove the name from the list.

Initargs

:dependencies

Readers

dependencies.

Writers

(setf dependencies).

Slot: test-function ¶

The actual test, a function with no arguments that returns non nil if the test passed

Initargs

:test-function

Readers

test-function.

Writers

(setf test-function).

Class: clunit-test-suite ¶

The slots test-cases, child-suites and
parent-suites hold the symbol names of test cases and test suites instead of the actual objects. using an indirect reference like this allows us to undefine a test case or test suite.

When we execute a test suite and try to resolve the reference for an object. if the object is not found, it means the reference is now stale so the name of that test case or suite is removed.

Package

clunit.

Source

clunit-test-suite.lisp.

Direct superclasses

named-class.

Direct methods

• (setf child-suites).
• child-suites.
• (setf test-cases).
• test-cases.

Direct slots

Slot: test-cases ¶

The tests that belongs to this suite (list of symbols)

Initargs

:test-cases

Readers

test-cases.

Writers

(setf test-cases).

Slot: child-suites ¶

Initargs

:child-suites

Readers

child-suites.

Writers

(setf child-suites).

Class: named-class ¶

A class for object with an identifier (the slot ’name’)

Package

clunit.

Source

clunit-test-case.lisp.

Direct subclasses

• clunit-test-case.
• clunit-test-suite.

Direct methods

• (setf name).
• name.

Direct slots

Slot: name ¶

Initargs

:name

Readers

name.

Writers

(setf name).