Get TLS SNI server-switching working with GnuTLS.

[users/heiko/exim.git] / test / README

diff --git a/test/README b/test/README
index 43d641375f2d6ddf935ccb2581dc491d5d4a93b6..4fd16eb9db7e267759197af5b6861ef710aac2c4 100644 (file)
--- a/test/README
+++ b/test/README
@@ -1,12 +1,10 @@
-$Cambridge: exim/test/README,v 1.5 2006/10/31 11:37:47 ph10 Exp $
-

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

-Test Suite Version: 4.64
-Date: 31 October 2006
+Test Suite Version: 4.67
+Date: 20 February 2007

 
 
 BACKGROUND
 
 
 BACKGROUND


@@ -65,8 +63,15 @@ 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.
+    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
 
 (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


@@ -107,6 +112,18 @@ In order to run this test suite, the following requirements must be met:
     interface; when one is not found, some tests are skipped (with a warning
     message).
 
     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. 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
 ---------------
 
 OPTIONAL EXTRAS
 ---------------


@@ -125,12 +142,14 @@ RUNNING THE TEST SUITE
 
 (2) cd into the exim-testsuite-x.xx directory.
 
 
 (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

 
 

-(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
 
 
 BREAKING OUT OF THE TEST SCRIPT


@@ -342,7 +361,7 @@ default, the output is from 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


@@ -351,7 +370,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


@@ -361,6 +380,8 @@ 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
 unexpectely not empty) 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:


@@ -436,7 +457,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


@@ -633,6 +658,12 @@ The file remains locked with the following command (normally exim) is obeyed.
 This command runs the exinext utility with the given argument 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
 
 This command is present at the start of all but one of the tests that use


@@ -755,9 +786,12 @@ 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
 
 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>] \
 
 
   client-ssl [<options>] <ip address> <port> [<outgoing interface>] \


@@ -951,7 +985,7 @@ are of the following kinds:
     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.
 
     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
 
   server PORT_S
   220 Greetings


@@ -974,6 +1008,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
 --------------------