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 easiest way to run tests is to say "make test", (or simply run the
12 notmuch-test script). Either command will run all available tests.
14 Alternately, you can run a specific subset of tests by simply invoking
15 one of the executable scripts in this directory, (such as ./search,
18 The following command-line options are available when running tests:
21 This may help the person who is developing a new test.
22 It causes the command defined with test_debug to run.
25 This causes the test to immediately exit upon the first
29 Execute notmuch with valgrind and exit with status
30 126 on errors (just like regular tests, this will only stop
31 the test script when running under -i). Valgrind errors
32 go to stderr, so you might want to pass the -v option, too.
34 Since it makes no sense to run the tests with --valgrind and
35 not see any output, this option implies --verbose. For
36 convenience, it also implies --tee.
39 In addition to printing the test output to the terminal,
40 write it to files named 't/test-results/$TEST_NAME.out'.
41 As the names depend on the tests' file names, it is safe to
42 run the tests with this option in parallel.
45 This runs the testsuites specified under a seperate directory.
46 However, caution is advised, as not all tests are maintained
47 with this relocation in mind, so some tests may behave
50 Pointing this argument at a tmpfs filesystem can improve the
51 speed of the test suite for some users.
53 When invoking the test suite via "make test" any of the above options
54 can be specified as follows:
56 make test OPTIONS="--verbose"
60 If, for any reason, you need to skip one or more tests, you can do so
61 by setting the NOTMUCH_SKIP_TESTS variable to the name of one or more
66 $ NOTMUCH_SKIP_TESTS="search reply" make test
68 Even more fine-grained skipping is possible by appending a test number
69 (or glob pattern) after the section name. For example, the first
70 search test and the second reply test could be skipped with:
72 $ NOTMUCH_SKIP_TESTS="search.1 reply.2" make test
74 Note that some tests in the existing test suite rely on previous test
75 items, so you cannot arbitrarily skip any test and expect the
76 remaining tests to be unaffected.
80 The test script is written as a shell script. It should start with
81 the standard "#!/usr/bin/env bash" with copyright notices, and an
82 assignment to variable 'test_description', like this:
86 # Copyright (c) 2005 Junio C Hamano
89 test_description='xxx test (option --frotz)
91 This test exercises the "notmuch xxx" command when
92 given the option --frotz.'
96 After assigning test_description, the test script should source
97 test-lib.sh like this:
101 This test harness library does the following things:
103 - If the script is invoked with command line argument --help
104 (or -h), it shows the test_description and exits.
106 - Creates a temporary directory with default notmuch-config and a
107 mail store with a corpus of mail, (initially, 50 early messages
108 sent to the notmuch list). This directory is
109 test/tmp.<test-basename>. The path to notmuch-config is exported in
110 NOTMUCH_CONFIG environment variable and mail store path is stored
111 in MAIL_DIR variable.
113 - Defines standard test helper functions for your scripts to
114 use. These functions are designed to make all scripts behave
115 consistently when command line arguments --verbose (or -v),
116 --debug (or -d), and --immediate (or -i) is given.
120 Your script will be a sequence of tests, using helper functions
121 from the test harness library. At the end of the script, call
126 There are a handful helper functions defined in the test harness
127 library for your script to use.
129 test_expect_success <message> <script>
131 This takes two strings as parameter, and evaluates the
132 <script>. If it yields success, test is considered
133 successful. <message> should state what it is testing.
135 test_expect_failure <message> <script>
137 This is NOT the opposite of test_expect_success, but is used
138 to mark a test that demonstrates a known breakage. Unlike
139 the usual test_expect_success tests, which say "ok" on
140 success and "FAIL" on failure, this will say "FIXED" on
141 success and "still broken" on failure. Failures from these
142 tests won't cause -i (immediate) to stop.
144 test_begin_subtest <message>
146 Set the test description message for a subsequent test_expect_equal
147 invocation (see below).
149 test_expect_equal <output> <expected>
151 This is an often-used convenience function built on top of
152 test_expect_success. It uses the message from the last
153 test_begin_subtest call, so call before calling
154 test_expect_equal. This function generates a successful test if
155 both the <output> and <expected> strings are identical. If not, it
156 will generate a failure and print the difference of the two
159 test_expect_equal_failure <output> <expected>
161 This works similar to test_expect_equal (see above) but is used to
162 mark a test that demonstrates a known breakage, (that is, the
163 author of the test expects "output" and "expected" to differ until
164 the breakage is fixed). See test_expect_failure for details.
168 This takes a single argument, <script>, and evaluates it only
169 when the test script is started with --debug command line
170 argument. This is primarily meant for use during the
171 development of a new test script.
173 test_emacs <emacs-lisp-expressions>
175 This function executes the provided emacs lisp script within
176 emacs. The script can be a sequence of emacs lisp expressions,
177 (that is, they will be evaluated within a progn form). The lisp
178 expressions can call `message' to generate output on stdout to be
179 examined by the calling test script.
183 Your test script must have test_done at the end. Its purpose
184 is to summarize successes and failures in the test script and
185 exit with an appropriate error code.
187 There are also a number of mail-specific functions which are useful in
192 Generates a message with an optional template. Most tests will
193 actually prefer to call add_message. See below.
197 Generate a message and add it to the database (by calling "notmuch
198 new"). It is sufficient to simply call add_message with no
199 arguments if you don't care about the content of the message. If
200 more control is needed, arguments can be provide to specify many
201 different header values for the new message. See the documentation
202 within test-lib.sh or refer to many example calls within existing
207 This function should be called at the beginning of a test file
208 when a test needs to operate on a non-empty body of messages. It
209 will initialize the mail database to a known state of 50 sample
210 messages, (culled from the early history of the notmuch mailing