4 In addition to having notmuch, you need:
9 - xz. Some speedup can be gotten by installing "pixz", but this is
10 probably only worthwhile if you are debugging the tests.
12 Getting set up to run tests:
13 ----------------------------
15 First, you need to get the corpus. If you don't already have the gpg
16 key for David Bremner, run
18 % gpg --search 'david@tethera.net'
20 This should get you a key with fingerprint
22 815B 6398 2A79 F8E7 C727 86C4 762B 57BB 7842 06AD
24 (the last 8 digits are printed as the "key id").
26 To fetch the actual corpus it should work to run
28 % make download-corpus
30 In case that fails or is too slow, check
32 http://notmuchmail.org/corpus
34 for a list of mirrors.
39 The easiest way to run performance tests is to say "make perf-test", (or
40 simply run the notmuch-perf-test script). Either command will run all
41 available performance tests.
43 Alternately, you can run a specific subset of tests by simply invoking
44 one of the executable scripts in this directory, (such as ./basic).
45 Each test script supports the following arguments
47 --small / --medium / --large Choose corpus size.
48 --debug Enable debugging. In particular don't delete
49 temporary directories.
54 Have a look at "01-dump-restore" for an example. Sourcing
55 "perf-test-lib.sh" is mandatory. Utility functions include
57 - 'add_email_corpus' unpacks a set of messages and adds them to the database.
58 - 'cache_database': makes a snapshot of the current database
59 - 'uncache_database': forces the next 'add_email_corpus' to rebuild the
61 - 'time_start' unpacks the mail corpus and calls notmuch new if it
62 cannot find a cache of the appropriate corpus.
63 - 'time_done' does the cleanup; comment it out or pass --debug to the
64 script to leave the temporary files around.
66 Scripts are run in the order specified in notmuch-perf-test. In the
67 future this order might be chosen automatically so please follow the
68 convention of starting the name with two digits to specify the order.