diff options
| author | David Bremner <david@tethera.net> | 2023-04-09 11:26:26 -0300 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2023-07-21 07:41:50 -0300 |
| commit | ec26eeaeec87781dee7dbf720103a5bc9b6bba5d (patch) | |
| tree | 421ad3947e7c06066663f3e53a3c41af5605057f /test/README | |
| parent | 73f3081160fb80345f3953cbdeba340975375325 (diff) | |
test: support testing notmuch as installed
We put some effort into testing the built copy rather than some
installed copy. On the other hand for people like packagers, testing
the installed copy is also of interest.
When NOTMUCH_TEST_INSTALLED is set to a nonempty value, tests do not
require a built notmuch tree or running configure.
Some of the tests marked as broken when running against installed
notmuch are probably fixable.
Diffstat (limited to 'test/README')
| -rw-r--r-- | test/README | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/test/README b/test/README index 10f127cb..a81808b1 100644 --- a/test/README +++ b/test/README @@ -137,6 +137,23 @@ 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 |