3 This directory contains the test suite for notmuch.
5 When fixing bugs or enhancing notmuch, you are strongly encouraged to
6 add tests in this directory to cover what you are trying to fix or
11 The test system itself requires:
13 - bash(1) version 4.0 or newer
15 Without bash 4.0+ the tests just refuse to run.
17 Some tests require external dependencies to run. Without them, they
18 will be skipped, or (rarely) marked failed. Please install these, so
19 that you know if you break anything.
29 If your system lacks these tools or have older, non-upgreable versions
30 of these, please (possibly compile and) install these to some other
31 path, for example /usr/local/bin or /opt/gnu/bin. Then prepend the
32 chosen directory to your PATH before running the tests.
34 e.g. env PATH=/opt/gnu/bin:$PATH make test
38 The easiest way to run tests is to say "make test", (or simply run the
39 notmuch-test script). Either command will run all available tests.
41 Alternately, you can run a specific subset of tests by simply invoking
42 one of the executable scripts in this directory, (such as ./T*-search.sh,
43 ./T*-reply.sh, etc). Note that you will probably want "make test-binaries"
44 before running individual tests.
46 The following command-line options are available when running tests:
49 This may help the person who is developing a new test.
50 It causes the command defined with test_debug to run.
53 This causes the test to immediately exit upon the first
57 Execute notmuch with valgrind and exit with status
58 126 on errors (just like regular tests, this will only stop
59 the test script when running under -i). Valgrind errors
60 go to stderr, so you might want to pass the -v option, too.
62 Since it makes no sense to run the tests with --valgrind and
63 not see any output, this option implies --verbose. For
64 convenience, it also implies --tee.
67 In addition to printing the test output to the terminal,
68 write it to files named 't/test-results/$TEST_NAME.out'.
69 As the names depend on the tests' file names, it is safe to
70 run the tests with this option in parallel.
73 This runs the testsuites specified under a separate directory.
74 However, caution is advised, as not all tests are maintained
75 with this relocation in mind, so some tests may behave
78 Pointing this argument at a tmpfs filesystem can improve the
79 speed of the test suite for some users.
81 Certain tests require precomputed databases to complete. You can fetch these
84 make download-test-databases
86 If you do not download the test databases, the relevant tests will be
89 When invoking the test suite via "make test" any of the above options
90 can be specified as follows:
92 make test OPTIONS="--verbose"
94 You can choose an emacs binary (and corresponding emacsclient) to run
95 the tests in one of the following ways.
97 TEST_EMACS=my-emacs TEST_EMACSCLIENT=my-emacsclient make test
98 TEST_EMACS=my-emacs TEST_EMACSCLIENT=my-emacsclient ./T*-emacs.sh
99 make test TEST_EMACS=my-emacs TEST_EMACSCLIENT=my-emacsclient
101 Some tests may require a c compiler. You can choose the name and flags similarly
104 make test TEST_CC=gcc TEST_CFLAGS="-g -O2"
109 Normally, when new script starts and when test PASSes you get a message
110 printed on screen. This printing can be disabled by setting the
111 NOTMUCH_TEST_QUIET variable to a non-null value. Message on test
112 failures and skips are still printed.
116 If, for any reason, you need to skip one or more tests, you can do so
117 by setting the NOTMUCH_SKIP_TESTS variable to the name of one or more
122 $ NOTMUCH_SKIP_TESTS="search reply" make test
124 Even more fine-grained skipping is possible by appending a test number
125 (or glob pattern) after the section name. For example, the first
126 search test and the second reply test could be skipped with:
128 $ NOTMUCH_SKIP_TESTS="search.1 reply.2" make test
130 Note that some tests in the existing test suite rely on previous test
131 items, so you cannot arbitrarily skip any test and expect the
132 remaining tests to be unaffected.
134 Currently we do not consider skipped tests as build failures. For
135 maximum robustness, when setting up automated build processes, you
136 should explicitely skip tests, rather than relying on notmuch's
137 detection of missing prerequisites. In the future we may treat tests
138 unable to run because of missing prerequisites, but not explicitely
139 skipped by the user, as failures.
143 The test script is written as a shell script. It is to be named as
144 Tddd-testname.sh where 'ddd' is three digits and 'testname' the "bare"
145 name of your test. Tests will be run in order the 'ddd' part determines.
147 The test script should start with the standard "#!/usr/bin/env bash"
148 with copyright notices, and an assignment to variable 'test_description',
153 # Copyright (c) 2005 Junio C Hamano
156 test_description='xxx test (option --frotz)
158 This test exercises the "notmuch xxx" command when
159 given the option --frotz.'
163 After assigning test_description, the test script should source
164 test-lib.sh like this:
166 . ./test-lib.sh || exit 1
168 This test harness library does the following things:
170 - If the script is invoked with command line argument --help
171 (or -h), it shows the test_description and exits.
173 - Creates a temporary directory with default notmuch-config and a
174 mail store with a corpus of mail, (initially, 50 early messages
175 sent to the notmuch list). This directory is
176 test/tmp.<test-basename>. The path to notmuch-config is exported in
177 NOTMUCH_CONFIG environment variable and mail store path is stored
178 in MAIL_DIR variable.
180 - Defines standard test helper functions for your scripts to
181 use. These functions are designed to make all scripts behave
182 consistently when command line arguments --verbose (or -v),
183 --debug (or -d), and --immediate (or -i) is given.
187 Your script will be a sequence of tests, using helper functions
188 from the test harness library. At the end of the script, call
193 There are a handful helper functions defined in the test harness
194 library for your script to use.
196 test_expect_success <message> <script>
198 This takes two strings as parameter, and evaluates the
199 <script>. If it yields success, test is considered
200 successful. <message> should state what it is testing.
202 test_begin_subtest <message>
204 Set the test description message for a subsequent test_expect_equal
205 invocation (see below).
207 test_subtest_known_broken
209 Mark the current test as broken. Such tests are expected to fail.
210 Unlike the normal tests, which say "PASS" on success and "FAIL" on
211 failure, these will say "FIXED" on success and "BROKEN" on failure.
212 Failures from these tests won't cause -i (immediate) to stop. A
213 test must call this before any test_expect_* function.
215 test_expect_equal <output> <expected>
217 This is an often-used convenience function built on top of
218 test_expect_success. It uses the message from the last
219 test_begin_subtest call, so call before calling
220 test_expect_equal. This function generates a successful test if
221 both the <output> and <expected> strings are identical. If not, it
222 will generate a failure and print the difference of the two
225 test_expect_equal_file <file1> <file2>
227 Identical to test_expect_equal, except that <file1> and <file2>
228 are files instead of strings. This is a much more robust method to
229 compare formatted textual information, since it also notices
230 whitespace and closing newline differences.
232 test_expect_equal_json <output> <expected>
234 Identical to test_expect_equal, except that the two strings are
235 treated as JSON and canonicalized before equality testing. This is
236 useful to abstract away from whitespace differences in the expected
237 output and that generated by running a notmuch command.
241 This takes a single argument, <script>, and evaluates it only
242 when the test script is started with --debug command line
243 argument. This is primarily meant for use during the
244 development of a new test script.
246 test_emacs <emacs-lisp-expressions>
248 This function executes the provided emacs lisp script within
249 emacs. The script can be a sequence of emacs lisp expressions,
250 (that is, they will be evaluated within a progn form). Emacs
251 stdout and stderr is not available, the common way to get output
252 is to save it to a file. There are some auxiliary functions
253 useful in emacs tests provided in test-lib.el. Do not use `setq'
254 for setting variables in Emacs tests because it affects other
255 tests that may run in the same Emacs instance. Use `let' instead
256 so the scope of the changed variables is limited to a single test.
258 test_emacs_expect_t <emacs-lisp-expressions>
260 This function executes the provided emacs lisp script within
261 emacs in a manner similar to 'test_emacs'. The expressions should
262 return the value `t' to indicate that the test has passed. If the
263 test does not return `t' then it is considered failed and all data
264 returned by the test is reported to the tester.
268 Your test script must have test_done at the end. Its purpose
269 is to summarize successes and failures in the test script and
270 exit with an appropriate error code.
272 There are also a number of notmuch-specific auxiliary functions and
273 variables which are useful in writing tests:
277 Generates a message with an optional template. Most tests will
278 actually prefer to call add_message. See below.
282 Generate a message and add it to the database (by calling "notmuch
283 new"). It is sufficient to simply call add_message with no
284 arguments if you don't care about the content of the message. If
285 more control is needed, arguments can be provide to specify many
286 different header values for the new message. See the documentation
287 within test-lib.sh or refer to many example calls within existing
292 This function should be called at the beginning of a test file
293 when a test needs to operate on a non-empty body of messages. It
294 will initialize the mail database to a known state of 50 sample
295 messages, (culled from the early history of the notmuch mailing
298 notmuch_counter_reset
299 $notmuch_counter_command
300 notmuch_counter_value
302 These allow to count how many times notmuch binary is called.
303 notmuch_counter_reset() function generates a script that counts
304 how many times it is called and resets the counter to zero. The
305 function sets $notmuch_counter_command variable to the path to the
306 generated script that should be called instead of notmuch to do
307 the counting. The notmuch_counter_value() function prints the
308 current counter value.
310 There are also functions which remove various environment-dependent
311 values from notmuch output; these are useful to ensure that test
312 results remain consistent across different machines.
314 notmuch_search_sanitize
315 notmuch_show_sanitize
316 notmuch_show_sanitize_all
317 notmuch_json_show_sanitize
319 All these functions should receive the text to be sanitized as the
320 input of a pipe, e.g.
321 output=`notmuch search "..." | notmuch_search_sanitize`