X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=test%2FREADME;h=e54e36b795e852e536dab96256420edbfee84368;hb=727fcd18c6a3897622582e71a2d71081e3ae40ea;hp=81a1c82dcdbdb9487cdbc701f7db5aa6bd9c43f0;hpb=8413582b6edc859285d68c9f7ad83236788567c0;p=notmuch diff --git a/test/README b/test/README index 81a1c82d..e54e36b7 100644 --- a/test/README +++ b/test/README @@ -84,6 +84,11 @@ the tests in one of the following ways. TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient ./emacs make test TEST_EMACS=my-special-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" + Quiet Execution --------------- @@ -112,6 +117,13 @@ 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 explicitely 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 explicitely +skipped by the user, as failures. + Writing Tests ------------- The test script is written as a shell script. It should start with @@ -133,7 +145,7 @@ Source 'test-lib.sh' After assigning test_description, the test script should source test-lib.sh like this: - . ./test-lib.sh + . ./test-lib.sh || exit 1 This test harness library does the following things: