nightly/README.txt

   1 INTRO
   2 -----
   3 This directory (nightly/) contains a simple, automatic build-and-test
   4 system for Valgrind, intended to be run nightly by cron or a similar
   5 program.
   6
   7
   8 BASIC OPERATIONS
   9 ----------------
  10 When run, the system clones and checks out two trees: one from 24 hours ago
  11 and the HEAD from now.  ("24 hours ago" and "now" are determined when
  12 the script starts running, so if any commits happen while the tests are
  13 running they will not be tested.)
  14
  15 If the two trees are different (i.e. there have been commits in the past 24
  16 hours, either to the master or a branch) it builds ("make"), installs ("make
  17 install") and runs the regression tests ("make regtest") in both, and
  18 compares the results.  Note that the "make install" isn't necessary in order
  19 to run the tests because the regression tests use the code built (with
  20 "make") within the tree, but it's worth doing because it tests that "make
  21 install" isn't totally broken.  After checking both trees, it emails a
  22 summary of the results to a recipient.  All this typically takes something
  23 like 30 minutes.
  24
  25 If the two trees are identical, the tests are not run and no results are
  26 emailed.  This avoids spamming people with uninteresting results emails when
  27 no commits have happened recently.
  28
  29
  30 SETTING UP
  31 ----------
  32 To set up nightly testing for a machine, do the following.
  33
  34 (1) Clone a shallow copy from the repository, eg:
  35
  36         git clone --depth 1 https://sourceware.org/git/valgrind.git/ $DIR
  37
  38     where $DIR is the name of the directory you want it to be in.
  39     You'll probably want to include "nightly" in the directory name.
  40
  41     Note that this doesn't clone the whole repo history, just the latest
  42     revision of everything in the repository. Under $DIR, only directory
  43     "nightly" is of interest to us - the rest is ignored. In other words: the
  44     testing script clones and checks out new trees (within $DIR/nightly) and
  45     tests them independently.
  46
  47 (2) Choose a tag that identifies the test results.  This is usually the
  48     machine name.  We'll call it $TAG in what follows.
  49
  50 (3) Create a configuration file $DIR/nightly/conf/$TAG.conf. It is sourced
  51     by the 'nightly' script, and can define any or all of the following
  52     environment variables. (In most cases, only ABT_DETAILS is needed.)
  53
  54     - ABT_DETAILS: describes the machine in more detail, eg. the OS.  The
  55       default is empty, but you should define it.  An example:
  56
  57         export ABT_DETAILS="Ubuntu 9.04, Intel x86-64"
  58
  59       You could also use some invocation of 'uname' or something similar
  60       to generate this string.  Eg. on Ubuntu Linux this works nicely:
  61
  62         export ABT_DETAILS="`cat /etc/issue.net`, `uname -m`"
  63
  64       And on Mac OS X this works nicely:
  65
  66         export ABT_DETAILS=`uname -mrs`
  67
  68       The advantage of doing it like this is that if you update the OS on
  69       the test machine you won't have to update ABT_DETAILS manually.
  70
  71     - ABT_CONFIGURE_OPTIONS: gives extra configure options.  The default is
  72       empty.
  73
  74     - ABT_EVAL: if provided, it must be the name of a shell script that
  75       executes the shell command $1 with arguments $2 .. ${$#}.  Allows to
  76       compile and run the Valgrind regression tests on another system than
  77       the system the 'nightly' script runs on.  It is assumed that the remote
  78       system shares the local filesystem tree through e.g. NFS.  It is the
  79       responsibility of the shell script to set the remote working directory
  80       such that it matches the local current directory ($PWD).
  81
  82     - ABT_RUN_REGTEST: if provided, it must be the name of an argumentless
  83       shell function (also specified in the $TAG.conf file) that will be used
  84       to run the tests.  If not specified, the usual "make regtest" will be
  85       used.
  86
  87     - ABT_JOBS: allows parallel builds -- it's passed as the argument to
  88       "make -j" when building Valgrind and the tests.  The default is 1.
  89
  90     - ABT_PERF: unset or set to "" mean 'do not run perf tests' (default value)
  91                 set to "--vg=../valgrind-new" (run perf tests for new tree)
  92                 set to "--vg=../valgrind-new --vg=../valgrind-old"
  93                 (run  perf tests for "new" and for "24 hours ago",
  94                  to compare the performances between the 2 trees).
  95
  96     - ABT_PERF_TOOLS: --tools=.... option of perf/vg_perf.
  97       (default value: all non experimental tools)
  98
  99     - ABT_PERF_REPS: --reps=... option of perf/vg_perf
 100       (default value: --reps=3)
 101
 102     Note that the appropriate syntax to use in this file will depend on the
 103     shell from which the $DIR/nightly/bin/nightly script is run (which in turn
 104     may depend on what shell is used by cron or any similar program).
 105
 106 (4) Create a mailer script $DIR/nightly/conf/$TAG.sendmail. It must be
 107     executable. It's used to send email results to the desired recipient (e.g.
 108     valgrind-developers@lists.sourceforge.net). It must handle three command
 109     line arguments.
 110
 111     - The first argument is the email subject line.  It contains
 112       $ABT_DETAILS plus some other stuff.
 113
 114     - The second argument is the name of the file containing the email's
 115       body (which shows the tests that failed, and the differences between now
 116       and 24 hours ago).
 117
 118     - The third is the name of the file containing all the diffs from
 119       failing tests.  Depending on the test results you get, you could
 120       inline this file into the email body, or attach it, or compress and
 121       attach it, or even omit it.  The right choice depends on how many
 122       failures you typically get -- if you get few failures, inlining the
 123       results make them easier to read;  if you get many failures,
 124       compressing might be a good idea to minimise the size of the emails.
 125
 126     The best way to do this depends on how mail is set up on your machine.
 127     You might be able to use /usr/bin/mail, or you might need something more
 128     elaborate like using Mutt to send mail via an external account.
 129
 130     At first, you should probably just send emails to yourself for testing
 131     purposes.  After it's working, then sending it to others might be
 132     appropriate.
 133
 134 (5) To run the tests, execute:
 135
 136        $DIR/nightly/bin/nightly $DIR/nightly $TAG
 137
 138     You probably want to put this command into a cron file or equivalent
 139     so it is run regularly (preferably every night).  Actually, it's
 140     probably better to put that command inside a script, and run the script
 141     from cron, rather than running $DIR/nightly/bin/nightly directly. That way
 142     you can put any other configuration stuff that's necessary inside the
 143     script (e.g. make sure that programs used by the mailer script are in
 144     your PATH).
 145
 146
 147 OUTPUT FILES
 148 ------------
 149 If the tests are run, the following files are produced:
 150
 151 - $DIR/nightly/old.verbose and $DIR/nightly/new.verbose contain full output of
 152   the whole process for each of the two trees.
 153
 154 - $DIR/nightly/old.short and $DIR/nightly/new.short contain summary output of
 155   the process for each of the two trees. The diff between these two files goes
 156   in $DIR/nightly/diff.short.
 157
 158 - $DIR/nighlty/final contains the overall summary, constructed from
 159   $DIR/nightly/old.short, $DIR/nightly/new.short, $DIR/nightly/diff.short and
 160   some other bits and pieces. (The name of this file is what's passed as the
 161   second argument to $DIR/nightly/conf/$TAG.sendmail.)
 162
 163 - $DIR/nightly/diffs holds the diffs from all the failing tests in the newer
 164   tree, concatenated together; the diff from each failure is truncated at 100
 165   lines to minimise possible size blow-outs. (The name of this file is
 166   what's passed as the third argument to $DIR/nightly/conf/$TAG.sendmail.)
 167
 168 - $DIR/nightly/sendmail.log contains the output (stdout and stderr) from
 169   $DIR/nightly/conf/$TAG.sendmail goes in $DIR/nightly/sendmail.log.
 170
 171 - $DIR/nightly/valgrind-old/ and $DIR/nightly/valgrind-new/ contain the tested
 172   trees (and $DIR/nightly/valgrind-old/Inst/ and $DIR/nightly/valgrind-new/Inst/
 173   contain the installed code).
 174
 175 If the tests aren't run, the following file is produced:
 176
 177 - $DIR/nightly/unchanged.log is created only if no tests were run because the
 178   two trees were identical. It will contain a short explanatory message.
 179
 180 Each time the tests are run, all files from previous runs are deleted.
 181
 182
 183 TROUBLESHOOTING
 184 ---------------
 185 If something goes wrong, looking at the output files can be useful.  For
 186 example, if no email was sent but you expected one, check sendmail.log to
 187 see if the mailer script had a problem.  Or check if unchanged.log exists.
 188
 189 Occasionally the git server isn't available when the tests runs, for either
 190 or both trees.  When this happens the email will be sent but it won't be
 191 very informative.  Usually it's just a temporary server problem and it'll
 192 run fine the next time without you having to do anything.
 193
 194 Note that the test suite is imperfect:
 195 - There are very few machines where all tests pass;  that's why the old/new
 196   diff is produced.  Some of the tests may not be as portable as intended.
 197 - Some tests are non-deterministic, and so may pass one day and fail the
 198   next.
 199
 200 Improving the test suite to avoid these problems is a long-term goal but it
 201 isn't easy.
 202
 203
 204 MAINTENANCE
 205 -----------
 206 The scripts in the nightly/ directory occasionally get updated.  If that
 207 happens, you can just "git pull" within $DIR to get the updated versions,
 208 which will then be used the next time the tests run.  (It's possible that
 209 the scripts will be changed in a way that requires changes to the files in
 210 $DIR/nightly/conf/, but we try to avoid this.)
 211
 212 If you want such updates to happen automatically, you could write a script
 213 that does all the steps in SETTING UP above, and instead run that script
 214 from cron.