This is the cacau Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 14:47:34 2024 GMT+0.
cacau/cacau.asdcacau/src/package.lispcacau/src/utils.lispcacau/src/kernel/timer.lispcacau/src/kernel/runnable.lispcacau/src/kernel/list-iterator.lispcacau/src/kernel/test.lispcacau/src/kernel/hook.lispcacau/src/kernel/suite.lispcacau/src/kernel/runner-listeners.lispcacau/src/kernel/runner.lispcacau/src/reporters/base.lispcacau/src/reporters/min.lispcacau/src/reporters/list.lispcacau/src/reporters/full.lispcacau/src/cacau.lispcacau/src/interfaces/common.lispcacau/src/interfaces/cl.lispcacau/src/interfaces/bdd.lispcacau/src/interfaces/tdd.lispcacau/src/interfaces/no-spaghetti.lispThe main system appears first, followed by any subsystem dependency.
cacauTest Runner in Common Lisp.
noloop <noloop@zoho.com>
noloop <noloop@zoho.com>
(GIT git@github.com:noloop/cacau.git)
GPLv3
1.0.0
eventbus (system).
assertion-error (system).
src (module).
Modules are listed depth-first from the system components tree.
cacau/srccacau (system).
package.lisp (file).
utils.lisp (file).
kernel (module).
reporters (module).
cacau.lisp (file).
interfaces (module).
cacau/src/kernelsrc (module).
timer.lisp (file).
runnable.lisp (file).
list-iterator.lisp (file).
test.lisp (file).
hook.lisp (file).
suite.lisp (file).
runner-listeners.lisp (file).
runner.lisp (file).
cacau/src/interfacessrc (module).
common.lisp (file).
cl.lisp (file).
bdd.lisp (file).
tdd.lisp (file).
no-spaghetti.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cacau/cacau.asdcacau/src/package.lispcacau/src/utils.lispcacau/src/kernel/timer.lispcacau/src/kernel/runnable.lispcacau/src/kernel/list-iterator.lispcacau/src/kernel/test.lispcacau/src/kernel/hook.lispcacau/src/kernel/suite.lispcacau/src/kernel/runner-listeners.lispcacau/src/kernel/runner.lispcacau/src/reporters/base.lispcacau/src/reporters/min.lispcacau/src/reporters/list.lispcacau/src/reporters/full.lispcacau/src/cacau.lispcacau/src/interfaces/common.lispcacau/src/interfaces/cl.lispcacau/src/interfaces/bdd.lispcacau/src/interfaces/tdd.lispcacau/src/interfaces/no-spaghetti.lispcacau/src/utils.lispsrc (module).
create-hash (macro).
create-list-iterator (macro).
defvar* (macro).
read-yes (function).
setf-hash (macro).
string-ansi-color (function).
string-if-not-string (function).
with-gensyms (macro).
cacau/src/kernel/timer.lispkernel (module).
duration-ms (reader method).
(setf duration-ms) (writer method).
end-ms (reader method).
(setf end-ms) (writer method).
end-timer (method).
extrapolated-p (method).
limit-ms (reader method).
(setf limit-ms) (writer method).
make-timer (function).
start-ms (reader method).
(setf start-ms) (writer method).
start-timer (method).
timer-class (class).
cacau/src/kernel/runnable.lispkernel (module).
after-run (generic function).
cl-debugger-p (reader method).
(setf cl-debugger-p) (writer method).
done-runnable (method).
eventbus (reader method).
(setf eventbus) (writer method).
fn (reader method).
(setf fn) (writer method).
inherit-timeout (method).
name (reader method).
(setf name) (writer method).
parent (reader method).
(setf parent) (writer method).
run-runnable (generic function).
runnable (class).
runnable-error (reader method).
(setf runnable-error) (writer method).
setf-assertion-error (method).
setf-error (method).
start-timeout (method).
timeout (reader method).
(setf timeout) (writer method).
timeout-extrapolated-p (method).
timer (reader method).
(setf timer) (writer method).
try-fn (method).
cacau/src/kernel/list-iterator.lispkernel (module).
add (method).
current-index (reader method).
(setf current-index) (writer method).
current-item (method).
done-p (method).
empty-p (method).
itens (reader method).
(setf itens) (writer method).
last-p (method).
list-iterator (class).
make-list-iterator (function).
next (method).
start-iterator (method).
start-iterator-reverse (method).
cacau/src/kernel/test.lispkernel (module).
after-run (method).
async-p (reader method).
(setf async-p) (writer method).
make-test (function).
only-p (reader method).
(setf only-p) (writer method).
run-runnable (method).
skip-p (reader method).
(setf skip-p) (writer method).
test-class (class).
cacau/src/kernel/hook.lispkernel (module).
after-run (method).
async-p (reader method).
(setf async-p) (writer method).
hook-class (class).
make-hook (function).
pos-hook-fn (reader method).
(setf pos-hook-fn) (writer method).
run-runnable (method).
cacau/src/kernel/suite.lispkernel (module).
add-child (method).
create-after-all (method).
create-after-each (method).
create-before-all (method).
create-before-each (method).
child-by-name (method).
children (reader method).
(setf children) (writer method).
collect-after-each-recursive (method).
collect-before-each-recursive (method).
count-suites-recursive (method).
count-tests-recursive (method).
execute-suites-each (method).
has-only-recursive (function).
inherit-only-recursive (method).
init-suite (method).
make-suite (function).
next-child (method).
only-p (reader method).
(setf only-p) (writer method).
parents-after-each (reader method).
(setf parents-after-each) (writer method).
parents-before-each (reader method).
(setf parents-before-each) (writer method).
remove-not-only-children-recursive (method).
remove-skip-children-recursive (method).
run-runnable (method).
skip-p (reader method).
(setf skip-p) (writer method).
suite-after-all (reader method).
(setf suite-after-all) (writer method).
suite-after-each (reader method).
(setf suite-after-each) (writer method).
suite-before-all (reader method).
(setf suite-before-all) (writer method).
suite-before-each (reader method).
(setf suite-before-each) (writer method).
suite-class (class).
cacau/src/kernel/runner-listeners.lispkernel (module).
create-runner-listeners (function).
cacau/src/kernel/runner.lispkernel (module).
create-suite (method).
create-test (method).
make-runner (function).
on-runner (method).
once-runner (method).
result (reader method).
(setf result) (writer method).
run-runner (method).
suite-root (reader method).
(setf suite-root) (writer method).
abort-p (reader method).
(setf abort-p) (writer method).
current-suite (reader method).
(setf current-suite) (writer method).
eventbus (reader method).
(setf eventbus) (writer method).
run-progress (method).
runner (class).
cacau/src/reporters/base.lispreporters (module).
cacau-logo (function).
create-format-gethash-text-color (function).
custom-result (function).
epilogue (function).
full-epilogue (function).
separation-bar (function).
skipped (function).
stack-test-errors (function).
suite-tests-list-events (function).
cacau/src/reporters/min.lispreporters (module).
reporter-min (function).
cacau/src/reporters/list.lispreporters (module).
reporter-list (function).
cacau/src/reporters/full.lispreporters (module).
reporter-full (function).
cacau/src/cacau.lispsrc (module).
cacau-runner (function).
cl-debugger (function).
reset-runner (function).
run (function).
create-reporter (function).
create-reporter-fn (function).
cacau/src/interfaces/common.lispinterfaces (module).
common-create-after-all (function).
common-create-after-each (function).
common-create-before-all (function).
common-create-before-each (function).
common-create-suite (function).
common-create-test (function).
common-create-suite-with-parent (function).
cond-options (macro).
cacau/src/interfaces/cl.lispinterfaces (module).
defafter-all (macro).
defafter-each (macro).
defbefore-all (macro).
defbefore-each (macro).
defsuite (macro).
deftest (macro).
cacau/src/interfaces/bdd.lispinterfaces (module).
after-all (function).
after-each (function).
before-all (function).
before-each (function).
context (function).
it (function).
cacau/src/interfaces/tdd.lispinterfaces (module).
suite (function).
suite-setup (function).
suite-teardown (function).
test (function).
test-setup (function).
test-teardown (function).
cacau/src/interfaces/no-spaghetti.lispinterfaces (module).
defafter-plan (macro).
defafter-t (macro).
defbefore-plan (macro).
defbefore-t (macro).
deft (macro).
in-plan (macro).
Packages are listed by definition order.
noloop.cacaucacau
common-lisp.
add-child (generic function).
after-all (function).
after-each (function).
before-all (function).
before-each (function).
cacau-runner (function).
cl-debugger (function).
common-create-after-all (function).
common-create-after-each (function).
common-create-before-all (function).
common-create-before-each (function).
common-create-suite (function).
common-create-test (function).
context (function).
create-after-all (generic function).
create-after-each (generic function).
create-before-all (generic function).
create-before-each (generic function).
create-suite (generic function).
create-test (generic function).
defafter-all (macro).
defafter-each (macro).
defafter-plan (macro).
defafter-t (macro).
defbefore-all (macro).
defbefore-each (macro).
defbefore-plan (macro).
defbefore-t (macro).
defsuite (macro).
deft (macro).
deftest (macro).
in-plan (macro).
it (function).
make-runner (function).
on-runner (generic function).
once-runner (generic function).
reset-runner (function).
result (generic reader).
(setf result) (generic writer).
run (function).
run-runner (generic function).
suite (function).
suite-root (generic reader).
(setf suite-root) (generic writer).
suite-setup (function).
suite-teardown (function).
test (function).
test-setup (function).
test-teardown (function).
abort-p (generic reader).
(setf abort-p) (generic writer).
add (generic function).
after-run (generic function).
async-p (generic reader).
(setf async-p) (generic writer).
cacau-logo (function).
child-by-name (generic function).
children (generic reader).
(setf children) (generic writer).
cl-debugger-p (generic reader).
(setf cl-debugger-p) (generic writer).
collect-after-each-recursive (generic function).
collect-before-each-recursive (generic function).
common-create-suite-with-parent (function).
cond-options (macro).
count-suites-recursive (generic function).
count-tests-recursive (generic function).
create-format-gethash-text-color (function).
create-hash (macro).
create-list-iterator (macro).
create-reporter (function).
create-reporter-fn (function).
create-runner-listeners (function).
current-index (generic reader).
(setf current-index) (generic writer).
current-item (generic function).
current-suite (generic reader).
(setf current-suite) (generic writer).
custom-result (function).
defvar* (macro).
done-p (generic function).
done-runnable (generic function).
duration-ms (generic reader).
(setf duration-ms) (generic writer).
empty-p (generic function).
end-ms (generic reader).
(setf end-ms) (generic writer).
end-timer (generic function).
epilogue (function).
eventbus (generic reader).
(setf eventbus) (generic writer).
execute-suites-each (generic function).
extrapolated-p (generic function).
fn (generic reader).
(setf fn) (generic writer).
full-epilogue (function).
has-only-recursive (function).
hook-class (class).
inherit-only-recursive (generic function).
inherit-timeout (generic function).
init-suite (generic function).
itens (generic reader).
(setf itens) (generic writer).
last-p (generic function).
limit-ms (generic reader).
(setf limit-ms) (generic writer).
list-iterator (class).
make-hook (function).
make-list-iterator (function).
make-suite (function).
make-test (function).
make-timer (function).
name (generic reader).
(setf name) (generic writer).
next (generic function).
next-child (generic function).
only-p (generic reader).
(setf only-p) (generic writer).
parent (generic reader).
(setf parent) (generic writer).
parents-after-each (generic reader).
(setf parents-after-each) (generic writer).
parents-before-each (generic reader).
(setf parents-before-each) (generic writer).
pos-hook-fn (generic reader).
(setf pos-hook-fn) (generic writer).
read-yes (function).
remove-not-only-children-recursive (generic function).
remove-skip-children-recursive (generic function).
reporter-full (function).
reporter-list (function).
reporter-min (function).
run-progress (generic function).
run-runnable (generic function).
runnable (class).
runnable-error (generic reader).
(setf runnable-error) (generic writer).
runner (class).
separation-bar (function).
setf-assertion-error (generic function).
setf-error (generic function).
setf-hash (macro).
skip-p (generic reader).
(setf skip-p) (generic writer).
skipped (function).
stack-test-errors (function).
start-iterator (generic function).
start-iterator-reverse (generic function).
start-ms (generic reader).
(setf start-ms) (generic writer).
start-timeout (generic function).
start-timer (generic function).
string-ansi-color (function).
string-if-not-string (function).
suite-after-all (generic reader).
(setf suite-after-all) (generic writer).
suite-after-each (generic reader).
(setf suite-after-each) (generic writer).
suite-before-all (generic reader).
(setf suite-before-all) (generic writer).
suite-before-each (generic reader).
(setf suite-before-each) (generic writer).
suite-class (class).
suite-tests-list-events (function).
test-class (class).
timeout (generic reader).
(setf timeout) (generic writer).
timeout-extrapolated-p (generic function).
timer (generic reader).
(setf timer) (generic writer).
timer-class (class).
try-fn (generic function).
with-gensyms (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Attention that the slot cl-debugger-p is :allocation :class in runnable class.
suite-class) child) ¶suite-class) name fn &key async-p timeout) ¶suite-class) name fn &key async-p timeout) ¶suite-class) name fn &key async-p timeout) ¶suite-class) name fn &key async-p timeout) ¶Example: (create-hash ’((:a 1) (:b 2)))
Creates a new lambda that returns the next item in the new-list reverted. Returns nil if there is not the next item in the list. Example:
(let* ((itens ’(1 2))
(next-item (create-list-iterator itens)))
(print (funcall next-item))
(print (funcall next-item))
(print (funcall next-item)))
=>
1
2
NIL
Example: (let ((hash (make-hash-table :test ’eq)))
(setf-hash hash ’((:a 1) (:b 2)))
hash)
list-iterator) item) ¶Something must be run after run-runnable.
hook-class)) ¶test-class)) ¶hook-class)) ¶automatically generated reader method
test-class)) ¶automatically generated reader method
hook-class)) ¶automatically generated writer method
test-class)) ¶automatically generated writer method
suite-class) parent-name) ¶suite-class)) ¶automatically generated reader method
suite-class)) ¶automatically generated writer method
suite-class) parents-each) ¶suite-class) parents-each) ¶list-iterator)) ¶automatically generated reader method
list-iterator)) ¶automatically generated writer method
list-iterator)) ¶list-iterator)) ¶timer-class)) ¶automatically generated reader method
timer-class)) ¶automatically generated writer method
list-iterator)) ¶timer-class)) ¶automatically generated reader method
timer-class)) ¶automatically generated writer method
timer-class)) ¶suite-class) parents-each after-hook-fn) ¶timer-class)) ¶suite-class)) ¶suite-class)) ¶list-iterator)) ¶automatically generated reader method
list-iterator)) ¶automatically generated writer method
list-iterator)) ¶timer-class)) ¶automatically generated reader method
timer-class)) ¶automatically generated writer method
list-iterator)) ¶suite-class)) ¶suite-class)) ¶automatically generated reader method
test-class)) ¶automatically generated reader method
suite-class)) ¶automatically generated writer method
test-class)) ¶automatically generated writer method
suite-class)) ¶automatically generated reader method
suite-class)) ¶automatically generated writer method
suite-class)) ¶automatically generated reader method
suite-class)) ¶automatically generated writer method
hook-class)) ¶automatically generated reader method
hook-class)) ¶automatically generated writer method
suite-class)) ¶suite-class)) ¶Something must be run, such as a test suite that calls run-runnable from each tests, or running a hook.
suite-class) &optional fn) ¶hook-class) &optional after-hook) ¶test-class) &optional fn) ¶suite-class)) ¶automatically generated reader method
test-class)) ¶automatically generated reader method
suite-class)) ¶automatically generated writer method
test-class)) ¶automatically generated writer method
list-iterator)) ¶list-iterator)) ¶timer-class)) ¶automatically generated reader method
timer-class)) ¶automatically generated writer method
timer-class)) ¶suite-class)) ¶automatically generated reader method
suite-class)) ¶automatically generated writer method
suite-class)) ¶automatically generated reader method
suite-class)) ¶automatically generated writer method
suite-class)) ¶automatically generated reader method
suite-class)) ¶automatically generated writer method
suite-class)) ¶automatically generated reader method
suite-class)) ¶automatically generated writer method
(setf cl-debugger-p).
cl-debugger-p.
done-runnable.
(setf eventbus).
eventbus.
(setf fn).
fn.
inherit-timeout.
(setf name).
name.
(setf parent).
parent.
(setf runnable-error).
runnable-error.
setf-assertion-error.
setf-error.
start-timeout.
(setf timeout).
timeout.
timeout-extrapolated-p.
(setf timer).
timer.
try-fn.
:parent
:eventbus
(noloop.cacau::make-timer)
:class
-1
:timeout
(noloop.eventbus:make-eventbus)
:suite-root
(make-hash-table)
add-child.
child-by-name.
(setf children).
children.
collect-after-each-recursive.
collect-before-each-recursive.
create-after-all.
create-after-each.
create-before-all.
create-before-each.
execute-suites-each.
inherit-only-recursive.
init-suite.
next-child.
(setf only-p).
only-p.
(setf parents-after-each).
parents-after-each.
(setf parents-before-each).
parents-before-each.
remove-not-only-children-recursive.
remove-skip-children-recursive.
run-runnable.
(setf skip-p).
skip-p.
(setf suite-after-all).
suite-after-all.
(setf suite-after-each).
suite-after-each.
(setf suite-before-all).
suite-before-all.
(setf suite-before-each).
suite-before-each.
(noloop.cacau::make-list-iterator)
(noloop.cacau::make-list-iterator)
(noloop.cacau::make-list-iterator)
:only-p
:skip-p
| Jump to: | (
A B C D E F G H I L M N O P R S T W |
|---|
| Jump to: | (
A B C D E F G H I L M N O P R S T W |
|---|
| Jump to: | A C D E F I L N O P R S T |
|---|
| Jump to: | A C D E F I L N O P R S T |
|---|
| Jump to: | B C F H I K L M N P R S T U |
|---|
| Jump to: | B C F H I K L M N P R S T U |
|---|