git.notmuchmail.org Git - notmuch/blob - 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.
  16
  17 It should work to run
  18
  19    % make download-corpus
  20
  21 In case that fails or is too slow, check
  22
  23    http://notmuchmail.org/corpus
  24
  25 for a list of mirrors.
  26
  27 Running tests
  28 -------------
  29
  30 The easiest way to run performance tests is to say "make perf-test", (or
  31 simply run the notmuch-perf-test script). Either command will run all
  32 available performance tests.
  33
  34 Alternately, you can run a specific subset of tests by simply invoking
  35 one of the executable scripts in this directory, (such as ./basic).
  36
  37 Writing tests
  38 -------------
  39
  40 Have a look at "basic" for an example.
  41
  42 add_email_corpus takes arguments "--small" and "--medium" for when you
  43 want smaller subsets of the corpus to check.
  44
  45 time_done does the cleanup; comment it out or define "$debug" to leave
  46 the temporary files around.
  47
  48 Currently there is no option processing (e.g. --debug) in the
  49 performance tests.