-$Cambridge: exim/test/README,v 1.4 2006/07/26 14:39:13 ph10 Exp $
-
EXPORTABLE EXIM TEST SUITE
--------------------------
This document last updated for:
-Test Suite Version: 4.63
-Date: 25 July 2006
+Test Suite Version: 4.67
+Date: 20 February 2007
BACKGROUND
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.
+ 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 be in the exim group so that
it has access to logs, spool files, etc. The login should not be one of the
gecos field is empty but there may be anomalies.
(4) The directory into which you unpack the test suite must be accessible by
- the Exim user, so that code running as exim can access the files therein. A
+ 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
(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.
interface; when one is not found, some tests are skipped (with a warning
message).
+(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
+ 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:LS:MAXNM:MESSAGE_LOGS:MSIZE:NOTDAEMON:ONCE:ONLY:OPT:OPTION:ORDER:PAH:PEX:PORT:PTBC:QDG:QOLL:QUOTA:QUOTA_FILECOUNT:QWM:RCPT_MSG:REMEMBER:REQUIRE:RETRY:RETRY1:RETRY2:RETURN:RETURN_ERROR_DETAILS:REWRITE:ROUTE_DATA:RRATELIMIT:RT:S:SELECTOR:SELF:SERVER:SERVERS:SREQCIP:SREQMAC:SRV:STD:STRICT:SUB:SUBMISSION_OPTIONS:TIMEOUTDEFER:TIMES:TRUSTED:TRYCLEAR:UL:USE_SENDER:UTF8:VALUE:WMF:X:Y
+
+(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
---------------
(2) cd into the exim-testsuite-x.xx directory.
-(3) Run "./configure" and then "make". This builds a few auxiliary programs
- that are written in C.
+(3) Run "autoconf" then "./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
-(4) Run "./runtest" (a Perl script) as described below.
+(5) Run "./runtest" (a Perl script) as described below.
-(5) If you want to see what tests are available, run "./listtests".
+(6) If you want to see what tests are available, run "./listtests".
BREAKING OUT OF THE TEST SCRIPT
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.
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
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
"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
unexpectely not empty) is:
. 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
--------------------------
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
These commands are not followed by any input data, or by a line of asterisks.
+
dbmbuild <file1> <file1>
This command runs the exim_dbmbuild utility to build a DBM file. It is used
"write" command (see below) that creates the input file.
+ dumpdb <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.
+ 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.
+
+
+ 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.
+
+
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
to the screen.
+ munge <name>
+
+This command requests custom munging of the test outputs. The munge names
+used are coded in the runtest script.
+
+
need_ipv4
This command must be at the head of a script. If no IPv4 interface has been
are still in existence at the end of the run (for messages that were not
delivered) are not compared with saved versions.
+
no_stderr_check
If this command is encountered anywhere in the script, the stderr output from
different order.
-A number of standard file management commands are recognized. These are cat,
-chmod, chown, cp, ln, ls, du, mkdir, mkfifo, rm, rmdir, 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
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 1 second. 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>] \
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 negociation 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>] \
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.
-Here is a simple server example:
+Here is a simple example of server use in a test script:
server PORT_S
220 Greetings
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
--------------------
git://git.exim.org / users / jgh / exim.git / blobdiff