X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;ds=sidebyside;f=test%2FREADME;h=7b2e96d466a7a1403fa78f03940ffacf15abdd14;hb=3f44da70b1dab028301641f7cfe5da6e420d60d9;hp=5861cc498027af53cbf3bcde2aec61e274bd4e13;hpb=029a105da35f53d758713a06e90bb10b25f1003a;p=notmuch
diff --git a/test/README b/test/README
index 5861cc49..7b2e96d4 100644
--- a/test/README
+++ b/test/README
@@ -13,15 +13,11 @@ 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.)
+./reply, etc). Note that you will probably want "make test-binaries"
+before running individual tests.
The following command-line options are available when running tests:
---verbose::
- This makes the test more verbose. Specifically, the
- command being run and their output if any are also
- output.
-
--debug::
This may help the person who is developing a new test.
It causes the command defined with test_debug to run.
@@ -46,6 +42,15 @@ The following command-line options are available when running tests:
As the names depend on the tests' file names, it is safe to
run the tests with this option in parallel.
+--root=
::
+ This runs the testsuites specified under a seperate directory.
+ However, caution is advised, as not all tests are maintained
+ with this relocation in mind, so some tests may behave
+ differently.
+
+ Pointing this argument at a tmpfs filesystem can improve the
+ speed of the test suite for some users.
+
When invoking the test suite via "make test" any of the above options
can be specified as follows:
@@ -73,11 +78,11 @@ remaining tests to be unaffected.
Writing Tests
-------------
-The test script is written as a shell script. It should start
-with the standard "#!/bin/bash" with copyright notices, and an
+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:
- #!/bin/bash
+ #!/usr/bin/env bash
#
# Copyright (c) 2005 Junio C Hamano
#
@@ -99,10 +104,12 @@ 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 empty
- mail store. 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.
+ - 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
@@ -120,27 +127,26 @@ Test harness library
There are a handful helper functions defined in the test harness
library for your script to use.
- - test_expect_success