Testsuite: Fix the [U]pdate for new testcases

[exim.git] / test / README

diff --git a/test/README b/test/README
index ef91049cc3dd3c6cd1242fb7781a6a55a64117ac..2a3fa00c8ec29309f8bdc2b2299e15145c114e62 100644 (file)
--- a/test/README
+++ b/test/README
@@ -79,6 +79,8 @@ In order to run this test suite, the following requirements must be met:
     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.
     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
     the Exim user, so that code running as exim can access the files therein.
 
 (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.


@@ -91,9 +93,10 @@ In order to run this test suite, the following requirements must be met:
 (5) Exim must be built with its user and group specified at build time, and
     with certain minimum facilities, namely:
 
 (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,6 +118,9 @@ In order to run this test suite, the following requirements must be met:
 
 (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
 
 (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.  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:
     
     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:
     


@@ -237,6 +243,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.
 


@@ -452,6 +463,9 @@ OTHER ISSUES
   be on by default and you'll see this problem, so make sure your umask is
   022 and re-checkout the test/ subdirectory.
 
   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
 --------------------------


@@ -668,7 +682,7 @@ 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.
 
 

-  dumpdb <dbname>
+  dump <dbname>

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


@@ -722,7 +736,7 @@ to the screen.
   munge <name>
 
 This command requests custom munging of the test outputs.  The munge names
   munge <name>
 
 This command requests custom munging of the test outputs.  The munge names

-used are coded in the runtest script.
+used are coded in the runtest script (look for 'name of munge').

 
 
   need_ipv4
 
 
   need_ipv4


@@ -827,7 +841,7 @@ 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. 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
 It is controlled by a script read from its standard input, details of which are
 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
+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 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.


@@ -838,9 +852,11 @@ 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 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>] \
 
 
   client-gnutls [<options>] <ip address> <port> [<outgoing interface>] \


@@ -871,6 +887,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>]
 


@@ -886,13 +907,15 @@ 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
+  -t <sec> sets a timeout (default 5) for when the server is

            awaiting an incoming connection
 
   -noipv4  causes the server not to set up an IPv4 socket
 
   -noipv6  causes the server not to set up an IPv6 socket
 
            awaiting an incoming connection
 
   -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


@@ -1008,7 +1031,10 @@ 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.


@@ -1022,7 +1048,10 @@ are of the following kinds:
 (5) 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
 (5) 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

-    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 example of server use in a test script:
 
 
 Here is a simple example of server use in a test script: