Testsuite: munging for Alpine Linux

[exim.git] / test / README

diff --git a/test/README b/test/README
index 13284ab2c5e66fe849a8182daa32a6c1b29f7487..d013f78233f21640451c78bd8122e13c29802f12 100644 (file)
--- a/test/README
+++ b/test/README
@@ -1,12 +1,10 @@
-$Cambridge: exim/test/README,v 1.2 2006/02/10 16:29:20 ph10 Exp $
-

 EXPORTABLE EXIM TEST SUITE
 --------------------------
 
 This document last updated for:
 
 EXPORTABLE EXIM TEST SUITE
 --------------------------
 
 This document last updated for:
 

-Test Suite Version: 4.61
-Date: 06 February 2006
+Test Suite Version: 4.87
+Date: 30 January 2016

 
 
 BACKGROUND
 
 
 BACKGROUND


@@ -26,16 +24,11 @@ that it assumes a version of Exim with more or less every optional feature
 enabled.
 
 This README describes a new test suite that is intended to be exportable and to
 enabled.
 
 This README describes a new test suite that is intended to be exportable and to

-run in a number of different environments. The current status of this project
-is "experimental and incomplete". I am releasing it in this state in order to
-get feedback on how well it succeeds and of course to iron out any bugs. The
-original test suite contains over 600 tests; it will be some time before they
-are all re-implemented in the new world.
-
-The tests themselves are in no particular order; they accumulated over the
-years as Exim was extended and modified. They vary greatly in size and
-complexity. Some were specifically constructed to test new features; others
-were made to demonstrate that a bug had been fixed.
+run in a number of different environments. The tests themselves are in no
+particular order; they accumulated over the years as Exim was extended and
+modified. They vary greatly in size and complexity. Some were specifically
+constructed to test new features; others were made to demonstrate that a bug
+had been fixed.

 
 A few of the original tests have had to be omitted from this more general
 suite because differences in operating system behaviour make it impossible to
 
 A few of the original tests have had to be omitted from this more general
 suite because differences in operating system behaviour make it impossible to


@@ -45,21 +38,18 @@ option set. In Linux, such a binary is able to deliver a message as the caller
 of Exim, because it can revert to the caller's uid. In FreeBSD this is not the
 case.
 
 of Exim, because it can revert to the caller's uid. In FreeBSD this is not the
 case.
 

-This is early documentation; it too may be buggy... :-) It is certainly
-incomplete, because there are features yet to be added to the test suite.
-

 
 REQUIREMENTS
 ------------
 
 In order to run this test suite, the following requirements must be met:
 
 
 REQUIREMENTS
 ------------
 
 In order to run this test suite, the following requirements must be met:
 

-(1) You should run the tests on the latest version of Exim, because the suite
+(1) You should run the tests on a matching version of Exim, because the suite

     is continuously updated to test the latest features and bug fixes. The
     version you test does not, however, have to be installed as the live
     is continuously updated to test the latest features and bug fixes. The
     version you test does not, however, have to be installed as the live

-    version. You can of course run the tests on an older Exim, but some may
-    fail. In particular, the test suite will fall apart horrible with versions
-    of Exim prior to 4.54.
+    version. You can of course try the tests on any version of Exim, but some
+    may fail. In particular, the test suite will fall apart horrible with
+    versions of Exim prior to 4.54.

 
 (2) You can use any non-root login to run the tests, but there must be access
     via "sudo" to root from this login. Privilege is required to override
 
 (2) You can use any non-root login to run the tests, but there must be access
     via "sudo" to root from this login. Privilege is required to override


@@ -73,31 +63,41 @@ In order to run this test suite, the following requirements must be met:
       Defaults timestamp_timeout=480
 
     in /etc/sudoers, a password lasts for 8 hours (a working day). It is
       Defaults timestamp_timeout=480
 
     in /etc/sudoers, a password lasts for 8 hours (a working day). It is

-    probably not a good idea to run the tests as the Exim user, as this is
-    recognized as special by Exim.
-
-(3) The login under which you run the tests must be in the exim group so that
-    it has access to logs, spool files, etc. The login should not be one of the
-    names "userx", "usery", "userz", or a few other simple ones such as "abcd"
-    and "xyz" and single letters that are used in the tests. (The original
-    tests use my login a lot; I'm weeding this out as I convert, and I'll try
-    to get rid of common names as well.) The test suite expects the login to
-    have a gecos name; I think it will now run if the gecos field is empty but
-    there may be anomalies.
+    not permitted to run the tests as the Exim user because the test suite
+    tracks the two users independently.  Using the same user would result
+    in false positives on some tests.
+
+    Further, some tests invoke sudo in an environment where there might not be
+    a TTY, so tickets should be global, not per-TTY.  Taking this all together
+    and assuming a user of "exim-build", you might have this in sudoers:
+
+      Defaults:exim-build     timestamp_timeout=480,!tty_tickets
+
+(3) The login under which you run the tests must have the exim group as a
+    secondary so that it has access to logs, spool files, etc.  However, it
+    should have a different primary group (eg. "users" vs. "eximgroup"). The
+    login should not be one of the names "userx", "usery", "userz", or a few
+    other simple ones such as "abcd" and "xyz" and single letters that are used
+    in the tests. The test suite expects the login to have a gecos name; I think
+    it will now run if the gecos field is empty but there may be anomalies.
+    The login must not contain a dash or an equal sign. (Otherwise some tests
+    about local_from_{suffix,prefix} will fail.)

 
 (4) The directory into which you unpack the test suite must be accessible by
 
 (4) The directory into which you unpack the test suite must be accessible by

