OCSP description: minor nits
[exim.git] / test / README
1 EXPORTABLE EXIM TEST SUITE
2 --------------------------
3
4 This document last updated for:
5
6 Test Suite Version: 4.67
7 Date: 20 February 2007
8
9
10 BACKGROUND
11 ----------
12
13 For a long time, the Exim test suite was confined to Philip Hazel's
14 workstation, because it relied on that particular environment. The problem is
15 that an MTA such as Exim interacts a great deal with its environment, so if you
16 run it somewhere else, the output will be different, which makes automatic
17 checking difficult. Even in a single environment, things are not all that easy.
18 For instance, if Exim delivers a message, the log line (which one would want to
19 compare) contains a timestamp and an Exim message id that will be different
20 each time. This issue is dealt with by a Perl script that munges the output by
21 recognizing changing sequences and replacing them with fixed values before
22 doing a comparison. Another problem with exporting the original test suite is
23 that it assumes a version of Exim with more or less every optional feature
24 enabled.
25
26 This README describes a new test suite that is intended to be exportable and to
27 run in a number of different environments. The tests themselves are in no
28 particular order; they accumulated over the years as Exim was extended and
29 modified. They vary greatly in size and complexity. Some were specifically
30 constructed to test new features; others were made to demonstrate that a bug
31 had been fixed.
32
33 A few of the original tests have had to be omitted from this more general
34 suite because differences in operating system behaviour make it impossible to
35 generalize them. An example is a test that uses a version of Exim that is
36 setuid to the Exim user rather than root, with the deliver_drop_privilege
37 option set. In Linux, such a binary is able to deliver a message as the caller
38 of Exim, because it can revert to the caller's uid. In FreeBSD this is not the
39 case.
40
41
42 REQUIREMENTS
43 ------------
44
45 In order to run this test suite, the following requirements must be met:
46
47 (1) You should run the tests on a matching version of Exim, because the suite
48     is continuously updated to test the latest features and bug fixes. The
49     version you test does not, however, have to be installed as the live
50     version. You can of course try the tests on any version of Exim, but some
51     may fail. In particular, the test suite will fall apart horrible with
52     versions of Exim prior to 4.54.
53
54 (2) You can use any non-root login to run the tests, but there must be access
55     via "sudo" to root from this login. Privilege is required to override
56     configuration change checks and for things like cleaning up spool files,
57     but on the other hand, the tests themselves need to call Exim from a
58     non-root process. The use of "sudo" is the easiest way to achieve all this.
59     The test script uses "sudo" to do a number of things as root, so it is best
60     if you set a sudo timeout so that you do not have to keep typing a
61     password. For example, if you put
62
63       Defaults timestamp_timeout=480
64
65     in /etc/sudoers, a password lasts for 8 hours (a working day). It is
66     not permitted to run the tests as the Exim user because the test suite
67     tracks the two users independently.  Using the same user would result
68     in false positives on some tests.
69
70     Further, some tests invoke sudo in an environment where there might not be
71     a TTY, so tickets should be global, not per-TTY.  Taking this all together
72     and assuming a user of "exim-build", you might have this in sudoers:
73
74       Defaults:exim-build     timestamp_timeout=480,!tty_tickets
75
76 (3) The login under which you run the tests must be in the exim group so that
77     it has access to logs, spool files, etc. The login should not be one of the
78     names "userx", "usery", "userz", or a few other simple ones such as "abcd"
79     and "xyz" and single letters that are used in the tests. The test suite
80     expects the login to have a gecos name; I think it will now run if the
81     gecos field is empty but there may be anomalies.
82
83 (4) The directory into which you unpack the test suite must be accessible by
84     the Exim user, so that code running as exim can access the files therein.
85     This includes search-access on all path elements leading to it. A
86     world-readable directory is fine. However, there may be problems if the
87     path name of the directory is excessively long. This is because it
88     sometimes appears in log lines or debug output, and if it is truncated, it
89     is no longer recognized.
90
91 (5) Exim must be built with its user and group specified at build time, and
92     with certain minimum facilities, namely:
93
94       Routers:    accept, dnslookup, manualroute, redirect
95       Transports: appendfile, autoreply, pipe, smtp
96       Lookups:    lsearch
97
98     Most Exim binaries will have these included.
99
100 (6) A C compiler is needed to build some test programs, and the test script is
101     written in Perl, so you need that.
102
103 (7) Some of the tests run Exim as a daemon, and others use a testing server
104     (described below). These require TCP ports. In the configurations and
105     scripts, the ports are parameterized, but at present, fixed values are
106     written into the controlling script. These are ports 1224 to 1229. If these
107     ports are not available for use, some of the tests will fail.
108
109 (8) There is an underlying assumption that the host on which the tests are
110     being run has an IPv4 address (which the test script seeks out). If there
111     is also an IPv6 address, additional tests are run when the Exim binary
112     contains IPv6 support. There are checks in the scripts for a running IPv4
113     interface; when one is not found, some tests are skipped (with a warning
114     message).
115
116 (9) Exim must be built with TRUSTED_CONFIG_LIST support, so that the test
117     configs can be placed into it.  A suitable file location is .../exim/test/trusted_configs
118     DISABLE_D_OPTION must not be used. If ALT_CONFIG_PREFIX is used, it
119     must contain the directory of the test-suite.  WHITELIST_D_MACROS should contain:
120     
121      DIR:EXIM_PATH:AA:ACL:ACLRCPT:ACL_MAIL:ACL_PREDATA:ACL_RCPT:AFFIX:ALLOW:ARG1:ARG2:AUTHF:AUTHS:AUTH_ID_DOMAIN:BAD:BANNER:BB:BR:BRB:CERT:COM:COMMAND_USER:CONNECTCOND:CONTROL:CREQCIP:CREQMAC:CRL:CSS:D6:DATA:DCF:DDF:DEFAULTDWC:DELAY:DETAILS:DRATELIMIT:DYNAMIC_OPTION:ELI:ERROR_DETAILS:ERT:FAKE:FALLBACK:FILTER:FILTER_PREPEND_HOME:FORBID:FORBID_SMTP_CODE:FUSER:HAI:HAP:HARDLIMIT:HEADER_LINE_MAXSIZE:HEADER_MAXSIZE:HELO_MSG:HL:HOSTS:HOSTS_AVOID_TLS:HOSTS_MAX_TRY:HVH:IFACE:IGNORE_QUOTA:INC:INSERT:IP1:IP2:LAST:LDAPSERVERS:LENCHECK:LIMIT:LIST:LOG_SELECTOR:LS:MAXNM:MESSAGE_LOGS:MSIZE:NOTDAEMON:ONCE:ONLY:OPT:OPTION:ORDER:PAH:PEX:PORT:PTBC:QDG:QOLL:QUOTA:QUOTA_FILECOUNT:QWM:RCPT_MSG:REMEMBER:REQUIRE:RETRY:RETRY1:RETRY2:RETURN:RETURN_ERROR_DETAILS:REWRITE:ROUTE_DATA:RRATELIMIT:RT:S:SELECTOR:SELF:SERVER:SERVERS:SREQCIP:SREQMAC:SRV:STD:STRICT:SUB:SUBMISSION_OPTIONS:TIMEOUTDEFER:TIMES:TRUSTED:TRYCLEAR:UL:USE_SENDER:UTF8:VALUE:WMF:X:Y
122
123 (10) Exim must *not* be built with USE_READLINE, as the test-suite's automation
124      assumes the simpler I/O model.
125      Exim must *not* be built with HEADERS_CHARSET set to UTF-8.
126
127
128
129 OPTIONAL EXTRAS
130 ---------------
131
132 If the Exim binary that is being tested contains extra functionality in
133 addition to the minimum specified above, additional tests are run to exercise
134 the extra functionality, except for a few special cases such as the databases
135 (MySQL, PostgreSQL, LDAP) where special data is needed for the tests.
136
137
138 RUNNING THE TEST SUITE
139 ----------------------
140
141 (1) Download the tarball exim-testsuite-x.xx.tar.bz2 and unpack it, preferably
142     in a directory alongside an Exim source directory (see below).
143
144 (2) cd into the exim-testsuite-x.xx directory.
145
146 (3) Run "autoconf" then "./configure" and then "make". This builds a few
147     auxiliary programs that are written in C.
148
149 (4) echo $PWD/test-config >> your_TRUSTED_CONFIG_LIST_filename
150     Typically that is .../exim/test/trusted_configs
151
152 (5) Run "./runtest" (a Perl script) as described below.
153
154 (6) If you want to see what tests are available, run "./listtests".
155
156
157 BREAKING OUT OF THE TEST SCRIPT
158 -------------------------------
159
160 If you abandon the test run by typing ^C, the interrupt may be passed to a
161 program that the script is running, or it may be passed to the script itself.
162 In the former case, the script should detect that the program has ended
163 abnormally. In both cases, the script tries to clean up everything, including
164 killing any Exim daemons that it has started. However, there may be race
165 conditions in which the clean up does not happen. If, after breaking out of a
166 run, you see strange errors in the next run, look for any left-over Exim
167 daemons, and kill them by hand.
168
169
170 THE LISTTESTS SCRIPT
171 --------------------
172
173 The individual test scripts are in subdirectories of the "scripts" directory.
174 If you do not supply any arguments to ./listtests, it scans all the scripts in
175 all the directories, and outputs the heading line from each script. The output
176 is piped through "less", and begins like this:
177
178 === 0000-Basic ===
179 Basic/0001 Basic configuration setting
180 Basic/0002 Common string expansions
181 Basic/0003 Caseless address blocking
182 ...
183
184 Lines that start === give the name of the subdirectory containing the test
185 scripts that follow. If you supply an argument to ./listtests, it is used as a
186 Perl pattern to match case-independently against the names of the
187 subdirectories. Only those that match are scanned. For example, "./listtests
188 ipv6" outputs this:
189
190 === 1000-Basic-ipv6 ===
191 === Requires: support IPv6
192 Basic-ipv6/1000 -bh and non-canonical IPv6 addresses
193 Basic-ipv6/1001 recognizing IPv6 address in HELO/EHLO
194
195 === 2250-dnsdb-ipv6 ===
196 === Requires: support IPv6
197               lookup dnsdb
198 dnsdb-ipv6/2250 dnsdb ipv6 lookup in string expansions
199
200 If you supply a second argument to ./listtests, it is used as a Perl pattern to
201 match case-independently against the individual script titles. For example,
202 "./listtests . mx" lists all tests whose titles contain "mx", because "."
203 matches all the subdirectory names.
204
205
206 THE RUNTEST SCRIPT
207 ------------------
208
209 If you do not supply any arguments to ./runtest, it searches for an Exim
210 source tree at the same level as the test suite directory. It then looks for an
211 Exim binary in a "build" directory of that source tree. If there are several
212 Exim source trees, it chooses the latest version of Exim. Consider the
213 following example:
214
215   $ ls -F /source/exim
216   exim-4.60/  exim-4.62/  exim-testsuite-x.xx/
217
218 A simple ./runtest from within the test suite will use a 4.62 binary if it
219 finds one, otherwise a 4.60 binary. If a binary cannot be found, the script
220 prompts for one. Alternatively, you can supply the binary on the command line:
221
222   ./runtest /usr/exim/bin/exim
223
224 A matching test suite is released with each Exim release; if you use a test
225 suite that does not match the binary, some tests may fail.
226
227 The test suite uses some of the Exim utilities (such as exim_dbmbuild), and it
228 expects to find them in the same directory as Exim itself. If they are not
229 found, the tests that use them are omitted. A suitable comment is output.
230
231 On the ./runtest command line, following the name of the binary, if present,
232 there may be a number of options and then one or two numbers. The full syntax
233 is as follows:
234
235   ./runtest [binary name] [runtest options] [exim options] \
236             [first test] [last test]
237
238 There are some options for the ./runtest script itself:
239
240   -DEBUG    This option is for debugging the test script. It causes some
241             tracing information to be output.
242
243   -DIFF     By default, file comparisons are done using a private compare
244             command called "cf", which is built from source that is provided in
245             the src directory. This is a command I've had for nearly 20 years -
246             look at the source comments for its history - whose output I
247             prefer. However, if you want to use "diff" instead, give -DIFF as a
248             runtest option. In that case, "diff -u" is used for comparisons.
249             (If it turns out that most people prefer to use diff, I'll change
250             the default.)
251
252   -KEEP     Normally, after a successful run, the test output files are
253             deleted. This option prevents this. It is useful when running a
254             single test, in order to look at the actual output before it is
255             modified for comparison with saved output.
256
257   -NOIPV4   Pretend that an IPv4 interface was not found. This is useful for
258             testing that the test suite correctly skips tests that require
259             a running IPv4 interface.
260
261   -NOIPV6   Pretend that an IPv6 interface was not found. This is useful for
262             testing that the test suite correctly skips tests that require
263             a running IPv6 interface.
264
265   -UPDATE   If this option is set, any detected changes in test output are
266             automatically accepted and used to update the stored copies of the
267             output. It is a dangerous option, but it useful for the test suite
268             maintainer after making a change to the code that affects a lot of
269             tests (for example, the wording of a message).
270
271 The options for ./runtest must be given first (but after the name of the
272 binary, if present). Any further options, that is, items on the command line
273 that start with a hyphen, are passed to the Exim binary when it is run as part
274 of a test. The only sensible use of this is to pass "-d" in order to run a test
275 with debugging enabled. Any other options are likely to conflict with options
276 that are set in the tests. Some tests are already set up to run with debugging.
277 In these cases, -d on the command line overrides their own debug settings.
278
279 The final two arguments specify the range of tests to be run. Test numbers lie
280 in the range 1 to 9999. If no numbers are given, the defaults are 1 and 8999
281 (sic). Tests with higher numbers (9000 upwards) are not run automatically
282 because they require specific data (such as a particular MySQL table) that is
283 unlikely to be generally available.
284
285 Tests that require certain optional features of Exim are grouped by number, so
286 in any given range, not all the tests will exist. Non-existent tests are just
287 skipped, but if there are no tests at all in the given range, a message is
288 output.
289
290 If you give only one number, just that test is run (if it exists). Instead of a
291 second number, you can give the character "+", which is interpreted as "to the
292 end". Normally this is 8999; if the starting number is 9000 or higher, "+" is
293 interpreted as 9999. Examples:
294
295   ./runtest 1300
296   ./runtest 1400 1699
297   ./runtest /usr/sbin/exim 5000 +
298   ./runtest -DIFF -d 81
299
300 When the script starts up, the first thing it does is to check that you have
301 sudo access to root. Then it outputs the version number of the Exim binary that
302 it is testing, and also information about the optional facilities that are
303 present (obtained from "exim -bV"). This is followed by some environmental
304 information, including the current login id and the hosts's IP address. The
305 script checks that the current user is in the Exim group, and that the Exim
306 user has access to the test suite directory.
307
308 The script outputs the list of tests requested, and a list of tests that will
309 be omitted because the relevant optional facilities are not in the binary. You
310 are then invited to press Return to start the tests running.
311
312
313 TEST OUTPUT
314 -----------
315
316 When all goes well, the only permanent output is the identity of the tests as
317 they are run, and "Script completed" for each test script, for example:
318
319   Basic/0001 Basic configuration setting
320     Script completed
321   Basic/0002 Basic string expansions
322     Script completed
323   Basic/0003 Caseless address blocking
324     Script completed
325   Basic/0004 Caseful address blocking
326     Script completed
327   Basic/0005 -bs to simple local delivery
328   ...
329
330 While a script is running, it shows "Test n" on the screen, for each of the
331 Exim tests within the script. There may also be comments from some tests when a
332 delay is expected, for example, if there is a "sleep" while testing a timeout.
333
334 Before each set of optional tests, an extra identifying line is output. For
335 example:
336
337   >>> The following tests require: authenticator cram_md5
338   CRAM-MD5/2500 CRAM-MD5 server tests
339     Script completed
340   CRAM-MD5/2501 CRAM-MD5 client tests
341     Script completed
342
343 If a test fails, you are shown the output of the text comparison that failed,
344 and prompted as to what to do next. The output is shown using the "less"
345 command, or "more" if "less" is not available. The options for "less" are set
346 to that it automatically exits if there is less that a screenful of output. By
347 default, the output is from the "cf" program, and might look like this:
348
349   DBM/1300 DBM files and exim_dbmbuild
350   ===============
351   Lines 7-9 of "test-stdout-munged" do not match lines 7-11 of "stdout/1300".
352   ----------
353   exim_dbmbuild exit code = 1
354   Continued set of lines is too long: max permitted length is 99999
355   exim_dbmbuild exit code = 1
356   ----------
357   dbmbuild abandoned
358   exim_dbmbuild exit code = 2
359   Continued set of lines is too long: max permitted length is 99999
360   dbmbuild abandoned
361   exim_dbmbuild exit code = 2
362   ===============
363   1 difference found.
364   "test-stdout-munged" contains 16 lines; "stdout/1300" contains 18 lines.
365
366   Continue, Retry, Update & retry, Quit? [Q]
367
368 This example was generated by running the test with a version of Exim
369 that had a bug in the exim_dbmbuild utility (the bug was fixed at release
370 4.53). See "How the tests work" below for a description of the files that are
371 used. In this case, the standard output differed from what was expected.
372
373 The reply to the prompt must either be empty, in which case it takes the
374 default that is given in brackets (in this case Q), or a single letter, in
375 upper or lower case (in this case, one of C, R, U, or Q). If you type anything
376 else, the prompt is repeated.
377
378 "Continue" carries on as if the files had matched; that is, it ignores the
379 mismatch. Any other output files for the same test will be compared before
380 moving on to the next test.
381
382 "Update & retry" copies the new file to the saved file, and reruns the test
383 after doing any further comparisons that may be necessary.
384
385 "Retry" does the same apart from the file copy.
386
387 Other circumstances give rise to other prompts. If a test generates output for
388 which there is no saved data, the prompt (after a message stating which file is
389 unexpectely not empty) is:
390
391   Continue, Show, or Quit? [Q]
392
393 "Show" displays the data on the screen, and then you get the "Continue..."
394 prompt. If a test ends with an unexpected return code, the prompt is:
395
396   show stdErr, show stdOut, Continue (without file comparison), or Quit? [Q]
397
398 Typically in these cases there will be something interesting in the stderr
399 or stdout output. There is a similar prompt after the "server" auxiliary
400 program fails.
401
402
403 OPENSSL AND GNUTLS ERROR MESSAGES
404 ---------------------------------
405
406 Some of the TLS tests deliberately cause errors to check how Exim handles them.
407 It has been observed that different releases of the OpenSSL and GnuTLS
408 libraries generate different error messages. This may cause the comparison with
409 the saved output to fail. Such errors can be ignored.
410
411
412 OTHER ISSUES
413 ------------
414
415 . Some of the tests are time-sensitive (e.g. when testing timeouts, as in test
416   461). These may fail if run on a host that is also running a lot of other
417   processes.
418
419 . Some versions of "ls" use a different format for times and dates. This can
420   cause test 345 to fail.
421
422 . Test 0142 tests open file descriptors; on some hosts the output may vary.
423
424 . Some tests may fail, for example 0022, because it says it uses cached data
425   when the expected output thinks it should not be in cache.  Item #5 in the
426   Requirements section has:
427     "Exim must be built with its user and group specified at build time"
428   This means that you cannot use the "ref:username" in your Local/Makefile
429   when building the exim binary, in any of the following fields:
430     EXIM_USER  EXIM_GROUP  CONFIGURE_OWNER  CONFIGURE_GROUP
431
432 . If the runtest script warns that the hostname is not a Fully Qualified
433   Domain Name (FQDN), expect that some tests will fail, for example 0036,
434   with an extra log line saying the hostname doesn't resolve.  You must use a
435   FQDN for the hostname for proper test functionality.
436
437 . If your hostname has an uppercase characters in it, expect that some tests
438   will fail, for example, 0036, because some log lines will have the hostname
439   in all lowercase.  The regex which extracts the hostname from the log lines
440   will not match the lowercased version.
441
442 . Some tests may fail, for example 0015, with a cryptic error message:
443     Server return code 99
444   Due to security concerns, some specific files MUST have the group write bit
445   off.  For the purposes of the test suite, some test/aux-fixed/* files MUST
446   have the group write bit off, so it's easier to just remove the group write
447   bit for all of them.  If your umask is set to 002, the group write bit will
448   be on by default and you'll see this problem, so make sure your umask is
449   022 and re-checkout the test/ subdirectory.
450
451
452 OTHER SCRIPTS AND PROGRAMS
453 --------------------------
454
455 There is a freestanding Perl script called "listtests" that scans the test
456 scripts and outputs a list of all the tests, with a short descriptive comment
457 for each one. Special requirements for groups of tests are also noted.
458
459 The main runtest script makes use of a second Perl script and some compiled C
460 programs. These are:
461
462 patchexim          A Perl script that makes a patched version of Exim (see the
463                    next section for details).
464
465 bin/cf             A text comparison program (see above).
466
467 bin/checkaccess    A program that is run as root; it changes uid/gid to the
468                    Exim user and group, and then checks that it can access
469                    files in the test suite's directory.
470
471 bin/client         A script-driven SMTP client simulation.
472
473 bin/client-gnutls  A script-driven SMTP client simulation with GnuTLS support.
474                    This is built only if GnuTLS support is detected on the host.
475
476 bin/client-ssl     A script-driven SMTP client simulation with OpenSSL support.
477                    This is built only if OpenSSL support is detected on the
478                    host.
479
480 bin/fakens         A fake "nameserver" for DNS tests (see below for details).
481
482 bin/fd             A program that outputs details of open file descriptors.
483
484 bin/iefbr14        A program that does nothing, and returns 0. It's just like
485                    the "true" command, but it is in a known place.
486
487 bin/loaded         Some dynamically loaded functions for testing dlfunc support.
488
489 bin/mtpscript      A script-driven SMTP/LMTP server simulation, on std{in,out}.
490
491 bin/server         A script-driven SMTP server simulation, over a socket.
492
493 bin/showids        Output the current uid, gid, euid, egid.
494
495 The runtest script also makes use of a number of ordinary commands such as
496 "cp", "kill", "more", and "rm", via the system() call. In some cases these are
497 run as root by means of sudo.
498
499
500 STANDARD SUBSTITUTIONS
501 ----------------------
502
503 In the following sections, there are several references to the "standard
504 substitutions". These make changes to some of the stored files when they are
505 used in a test. To save repetition, the substitutions themselves are documented
506 here:
507
508   CALLER         is replaced by the login name of the user running the tests
509   CALLERGROUP    is replaced by the caller's group id
510   CALLER_GID     is replaced by the caller's group id
511   CALLER_UID     is replaced by the caller's user id
512   DIR            is replaced by the name of the test-suite directory
513   EXIMGROUP      is replaced by the name of the Exim group
514   EXIMUSER       is replaced by the name of the Exim user
515   HOSTIPV4       is replaced by the local host's IPv4 address
516   HOSTIPV6       is replaced by the local host's IPv6 address
517   HOSTNAME       is replaced by the local host's name
518   PORT_D         is replaced by a port number for normal daemon use
519   PORT_N         is replaced by a port number that should never respond
520   PORT_S         is replaced by a port number for normal bin/server use
521   TESTNUM        is replaced by the current test number
522   V4NET          is replaced by an IPv4 network number for testing
523   V6NET          is replaced by an IPv6 network number for testing
524
525 PORT_D is currently hard-wired to 1225, PORT_N to 1223, and PORT_S to 1224.
526 V4NET is hardwired to 224 and V6NET to ff00. These networks are used for DNS
527 testing purposes, and for testing Exim with -bh. The only requirement is that
528 they are networks that can never be used for an IP address of a real host. I've
529 chosen two multicast networks for the moment.
530
531 If the host has no IPv6 address, "<no IPv6 address found>" is substituted but
532 that does not matter because no IPv6 tests will be run. A similar substitution
533 is made if there is no IPv4 address, and again, tests that actually require a
534 running IPv4 interface should be skipped.
535
536 If the host has more than one IPv4 or IPv6 address, the first one that
537 "ifconfig" lists is used. If the only available address is 127.0.0.1 (or ::1
538 for IPv6) it is used, but another value is preferred if available.
539
540 In situations where a specific test is not being run (for example, when setting
541 up dynamic data files), TESTNUM is replaced by an empty string, but should not
542 in fact occur in such files.
543
544
545 HOW THE TESTS WORK
546 ------------------
547
548 Each numbered script runs Exim (sometimes several times) with its own Exim
549 configuration file. The configurations are stored in the "confs" directory,
550 and before running each test, a copy of the appropriate configuration, with the
551 standard substitutions, is made in the file test-config. The -C command line
552 option is used to tell Exim to use this configuration.
553
554 The -D option is used to pass the path of the Exim binary to the configuration.
555 This is not standardly substituted, because there are two possible binaries
556 that might be used in the same test (one setuid to root, the other to the exim
557 user). Some tests also make use of -D to vary the configuration for different
558 calls to the Exim binary.
559
560 Normally, of course, Exim gives up root privilege when -C and -D are used by
561 unprivileged users. We do not want this to happen when running the tests,
562 because we want to be able to test all aspects of Exim, including receiving
563 mail from unprivileged users. The way this is handled is as follows:
564
565 At the start of the runtest script, the patchexim script is run as root. This
566 script makes a copy of the Exim binary that is to be tested, patching it as it
567 does so. (This is a binary patch, not a source patch.) The patch causes the
568 binary, when run, to "know" that it is running in the test harness. It does not
569 give up root privilege when -C and -D are used, and in a few places it takes
570 other special actions, such as delaying when starting a subprocess to allow
571 debug output from the parent to be written first. If you want to know more,
572 grep the Exim source files for "running_in_test_harness".
573
574 The patched binary is placed in the directory eximdir/exim and given the normal
575 setuid root privilege. This is, of course, a dangerous binary to have lying
576 around, especially if there are unprivileged users on the system. To protect
577 it, the eximdir directory is created with the current user as owner, exim as
578 the group owner, and with access drwx--x---. Thus, only the user who is running
579 the tests (who is known to have access to root) and the exim user have access
580 to the modified Exim binary. When runtest terminates, the patched binary is
581 removed.
582
583 Each set of tests proceeds by interpreting its controlling script. The scripts
584 are in subdirectories of the "scripts" directory. They are split up according
585 to the requirements of the tests they contain, with the 0000-Basic directory
586 containing tests that can always be run. Run the "listtests" script to obtain a
587 list of tests.
588
589
590 TEST OUTPUT
591 -----------
592
593 Output from script runs is written to the files test-stdout and test-stderr.
594 When an Exim server is involved, test-stdout-server and test-stderr-server are
595 used for its output. Before being compared with the saved output, the
596 non-server and server files are concatenated, so a single saved file contains
597 both.
598
599 A directory called spool is used for Exim's spool files, and for Exim logs.
600 These locations are specified in every test's configuration file.
601
602 When messages are delivered to files, the files are put in the test-mail
603 directory. Output from comparisons is written to test-cf.
604
605 Before comparisons are done, output texts are modified ("munged") to change or
606 remove parts that are expected to vary from run to run. The modified files all
607 end with the suffix "-munged". Thus, you will see test-stdout-munged,
608 test-mainlog-munged, test-mail-munged, and so on. Other files whose names start
609 with "test-" are created and used by some of the tests.
610
611 At the end of a successful test run, the spool directory and all the files
612 whose names begin with "test-" are removed. If the run ends unsuccessfully
613 (typically after a "Q" response to a prompt), the spool and test files are left
614 in existence so that the problem can be investigated.
615
616
617 TEST COMMANDS
618 -------------
619
620 Each test script consists of a list of commands, each optionally preceded by
621 comments (lines starting with #) and (also optionally) a line containing an
622 expected return code. Some of the commands are followed by data lines
623 terminated by a line of four asterisks.
624
625 The first line of each script must be a comment that briefly describes the
626 script. For example:
627
628   # -bS Use of HELO/RSET
629
630 A line consisting just of digits is interpreted as the expected return code
631 for the command that follows. The default expectation when no such line exists
632 is a zero return code. For example, here is a complete test script, containing
633 just one command:
634
635   # -bS Unexpected EOF in headers
636   1
637   exim -bS -odi
638   mail from:<someone@some.where>
639   rcpt to:<blackhole@HOSTNAME>
640   data
641   from: me
642   ****
643
644 The expected return code in this case is 1, and the data lines are passed to
645 Exim on its standard input. Both the command line and the data lines have the
646 standard substitions applied to them. Thus, HOSTNAME in the example above will
647 be replaced by the local host's name. Long commands can be continued over
648 several lines by using \ as a continuation character. This does *not* apply to
649 data lines.
650
651 Here follows a list of supported commands. They can be divided into two groups:
652
653
654 Commands with no input
655 ----------------------
656
657 These commands are not followed by any input data, or by a line of asterisks.
658
659
660   dbmbuild <file1> <file1>
661
662 This command runs the exim_dbmbuild utility to build a DBM file. It is used
663 only when DBM support is available in Exim, and typically follows the use of a
664 "write" command (see below) that creates the input file.
665
666
667   dumpdb <dbname>
668
669 This command runs the exim_dumpdb utility on the testing spool directory, using
670 the database name given, for example: "dumpdb retry".
671
672
673   echo <text>
674
675 The text is written to the screen; this is used to output comments from
676 scripts.
677
678
679   exim_lock [options] <file name>
680
681 This command runs the exim_lock utility with the given options and file name.
682 The file remains locked with the following command (normally exim) is obeyed.
683
684
685   exinext <data>
686
687 This command runs the exinext utility with the given argument data.
688
689
690   exigrep <data>
691
692 This command runs the exigrep utility with the given data (the search pattern)
693 on the current mainlog file.
694
695
696   gnutls
697
698 This command is present at the start of all but one of the tests that use
699 GnuTLS. It copies a pre-existing parameter file into the spool directory, so
700 that Exim does not have to re-create the file each time. The first GnuTLS test
701 does not do this, in order to test that Exim can create the file.
702
703
704   killdaemon
705
706 This command must be given in any script that starts an Exim daemon, normally
707 at the end. It searches for the PID file in the spool directory, and sends a
708 SIGINT signal to the Exim daemon process whose PID it finds. See below for
709 comments about starting Exim daemons.
710
711
712   millisleep <m>
713
714 This command causes the script to sleep for m milliseconds. Nothing is output
715 to the screen.
716
717
718   need_ipv4
719
720 This command must be at the head of a script. If no IPv4 interface has been
721 found, the entire script is skipped, and a comment is output.
722
723
724   need_ipv6
725
726 This command must be at the head of a script. If no IPv6 interface has been
727 found, the entire script is skipped, and a comment is output.
728
729
730   need_largefiles
731
732 This command must be at the head of a script. If the Exim binary does not
733 suppport large files (off_t is <= 4), the entire script is skipped, and a
734 comment is output.
735
736
737   need_move_frozen_messages
738
739 This command must be at the head of a script. If the Exim binary does not have
740 support for moving frozen messages (which is an optional feature), the entire
741 script is skipped, and a comment is output.
742
743
744   no_message_check
745
746 If this command is encountered anywhere in the script, messages that are
747 delivered when the script runs are not compared with saved versions.
748
749
750   no_msglog_check
751
752 If this command is encountered anywhere in the script, message log files that
753 are still in existence at the end of the run (for messages that were not
754 delivered) are not compared with saved versions.
755
756
757   no_stderr_check
758
759 If this command is encountered anywhere in the script, the stderr output from
760 the run is not compared with a saved version.
761
762
763   no_stdout_check
764
765 If this command is encountered anywhere in the script, the stdout output from
766 the run is not compared with a saved version.
767
768
769   rmfiltertest
770
771 This command indicates that the script is for a certain type of filter test, in
772 which there are a lot of repetitive stdout lines that get in the way, because
773 filter tests output data about the sender and recipient. Such lines are removed
774 from the stdout output before comparing, for ease of human perusal.
775
776
777   sleep <n>
778
779 This command causes the script to sleep for n seconds. If n is greater than
780 one, "sleep <n>" is output to the screen, followed by a dot for every second
781 that passes.
782
783
784   sortlog
785
786 This command causes special sorting to occur on the mainlog file before
787 comparison. Every sequence of contiguous delivery lines (lines containing the
788 => -> or *> flags) is sorted. This is necessary in some tests that use parallel
789 deliveries because on different systems the processes may terminate in a
790 different order.
791
792
793 A number of standard file management commands are also recognized. These are
794 cat, chmod, chown, cp, du, ln, ls, du, mkdir, mkfifo, rm, rmdir, and touch.
795 Some are run as root using "sudo".
796
797
798 Commands with input
799 -------------------
800
801 The remaining commands are followed by data lines for their standard input,
802 terminated by four asterisks. Even if no data is required for the particular
803 usage, the asterisks must be given.
804
805
806   catwrite <file name> [nxm[=start-of-line-text]]*
807
808 This command operates like the "write" command, which is described below,
809 except that the data it generates is copied to the end of the test-stdout file
810 as well as to the named file.
811
812
813
814   client [<options>] <ip address> <port> [<outgoing interface>]
815
816 This command runs the auxiliary "client" program that simulates an SMTP client.
817 It is controlled by a script read from its standard input, details of which are
818 given below. There are two options. One is -t, which must be followed directly
819 by a number, to specify the command timeout in seconds (e.g. -t5). The default
820 timeout is 1 second. The other option is -tls-on-connect, which causes the
821 client to try to start up a TLS session as soon as it has connected, without
822 using the STARTTLS command. The client program connects to the given IP address
823 and port, using the specified interface, if one is given.
824
825
826   client-ssl [<options>] <ip address> <port> [<outgoing interface>] \
827              [<cert file>] [<key file>]
828
829 When OpenSSL is available on the host, an alternative version of the client
830 program is compiled, one that supports TLS using OpenSSL. The additional
831 arguments specify a certificate and key file when required. There is one
832 additional option, -tls-on-connect, that causes the client to initiate TLS
833 negotiation immediately on connection.
834
835
836   client-gnutls [<options>] <ip address> <port> [<outgoing interface>] \
837                 [<cert file>] [<key file>]
838
839 When GnuTLS is available on the host, an alternative version of the client
840 program is compiled, one that supports TLS using GnuTLS. The additional
841 arguments specify a certificate and key file when required. There is one
842 additional option, -tls-on-connect, that causes the client to initiate TLS
843 negotiation immediately on connection.
844
845
846   exim [<options>] [<arguments>]
847
848 This command runs the testing version of Exim. Any occurrence of "$msg1" in the
849 command line is replaced by the ID of the first (oldest) message in Exim's
850 (testing) spool. "$msg2" refers to the second, and so on. The name "exim" can
851 be preceded by an environment setting as in this example:
852
853   LDAPTLS_REQCERT=never exim -be
854
855 It can also be preceded by a number; this specifies a number of seconds to wait
856 before closing the stdout pipe to Exim, and is used for some timeout tests. For
857 example:
858
859   3 exim -bs
860
861 Finally, "exim" can be preceded by "sudo", to run Exim as root. If more than
862 one of these prefixes is present, they must be in the above order.
863
864
865   exim_exim [<options>] [<arguments>]
866
867 This runs an alternative version of Exim that is setuid to exim rather than to
868 root.
869
870
871   server [<options>] <port or socket> [<connection count>]
872
873 This command runs the auxiliary "server" program that simulates an SMTP (or
874 other) server. It is controlled by a script that is read from its standard
875 input, details of which are given below. A number of options are implemented:
876
877   -d       causes the server to output debugging information
878
879   -t       sets a timeout in seconds (default 5) for when the server is
880            awaiting an incoming connection
881
882   -noipv4  causes the server not to set up an IPv4 socket
883
884   -noipv6  causes the server not to set up an IPv6 socket
885
886 By default, in an IPv6 environment, both kinds of socket are set up. However,
887 the test script knows which interfaces actually exist on the host, and it adds
888 -noipv4 or -noipv6 to the server command as required. An error occurs if both
889 these options are given.
890
891 The only required argument is either a port number or the path name of a Unix
892 domain socket. The port is normally PORT_S, which is changed to an actual
893 number by the standard substitutions. The optional final argument specifies the
894 number of different connections to expect (default 1). These must happen
895 serially (one at a time). There is no support for multiple simultaneous
896 connections. Here are some example commands:
897
898   server PORT_S
899   server -t 10 PORT_S 3
900   server /tmp/somesocket
901
902 The following lines, up to a line of four asterisks, are the server's
903 controlling standard input (described below). These lines are read and
904 remembered; during the following commands, until an "exim" command is reached,
905 the server is run in parallel.
906
907
908   write <file name> [nxm[=start-of-line-text]]*
909
910 The "write" command is a way of creating files of specific sizes for buffering
911 tests, or containing specific data lines. Being able to do this from within the
912 script saves holding lots of little test files. The optional argument specifies
913 n lines of length m. The lines consist of the letter "a". If start of line text
914 is supplied, it replaces "a"s at the start of each line. Underscores in the
915 start of line text are turned into spaces. The optional argument may be
916 repeated. The data lines that follow a "write" command are split into two by a
917 line of four plus signs. Any above the split are written before the
918 fixed-length lines, and any below the split are written after. For example:
919
920   write test-data 3x30=AB_ 1x50
921   Pre-data
922   lines
923   ++++
924   Post-data
925   lines
926   ****
927
928 This command generates a file containing:
929
930   Pre-data
931   lines
932   AB aaaaaaaaaaaaaaaaaaaaaaaaaaa
933   AB aaaaaaaaaaaaaaaaaaaaaaaaaaa
934   AB aaaaaaaaaaaaaaaaaaaaaaaaaaa
935   aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
936   Post-data
937   lines
938
939 If there are no fixed-length line specifiers, there is no need to split the
940 data, and a line of plusses is not needed.
941
942
943   [sudo] perl
944
945 This command runs Perl, with the data as its standard input, to allow arbitrary
946 one-off things to be done.
947
948
949 CLIENT SCRIPTS
950 --------------
951
952 Lines in client scripts are of two kinds:
953
954 (1) If a line begins with three question marks and a space, the rest of the
955     line defines the start of expected output from the server. If what is
956     received does not match, the client bombs out with an error message.
957
958 (2) If a line starts with three plus signs followed by a space, the rest of the
959     line specifies a number of seconds to sleep for before proceeding.
960
961 (3) Otherwise, the line is an input line line that is sent to the server. Any
962     occurrences of \r and \n in the line are turned into carriage return and
963     linefeed, respectively. This is used for testing PIPELINING.
964
965 Here is a simple example:
966
967   client 127.0.0.1 PORT_D
968   ??? 250
969   EHLO xxx
970   ??? 250-
971   ??? 250
972   AUTH PLAIN AbdXi0AdnD2CVy
973   ??? 535
974   quit
975   ??? 221
976   ****
977
978 In the case of client-gnutls and client-ssl, if a command is "starttls", this
979 is remembered, and after a subsequent OK response, an attempt to move into TLS
980 mode occurs. If a command is "starttls_wait", the client sends "starttls" but
981 does not start up TLS; this is for testing timeouts. If a command is "stoptls",
982 an existing TLS connection is shut down, but nothing is sent.
983
984
985 SERVER SCRIPTS
986 --------------
987
988 The server program sleeps till a connection occurs or its timeout is reached,
989 in which case it bombs out. The next set of command lines are interpreted. They
990 are of the following kinds:
991
992 (1) A line that starts with '>' or with a digit is an output line that is sent
993     to the client. In the case of '>':
994
995     (a) If the line starts with ">>", no terminating CRLF is sent.
996     (b) If the line starts with ">CR>", just CR is sent at the end.
997     (c) If the line starts with ">LF>", just LF is sent at the end.
998     (d) If the line starts with ">*eof", nothing is sent and the connection
999           is closed.
1000
1001     The data that is sent starts after the initial '>' sequence.
1002
1003 (2) A line that starts with "*sleep" specifies a number of seconds to wait
1004     before proceeding.
1005
1006 (3) A line containing "*eof" specifies that the client is expected to close
1007     the connection at this point.
1008
1009 (4) A line containing just '.' specifies that the client is expected to send
1010     many lines, terminated by one that contains just a dot.
1011
1012 (5) Otherwise, the line defines the start of an input line that the client
1013     is expected to send. To allow for lines that start with digits, the line
1014     may start with '<', which is not taken as part of the input data. If the
1015     input does not match, the server bombs out with an error message.
1016
1017 Here is a simple example of server use in a test script:
1018
1019   server PORT_S
1020   220 Greetings
1021   EHLO
1022   250 Hello there
1023   MAIL FROM
1024   250 OK
1025   RCPT TO
1026   250 OK
1027   DATA
1028   354 Send it!
1029   .
1030   250 OK
1031   QUIT
1032   225 OK
1033   ****
1034
1035 After a "server" command in a test script, the server runs in parallel until an
1036 "exim" command is reached. The "exim" command attempts to deliver one or more
1037 messages to port PORT_S on the local host. When it has finished, the test
1038 script waits for the "server" process to finish.
1039
1040 The "mtpscript" program is like "server", except that it uses stdin/stdout for
1041 its input and output instead of a script. However, it is not called from test
1042 scripts; instead it is used as the command for pipe transports in some
1043 configurations, to simulate non-socket LMTP servers.
1044
1045
1046 AUXILIARY DATA FILES
1047 --------------------
1048
1049 Many of the tests make use of auxiliary data files. There are two types; those
1050 whose content is fixed, and those whose content needs to be varied according to
1051 the current environment. The former are kept in the directory aux-fixed. The
1052 latter are distributed in the directory aux-var-src, and copied with the
1053 standard substitutions into the directory aux-var at the start of each test
1054 run.
1055
1056 Most of the auxiliary files have names that start with a test number,
1057 indicating that they are specific to that one test. A few fixed files (for
1058 example, some TLS certificates) are used by more than one test, and so their
1059 names are not of this form.
1060
1061 There are also some auxilary DNS zone files, which are described in the next
1062 section.
1063
1064
1065 DNS LOOKUPS AND GETHOSTBYNAME
1066 -----------------------------
1067
1068 The original test suite required special testing zones to be loaded into a
1069 local nameserver. This is no longer a requirement for the new suite. Instead, a
1070 program called fakens is used to simulate a nameserver. When Exim is running in
1071 the test harness, instead of calling res_search() - the normal call to the DNS
1072 resolver - it calls a testing function. This handles a few special names itself
1073 (for compatibility with the old test suite), but otherwise passes the query to
1074 the fakens program.
1075
1076 The fakens program consults "zone files" in the directory called dnszones, and
1077 returns data in the standard resource record format for Exim to process as if
1078 it came from the DNS. However, if the requested domain is not in any of the
1079 zones that fakens knows about, it returns a special code that causes Exim to
1080 pass the query on to res_search(). The zone files are:
1081
1082   db.test.ex    A zone for the domain test.ex.
1083   db.ip4.10     A zone for one special case in 10.250.0.0/16 (see below)
1084   db.ip4.V4NET  A zone for the domain V4NET.in-addr.arpa.
1085   db.ip4.127    A zone for the domain 127.in-addr.arpa.
1086   db.ip6.V6NET  A zone for the domain inverted(V6NET).ip6.arpa.
1087   db.ip6.0      A zone for the domain 0.ip6.arpa.
1088
1089 V4NET and V6NET are substituted with the current testing networks (see above).
1090 In the case of V6NET, the network is four hex digits, and it is split and
1091 inverted appropriately when setting up the zone.
1092
1093 These fake zone files are built dynamically from sources in the dnszones-src
1094 directory by applying the standard substitutions. The test suite also builds
1095 dynamic zone files for the name of the current host and its IP address(es). The
1096 idea is that there should not be any need to rely on an external DNS.
1097
1098 The domain names that are handled directly by Exim, without being passed to
1099 fakens, are:
1100
1101   test.again.dns    This always provokes a TRY_AGAIN response, for testing the
1102                     handling of temporary DNS error. If the full domain name
1103                     starts with digits, a delay of that many seconds occurs.
1104
1105   test.fail.dns     This always provokes a NO_RECOVERY response, for testing
1106                     DNS server failures.
1107
1108 This special handling could now be done in the fakens program, but while the
1109 old test suite is still being used it has to be done in Exim itself, so for the
1110 moment it remains there.
1111
1112 The use of gethostbyname() and its IPv6 friends is also subverted when Exim is
1113 running in the test harness. The test code handles a few special names
1114 directly; for all the others it uses DNS lookups, which are then handled as
1115 just described. Thus, the use of /etc/hosts is completely bypassed. The names
1116 that are specially handled are:
1117
1118   manyhome.test.ex  This name is used for testing hosts with ridiculously large
1119                     numbers of IP addresses; 2048 IP addresses are generated
1120                     and returned. Doing it this way saves having to make the
1121                     interface to fakens handle more records that can fit in the
1122                     data block. The addresses that are generated are in the
1123                     10.250.0.0/16 network.
1124
1125   localhost         Always returns 127.0.0.1 or ::1, for IPv4 and IPv6 lookups,
1126                     respectively.
1127
1128   <an IP address>   If the IP address is of the correct form for the lookup
1129                     type (IPv4 or IPv6), it is returned. Otherwise a panic-die
1130                     error occurs.
1131
1132 The reverse zone db.ip4.10 is provided just for the manyhome.test.ex case. It
1133 contains a single wildcard resource record. It also contains the line
1134
1135   PASS ON NOT FOUND
1136
1137 Whenever fakens finds this line in a zone file, it returns PASS_ON instead of
1138 HOST_NOT_FOUND. This causes Exim to pass the query to res_search().
1139
1140 ****