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). The local net may not be in 10.0/8 as that is used by the suite.
+ 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
assumes the simpler I/O model.
Exim must *not* be built with HEADERS_CHARSET set to UTF-8.
+(11) If building any dynamically-loaded lookups, LOOKUP_MODULE_DIR should
+ be set to .../exim/test/eximdir.
+
OPTIONAL EXTRAS
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 "autoconf" then "./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) echo $PWD/test-config >> your_TRUSTED_CONFIG_LIST_filename
Typically that is .../exim/test/trusted_configs
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.
- (Autodection is possible for known flavours only. Known
+ (Autodetection is possible for known flavours only. Known
flavours are computed after file name extensions in stdout/*
and stderr/*.)
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
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]
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.
# -bS Use of HELO/RSET
A line consisting just of digits is interpreted as the expected return code
-for the command that follows. The default expectation when no such line exists
+for the command that follows.
+
+A line consisting of a tilde (~) followed by digits indicates a non-expected
+return code for the command that follows.
+
+The default expectation when neither such line exists
is a zero return code. For example, here is a complete test script, containing
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
-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.
+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:
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
exim_lock [options] <file name>
This command runs the exim_lock utility with the given options and file name.
-The file remains locked with the following command (normally exim) is obeyed.
+The file remains locked for following commands until a non-daemon "exim"
+completes.
exinext <data>
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
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.
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
-------------------
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.
+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
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.
program is compiled, one that supports TLS using OpenSSL. The additional
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 negociation immediately on connection; -ocsp that causes the TLS
+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.
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]]*
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.
-(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.
-(3) If a line begins with three '>' characters and a space, the rest of the
+(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.
-(4) Otherwise, the line is an input line line that is sent to the server. Any
+(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.
- Any sequences of \x followed by two hex digits are converted to the equvalent
+ 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:
(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 bytes; the server discards them
+
+(4) A line containing "*eof" specifies that the client is expected to close
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.
-(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
lines starts with '<<' then only the characters are expected; no return-
the current environment. The former are kept in the directory aux-fixed. The
latter are distributed in the directory aux-var-src, and copied with the
standard substitutions into the directory aux-var at the start of each test
-run.
+run (with TESTNUM from the numeric prefix of the filename is there is one).
Most of the auxiliary files have names that start with a test number,
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.
-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.
git://git.exim.org / exim.git / blobdiff