-    the Exim user, so that code which is running as exim can access the files
-    therein. A world-readable directory is fine. However, there may be problems
-    if the path name of the directory is excessively long. This is because it
-    sometimes appears in logs lines or debug output, and if it is truncated, it
+    the Exim user, so that code running as exim can access the files therein.
+    This includes search-access on all path elements leading to it. A
+    world-readable directory is fine. However, there may be problems if the
+    path name of the directory is excessively long. This is because it
+    sometimes appears in log lines or debug output, and if it is truncated, it

     is no longer recognized.
 
 (5) Exim must be built with its user and group specified at build time, and
     with certain minimum facilities, namely:
 
     is no longer recognized.
 
 (5) Exim must be built with its user and group specified at build time, and
     with certain minimum facilities, namely:
 

-      Routers:    accept, dnslookup, manualroute, redirect
-      Transports: appendfile, autoreply, pipe, smtp
-      Lookups:    lsearch
+      Routers:        accept, dnslookup, manualroute, redirect
+      Transports:     appendfile, autoreply, pipe, smtp
+      Lookups:        lsearch
+      Authenticators: plaintext

 
     Most Exim binaries will have these included.
 
 
     Most Exim binaries will have these included.
 


@@ -115,7 +115,23 @@ In order to run this test suite, the following requirements must be met:
     is also an IPv6 address, additional tests are run when the Exim binary
     contains IPv6 support. There are checks in the scripts for a running IPv4
     interface; when one is not found, some tests are skipped (with a warning
     is also an IPv6 address, additional tests are run when the Exim binary
     contains IPv6 support. There are checks in the scripts for a running IPv4
     interface; when one is not found, some tests are skipped (with a warning

-    message).
+    message).  The local net may not be in 10.250.0/16 as that is used by the suite.
+
+(9) Exim must be built with TRUSTED_CONFIG_LIST support, so that the test
+    configs can be placed into it.  A suitable file location is .../exim/test/trusted_configs
+    with content .../exim/test/test-config [fill out the ... to make full
+    paths].  This file should be owner/group matching CONFIGURE_OWNER/GROUP,
+    or root/root, and it has to be accessible for the login, under which
+    you run the tests.  The config files in .../exim/test/confs/ should be
+    owner/group the same.  DISABLE_D_OPTION must not be used. If ALT_CONFIG_PREFIX is used, it
+    must contain the directory of the test-suite.  WHITELIST_D_MACROS should contain:
+
+     DIR:EXIM_PATH:AA:ACL:ACLRCPT:ACL_MAIL:ACL_PREDATA:ACL_RCPT:AFFIX:ALLOW:ARG1:ARG2:AUTHF:AUTHS:AUTH_ID_DOMAIN:BAD:BANNER:BB:BR:BRB:CERT:COM:COMMAND_USER:CONNECTCOND:CONTROL:CREQCIP:CREQMAC:CRL:CSS:D6:DATA:DCF:DDF:DEFAULTDWC:DELAY:DETAILS:DRATELIMIT:DYNAMIC_OPTION:ELI:ERROR_DETAILS:ERT:FAKE:FALLBACK:FILTER:FILTER_PREPEND_HOME:FORBID:FORBID_SMTP_CODE:FUSER:HAI:HAP:HARDLIMIT:HEADER_LINE_MAXSIZE:HEADER_MAXSIZE:HELO_MSG:HL:HOSTS:HOSTS_AVOID_TLS:HOSTS_MAX_TRY:HVH:IFACE:IGNORE_QUOTA:INC:INSERT:IP1:IP2:LAST:LDAPSERVERS:LENCHECK:LIMIT:LIST:LOG_SELECTOR:MAXNM:MESSAGE_LOGS:MSIZE:NOTDAEMON:ONCE:ONLY:OPT:OPTION:ORDER:PAH:PEX:PORT:PTBC:QDG:QOLL:QUOTA:QUOTA_FILECOUNT:QWM:RCPT_MSG:REMEMBER:REQUIRE:RETRY:RETRY1:RETRY2:RETURN:RETURN_ERROR_DETAILS:REWRITE:ROUTE_DATA:RRATELIMIT:SELECTOR:SELF:SERVER:SERVERS:SREQCIP:SREQMAC:SRV:STRICT:SUB:SUBMISSION_OPTIONS:TIMEOUTDEFER:TIMES:TRUSTED:TRYCLEAR:UL:USE_SENDER:UTF8:VALUE:WMF
+
+(10) Exim must *not* be built with USE_READLINE, as the test-suite's automation
+     assumes the simpler I/O model.
+     Exim must *not* be built with HEADERS_CHARSET set to UTF-8.
+

 
 
 OPTIONAL EXTRAS
 
 
 OPTIONAL EXTRAS


@@ -130,17 +146,20 @@ the extra functionality, except for a few special cases such as the databases
 RUNNING THE TEST SUITE
 ----------------------
 
 RUNNING THE TEST SUITE
 ----------------------
 

-(1) Download the tarball exim-testsuite-x.xx.tar.bz2 and unpack it, preferably
-    in a directory alongside an Exim source directory (see below).
+(1) Clone the git tree for Exim.  This include both the Exim source and the
+    testsuite.

 
 

-(2) cd into the exim-testsuite-x.xx directory.
+(2) cd into the test/ subdirectory (where this README lives).

 
 

-(3) Run "./configure" and then "make". This builds a few auxiliary programs
-    that are written in C.
+(3) Run "./configure" and then "make". This builds a few auxiliary programs that
+    are written in C.

 
 

-(4) Run "./runtest" (a Perl script) as described below.
+(4) echo $PWD/test-config >> your_TRUSTED_CONFIG_LIST_filename
+    Typically that is .../exim/test/trusted_configs

 
 

-(5) If you want to see what tests are available, run "./listtests".
+(5) Run "./runtest" (a Perl script) as described below.
+
+(6) If you want to see what tests are available, run "./listtests".

 
 
 BREAKING OUT OF THE TEST SCRIPT
 
 
 BREAKING OUT OF THE TEST SCRIPT


