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