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