Fix orthography

[notmuch] / test / README

diff --git a/test/README b/test/README
index ce403cef298dd8aaeac60ab94b49a029d7839ed4..8e06f44241a667609fdd5b47eda05b51e6fd3b47 100644 (file)
--- a/test/README
+++ b/test/README
@@ -8,10 +8,17 @@ enhance.
 
 Prerequisites
 -------------
 
 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.
 
 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)
   - dtach(1)
   - emacs(1)
   - emacsclient(1)


@@ -19,14 +26,32 @@ that you know if you break anything.
   - gpg(1)
   - python(1)
 
   - gpg(1)
   - python(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
 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 ./search,
-./reply, etc). Note that you will probably want "make test-binaries"
+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:
 before running individual tests.
 
 The following command-line options are available when running tests:


@@ -80,9 +105,9 @@ can be specified as follows:
 You can choose an emacs binary (and corresponding emacsclient) to run
 the tests in one of the following ways.
 
 You can choose an emacs binary (and corresponding emacsclient) to run
 the tests in one of the following ways.
 

-       TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient make test
-       TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient ./emacs
-       make test TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient
+       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.
 
 Some tests may require a c compiler. You can choose the name and flags similarly
 to with emacs, e.g.


@@ -117,16 +142,23 @@ 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.
 
 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.
+

 Writing Tests
 -------------
 Writing Tests
 -------------

-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:
+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
 
        #!/usr/bin/env bash

-       #
-       # Copyright (c) 2005 Junio C Hamano
-       #

 
        test_description='xxx test (option --frotz)
 
 
        test_description='xxx test (option --frotz)
 


@@ -168,16 +200,21 @@ Test harness library
 There are a handful helper functions defined in the test harness
 library for your script to use.
 
 There are a handful helper functions defined in the test harness
 library for your script to use.
 

- test_expect_success <message> <script>
+ test_begin_subtest <message>
+
+   Set the test description message for a subsequent test_expect_*
+   invocation (see below).

 
 

-   This takes two strings as parameter, and evaluates the
+ test_expect_success <script>
+
+   This takes a string as parameter, and evaluates the

    <script>.  If it yields success, test is considered
    <script>.  If it yields success, test is considered

-   successful.  <message> should state what it is testing.
+   successful.

 
 

- test_begin_subtest <message>
+ test_expect_code <code> <script>

 
 

-   Set the test description message for a subsequent test_expect_equal
-   invocation (see below).
+   This takes two strings as parameter, and evaluates the <script>.
+   If it yields <code> exit status, test is considered successful.

 
  test_subtest_known_broken
 
 
  test_subtest_known_broken