debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-25 04:18:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

test/README: have matching test script file names

Browse source 
A while ago test script names were changed to format
Tddd-basename.sh. Update README to reflect that.

While at it, included some small requirements updates.
This commit is contained in:
Tomi Ollila 2016-02-12 21:17:00 +02:00 committed by David Bremner
parent 9f8b2091c8
commit f8cc320694
1 changed files with 26 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
test/README
View file

@ -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 Some tests require external dependencies to run. Without them, they
will be skipped, or (rarely) marked failed. Please install these, so will be skipped, or (rarely) marked failed. Please install these, so
that you know if you break anything. that you know if you break anything.
- GNU tar(1)
- dtach(1) - dtach(1)
- emacs(1) - emacs(1)
- emacsclient(1) - emacsclient(1)
@ -19,14 +26,21 @@ that you know if you break anything.
- gpg(1) - gpg(1)
- python(1) - python(1)
If your system lacks these tools or have older, non-upgreable 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
Running Tests Running Tests
------------- -------------
The easiest way to run tests is to say "make test", (or simply run the 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. notmuch-test script). Either command will run all available tests.
Alternately, you can run a specific subset of tests by simply invoking Alternately, you can run a specific subset of tests by simply invoking
one of the executable scripts in this directory, (such as ./search, one of the executable scripts in this directory, (such as ./T*-search.sh,
./reply, etc). Note that you will probably want "make test-binaries" ./T*-reply.sh, etc). Note that you will probably want "make test-binaries"
before running individual tests. before running individual tests.
The following command-line options are available when running tests: The following command-line options are available when running tests:
@ -80,9 +94,9 @@ can be specified as follows:
You can choose an emacs binary (and corresponding emacsclient) to run You can choose an emacs binary (and corresponding emacsclient) to run
the tests in one of the following ways. the tests in one of the following ways.
TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient make test TEST_EMACS=my-emacs TEST_EMACSCLIENT=my-emacsclient make test
TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient ./emacs TEST_EMACS=my-emacs TEST_EMACSCLIENT=my-emacsclient ./T*-emacs.sh
make test TEST_EMACS=my-special-emacs TEST_EMACSCLIENT=my-emacsclient 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 Some tests may require a c compiler. You can choose the name and flags similarly
to with emacs, e.g. to with emacs, e.g.
@ -126,9 +140,13 @@ skipped by the user, as failures.
Writing Tests Writing Tests
------------- -------------
The test script is written as a shell script. It should start with The test script is written as a shell script. It is to be named as
the standard "#!/usr/bin/env bash" with copyright notices, and an Tddd-testname.sh where 'ddd' is three digits and 'testname' the "bare"
assignment to variable 'test_description', like this: 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"
with copyright notices, and an assignment to variable 'test_description',
like this:
#!/usr/bin/env bash #!/usr/bin/env bash
# #