This is the rove Reference Manual, version 0.10.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 06:36:58 2024 GMT+0.
rove
rove/main
rove/core/assertion
rove/core/stats
rove/core/result
rove/core/test
rove/core/suite/package
rove/core/suite/file
rove/core/suite
rove/reporter
rove/reporter/registry
rove/misc/color
rove/reporter/spec
rove/misc/stream
rove/utils/reporter
rove/reporter/dot
rove/rove.asd
rove/main/file-type.lisp
rove/core/assertion/file-type.lisp
rove/core/stats/file-type.lisp
rove/core/result/file-type.lisp
rove/core/test/file-type.lisp
rove/core/suite/package/file-type.lisp
rove/core/suite/file/file-type.lisp
rove/core/suite/file-type.lisp
rove/reporter/file-type.lisp
rove/reporter/registry/file-type.lisp
rove/misc/color/file-type.lisp
rove/reporter/spec/file-type.lisp
rove/misc/stream/file-type.lisp
rove/utils/reporter/file-type.lisp
rove/reporter/dot/file-type.lisp
rove/core/suite/package
rove/misc/color
rove/core/suite
rove/core/result
rove/core/suite/file
rove
rove/reporter/spec
rove/reporter/registry
rove/misc/stream
rove/utils/reporter
rove/core/assertion
rove/reporter/dot
rove/reporter
rove/stats
rove/core/test
The main system appears first, followed by any subsystem dependency.
rove
rove/main
rove/core/assertion
rove/core/stats
rove/core/result
rove/core/test
rove/core/suite/package
rove/core/suite/file
rove/core/suite
rove/reporter
rove/reporter/registry
rove/misc/color
rove/reporter/spec
rove/misc/stream
rove/utils/reporter
rove/reporter/dot
rove
Yet another testing framework intended to be a successor of Prove
Eitaro Fukamachi
BSD 3-Clause
0.10.0
rove/main
(system).
rove/main
Eitaro Fukamachi
BSD 3-Clause
rove/core/assertion
(system).
rove/core/test
(system).
rove/core/suite
(system).
rove/core/result
(system).
rove/reporter
(system).
rove/core/stats
(system).
rove/misc/color
(system).
rove/reporter/spec
(system).
rove/reporter/dot
(system).
cl-ppcre
(system).
rove/core/assertion
Eitaro Fukamachi
BSD 3-Clause
rove/core/stats
(system).
rove/core/result
(system).
dissect
(system).
rove/core/stats
Eitaro Fukamachi
BSD 3-Clause
rove/core/result
(system).
rove/core/test
Eitaro Fukamachi
BSD 3-Clause
rove/core/stats
(system).
rove/core/suite/package
(system).
rove/core/assertion
(system).
dissect
(system).
rove/core/suite/package
Eitaro Fukamachi
BSD 3-Clause
rove/core/suite/file
(system).
rove/core/stats
(system).
rove/core/suite
Eitaro Fukamachi
BSD 3-Clause
rove/core/assertion
(system).
rove/core/result
(system).
rove/core/test
(system).
rove/core/stats
(system).
rove/core/suite/package
(system).
rove/core/suite/file
(system).
rove/reporter
Eitaro Fukamachi
BSD 3-Clause
rove/core/stats
(system).
rove/reporter/registry
(system).
rove/core/result
(system).
bordeaux-threads
(system).
rove/reporter/spec
Eitaro Fukamachi
BSD 3-Clause
rove/core/stats
(system).
rove/core/result
(system).
rove/reporter
(system).
rove/misc/stream
(system).
rove/misc/color
(system).
rove/utils/reporter
(system).
dissect
(system).
rove/misc/stream
Eitaro Fukamachi
BSD 3-Clause
trivial-gray-streams
(system).
rove/utils/reporter
Eitaro Fukamachi
BSD 3-Clause
rove/core/stats
(system).
rove/core/assertion
(system).
rove/core/result
(system).
rove/misc/stream
(system).
rove/misc/color
(system).
rove/reporter/dot
Eitaro Fukamachi
BSD 3-Clause
rove/reporter
(system).
rove/core/stats
(system).
rove/core/result
(system).
rove/misc/stream
(system).
rove/misc/color
(system).
rove/utils/reporter
(system).
Files are sorted by type and then listed depth-first from the systems components trees.
rove/rove.asd
rove/main/file-type.lisp
rove/core/assertion/file-type.lisp
rove/core/stats/file-type.lisp
rove/core/result/file-type.lisp
rove/core/test/file-type.lisp
rove/core/suite/package/file-type.lisp
rove/core/suite/file/file-type.lisp
rove/core/suite/file-type.lisp
rove/reporter/file-type.lisp
rove/reporter/registry/file-type.lisp
rove/misc/color/file-type.lisp
rove/reporter/spec/file-type.lisp
rove/misc/stream/file-type.lisp
rove/utils/reporter/file-type.lisp
rove/reporter/dot/file-type.lisp
rove/main/file-type.lisp
rove/main
(system).
rove
.
*default-env*
(special variable).
*default-reporter*
(special variable).
run
(generic function).
run*
(function).
run-test
(generic function).
run-tests
(method).
with-local-envs
(macro).
compile-wild-card
(function).
ensure-test
(function).
rove/core/assertion/file-type.lisp
rove/core/assertion
(system).
*debug-on-error*
(special variable).
assert-ng
(macro).
assert-ok
(macro).
expands
(macro).
fail
(function).
form-description
(method).
form-description
(method).
form-description
(method).
ng
(macro).
ok
(macro).
outputs
(macro).
pass
(function).
signals
(macro).
skip
(function).
%okng
(macro).
%okng-record
(function).
*fail*
(special variable).
calc-duration
(function).
debug-on-error-p
(function).
equal*
(function).
form-inspect
(macro).
form-steps
(function).
ng-assertion-class
(function).
ok-assertion-class
(function).
output-of
(macro).
record-error
(function).
source-filename
(function).
unwrap-quoted
(function).
rove/core/stats/file-type.lisp
rove/core/stats
(system).
*stats*
(special variable).
all-failed-assertions
(function).
context-test-count
(generic function).
failed-tests
(method).
initialize
(generic function).
passed-tests
(method).
passedp
(method).
pending-tests
(method).
plan
(function).
print-object
(method).
record
(generic function).
stats
(class).
stats-context
(generic function).
stats-context-labels
(generic function).
stats-failed-tests
(reader method).
(setf stats-failed-tests)
(writer method).
stats-passed-tests
(reader method).
(setf stats-passed-tests)
(writer method).
stats-pending-tests
(reader method).
(setf stats-pending-tests)
(writer method).
stats-plan
(reader method).
(setf stats-plan)
(writer method).
stats-results
(reader method).
(setf stats-results)
(writer method).
suite-begin
(generic function).
suite-finish
(generic function).
summarize
(generic function).
system-tests-begin
(generic function).
system-tests-finish
(generic function).
test-begin
(generic function).
test-finish
(generic function).
toplevel-stats-p
(function).
with-context
(macro).
leave-context
(function).
new-context
(function).
stats-name
(reader method).
(setf stats-name)
(writer method).
rove/core/result/file-type.lisp
rove/core/result
(system).
*print-assertion*
(special variable).
assertion
(class).
assertion-args
(reader method).
assertion-description
(generic function).
assertion-duration
(reader method).
assertion-form
(reader method).
assertion-labels
(reader method).
assertion-reason
(reader method).
assertion-source-location
(reader method).
assertion-stacks
(reader method).
assertion-steps
(reader method).
assertion-values
(reader method).
failed
(class).
failed-assertion
(class).
failed-test
(class).
failed-tests
(generic function).
form-description
(generic function).
passed
(class).
passed-assertion
(class).
passed-test
(class).
passed-tests
(generic function).
passedp
(generic function).
pending
(class).
pending-assertion
(class).
pending-tests
(generic function).
print-object
(method).
print-object
(method).
test
(class).
test-description
(reader method).
test-name
(reader method).
test-failed-tests
(reader method).
(setf test-failed-tests)
(writer method).
test-passed-tests
(reader method).
(setf test-passed-tests)
(writer method).
test-pending-tests
(reader method).
(setf test-pending-tests)
(writer method).
rove/core/test/file-type.lisp
rove/core/test
(system).
call-with-testing-with-options
(function).
with-testing-with-options
(macro).
rove/core/suite/package/file-type.lisp
rove/core/suite/package
(system).
all-suites
(function).
find-suite
(generic function).
get-test
(function).
package-suite
(function).
remove-test
(function).
run-suite
(generic function).
set-test
(function).
suite-after-hooks
(reader method).
(setf suite-after-hooks)
(writer method).
suite-before-hooks
(reader method).
(setf suite-before-hooks)
(writer method).
suite-name
(reader method).
(setf suite-name)
(writer method).
suite-setup
(reader method).
(setf suite-setup)
(writer method).
suite-teardown
(reader method).
(setf suite-teardown)
(writer method).
suite-tests
(function).
(setf suite-tests)
(function).
system-suites
(function).
*package-suites*
(special variable).
make-new-suite
(function).
run-hook
(function).
suite
(class).
suite-package
(reader method).
(setf suite-package)
(writer method).
rove/core/suite/file/file-type.lisp
rove/core/suite/file
(system).
file-package
(function).
(setf file-package)
(function).
resolve-file
(function).
system-files
(function).
*file-package*
(special variable).
compile-file-p
(function).
component-source-files
(function).
package-inferred-system-component-names
(function).
package-inferred-system-files
(function).
system-component-p
(function).
system-packages
(function).
rove/core/suite/file-type.lisp
rove/core/suite
(system).
*last-suite-report*
(special variable).
*rove-error-output*
(special variable).
*rove-standard-output*
(special variable).
run-system
(generic function).
run-test-functions
(function).
call-with-suite
(function).
run-system-tests
(function).
rove/reporter/file-type.lisp
rove/reporter
(system).
*report-stream*
(special variable).
diag
(function).
failed-tests
(method).
invoke-reporter
(generic function).
passed-tests
(method).
pending-tests
(method).
reporter
(class).
reporter-stream
(reader method).
(setf reporter-stream)
(writer method).
use-reporter
(function).
with-reporter
(macro).
*single-test-summarize-preference*
(special variable).
make-reporter
(function).
print-message
(generic function).
rove/reporter/registry/file-type.lisp
rove/reporter/registry
(system).
add-reporter
(function).
get-reporter
(function).
*registry*
(special variable).
rove/misc/color/file-type.lisp
rove/misc/color
(system).
*enable-colors*
(special variable).
color-text
(function).
*color-code*
(special variable).
rove/reporter/spec/file-type.lisp
rove/reporter/spec
(system).
initialize-instance
(method).
record
(method).
record
(method).
record
(method).
spec-reporter
(class).
suite-begin
(method).
summarize
(method).
system-tests-begin
(method).
test-begin
(method).
test-finish
(method).
print-duration
(function).
rove/misc/stream/file-type.lisp
rove/misc/stream
(system).
make-indent-stream
(function).
stream-clear-output
(method).
stream-finish-output
(method).
stream-force-output
(method).
stream-indent-level
(reader method).
(setf stream-indent-level)
(writer method).
stream-line-column
(method).
stream-start-line-p
(method).
stream-write-char
(method).
with-indent
(macro).
indent-stream
(class).
indent-stream-line-column
(reader method).
(setf indent-stream-line-column)
(writer method).
new-line-char-p
(function).
stream-fresh-line-p
(reader method).
(setf stream-fresh-line-p)
(writer method).
stream-real-stream
(reader method).
(setf stream-real-stream)
(writer method).
rove/utils/reporter/file-type.lisp
rove/utils/reporter
(system).
format-failure-tests
(function).
enough-namestring*
(function).
print-source-location
(function).
print-source-location-as-file-path
(function).
print-source-location-as-github-url
(function).
rove/reporter/dot/file-type.lisp
rove/reporter/dot
(system).
dot-reporter
(class).
record
(method).
record
(method).
record
(method).
summarize
(method).
test-finish
(method).
Packages are listed by definition order.
rove/core/suite/package
rove/misc/color
rove/core/suite
rove/core/result
rove/core/suite/file
rove
rove/reporter/spec
rove/reporter/registry
rove/misc/stream
rove/utils/reporter
rove/core/assertion
rove/reporter/dot
rove/reporter
rove/stats
rove/core/test
rove/core/suite/package
common-lisp
.
all-suites
(function).
find-suite
(generic function).
get-test
(function).
package-suite
(function).
remove-test
(function).
run-suite
(generic function).
set-test
(function).
suite-after-hooks
(generic reader).
(setf suite-after-hooks)
(generic writer).
suite-before-hooks
(generic reader).
(setf suite-before-hooks)
(generic writer).
suite-name
(generic reader).
(setf suite-name)
(generic writer).
suite-setup
(generic reader).
(setf suite-setup)
(generic writer).
suite-teardown
(generic reader).
(setf suite-teardown)
(generic writer).
suite-tests
(function).
(setf suite-tests)
(function).
system-suites
(function).
*package-suites*
(special variable).
make-new-suite
(function).
run-hook
(function).
suite
(class).
suite-package
(generic reader).
(setf suite-package)
(generic writer).
rove/misc/color
common-lisp
.
*enable-colors*
(special variable).
color-text
(function).
*color-code*
(special variable).
rove/core/suite
common-lisp
.
rove/core/assertion
.
rove/core/result
.
rove/core/test
.
rove/stats
.
rove
.
*last-suite-report*
(special variable).
*rove-error-output*
(special variable).
*rove-standard-output*
(special variable).
run-system
(generic function).
run-test-functions
(function).
call-with-suite
(function).
run-system-tests
(function).
rove/core/result
common-lisp
.
*print-assertion*
(special variable).
assertion
(class).
assertion-args
(generic reader).
assertion-description
(generic function).
assertion-duration
(generic reader).
assertion-form
(generic reader).
assertion-labels
(generic reader).
assertion-reason
(generic reader).
assertion-source-location
(generic reader).
assertion-stacks
(generic reader).
assertion-steps
(generic reader).
assertion-values
(generic reader).
failed
(class).
failed
(slot).
failed-assertion
(class).
failed-test
(class).
failed-tests
(generic function).
form-description
(generic function).
passed
(class).
passed
(slot).
passed-assertion
(class).
passed-test
(class).
passed-tests
(generic function).
passedp
(generic function).
pending
(class).
pending
(slot).
pending-assertion
(class).
pending-tests
(generic function).
test
(class).
test-description
(generic reader).
test-name
(generic reader).
test-failed-tests
(generic reader).
(setf test-failed-tests)
(generic writer).
test-passed-tests
(generic reader).
(setf test-passed-tests)
(generic writer).
test-pending-tests
(generic reader).
(setf test-pending-tests)
(generic writer).
rove/core/suite/file
common-lisp
.
file-package
(function).
(setf file-package)
(function).
resolve-file
(function).
system-files
(function).
*file-package*
(special variable).
compile-file-p
(function).
component-source-files
(function).
package-inferred-system-component-names
(function).
package-inferred-system-files
(function).
system-component-p
(function).
system-packages
(function).
rove
rove/main
common-lisp
.
rove/core/assertion
.
rove/core/result
.
rove/core/suite
.
rove/core/test
.
rove/reporter
.
*default-env*
(special variable).
*default-reporter*
(special variable).
run
(generic function).
run*
(function).
run-test
(generic function).
run-tests
(generic function).
with-local-envs
(macro).
compile-wild-card
(function).
ensure-test
(function).
rove/reporter/spec
common-lisp
.
rove/core/result
.
rove/misc/color
.
rove/misc/stream
.
rove/reporter
.
rove/stats
.
rove/utils/reporter
.
spec-reporter
(class).
print-duration
(function).
rove/reporter/registry
common-lisp
.
add-reporter
(function).
get-reporter
(function).
*registry*
(special variable).
rove/misc/stream
common-lisp
.
trivial-gray-streams
.
make-indent-stream
(function).
stream-indent-level
(generic reader).
(setf stream-indent-level)
(generic writer).
with-indent
(macro).
indent-stream
(class).
indent-stream-line-column
(generic reader).
(setf indent-stream-line-column)
(generic writer).
new-line-char-p
(function).
stream-fresh-line-p
(generic reader).
(setf stream-fresh-line-p)
(generic writer).
stream-real-stream
(generic reader).
(setf stream-real-stream)
(generic writer).
rove/utils/reporter
common-lisp
.
rove/core/assertion
.
rove/core/result
.
rove/misc/color
.
rove/misc/stream
.
rove/stats
.
format-failure-tests
(function).
enough-namestring*
(function).
print-source-location
(function).
print-source-location-as-file-path
(function).
print-source-location-as-github-url
(function).
rove/core/assertion
common-lisp
.
rove/core/result
.
rove/stats
.
%okng
(macro).
%okng-record
(function).
*fail*
(special variable).
calc-duration
(function).
debug-on-error-p
(function).
equal*
(function).
form-inspect
(macro).
form-steps
(function).
ng-assertion-class
(function).
ok-assertion-class
(function).
output-of
(macro).
record-error
(function).
source-filename
(function).
unwrap-quoted
(function).
rove/reporter/dot
common-lisp
.
rove/core/result
.
rove/misc/color
.
rove/misc/stream
.
rove/reporter
.
rove/stats
.
rove/utils/reporter
.
dot-reporter
(class).
rove/reporter
common-lisp
.
*report-stream*
(special variable).
diag
(function).
invoke-reporter
(generic function).
reporter
(class).
reporter-stream
(generic reader).
(setf reporter-stream)
(generic writer).
use-reporter
(function).
with-reporter
(macro).
*single-test-summarize-preference*
(special variable).
make-reporter
(function).
print-message
(generic function).
rove/stats
rove/core/stats
common-lisp
.
rove/core/result
.
*stats*
(special variable).
all-failed-assertions
(function).
context-test-count
(generic function).
initialize
(generic function).
plan
(function).
record
(generic function).
stats
(class).
stats-context
(generic function).
stats-context-labels
(generic function).
stats-failed-tests
(generic reader).
(setf stats-failed-tests)
(generic writer).
stats-passed-tests
(generic reader).
(setf stats-passed-tests)
(generic writer).
stats-pending-tests
(generic reader).
(setf stats-pending-tests)
(generic writer).
stats-plan
(generic reader).
(setf stats-plan)
(generic writer).
stats-results
(generic reader).
(setf stats-results)
(generic writer).
suite-begin
(generic function).
suite-finish
(generic function).
summarize
(generic function).
system-tests-begin
(generic function).
system-tests-finish
(generic function).
test-begin
(generic function).
test-finish
(generic function).
toplevel-stats-p
(function).
with-context
(macro).
leave-context
(function).
new-context
(function).
stats-name
(generic reader).
(setf stats-name)
(generic writer).
rove/core/test
common-lisp
.
rove/core/suite/package
.
rove/stats
.
call-with-testing-with-options
(function).
with-testing-with-options
(macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Returns t if given form raise condition of given type,
and nil otherwise.
Warning:
Use only in conjunction with ‘ok’ macro to build an assertion.
Returns a string to print description of
an object of class ‘assertion’.
Useful, when you write your own assertions based on Rove’s and want to customize their representation in test results.
(eql rove/core/assertion:expands)
) args values &key negative) ¶(eql rove/core/assertion:outputs)
) args values &key negative) ¶(eql rove/core/assertion:signals)
) args values &key negative) ¶(eql typep)
) args values &key negative) ¶(eql not)
) args values &key negative) ¶dot-reporter
) (object pending-assertion
)) ¶dot-reporter
) (object failed-assertion
)) ¶dot-reporter
) (object passed-assertion
)) ¶spec-reporter
) (object pending-assertion
)) ¶spec-reporter
) (object failed-assertion
)) ¶spec-reporter
) (object passed-assertion
)) ¶null
) object) ¶Run a test package.
Run a single test function.
Returns the current stats to record.
Returns the labels of the current contexts (including nested ones)
indent-stream
)) ¶automatically generated reader method
indent-stream
)) ¶automatically generated writer method
spec-reporter
) suite-name) ¶dot-reporter
)) ¶spec-reporter
)) ¶spec-reporter
) system) ¶spec-reporter
) description &optional count) ¶dot-reporter
) description) ¶spec-reporter
) description) ¶spec-reporter
) &rest initargs &key stream &allow-other-keys) ¶indent-stream
)) ¶sb-gray
.
indent-stream
)) ¶sb-gray
.
indent-stream
)) ¶sb-gray
.
indent-stream
)) ¶sb-gray
.
indent-stream
)) ¶sb-gray
.
indent-stream
) char) ¶sb-gray
.
:form
This slot is read-only.
:steps
This slot is read-only.
:args
This slot is read-only.
common-lisp
.
:values
This slot is read-only.
:reason
This slot is read-only.
:duration
This slot is read-only.
:stacks
This slot is read-only.
common-lisp
.
:labels
This slot is read-only.
:desc
:negative
:source-location
This slot is read-only.
common-lisp
.
:stream
context-test-count
.
failed-tests
.
passed-tests
.
passedp
.
pending-tests
.
print-object
.
record
.
record
.
record
.
stats-context
.
stats-context-labels
.
(setf stats-failed-tests)
.
stats-failed-tests
.
(setf stats-name)
.
stats-name
.
(setf stats-passed-tests)
.
stats-passed-tests
.
(setf stats-pending-tests)
.
stats-pending-tests
.
(setf stats-plan)
.
stats-plan
.
(setf stats-results)
.
stats-results
.
(make-array 0 :adjustable t :fill-pointer 0)
(make-array 0 :adjustable t :fill-pointer 0)
(make-array 0 :adjustable t :fill-pointer 0)
(quote nil)
:plan
:name
indent-stream
)) ¶automatically generated reader method
indent-stream
)) ¶automatically generated writer method
indent-stream
)) ¶automatically generated reader method
indent-stream
)) ¶automatically generated writer method
indent-stream
)) ¶automatically generated reader method
indent-stream
)) ¶automatically generated writer method
fundamental-character-output-stream
.
trivial-gray-stream-mixin
.
(setf indent-stream-line-column)
.
indent-stream-line-column
.
stream-clear-output
.
stream-finish-output
.
stream-force-output
.
(setf stream-fresh-line-p)
.
stream-fresh-line-p
.
(setf stream-indent-level)
.
stream-indent-level
.
stream-line-column
.
(setf stream-real-stream)
.
stream-real-stream
.
stream-start-line-p
.
stream-write-char
.
common-lisp
.
:stream
0
:level
0
t
string
(error ":name is required")
:name
common-lisp
.
package
(error ":package is required")
:package
(or function null)
:setup
(or function null)
:teardown
list
(quote nil)
:before-hooks
list
(quote nil)
:after-hooks
(quote nil)
Jump to: | %
(
A C D E F G I L M N O P R S T U W |
---|
Jump to: | %
(
A C D E F G I L M N O P R S T U W |
---|
Jump to: | %
*
A B C D F L N P R S T V |
---|
Jump to: | %
*
A B C D F L N P R S T V |
---|
Jump to: | A C D F I P R S T |
---|
Jump to: | A C D F I P R S T |
---|