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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
Notmuch test suite
==================
This directory contains the test suite for notmuch.
When fixing bugs or enhancing notmuch, you are strongly encouraged to
add tests in this directory to cover what you are trying to fix or
enhance.
Running Tests
-------------
The easiest way to run tests is to say "make test", (or simply run the
notmuch-test script). Either command will run all available tests.
Alternately, you can run a specific subset of tests by simply invoking
one of the executable scripts in this directory, (such as ./search,
./reply, etc.)
The following command-line options are available when running tests:
--debug::
This may help the person who is developing a new test.
It causes the command defined with test_debug to run.
--immediate::
This causes the test to immediately exit upon the first
failed test.
--valgrind::
Execute notmuch with valgrind and exit with status
126 on errors (just like regular tests, this will only stop
the test script when running under -i). Valgrind errors
go to stderr, so you might want to pass the -v option, too.
Since it makes no sense to run the tests with --valgrind and
not see any output, this option implies --verbose. For
convenience, it also implies --tee.
--tee::
In addition to printing the test output to the terminal,
write it to files named 't/test-results/$TEST_NAME.out'.
As the names depend on the tests' file names, it is safe to
run the tests with this option in parallel.
When invoking the test suite via "make test" any of the above options
can be specified as follows:
make test OPTIONS="--verbose"
Skipping Tests
--------------
If, for any reason, you need to skip one or more tests, you can do so
by setting the NOTMUCH_SKIP_TESTS variable to the name of one or more
sections of tests.
For example:
$ NOTMUCH_SKIP_TESTS="search reply" make test
Even more fine-grained skipping is possible by appending a test number
(or glob pattern) after the section name. For example, the first
search test and the second reply test could be skipped with:
$ NOTMUCH_SKIP_TESTS="search.1 reply.2" make test
Note that some tests in the existing test suite rely on previous test
items, so you cannot arbitrarily skip any test and expect the
remaining tests to be unaffected.
Writing Tests
-------------
The test script is written as a shell script. It should start with
the standard "#!/usr/bin/env bash" with copyright notices, and an
assignment to variable 'test_description', like this:
#!/usr/bin/env bash
#
# Copyright (c) 2005 Junio C Hamano
#
test_description='xxx test (option --frotz)
This test exercises the "notmuch xxx" command when
given the option --frotz.'
Source 'test-lib.sh'
--------------------
After assigning test_description, the test script should source
test-lib.sh like this:
. ./test-lib.sh
This test harness library does the following things:
- If the script is invoked with command line argument --help
(or -h), it shows the test_description and exits.
- Creates a temporary directory with default notmuch-config and a
mail store with a corpus of mail, (initially, 50 early messages
sent to the notmuch list). This directory is
test/tmp.<test-basename>. The path to notmuch-config is exported in
NOTMUCH_CONFIG environment variable and mail store path is stored
in MAIL_DIR variable.
- Defines standard test helper functions for your scripts to
use. These functions are designed to make all scripts behave
consistently when command line arguments --verbose (or -v),
--debug (or -d), and --immediate (or -i) is given.
End with test_done
------------------
Your script will be a sequence of tests, using helper functions
from the test harness library. At the end of the script, call
'test_done'.
Test harness library
--------------------
There are a handful helper functions defined in the test harness
library for your script to use.
test_expect_success <message> <script>
This takes two strings as parameter, and evaluates the
<script>. If it yields success, test is considered
successful. <message> should state what it is testing.
test_expect_failure <message> <script>
This is NOT the opposite of test_expect_success, but is used
to mark a test that demonstrates a known breakage. Unlike
the usual test_expect_success tests, which say "ok" on
success and "FAIL" on failure, this will say "FIXED" on
success and "still broken" on failure. Failures from these
tests won't cause -i (immediate) to stop.
test_begin_subtest <message>
Set the test description message for a subsequent test_expect_equal
invocation (see below).
test_expect_equal <output> <expected>
This is an often-used convenience function built on top of
test_expect_success. It uses the message from the last
test_begin_subtest call, so call before calling
test_expect_equal. This function generates a successful test if
both the <output> and <expected> strings are identical. If not, it
will generate a failure and print the difference of the two
strings.
test_expect_equal_failure <output> <expected>
This works similar to test_expect_equal (see above) but is used to
mark a test that demonstrates a known breakage, (that is, the
author of the test expectes "output" and "expected" to differ until
the breakage is fixed). See test_expect_failure for details.
test_debug <script>
This takes a single argument, <script>, and evaluates it only
when the test script is started with --debug command line
argument. This is primarily meant for use during the
development of a new test script.
test_emacs <emacs-lisp-expressions>
This function executes the provided emacs lisp script within
emacs. The script can be a sequence of emacs lisp expressions,
(that is, they will be evaluated within a progn form). The lisp
expressions can call `message' to generate output on stdout to be
examined by the calling test script.
test_done
Your test script must have test_done at the end. Its purpose
is to summarize successes and failures in the test script and
exit with an appropriate error code.
There are also a number of mail-specific functions which are useful in
writing tests:
generate_message
Generates a message with an optional template. Most tests will
actually prefere to call add_message. See below.
add_message
Generate a message and add it to the database (by calling "notmuch
new"). It is sufficient to simply call add_message with no
arguments if you don't care about the content of the message. If
more control is needed, arguments can be provide to specify many
different header values for the new message. See the documentation
within test-lib.sh or refer to many example calls within existing
tests.
add_email_corpus
This function should be called at the beginning of a test file
when a test needs to operate on a non-empty body of messages. It
will intialize the mail database to a known state of 50 sample
messages, (culled from the early history of the notmuch mailing
list).
|
