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