boot.test — boot/core 2.8.3

clojurize-summaries clj

(clojurize-summaries java-summaries)

Transform Java to Clojure summaries, for instance converting keys to keywords. Returns a map of summaries indexed by command string (the boot in boot command executed, see command-str).

deftesttask clj macro

(deftesttask & forms)

Define a test task. It enhances deftask so that tests can be run in parallel through boot.built-in/runtests.

Inside a task you can combine the clojure.test facilities testing, is, are, ... the only requirement is that your deftesttask follows boot's middleware pattern and return either the result of comp-ositing tasks or identity.

Example of declaration:

(deftesttask my-test "Testing." (with-pass-thru fs (testing "whatever" (is true "Whatever must be true"))))

When clojure.test/load-tests is false, deftesttask is ignored.

inc-test-counter clj

(inc-test-counter & {:as *opts* :keys [help]})

No description provided.

Keyword Args: :help bool Print this help info.

merge-summaries clj

(merge-summaries summaries)

Merge summaries. Note that it has to be in Clojure form already, see clojurize-summary.

namespaces->vars clj

(namespaces->vars pred namespaces)

Filter the input namespaces in order to get the test task vars according to pred, a 1-arity function that accepts a var in input and returns true it is to be considered a test var.

TODO: use transduce when switching Clojure 1.7.0

print-summary! clj

(print-summary! summary)

Print out (info) the summary. Note that it has to be in Clojure form already, see clojurize-summary.

runtests clj

(runtests & {:as *opts* :keys [help commands threads namespaces exclusions]})

Run boot-in-boot parallel tests and collect the results.

The default, no argument variant runs all the test tasks found in all the namespaces on the classpath, see boot.test/deftesttask on how to create test tasks.

If you want more control, there actually is a command mode and a namespace mode. To avoid clashing they are mutually exclusive, command mode takes precedence.

A command is the string you would use on the command line for running the task (after having it required in build.boot).

The namespaces option, instead, is self-explanatory and does not allow to specify additionally arguments to tasks.

Usage example at the command line:

$ boot runtests -c "foo-tests --param --int 5" -c "bar-tests"

Or in build.boot: (runtests :commands #{"foo-tests :param true :int 5" "bar-test"})

Last but not least, :threads is an integer that limits the number of spawned threads, defaulting to the canonical (-> (number of processors) inc inc).

Keyword Args: :help bool Print this help info. :commands ^:! #{str} The boot task cli calls + arguments (a set of strings). :threads int The maximum number of threads to spawn during the tests. :namespaces #{sym} The set of namespace symbols to run tests in. :exclusions #{sym} The set of namespace symbols to be excluded from test.

set-summary clj

(set-summary & {:as *opts* :keys [help]})

No description provided.

Keyword Args: :help bool Print this help info.

set-summary-data! clj

(set-summary-data! data)

Set the test summary in the (shared) sync map for this pod

summary-errors clj

(summary-errors summary)

Retrieve the number or errors in a summary. Note that it has to be in Clojure form already, see clojurize-summary.

test-exit clj

(test-exit & {:as *opts* :keys [help]})

Adds the ability to exit from the test with the right code, it simply parses the input summaries and call boot.util/exit-errors in case of failures or errors.

You can omit this task if you don't care about having the return code not equal to zero (for instance during continuous testing in development).

Keyword Args: :help bool Print this help info.

test-me-pred clj

Return true when boot.test/test-task meta on the var is boot.test/test-me.

test-report clj

(test-report & {:as *opts* :keys [help]})

Boot's default test report task, it prints out the final summary.

The usual -v/-vv control the verbosity of the report.

Keyword Args: :help bool Print this help info.

test-task clj

(test-task task)

Create a boot test task by wrapping other tasks, either the result of deftask or comp. Another way to say it is that a boot middleware should be passed here.

testing-context clj

(testing-context & {:as *opts* :keys [help]})

No description provided.

Keyword Args: :help bool Print this help info.

update-body clj

(update-body forms f)

Given the split vector returned by split-deftask-forms, rebuild the correct forms for the deftask macro, replacing body with the one returned by (f old-body).

var->command clj

(var->command var)

Return a string representing the task command to trigger (needed in runboot).

with-report-counters clj

(with-report-counters & {:as *opts* :keys [help]})

No description provided.

Keyword Args: :help bool Print this help info.