36f1dacd3cbff9e35c78801fe8712e37fe3e72a2
[notmuch] / performance-test / README
1 Pre-requisites
2 --------------
3
4 In addition to having notmuch, you need:
5
6 - gpg
7 - gnu tar
8 - gnu time
9 - xz. Some speedup can be gotten by installing "pixz", but this is
10   probably only worthwhile if you are debugging the tests.
11
12 Getting set up to run tests:
13 ----------------------------
14
15 First, you need to get the corpus.  If you don't already have the gpg
16 key for David Bremner, run
17
18    % gpg --search 'david@tethera.net'
19
20 This should get you a key with fingerprint
21
22     815B 6398 2A79 F8E7 C727  86C4 762B 57BB 7842 06AD
23
24 (the last 8 digits are printed as the "key id").
25
26 To fetch the actual corpus it should work to run
27
28    % make download-corpus
29
30 In case that fails or is too slow, check
31
32    http://notmuchmail.org/corpus
33
34 for a list of mirrors.
35
36 Running tests
37 -------------
38
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.
42
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
46 Writing tests
47 -------------
48
49 Have a look at "basic" for an example.
50
51 add_email_corpus takes arguments "--small" and "--medium" for when you
52 want smaller subsets of the corpus to check.
53
54 time_done does the cleanup; comment it out or define "$debug" to leave
55 the temporary files around.
56
57 Currently there is no option processing (e.g. --debug) in the
58 performance tests.