git.notmuchmail.org Git - notmuch/blob - test/README

   1 Notmuch test suite
   2 ==================
   3 This directory contains the test suite for notmuch.
   4
   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
   7 enhance.
   8
   9 Running Tests
  10 -------------
  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.
  13
  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,
  16 ./reply, etc). Note that you will probably want "make test-binaries"
  17 before running individual tests.
  18
  19 The following command-line options are available when running tests:
  20
  21 --debug::
  22         This may help the person who is developing a new test.
  23         It causes the command defined with test_debug to run.
  24
  25 --immediate::
  26         This causes the test to immediately exit upon the first
  27         failed test.
  28
  29 --valgrind::
  30         Execute notmuch with valgrind and exit with status
  31         126 on errors (just like regular tests, this will only stop
  32         the test script when running under -i).  Valgrind errors
  33         go to stderr, so you might want to pass the -v option, too.
  34
  35         Since it makes no sense to run the tests with --valgrind and
  36         not see any output, this option implies --verbose.  For
  37         convenience, it also implies --tee.
  38
  39 --tee::
  40         In addition to printing the test output to the terminal,
  41         write it to files named 't/test-results/$TEST_NAME.out'.
  42         As the names depend on the tests' file names, it is safe to
  43         run the tests with this option in parallel.
  44
  45 --root=<dir>::
  46         This runs the testsuites specified under a seperate directory.
  47         However, caution is advised, as not all tests are maintained
  48         with this relocation in mind, so some tests may behave
  49         differently.
  50
  51         Pointing this argument at a tmpfs filesystem can improve the
  52         speed of the test suite for some users.
  53
  54 When invoking the test suite via "make test" any of the above options
  55 can be specified as follows:
  56
  57         make test OPTIONS="--verbose"
  58
  59 Skipping Tests
  60 --------------
  61 If, for any reason, you need to skip one or more tests, you can do so
  62 by setting the NOTMUCH_SKIP_TESTS variable to the name of one or more
  63 sections of tests.
  64
  65 For example:
  66
  67     $ NOTMUCH_SKIP_TESTS="search reply" make test
  68
  69 Even more fine-grained skipping is possible by appending a test number
  70 (or glob pattern) after the section name. For example, the first
  71 search test and the second reply test could be skipped with:
  72
  73     $ NOTMUCH_SKIP_TESTS="search.1 reply.2" make test
  74
  75 Note that some tests in the existing test suite rely on previous test
  76 items, so you cannot arbitrarily skip any test and expect the
  77 remaining tests to be unaffected.
  78
  79 Writing Tests
  80 -------------
  81 The test script is written as a shell script.  It should start with
  82 the standard "#!/usr/bin/env bash" with copyright notices, and an
  83 assignment to variable 'test_description', like this:
  84
  85         #!/usr/bin/env bash
  86         #
  87         # Copyright (c) 2005 Junio C Hamano
  88         #
  89
  90         test_description='xxx test (option --frotz)
  91
  92         This test exercises the "notmuch xxx" command when
  93         given the option --frotz.'
  94
  95 Source 'test-lib.sh'
  96 --------------------
  97 After assigning test_description, the test script should source
  98 test-lib.sh like this:
  99
 100         . ./test-lib.sh
 101
 102 This test harness library does the following things:
 103
 104  - If the script is invoked with command line argument --help
 105    (or -h), it shows the test_description and exits.
 106
 107  - Creates a temporary directory with default notmuch-config and a
 108    mail store with a corpus of mail, (initially, 50 early messages
 109    sent to the notmuch list). This directory is
 110    test/tmp.<test-basename>. The path to notmuch-config is exported in
 111    NOTMUCH_CONFIG environment variable and mail store path is stored
 112    in MAIL_DIR variable.
 113
 114  - Defines standard test helper functions for your scripts to
 115    use.  These functions are designed to make all scripts behave
 116    consistently when command line arguments --verbose (or -v),
 117    --debug (or -d), and --immediate (or -i) is given.
 118
 119 End with test_done
 120 ------------------
 121 Your script will be a sequence of tests, using helper functions
 122 from the test harness library.  At the end of the script, call
 123 'test_done'.
 124
 125 Test harness library
 126 --------------------
 127 There are a handful helper functions defined in the test harness
 128 library for your script to use.
 129
 130  test_expect_success <message> <script>
 131
 132    This takes two strings as parameter, and evaluates the
 133    <script>.  If it yields success, test is considered
 134    successful.  <message> should state what it is testing.
 135
 136  test_begin_subtest <message>
 137
 138    Set the test description message for a subsequent test_expect_equal
 139    invocation (see below).
 140
 141  test_subtest_known_broken
 142
 143    Mark the current test as broken.  Such tests are expected to fail.
 144    Unlike the normal tests, which say "PASS" on success and "FAIL" on
 145    failure, these will say "FIXED" on success and "BROKEN" on failure.
 146    Failures from these tests won't cause -i (immediate) to stop.  A
 147    test must call this before any test_expect_* function.
 148
 149  test_expect_equal <output> <expected>
 150
 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
 157    strings.
 158
 159  test_expect_equal_file <output> <expected>
 160
 161    Identical to test_exepect_equal, except that <output> and
 162    <expected> are files instead of strings.  This is a much more
 163    robust method to compare formatted textual information, since it
 164    also notices whitespace and closing newline differences.
 165
 166  test_debug <script>
 167
 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.
 172
 173  test_emacs <emacs-lisp-expressions>
 174
 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). Emacs
 178    stdout and stderr is not available, the common way to get output
 179    is to save it to a file. There are some auxiliary functions
 180    useful in emacs tests provided in test-lib.el. Do not use `setq'
 181    for setting variables in Emacs tests because it affects other
 182    tests that may run in the same Emacs instance.  Use `let' instead
 183    so the scope of the changed variables is limited to a single test.
 184
 185  test_done
 186
 187    Your test script must have test_done at the end.  Its purpose
 188    is to summarize successes and failures in the test script and
 189    exit with an appropriate error code.
 190
 191 There are also a number of notmuch-specific auxiliary functions and
 192 variables which are useful in writing tests:
 193
 194   generate_message
 195
 196     Generates a message with an optional template. Most tests will
 197     actually prefer to call add_message. See below.
 198
 199   add_message
 200
 201     Generate a message and add it to the database (by calling "notmuch
 202     new"). It is sufficient to simply call add_message with no
 203     arguments if you don't care about the content of the message. If
 204     more control is needed, arguments can be provide to specify many
 205     different header values for the new message. See the documentation
 206     within test-lib.sh or refer to many example calls within existing
 207     tests.
 208
 209   add_email_corpus
 210
 211     This function should be called at the beginning of a test file
 212     when a test needs to operate on a non-empty body of messages. It
 213     will initialize the mail database to a known state of 50 sample
 214     messages, (culled from the early history of the notmuch mailing
 215     list).
 216
 217   notmuch_counter_reset
 218   $notmuch_counter_command
 219   notmuch_counter_value
 220
 221     These allow to count how many times notmuch binary is called.
 222     notmuch_counter_reset() function generates a script that counts
 223     how many times it is called and resets the counter to zero.  The
 224     function sets $notmuch_counter_command variable to the path to the
 225     generated script that should be called instead of notmuch to do
 226     the counting.  The notmuch_counter_value() function prints the
 227     current counter value.