For REPL use there's the
kaocha.repl
namespace. Its main entry point is the
run
function. Calling it is similar to starting Kaocha from the CLI, it will load
tests.edn
, merge in any extra options and flags, and then load and run your
test suites.
As arguments to run
you pass it one or more identifiers of things you want to
test. This can be a test suite, a namespace, or a specific test var.
Say you have a single :unit
test suite, with a kaocha.random-test
namespace
containing two tests.
.
└── :unit
└── kaocha.random-test
├── kaocha.random-test/rand-ints-test
└── kaocha.random-test/randomize-test
You could run the whole suite
(use 'kaocha.repl)
(run :unit)
The namespace
(run 'kaocha.random-test)
Or specific test vars
(run 'kaocha.random-test/rand-ints-test 'kaocha.random-test/randomize-test)
These are equivalent to using --focus
on the command line. run
also
understand namespace and var objects.
(run *ns*)
(run #'rand-ints-test)
(run)
without any arguments is equivalent to (run *ns*)
. If you really want to run all test suites without discrimination, use run-all.
If the last argument to (run)
is a map, then it is considered extra
configuration which is applied on top of what is read from tests.edn
. The
special key :config-file
is available to change the location from which
tests.edn
is read.
(run {:config-file "/tmp/my_tests.edn"})
Other keys in the map need to be either fully qualified keywords as used in
Kaocha's configuration, or the short equivalent that is available in tests.edn
when using the #kaocha/v1
reader tag.
kaocha.repl
is especially useful when used with a editor-connected REPL, so
that code can be evaluated in place. When working on a specific test you can
wrap it in kaocha.repl/run
. Since deftest
returns the var it defines, this
redefines and runs the test in one go.
(kaocha.repl/run
(deftest my-test
,,,))
When using CIDER this combines really well with
cider-pprint-eval-defun-at-point
(binding in CIDER 1.18.1: C-c C-f
).
The (kaocha.repl/config)
and (kaocha.repl/test-plan)
functions are very
useful when diagnosing issues, and can be helpful when developing plugins or
test types.
Can you improve this documentation? These fine people already did:
Arne Brasseur & François De SerresEdit on GitHub
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close