@@ -196,23 +215,28 @@ THE RUNTEST SCRIPT
 ------------------
 
 If you do not supply any arguments to ./runtest, it searches for an Exim
 ------------------
 
 If you do not supply any arguments to ./runtest, it searches for an Exim

-source tree at the same level as the test suite directory. It then looks for an
-Exim binary in a "build" directory of that source tree. If there are several
-Exim source trees, it chooses the latest version of Exim. Consider the
-following example:
+source tree at the same level as the test suite directory. A source tree
+is a source tree, if it contains a build-* directory.
+
+It then looks for an Exim binary in a "build" directory of that source
+tree. If there are several Exim source trees, it chooses the latest
+version of Exim. Consider the following example:

 
   $ ls -F /source/exim
 
   $ ls -F /source/exim

-  exim-4.50/  exim-4.52/  exim-testsuite-0.00/
+  exim-4.60/  exim-4.62/  exim-testsuite-x.xx/

 
 

-A simple ./runtest from within the test suite will use a 4.52 binary if it
-finds one, otherwise a 4.50 binary. If a binary cannot be found, the script
+A simple ./runtest from within the test suite will use a 4.62 binary if it
+finds one, otherwise a 4.60 binary. If a binary cannot be found, the script

 prompts for one. Alternatively, you can supply the binary on the command line:
 
   ./runtest /usr/exim/bin/exim
 
 prompts for one. Alternatively, you can supply the binary on the command line:
 
   ./runtest /usr/exim/bin/exim
 

-The test suite also uses some of the Exim utilities (such as exim_dbmbuild),
-and it expects to find them in the same directory as Exim itself. If they are
-not found, the tests that use them are omitted. A suitable comment is output.
+A matching test suite is released with each Exim release; if you use a test
+suite that does not match the binary, some tests may fail.
+
+The test suite uses some of the Exim utilities (such as exim_dbmbuild), and it
+expects to find them in the same directory as Exim itself. If they are not
+found, the tests that use them are omitted. A suitable comment is output.

 
 On the ./runtest command line, following the name of the binary, if present,
 there may be a number of options and then one or two numbers. The full syntax
 
 On the ./runtest command line, following the name of the binary, if present,
 there may be a number of options and then one or two numbers. The full syntax


@@ -223,6 +247,11 @@ is as follows:
 
 There are some options for the ./runtest script itself:
 
 
 There are some options for the ./runtest script itself:
 

+  -CONTINUE This will allow the script to move past some failing tests. It will
+            write a simple failure line with the test number in a temporary
+            logfile test/failed-summary.log. Unexpected exit codes will still
+            stall the test execution and require interaction.
+

   -DEBUG    This option is for debugging the test script. It causes some
             tracing information to be output.
 
   -DEBUG    This option is for debugging the test script. It causes some
             tracing information to be output.
 


@@ -235,6 +264,21 @@ There are some options for the ./runtest script itself:
             (If it turns out that most people prefer to use diff, I'll change
             the default.)
 
             (If it turns out that most people prefer to use diff, I'll change
             the default.)
 

