1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
## Running tests
You can run `clojure.test` tests pretty quickly in CIDER. Pressing <kbd>C-c C-t
n</kbd> or <kbd>C-c C-t C-n</kbd> in a source buffer or a REPL buffer will run
the tests for the namespace you're currently in. CIDER is smart enough to figure
out the namespace containing the tests. The inference logic works in a pretty
simple manner - if you're in an implementation namespace (e.g. `some.ns`) CIDER
will try to find a matching test namespace (by default `some.ns-test`) and run
the tests there. On the other hand - if you're in something that looks like a
test namespace (e.g. `some.ns-test`), then the command will simply run the tests
in that namespace. From time to time, however, you might want to suppress the
test namespace inference logic (e.g. you have some tests in the implementation
namespace that were defined with `clojure.test/with-test`)
- in such cases you should use <kbd>C-u C-c C-t C-n</kbd>, which will simply run
whatever tests are present in the currently visited/active namespace.
You can also press <kbd>C-c C-t C-s</kbd> to run a subset of the tests defined in
the namespace filtered by test selectors. CIDER will ask you for those test selectors
in the minibuffer. If you call this command with a prefix (<kbd>C-u C-c C-t C-s</kbd>)
you can suppress the inference logic as for run tests for the namespace.
You can also run all loaded tests with <kbd>C-c C-t l</kbd> or <kbd>C-c C-t
C-l</kbd> and all tests within a project with <kbd>C-c C-t p</kbd> or <kbd>C-c
C-t C-p</kbd> (note that this will load **all** namespaces in your
project). If you call these two with a prefix CIDER will ask for test selector filters
and only run those tests in the project which match the selector inclusions/exclusions. Using
<kbd>C-c C-t t</kbd> or <kbd>C-c C-t C-t</kbd>, you can execute only the
test at point.
Test selectors are originally a `leiningen` feature - see `lein help test` for some explanation.
People use them to define subsets of tests usually run together for different purposes. For
example you can mark some of your tests with the `^:smoke` metadata marker others with
`^:integration`. This enables you to run these tests separately in your build pipeline.
This feature in CIDER helps you to run these test subsets in your development environment.
All test commands are available in REPL buffers as well. There you can also use
<kbd>,</kbd> to invoke some of the testing commands.
In the buffer displaying the test execution results (`*cider-test-results*`)
you'll have a bit of additional functionality at your disposal.
Keyboard shortcut | Description
--------------------------------|-------------------------------
<kbd>g</kbd> | Run test at point.
<kbd>n</kbd> | Run tests for current namespace.
<kbd>s</kbd> | Run tests for current namespace with selector filter.
<kbd>l</kbd> | Run tests for all loaded namespaces.
<kbd>p</kbd> | Run tests for all project namespaces. This loads the additional namespaces.
<kbd>f</kbd> | Re-run test failures/errors.
<kbd>M-p</kbd> | Move point to previous test.
<kbd>M-n</kbd> | Move point to next test.
<kbd>t</kbd> or <kbd>M-.</kbd> | Jump to test definition.
<kbd>d</kbd> | Display diff of actual vs expected.
<kbd>e</kbd> | Display test error cause and stacktrace info.
Certain aspects of the test execution behavior are configurable:
* If your tests are not following the `some.ns-test` naming convention you can
customize the variable `cider-test-infer-test-ns`. It should be bound to a
function that takes the current namespace and returns the matching test
namespace (which may be the same as the current namespace).
* If your individual tests are not defined by `deftest` or `defspec`, CIDER will
not recognize them when searching for a test at point in `cider-test-run-test`.
You can customize the variable `cider-test-defining-forms` to add additional
forms for CIDER to recognize as individual test definitions.
* If you want to view the test report regardless of whether the tests have
passed or failed:
```el
(setq cider-test-show-report-on-success t)
```
### Running tests automatically (test-driven development)
CIDER provides a minor-mode that automatically runs all tests for a namespace
whenever you load a file (with <kbd>C-c C-k</kbd>). You can toggle it
manually with <kbd>M-x</kbd> `cider-auto-test-mode`, or you can use:
```el
(cider-auto-test-mode 1)
```
This is completely equivalent to manually typing <kbd>C-c C-t C-n</kbd> every
time you load a Clojure buffer. Also, as described above before, CIDER is smart
enough to figure out the namespace containing the tests.
### Using cider-test with alternative test libraries
The `clojure.test` machinery is designed to be pluggable. Any test library
can implement it if so desired, and therefore leverage `cider-test`. For
instance, [test.check](https://github.com/clojure/test.check/) does this, and
`cider-test` handles `defspec` just like `deftest`.
As a test framework author, supporting the built-in `clojure.test` machinery
(and hence `cider-test`) is pretty straightforward:
1. Assoc each test fn as `:test` metadata on some var. These are what get run.
2. Implement the `clojure.test/report` multimethod to capture the test results.
The `test.check` library is a good example here. It was also designed completely
independently of `clojure.test`. It just adds compatibility in this
[namespace](https://github.com/clojure/test.check/blob/24f74b83f1c7a032f98efdcc1db9d74b3a6a794d/src/main/clojure/clojure/test/check/clojure_test.cljc).
[clojure-expectations](https://github.com/clojure-expectations/expectations) added
support for `clojure.test` in version 2.2 and should also work with CIDER.
|
