-$Cambridge: exim/test/README,v 1.3 2006/04/25 14:02:30 ph10 Exp $
-
EXPORTABLE EXIM TEST SUITE
--------------------------
This document last updated for:
-Test Suite Version: 4.61
-Date: 06 February 2006
+Test Suite Version: 4.67
+Date: 20 February 2007
BACKGROUND
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
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:
-(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
- 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
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
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.
+ 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.
(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
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
following example:
$ 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
-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
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
===============
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:
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 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.
+
+
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
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
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
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:
+Here follows a list of supported commands. They can be divided into two groups:
Commands with no input
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
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.
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>] \
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 / heiko / exim.git / blobdiff