+  -FLAVOR <flavor>
+  -FLAVOUR <flavour>
+            This allows "overrides" for the test results. It's intended
+            use is to deal with distro specific differences in the test
+            output. The default flavour is "FOO" if autodetection fails.
+            (Autodetection is possible for known flavours only. Known
+            flavours are computed after file name extensions in stdout/*
+            and stderr/*.)
+
+            If during the test run differences between the current and
+            the expected output are found and no flavour file exists already,
+            you may update the "common" expected output or you may create a
+            flavour file. If  a flavour file already exists, any updates will go
+            into that flavour file!
+

   -KEEP     Normally, after a successful run, the test output files are
             deleted. This option prevents this. It is useful when running a
             single test, in order to look at the actual output before it is
   -KEEP     Normally, after a successful run, the test output files are
             deleted. This option prevents this. It is useful when running a
             single test, in order to look at the actual output before it is


@@ -254,6 +298,14 @@ There are some options for the ./runtest script itself:
             maintainer after making a change to the code that affects a lot of
             tests (for example, the wording of a message).
 
             maintainer after making a change to the code that affects a lot of
             tests (for example, the wording of a message).
 

+  -SLOW     For very slow hosts that appear to have Heisenbugs, delay before
+            comparing output files from a testcase
+
+  -TLS <client>  For cross-library testing. Specify 'openssl" or 'gnutls'
+            as the client; the other is used as the server (assumes that
+           both have been built: set up Local/Makefile for OpenSSL and
+           "make exim_openssl", then for GnuTLS and "make exim_gnutls")
+

 The options for ./runtest must be given first (but after the name of the
 binary, if present). Any further options, that is, items on the command line
 that start with a hyphen, are passed to the Exim binary when it is run as part
 The options for ./runtest must be given first (but after the name of the
 binary, if present). Any further options, that is, items on the command line
 that start with a hyphen, are passed to the Exim binary when it is run as part


@@ -328,8 +380,9 @@ example:
 
 If a test fails, you are shown the output of the text comparison that failed,
 and prompted as to what to do next. The output is shown using the "less"
 
 If a test fails, you are shown the output of the text comparison that failed,
 and prompted as to what to do next. The output is shown using the "less"

-command, or "more" if "less" is not available. By default, the output is from
-the "cf" program, and might look like this:
+command, or "more" if "less" is not available. The options for "less" are set
+to that it automatically exits if there is less that a screenful of output. By
+default, the output is from the "cf" program, and might look like this:

 
   DBM/1300 DBM files and exim_dbmbuild
   ===============
 
   DBM/1300 DBM files and exim_dbmbuild
   ===============


@@ -348,7 +401,7 @@ the "cf" program, and might look like this:
   1 difference found.
   "test-stdout-munged" contains 16 lines; "stdout/1300" contains 18 lines.
 
   1 difference found.
   "test-stdout-munged" contains 16 lines; "stdout/1300" contains 18 lines.
 

-  Continue, Update & retry, Quit? [Q]
+  Continue, Retry, Update & retry, Quit? [Q]

 
 This example was generated by running the test with a version of Exim
 that had a bug in the exim_dbmbuild utility (the bug was fixed at release
 
 This example was generated by running the test with a version of Exim
 that had a bug in the exim_dbmbuild utility (the bug was fixed at release


@@ -357,7 +410,7 @@ used. In this case, the standard output differed from what was expected.
 
 The reply to the prompt must either be empty, in which case it takes the
 default that is given in brackets (in this case Q), or a single letter, in
 
 The reply to the prompt must either be empty, in which case it takes the
 default that is given in brackets (in this case Q), or a single letter, in

-upper or lower case (in this case, one of C, U, or Q). If you type anything
+upper or lower case (in this case, one of C, R, U, or Q). If you type anything

 else, the prompt is repeated.
 
 "Continue" carries on as if the files had matched; that is, it ignores the
 else, the prompt is repeated.
 
 "Continue" carries on as if the files had matched; that is, it ignores the


@@ -367,9 +420,11 @@ moving on to the next test.
 "Update & retry" copies the new file to the saved file, and reruns the test
 after doing any further comparisons that may be necessary.
 
 "Update & retry" copies the new file to the saved file, and reruns the test
 after doing any further comparisons that may be necessary.
 

+"Retry" does the same apart from the file copy.
+

 Other circumstances give rise to other prompts. If a test generates output for
 which there is no saved data, the prompt (after a message stating which file is
 Other circumstances give rise to other prompts. If a test generates output for
 which there is no saved data, the prompt (after a message stating which file is

-unexpectely not empty) is:
+unexpectedly not empty) is:

 
   Continue, Show, or Quit? [Q]
 
 
   Continue, Show, or Quit? [Q]
 


@@ -392,6 +447,53 @@ libraries generate different error messages. This may cause the comparison with
 the saved output to fail. Such errors can be ignored.
 
 
 the saved output to fail. Such errors can be ignored.
 
 

+OTHER ISSUES
+------------
+
+. Some of the tests are time-sensitive (e.g. when testing timeouts, as in test
+  461). These may fail if run on a host that is also running a lot of other
+  processes.
+
+. Some versions of "ls" use a different format for times and dates. This can
+  cause test 345 to fail.
+
+. Test 0142 tests open file descriptors; on some hosts the output may vary.
+
+. Some tests may fail, for example 0022, because it says it uses cached data
+  when the expected output thinks it should not be in cache.  Item #5 in the
+  Requirements section has:
+    "Exim must be built with its user and group specified at build time"
+  This means that you cannot use the "ref:username" in your Local/Makefile
+  when building the exim binary, in any of the following fields:
+    EXIM_USER  EXIM_GROUP  CONFIGURE_OWNER  CONFIGURE_GROUP
+
+. If the runtest script warns that the hostname is not a Fully Qualified
+  Domain Name (FQDN), expect that some tests will fail, for example 0036,
+  with an extra log line saying the hostname doesn't resolve.  You must use a
+  FQDN for the hostname for proper test functionality.
+
+. If you change your hostname to a FQDN, you must delete the test/dnszones
+  subdirectory.  When you next run the runtest script, it will rebuild the
+  content to use the new hostname.
+
+. If your hostname has an uppercase characters in it, expect that some tests
+  will fail, for example, 0036, because some log lines will have the hostname
+  in all lowercase.  The regex which extracts the hostname from the log lines
+  will not match the lowercased version.
+
+. Some tests may fail, for example 0015, with a cryptic error message:
+    Server return code 99
+  Due to security concerns, some specific files MUST have the group write bit
+  off.  For the purposes of the test suite, some test/aux-fixed/* files MUST
+  have the group write bit off, so it's easier to just remove the group write
+  bit for all of them.  If your umask is set to 002, the group write bit will
+  be on by default and you'll see this problem, so make sure your umask is
+  022 and re-checkout the test/ subdirectory.
+
+. Some tests will fail if the username and group name are different. It does
+  not have to be the primary group, a secondary group is sufficient.
+
+

 OTHER SCRIPTS AND PROGRAMS
 --------------------------
 
 OTHER SCRIPTS AND PROGRAMS
 --------------------------
 


@@ -420,6 +522,9 @@ bin/client-ssl     A script-driven SMTP client simulation with OpenSSL support.
                    This is built only if OpenSSL support is detected on the
                    host.
 
                    This is built only if OpenSSL support is detected on the
                    host.
 

+bin/client-anytls  A symlink to either client-ssl or client-gnutls, if
+                   any is built.
+

 bin/fakens         A fake "nameserver" for DNS tests (see below for details).
 
 bin/fd             A program that outputs details of open file descriptors.
 bin/fakens         A fake "nameserver" for DNS tests (see below for details).
 
 bin/fd             A program that outputs details of open file descriptors.


@@ -429,7 +534,11 @@ bin/iefbr14        A program that does nothing, and returns 0. It's just like
 
 bin/loaded         Some dynamically loaded functions for testing dlfunc support.
 
 
 bin/loaded         Some dynamically loaded functions for testing dlfunc support.
 

-bin/server         A script-driven SMTP server simulation.
+bin/mtpscript      A script-driven SMTP/LMTP server simulation, on std{in,out}.
+
+bin/server         A script-driven SMTP server simulation, over a socket.
+
+bin/showids        Output the current uid, gid, euid, egid.

 
 The runtest script also makes use of a number of ordinary commands such as
 "cp", "kill", "more", and "rm", via the system() call. In some cases these are
 
 The runtest script also makes use of a number of ordinary commands such as
 "cp", "kill", "more", and "rm", via the system() call. In some cases these are


@@ -445,6 +554,7 @@ used in a test. To save repetition, the substitutions themselves are documented
 here:
 
   CALLER         is replaced by the login name of the user running the tests
 here:
 
   CALLER         is replaced by the login name of the user running the tests

+  CALLERGROUP    is replaced by the caller's group id

   CALLER_GID     is replaced by the caller's group id
   CALLER_UID     is replaced by the caller's user id
   DIR            is replaced by the name of the test-suite directory
   CALLER_GID     is replaced by the caller's group id
   CALLER_UID     is replaced by the caller's user id
   DIR            is replaced by the name of the test-suite directory


@@ -456,6 +566,7 @@ here:
   PORT_D         is replaced by a port number for normal daemon use
   PORT_N         is replaced by a port number that should never respond
   PORT_S         is replaced by a port number for normal bin/server use
   PORT_D         is replaced by a port number for normal daemon use
   PORT_N         is replaced by a port number that should never respond
   PORT_S         is replaced by a port number for normal bin/server use

+  PORT_DYNAMIC   is replaced by a port number allocated dynamically

   TESTNUM        is replaced by the current test number
   V4NET          is replaced by an IPv4 network number for testing
   V6NET          is replaced by an IPv6 network number for testing
   TESTNUM        is replaced by the current test number
   V4NET          is replaced by an IPv4 network number for testing
   V6NET          is replaced by an IPv6 network number for testing


@@ -466,6 +577,10 @@ testing purposes, and for testing Exim with -bh. The only requirement is that
 they are networks that can never be used for an IP address of a real host. I've
 chosen two multicast networks for the moment.
 
 they are networks that can never be used for an IP address of a real host. I've
 chosen two multicast networks for the moment.
 

+PORT_DYNAMIC is allocated by hunting for a free port (starting at port
+1024) a listener can bind to. This is done by runtest, for simulating
+inetd operations.
+

 If the host has no IPv6 address, "<no IPv6 address found>" is substituted but
 that does not matter because no IPv6 tests will be run. A similar substitution
 is made if there is no IPv4 address, and again, tests that actually require a
 If the host has no IPv6 address, "<no IPv6 address found>" is substituted but
 that does not matter because no IPv6 tests will be run. A similar substitution
 is made if there is no IPv4 address, and again, tests that actually require a


@@ -473,7 +588,7 @@ running IPv4 interface should be skipped.
 
 If the host has more than one IPv4 or IPv6 address, the first one that
 "ifconfig" lists is used. If the only available address is 127.0.0.1 (or ::1
 
 If the host has more than one IPv4 or IPv6 address, the first one that
 "ifconfig" lists is used. If the only available address is 127.0.0.1 (or ::1

-for IPv6) it is used, but another value is prefered if available.
+for IPv6) it is used, but another value is preferred if available.

 
 In situations where a specific test is not being run (for example, when setting
 up dynamic data files), TESTNUM is replaced by an empty string, but should not
 
 In situations where a specific test is not being run (for example, when setting
 up dynamic data files), TESTNUM is replaced by an empty string, but should not


@@ -581,13 +696,23 @@ just one command:
 
 The expected return code in this case is 1, and the data lines are passed to
 Exim on its standard input. Both the command line and the data lines have the
 
 The expected return code in this case is 1, and the data lines are passed to
 Exim on its standard input. Both the command line and the data lines have the

-standard substitions applied to them. Thus, HOSTNAME in the example above will
+standard substitutions applied to them. Thus, HOSTNAME in the example above will

 be replaced by the local host's name. Long commands can be continued over
 several lines by using \ as a continuation character. This does *not* apply to
 data lines.
 
 be replaced by the local host's name. Long commands can be continued over
 several lines by using \ as a continuation character. This does *not* apply to
 data lines.
 

-Here follows a [currently incomplete] list of supported commands. They can be
-divided into two groups:
+A line with a leading number followed by a space and then an uppercase
+word, equals character, value sets an expected return code as above
+plus an environment variable.  Example:
+
+  255 TZ=GB
+  exim_msgdate -l -u -z -localhost_number=20 000000 1PANS3 ZZZZZZ
+  ****
+
+
+
+
+Here follows a list of supported commands. They can be divided into two groups:

 
 
 Commands with no input
 
 
 Commands with no input


@@ -595,6 +720,12 @@ Commands with no input
 
 These commands are not followed by any input data, or by a line of asterisks.
 
 
 These commands are not followed by any input data, or by a line of asterisks.
 

+
+  ### This is a verbose comment
+
+A line starting with three hashmarks and some space copies the following text to
+both stdout and stderr file being written by the test.
+

   dbmbuild <file1> <file1>
 
 This command runs the exim_dbmbuild utility to build a DBM file. It is used
   dbmbuild <file1> <file1>
 
 This command runs the exim_dbmbuild utility to build a DBM file. It is used


@@ -602,19 +733,48 @@ only when DBM support is available in Exim, and typically follows the use of a
 "write" command (see below) that creates the input file.
 
 
 "write" command (see below) that creates the input file.
 
 

+  dump <dbname>
+
+This command runs the exim_dumpdb utility on the testing spool directory, using
+the database name given, for example: "dumpdb retry".
+
+

   echo <text>
 
 The text is written to the screen; this is used to output comments from
 scripts.
 
 
   echo <text>
 
 The text is written to the screen; this is used to output comments from
 scripts.
 
 

+  exim_lock [options] <file name>
+
+This command runs the exim_lock utility with the given options and file name.
+The file remains locked for following commands until a non-daemon "exim"
+completes.
+
+
+  exinext <data>
+
+This command runs the exinext utility with the given argument data.
+
+
+  exigrep <data>
+
+This command runs the exigrep utility with the given data (the search pattern)
+on the current mainlog file.
+
+
+  exiqgrep <data>
+
+This command runs the exiqgrep utility with the given options
+on the current spool directory.
+
+

   gnutls
 
 This command is present at the start of all but one of the tests that use
 GnuTLS. It copies a pre-existing parameter file into the spool directory, so
 that Exim does not have to re-create the file each time. The first GnuTLS test
   gnutls
 
 This command is present at the start of all but one of the tests that use
 GnuTLS. It copies a pre-existing parameter file into the spool directory, so
 that Exim does not have to re-create the file each time. The first GnuTLS test

-does not do this, in order to test that Exim can create the file (it takes some
-time).
+does not do this, in order to test that Exim can create the file.

 
 
   killdaemon
 
 
   killdaemon


@@ -631,6 +791,12 @@ This command causes the script to sleep for m milliseconds. Nothing is output
 to the screen.
 
 
 to the screen.
 
 

+  munge <name>
+
+This command requests custom munging of the test outputs.  The munge names
+used are coded in the runtest script (look for 'name of munge').
+
+

   need_ipv4
 
 This command must be at the head of a script. If no IPv4 interface has been
   need_ipv4
 
 This command must be at the head of a script. If no IPv4 interface has been


@@ -646,7 +812,7 @@ found, the entire script is skipped, and a comment is output.
   need_largefiles
 
 This command must be at the head of a script. If the Exim binary does not
   need_largefiles
 
 This command must be at the head of a script. If the Exim binary does not

-suppport large files (off_t is <= 4), the entire script is skipped, and a
+support large files (off_t is <= 4), the entire script is skipped, and a

 comment is output.
 
 
 comment is output.
 
 


@@ -669,6 +835,15 @@ If this command is encountered anywhere in the script, message log files that
 are still in existence at the end of the run (for messages that were not
 delivered) are not compared with saved versions.
 
 are still in existence at the end of the run (for messages that were not
 delivered) are not compared with saved versions.
 

+
+  no_munge
+
+If this command is encountered anywhere in the script, the output is not
+munged before it is compared with a saved version.
+This option allows meaningful tests of the exim_msgdate utility;
+without it all date comparison checks would succeed.
+
+

   no_stderr_check
 
 If this command is encountered anywhere in the script, the stderr output from
   no_stderr_check
 
 If this command is encountered anywhere in the script, the stderr output from


@@ -705,33 +880,58 @@ deliveries because on different systems the processes may terminate in a
 different order.
 
 
 different order.
 
 

-A number of standard file management commands are recognized. These are chmod,
-chown, ln, ls, du, mkdir, mkfifo, and touch. Some are run as root using "sudo".
+A number of standard file management commands are also recognized. These are
+cat, chmod, chown, cp, du, ln, ls, du, mkdir, mkfifo, rm, rmdir, and touch.
+Some are run as root using "sudo".

 
 
 Commands with input
 -------------------
 
 The remaining commands are followed by data lines for their standard input,
 
 
 Commands with input
 -------------------
 
 The remaining commands are followed by data lines for their standard input,

-terminated by four asterisks. Even if no data is required for the particular
+terminated by four asterisks ("****"). Even if no data is required for the particular

 usage, the asterisks must be given.
 
 usage, the asterisks must be given.
 

+If the input line starts with ':<cmd>:', this prefix is removed and the
+line is processed by the runtest script before sending. The following
+commands are recognised:
+
+- "eval": process the reset of the line with Perl's string eval()
+  function. This can be used to send arbitrary data by encoding it as
+  escape sequences (e.g. "\x41\101"). If you need a line ending, you have
+  to append it accordingly (e.g. "\r\n").
+
+- "noeol": do not terminate the data sent to the application with an end
+  of line character.
+
+- "sleep": interpret the rest of the line as an integer and sleep for
+  that number of seconds before proceeding. No data will be output to
+  the application.
+
+
+  background
+
+This command takes one script line and runs it in the background,
+in parallel with following commands.  For external daemons, eg. redis-server.
+

 
   catwrite <file name> [nxm[=start-of-line-text]]*
 
 This command operates like the "write" command, which is described below,
 
   catwrite <file name> [nxm[=start-of-line-text]]*
 
 This command operates like the "write" command, which is described below,

-except that the out it generates is copied to the end of the test-stdout file
+except that the data it generates is copied to the end of the test-stdout file

 as well as to the named file.
 
 
 as well as to the named file.
 
 

-

   client [<options>] <ip address> <port> [<outgoing interface>]
 
 This command runs the auxiliary "client" program that simulates an SMTP client.
 It is controlled by a script read from its standard input, details of which are
   client [<options>] <ip address> <port> [<outgoing interface>]
 
 This command runs the auxiliary "client" program that simulates an SMTP client.
 It is controlled by a script read from its standard input, details of which are

-given below. The only option is -t, which must be followed by a number, to
-specify the command timeout in seconds. The program connects to the given IP
-address and port, using the specified interface, if one is given.
+given below. There are two options. One is -t, which must be followed directly
+by a number, to specify the command timeout in seconds (e.g. -t5). The default
+timeout is 5 seconds. The other option is -tls-on-connect, which causes the
+client to try to start up a TLS session as soon as it has connected, without
+using the STARTTLS command. The client program connects to the given IP address
+and port, using the specified interface, if one is given.

 
 
   client-ssl [<options>] <ip address> <port> [<outgoing interface>] \
 
 
   client-ssl [<options>] <ip address> <port> [<outgoing interface>] \


@@ -739,9 +939,11 @@ address and port, using the specified interface, if one is given.
 
 When OpenSSL is available on the host, an alternative version of the client
 program is compiled, one that supports TLS using OpenSSL. The additional
 
 When OpenSSL is available on the host, an alternative version of the client
 program is compiled, one that supports TLS using OpenSSL. The additional

-arguments specify a certificate and key file when required. There is one
-additional option, -tls-on-connect, that causes the client to initiate TLS
-negotiation immediately on connection.
+arguments specify a certificate and key file when required for the connection.
+There are two additional options: -tls-on-connect, that causes the client to
+initiate TLS negotiation immediately on connection; -ocsp that causes the TLS
+negotiation to include a certificate-status request.  The latter takes a
+filename argument, the CA info for verifying the stapled response.

 
 
   client-gnutls [<options>] <ip address> <port> [<outgoing interface>] \
 
 
   client-gnutls [<options>] <ip address> <port> [<outgoing interface>] \


@@ -772,6 +974,11 @@ example:
 Finally, "exim" can be preceded by "sudo", to run Exim as root. If more than
 one of these prefixes is present, they must be in the above order.
 
 Finally, "exim" can be preceded by "sudo", to run Exim as root. If more than
 one of these prefixes is present, they must be in the above order.
 

+If the options include "-DSERVER" but not "-DNOTDAEMON", the script waits for
+Exim to start but then continues without waiting for it to terminate. Typically
+this will be for a daemon-mode "-bd" operation.  The daemon should be later
+terminated using "killdaemon".
+

 
   exim_exim [<options>] [<arguments>]
 
 
   exim_exim [<options>] [<arguments>]
 


@@ -787,13 +994,17 @@ input, details of which are given below. A number of options are implemented:
 
   -d       causes the server to output debugging information
 
 
   -d       causes the server to output debugging information
 

-  -t       sets a timeout in seconds (default 5) for when the server is
-           awaiting an incoming connection
+  -t <sec> sets a timeout (default 5) for when the server is
+           awaiting an incoming connection. If negative, the
+          absolute value is used and a timeout results in a
+          nonfailure exit code

 
   -noipv4  causes the server not to set up an IPv4 socket
 
   -noipv6  causes the server not to set up an IPv6 socket
 
 
   -noipv4  causes the server not to set up an IPv4 socket
 
   -noipv6  causes the server not to set up an IPv6 socket
 

+  -i <sec> sets an initial pause, to delay before creating the listen sockets
+

 By default, in an IPv6 environment, both kinds of socket are set up. However,
 the test script knows which interfaces actually exist on the host, and it adds
 -noipv4 or -noipv6 to the server command as required. An error occurs if both
 By default, in an IPv6 environment, both kinds of socket are set up. However,
 the test script knows which interfaces actually exist on the host, and it adds
 -noipv4 or -noipv6 to the server command as required. An error occurs if both


@@ -812,8 +1023,9 @@ connections. Here are some example commands:
 
 The following lines, up to a line of four asterisks, are the server's
 controlling standard input (described below). These lines are read and
 
 The following lines, up to a line of four asterisks, are the server's
 controlling standard input (described below). These lines are read and

-remembered; during the following commands, until an "exim" command is reached,
-the server is run in parallel.
+remembered; during the following commands, until a non-deamon "exim" command
+is reached, the server is run in parallel.  Then the server termination
+is waited for.

 
 
   write <file name> [nxm[=start-of-line-text]]*
 
 
   write <file name> [nxm[=start-of-line-text]]*


@@ -860,23 +1072,43 @@ one-off things to be done.
 CLIENT SCRIPTS
 --------------
 
 CLIENT SCRIPTS
 --------------
 

-Lines in client scripts are of two kinds:
+Lines in client scripts are of several kinds:

 
 

-(1) If a line begins with three question marks and a space, the rest of the
+(1) "??? ": If a line begins with three question marks and a space, the rest of the

     line defines the start of expected output from the server. If what is
     received does not match, the client bombs out with an error message.
 
     line defines the start of expected output from the server. If what is
     received does not match, the client bombs out with an error message.
 

-(2) If a line starts with three plus signs followed by a space, the rest of the
+(2) "???*": If a line begins with three question marks and an asterisk, the server
+    is expected to close the connection.
+
+(3) "????": If a line begins with four question marks, the rest of the line defines
+    the start of one or more possible output lines from the server.  When it
+    matches, the client silently repeats the comparison using the next server
+    line.  When the match fails, the client silently proceeds to the next script
+    line with the then-current server output unconsumed.
+
+(4) "+++ ": If a line starts with three plus signs followed by a space, the rest of the

     line specifies a number of seconds to sleep for before proceeding.
 
     line specifies a number of seconds to sleep for before proceeding.
 

-(3) Otherwise, the line is an input line line that is sent to the server. Any
+(5) ">>> ": If a line begins with three '>' characters and a space, the rest of the
+    line is input to be sent to the server.  Backslash escaping is done as
+    described below, but no trailing "\r\n" is sent.
+
+(6) "<<< ": If a line begin with three '<' characters and a space, the rest of the
+    line is a filename; the content of the file is inserted into the script
+    at this point.
+
+(7) Otherwise, the line is an input line line that is sent to the server. Any

     occurrences of \r and \n in the line are turned into carriage return and
     linefeed, respectively. This is used for testing PIPELINING.
     occurrences of \r and \n in the line are turned into carriage return and
     linefeed, respectively. This is used for testing PIPELINING.

+    Any sequences of \x followed by two hex digits are converted to the equivalent
+    byte value.  Any other character following a \ is sent verbatim.
+    The line is sent with a trailing "\r\n".

 
 Here is a simple example:
 
   client 127.0.0.1 PORT_D
 
 Here is a simple example:
 
   client 127.0.0.1 PORT_D

-  ??? 250
+  ??? 220

   EHLO xxx
   ??? 250-
   ??? 250
   EHLO xxx
   ??? 250-
   ??? 250


@@ -909,23 +1141,32 @@ are of the following kinds:
     (d) If the line starts with ">*eof", nothing is sent and the connection
           is closed.
 
     (d) If the line starts with ">*eof", nothing is sent and the connection
           is closed.
 

-    The data that is sent starts after the initial '>' sequence.
+    The data that is sent starts after the initial '>' sequence.  Within
+    each line the sequence '\x' followed by two hex digits can be used
+    to specify an arbitrary byte value.  The sequence '\\' specifies a
+    single backslash.

 
 (2) A line that starts with "*sleep" specifies a number of seconds to wait
     before proceeding.
 
 
 (2) A line that starts with "*sleep" specifies a number of seconds to wait
     before proceeding.
 

-(3) A line containing "*eof" specifies that the client is expected to close
+(3) A line containing "*data" and a number specifies that the client is
+    expected to send that many byte; the server discards them
+
+(4) A line containing "*eof" specifies that the client is expected to close

     the connection at this point.
 
     the connection at this point.
 

-(4) A line containing just '.' specifies that the client is expected to send
+(5) A line containing just '.' specifies that the client is expected to send

     many lines, terminated by one that contains just a dot.
 
     many lines, terminated by one that contains just a dot.
 

-(5) Otherwise, the line defines the start of an input line that the client
+(6) Otherwise, the line defines the start of an input line that the client

     is expected to send. To allow for lines that start with digits, the line
     may start with '<', which is not taken as part of the input data. If the
     is expected to send. To allow for lines that start with digits, the line
     may start with '<', which is not taken as part of the input data. If the

-    input does not match, the server bombs out with an error message.
+    lines starts with '<<' then only the characters are expected; no return-
+    linefeed terminator. If the input does not match, the server bombs out
+    with an error message.  Backslash-escape sequences may be used in the
+    line content as for output lines.

 
 

-Here is a simple server example:
+Here is a simple example of server use in a test script:

 
   server PORT_S
   220 Greetings
 
   server PORT_S
   220 Greetings


@@ -948,6 +1189,11 @@ After a "server" command in a test script, the server runs in parallel until an
 messages to port PORT_S on the local host. When it has finished, the test
 script waits for the "server" process to finish.
 
 messages to port PORT_S on the local host. When it has finished, the test
 script waits for the "server" process to finish.
 

+The "mtpscript" program is like "server", except that it uses stdin/stdout for
+its input and output instead of a script. However, it is not called from test
+scripts; instead it is used as the command for pipe transports in some
+configurations, to simulate non-socket LMTP servers.
+

 
 AUXILIARY DATA FILES
 --------------------
 
 AUXILIARY DATA FILES
 --------------------


@@ -964,7 +1210,7 @@ indicating that they are specific to that one test. A few fixed files (for
 example, some TLS certificates) are used by more than one test, and so their
 names are not of this form.
 
 example, some TLS certificates) are used by more than one test, and so their
 names are not of this form.
 

-There are also some auxilary DNS zone files, which are described in the next
+There are also some auxiliary DNS zone files, which are described in the next

 section.
 
 
 section.
 
 


@@ -1001,8 +1247,15 @@ directory by applying the standard substitutions. The test suite also builds
 dynamic zone files for the name of the current host and its IP address(es). The
 idea is that there should not be any need to rely on an external DNS.
 
 dynamic zone files for the name of the current host and its IP address(es). The
 idea is that there should not be any need to rely on an external DNS.
 

-The domain names that are handled directly by Exim, without being passed to
-fakens, are:
+The fakens program handles some names programmatically rather than using the
+fake zone files.  These are:
+
+  manyhome.test.ex  This name is used for testing hosts with ridiculously large
+                    numbers of IP addresses; 2048 IP addresses are generated
+                    and returned. Doing it this way saves having to make the
+                    interface to fakens handle more records that can fit in the
+                    data block. The addresses that are generated are in the
+                    10.250.0.0/16 network.

 
   test.again.dns    This always provokes a TRY_AGAIN response, for testing the
                     handling of temporary DNS error. If the full domain name
 
   test.again.dns    This always provokes a TRY_AGAIN response, for testing the
                     handling of temporary DNS error. If the full domain name


@@ -1011,23 +1264,12 @@ fakens, are:
   test.fail.dns     This always provokes a NO_RECOVERY response, for testing
                     DNS server failures.
 
   test.fail.dns     This always provokes a NO_RECOVERY response, for testing
                     DNS server failures.
 

-This special handling could now be done in the fakens program, but while the
-old test suite is still being used it has to be done in Exim itself, so for the
-moment it remains there.
-

 The use of gethostbyname() and its IPv6 friends is also subverted when Exim is
 running in the test harness. The test code handles a few special names
 directly; for all the others it uses DNS lookups, which are then handled as
 just described. Thus, the use of /etc/hosts is completely bypassed. The names
 that are specially handled are:
 
 The use of gethostbyname() and its IPv6 friends is also subverted when Exim is
 running in the test harness. The test code handles a few special names
 directly; for all the others it uses DNS lookups, which are then handled as
 just described. Thus, the use of /etc/hosts is completely bypassed. The names
 that are specially handled are:
 

-  manyhome.test.ex  This name is used for testing hosts with ridiculously large
-                    numbers of IP addresses; 2048 IP addresses are generated
-                    and returned. Doing it this way saves having to make the
-                    interface to fakens handle more records that can fit in the
-                    data block. The addresses that are generated are in the
-                    10.250.0.0/16 network.
-

   localhost         Always returns 127.0.0.1 or ::1, for IPv4 and IPv6 lookups,
                     respectively.
 
   localhost         Always returns 127.0.0.1 or ::1, for IPv4 and IPv6 lookups,
                     respectively.