This is the prove Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 06:25:13 2024 GMT+0.
prove/prove.asd
prove/src/prove.lisp
prove/src/test.lisp
prove/src/report.lisp
prove/src/reporter.lisp
prove/src/reporter-components/tap.lisp
prove/src/reporter-components/fiveam.lisp
prove/src/reporter-components/list.lisp
prove/src/reporter-components/dot.lisp
prove/src/suite.lisp
prove/src/asdf.lisp
prove/src/color.lisp
prove/src/output.lisp
The main system appears first, followed by any subsystem dependency.
Modules are listed depth-first from the system components tree.
prove/src
prove
(system).
prove.lisp
(file).
test.lisp
(file).
report.lisp
(file).
reporter.lisp
(file).
reporter-components
(module).
suite.lisp
(file).
asdf.lisp
(file).
color.lisp
(file).
output.lisp
(file).
prove/src/reporter-components
report.lisp
(file).
reporter.lisp
(file).
color.lisp
(file).
src
(module).
tap.lisp
(file).
fiveam.lisp
(file).
list.lisp
(file).
dot.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
prove/prove.asd
prove/src/prove.lisp
prove/src/test.lisp
prove/src/report.lisp
prove/src/reporter.lisp
prove/src/reporter-components/tap.lisp
prove/src/reporter-components/fiveam.lisp
prove/src/reporter-components/list.lisp
prove/src/reporter-components/dot.lisp
prove/src/suite.lisp
prove/src/asdf.lisp
prove/src/color.lisp
prove/src/output.lisp
prove/src/prove.lisp
output.lisp
(file).
test.lisp
(file).
suite.lisp
(file).
asdf.lisp
(file).
color.lisp
(file).
src
(module).
prove/src/test.lisp
output.lisp
(file).
report.lisp
(file).
reporter.lisp
(file).
suite.lisp
(file).
src
(module).
*debug-on-error*
(special variable).
*default-test-function*
(special variable).
*gensym-prefix*
(special variable).
deftest
(macro).
diag
(function).
fail
(function).
is
(macro).
is-condition
(macro).
is-expand
(macro).
is-print
(macro).
is-type
(macro).
is-values
(macro).
isnt
(macro).
like
(macro).
ok
(macro).
pass
(function).
remove-test
(function).
remove-test-all
(function).
run-test
(function).
run-test-all
(function).
run-test-package
(function).
skip
(function).
subtest
(macro).
%subtest
(function).
*gensym-alist*
(special variable).
*package-tests*
(special variable).
gensym-tree-equal
(generic function).
gensymp
(function).
parse-description-and-test
(function).
test
(function).
with-catching-errors
(macro).
with-duration
(macro).
prove/src/report.lisp
src
(module).
comment-report
(class).
composed-test-report
(class).
error-report-p
(function).
error-test-report
(class).
failed-report-p
(function).
failed-test-report
(class).
normal-test-report
(class).
passed-report-p
(function).
passed-test-report
(class).
print-object
(method).
report
(class).
skipped-report-p
(function).
skipped-test-report
(class).
test-report
(class).
test-report-p
(function).
prove/src/reporter.lisp
report.lisp
(file).
output.lisp
(file).
src
(module).
*indent-level*
(special variable).
format-report
(generic function).
format/indent
(function).
print-error-report
(generic function).
print-finalize-report
(generic function).
print-plan-report
(generic function).
reporter
(class).
with-additional-indent
(macro).
*additional-indent*
(special variable).
*debug-indentation*
(special variable).
find-reporter
(function).
indent
(function).
prove/src/reporter-components/tap.lisp
reporter-components
(module).
format-report
(method).
format-report
(method).
format-report
(method).
print-error-report
(method).
print-finalize-report
(method).
print-plan-report
(method).
tap-reporter
(class).
prove/src/reporter-components/fiveam.lisp
reporter-components
(module).
format-report
(method).
format-report
(method).
print-error-report
(method).
print-error-report
(method).
print-error-report
(method).
print-finalize-report
(method).
fiveam-reporter
(class).
prove/src/reporter-components/list.lisp
reporter-components
(module).
format-report
(method).
format-report
(method).
format-report
(method).
format-report
(method).
format-report
(method).
format-report
(method).
list-reporter
(class).
print-finalize-report
(method).
print-plan-report
(method).
report-expected-line
(generic function).
escape-tildes
(function).
omit-long-value
(function).
possible-report-description
(function).
print-duration
(function).
prove/src/reporter-components/dot.lisp
list.lisp
(file).
reporter-components
(module).
format-report
(method).
format-report
(method).
print-finalize-report
(method).
print-finalize-report
(method).
dot-reporter
(class).
prove/src/suite.lisp
output.lisp
(file).
report.lisp
(file).
reporter.lisp
(file).
asdf.lisp
(file).
src
(module).
*default-slow-threshold*
(special variable).
*suite*
(special variable).
add-report
(function).
current-suite
(function).
failed
(reader method).
(setf failed)
(writer method).
finalize
(function).
package-suite
(class).
plan
(function).
reports
(reader method).
(setf reports)
(writer method).
slow-threshold
(function).
suite
(class).
suite-plan
(reader method).
(setf suite-plan)
(writer method).
test-count
(reader method).
(setf test-count)
(writer method).
*defined-suites*
(special variable).
find-package-suite
(function).
reset-suite
(function).
prove/src/asdf.lisp
output.lisp
(file).
color.lisp
(file).
src
(module).
*last-suite-report*
(special variable).
compute-action-stamp
(method).
perform
(method).
perform
(method).
run
(function).
run-test-system
(function).
test-file
(class).
*system-test-files*
(special variable).
test-files-in-directory
(function).
prove/src/color.lisp
src
(module).
*enable-colors*
(special variable).
with-color
(macro).
with-gray
(macro).
prove/src/output.lisp
src
(module).
*default-reporter*
(special variable).
*test-result-output*
(special variable).
Packages are listed by definition order.
prove
prove.report
prove.reporter.list
prove.reporter
prove.color
prove.reporter.dot
prove.reporter.fiveam
prove.test
prove.reporter.tap
prove.suite
prove.output
prove.asdf
prove.report
common-lisp
.
comment-report
(class).
composed-test-report
(class).
error-report-p
(function).
error-test-report
(class).
failed-report-p
(function).
failed-test-report
(class).
normal-test-report
(class).
passed-report-p
(function).
passed-test-report
(class).
report
(class).
skipped-report-p
(function).
skipped-test-report
(class).
test-report
(class).
test-report-p
(function).
prove.reporter.list
common-lisp
.
prove.report
.
prove.reporter
.
list-reporter
(class).
report-expected-line
(generic function).
escape-tildes
(function).
omit-long-value
(function).
possible-report-description
(function).
print-duration
(function).
prove.reporter
common-lisp
.
*indent-level*
(special variable).
format-report
(generic function).
format/indent
(function).
indent-space
(slot).
print-error-report
(generic function).
print-finalize-report
(generic function).
print-plan-report
(generic function).
reporter
(class).
with-additional-indent
(macro).
*additional-indent*
(special variable).
*debug-indentation*
(special variable).
find-reporter
(function).
indent
(function).
prove.color
common-lisp
.
*enable-colors*
(special variable).
with-color
(macro).
with-gray
(macro).
prove.reporter.dot
common-lisp
.
prove.color
.
prove.report
.
prove.reporter
.
prove.reporter.list
.
dot-reporter
(class).
prove.reporter.fiveam
common-lisp
.
prove.report
.
prove.reporter
.
fiveam-reporter
(class).
prove.test
common-lisp
.
*debug-on-error*
(special variable).
*default-test-function*
(special variable).
*gensym-prefix*
(special variable).
deftest
(macro).
diag
(function).
fail
(function).
is
(macro).
is-condition
(macro).
is-error
(macro).
is-expand
(macro).
is-print
(macro).
is-type
(macro).
is-values
(macro).
isnt
(macro).
like
(macro).
ok
(macro).
pass
(function).
remove-test
(function).
remove-test-all
(function).
run-test
(function).
run-test-all
(function).
run-test-package
(function).
skip
(function).
subtest
(macro).
%subtest
(function).
*gensym-alist*
(special variable).
*package-tests*
(special variable).
gensym-tree-equal
(generic function).
gensymp
(function).
parse-description-and-test
(function).
test
(function).
with-catching-errors
(macro).
with-duration
(macro).
prove.reporter.tap
common-lisp
.
prove.report
.
prove.reporter
.
tap-reporter
(class).
prove.suite
common-lisp
.
*default-slow-threshold*
(special variable).
*suite*
(special variable).
add-report
(function).
current-suite
(function).
failed
(generic reader).
(setf failed)
(generic writer).
finalize
(function).
package-suite
(class).
plan
(function).
reports
(generic reader).
(setf reports)
(generic writer).
slow-threshold
(function).
suite
(class).
suite-plan
(generic reader).
(setf suite-plan)
(generic writer).
test-count
(generic reader).
(setf test-count)
(generic writer).
*defined-suites*
(special variable).
find-package-suite
(function).
reset-suite
(function).
prove.output
common-lisp
.
*default-reporter*
(special variable).
*test-result-output*
(special variable).
prove.asdf
prove-asdf
asdf/interface
.
common-lisp
.
*last-suite-report*
(special variable).
run
(function).
run-test-system
(function).
test-file
(class).
*system-test-files*
(special variable).
test-files-in-directory
(function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Flag whether colorize a test report. The default is T except on Emacs (SLIME).
Level for nested test-cases output.
Number of spaces, added for each indentation level
is described in reporter’s indent-space slot.
Also, macro shift-indent could be used to slightly
indent content inside the main indentation level.
full-indent = indent-space * indent-level + additional-indent
Here is an example of the output:
1| x Blah minor.
2| Next line of description:
3|
4| x Nested test.
5| Also has multiline description.
In this example, indent-space is 4, that is why
text on lines 1 and 4 have 4 spaces between the ’x’
horizontally.
Outputting the first line " x ", reporter sets
*additional-indent* to 4. That is why these additional
4 lines are prepended to the rest lines of the main
test case description.
When inner testcase runs, it increments *indent-level*,
which shifts output to another 4 spaces (indent-space)
to the right, simultaneously resetting *additional-indent*
to zero.
For nested test, reporter writes " x " and again,
sets *additional-indent* to 4 and every other lines now
shifted by 1 * 4 + 4 = 8 spaces.
Writes a text to given stream with indentation, dictated by
*indent-level* and *additional-indent*.
If first line start with ~&, then output will start from a fresh line. Otherwise, all lines except the first one are indented.
Runs a test. OBJECT can be one of a file pathname, a directory pathname or an ASDF system name.
Returns 3 multiple-values, a flag if the tests passed as T or NIL, passed test files as a list and failed test files also as a list.
Example:
(prove:run :myapp-test)
(prove:run #P"myapp/tests/")
(prove:run #P"myapp/tests/01-main.lisp")
Runs a testing ASDF system.
dot-reporter
) (report test-report
) &rest args) ¶dot-reporter
) (report comment-report
) &rest args) ¶list-reporter
) (report composed-test-report
) &rest args) ¶list-reporter
) (report error-test-report
) &rest args) ¶list-reporter
) (report failed-test-report
) &rest args) ¶list-reporter
) (report skipped-test-report
) &rest args) ¶list-reporter
) (report normal-test-report
) &rest args) ¶list-reporter
) (report comment-report
) &rest args) ¶fiveam-reporter
) (report test-report
) &rest args) ¶fiveam-reporter
) (report comment-report
) &rest args) ¶tap-reporter
) (report skipped-test-report
) &key count) ¶tap-reporter
) (report test-report
) &key count) ¶tap-reporter
) (report comment-report
) &rest args) ¶fiveam-reporter
) (report comment-report
) stream) ¶fiveam-reporter
) (report composed-test-report
) stream) ¶fiveam-reporter
) (report failed-test-report
) stream) ¶tap-reporter
) (report failed-test-report
) stream) ¶null
) (report test-report
) stream) ¶dot-reporter
) plan reports stream) ¶dot-reporter
) plan reports stream) ¶list-reporter
) plan reports stream) ¶fiveam-reporter
) plan reports stream) ¶tap-reporter
) plan reports stream) ¶null
) plan reports stream) ¶list-reporter
) num stream) ¶tap-reporter
) num stream) ¶null
) num stream) ¶Reports about failed or passed test.
Should return a string with description of what have happened.
normal-test-report
)) ¶operation
) (c test-file
) &key just-done) ¶asdf/action
.
normal-test-report
) stream) ¶(or function symbol)
:test-function
boolean
:notp
(error ":got is required")
:got
(quote #:unbound)
:got-form
(error ":expected is required")
:expected
(or null string)
:report-expected-label
(or null string)
:description
2
:unspecified
:plan
prove.suite:*default-slow-threshold*
:slow-threshold
0
0
(make-array 0 :adjustable t :fill-pointer 0)
cl-source-file
.
Number of spaces to add to each line. see *indent-level* docstring for full description.
If True, then indentation will have ’=’ and ’-’ symbols for main indentaion and additional, instead of spaces.
Creates a string with a number of spaces to indent new line of a test report.
Jump to: | %
(
A C D E F G I L M O P R S T W |
---|
Jump to: | %
(
A C D E F G I L M O P R S T W |
---|
Jump to: | *
C D E F G I N P R S T |
---|
Jump to: | *
C D E F G I N P R S T |
---|
Jump to: | A C D E F L M N O P R S T |
---|
Jump to: | A C D E F L M N O P R S T |
---|