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. Prerequisites ------------- The test system itself requires: - bash(1) version 4.0 or newer Without bash 4.0+ the tests just refuse to run. Some tests require external dependencies to run. Without them, they will be skipped, or (rarely) marked failed. Please install these, so that you know if you break anything. - GNU tar(1) - dtach(1) - emacs(1) - emacsclient(1) - gdb(1) - gpg(1) - python(1) - xapian-metadata(1) If your system lacks these tools or have older, non-upgradable versions of these, please (possibly compile and) install these to some other path, for example /usr/local/bin or /opt/gnu/bin. Then prepend the chosen directory to your PATH before running the tests. e.g. env PATH=/opt/gnu/bin:$PATH make test For FreeBSD you need to install latest gdb from ports or packages and provide path to it in TEST_GDB environment variable before executing the tests, native FreeBSD gdb does not not work. If you install coreutils, which provides GNU versions of basic utils like 'date' and 'base64' on FreeBSD, the test suite will use these instead of the native ones. This provides robustness against portability issues with these system tools. Most often the tests are written, reviewed and tested on Linux system so such portability issues arise from time to time. 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 ./T*-search.sh, ./T*-reply.sh, etc). Note that you will probably want "make test-binaries" before running individual tests. 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" You can choose an emacs binary (and corresponding emacsclient) to run the tests in one of the following ways. TEST_EMACS=my-emacs TEST_EMACSCLIENT=my-emacsclient make test TEST_EMACS=my-emacs TEST_EMACSCLIENT=my-emacsclient ./T*-emacs.sh make test TEST_EMACS=my-emacs TEST_EMACSCLIENT=my-emacsclient Some tests may require a c compiler. You can choose the name and flags similarly to with emacs, e.g. make test TEST_CC=gcc TEST_CFLAGS="-g -O2" Parallel Execution ------------------ If either the moreutils or GNU "parallel" utility is available all tests will be run in parallel. If the NOTMUCH_TEST_SERIALIZE variable is non-null all tests will be executed sequentially. Quiet Execution --------------- Normally, when new script starts and when test PASSes you get a message printed on screen. This printing can be disabled by setting the NOTMUCH_TEST_QUIET variable to a non-null value. Message on test failures and skips are still printed. 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. Currently we do not consider skipped tests as build failures. For maximum robustness, when setting up automated build processes, you should explicitly skip tests, rather than relying on notmuch's detection of missing prerequisites. In the future we may treat tests unable to run because of missing prerequisites, but not explicitly skipped by the user, as failures. Testing installed notmuch ------------------------- Systems integrators (e.g. Linux distros) may wish to test an installed version of notmuch. This can be done be running $ NOTMUCH_TEST_INSTALLED=1 ./test/notmuch-test In this scenario the test suite does not assume a built tree, and in particular cannot rely on the output of 'configure'. You may want to set certain feature environment variables ('NOTMUCH_HAVE_*') directly if you know those apply to your installed notmuch). Consider also setting TERM=dumb if the value of TERM cannot be used (e.g. in a chroot with missing terminfo). Note that having a built tree may cause surprising/broken results for NOTMUCH_TEST_INSTALLED, so consider cleaning first. Writing Tests ------------- The test script is written as a shell script. It is to be named as Tddd-testname.sh where 'ddd' is three digits and 'testname' the "bare" name of your test. Tests will be run in order the 'ddd' part determines. The test script should start with the standard "#!/usr/bin/env bash" and an assignment to variable 'test_description', like this: #!/usr/bin/env bash 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 || exit 1 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.. 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_begin_subtest Set the test description message for a subsequent test_expect_* invocation (see below). test_expect_success