Testsuite: separate cases for TLS resumption with/out OCSP

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

diff --git a/test/README b/test/README
index a600756be0c12f55067159264d3c138f9873ef0a..d944b29ac8ec792b96908499f8b84f2275228c66 100644 (file)
--- a/test/README
+++ b/test/README
@@ -115,7 +115,7 @@ In order to run this test suite, the following requirements must be met:
     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
     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
 
 (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


@@ -146,13 +146,13 @@ the extra functionality, except for a few special cases such as the databases
 RUNNING THE TEST SUITE
 ----------------------
 
 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
 
 (4) echo $PWD/test-config >> your_TRUSTED_CONFIG_LIST_filename
     Typically that is .../exim/test/trusted_configs


@@ -269,7 +269,7 @@ There are some options for the ./runtest script itself:
             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.
             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/*.)
 
             flavours are computed after file name extensions in stdout/*
             and stderr/*.)
 


@@ -298,6 +298,9 @@ There are some options for the ./runtest script itself:
             maintainer after making a change to the code that affects a lot of
             tests (for example, the wording of a message).
 
             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
+

 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
 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


@@ -416,7 +419,7 @@ after doing any further comparisons that may be necessary.
 
 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
 
 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]
 
 
   Continue, Show, or Quit? [Q]
 


@@ -514,6 +517,9 @@ bin/client-ssl     A script-driven SMTP client simulation with OpenSSL support.
                    This is built only if OpenSSL support is detected on the
                    host.
 
                    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.
 bin/fakens         A fake "nameserver" for DNS tests (see below for details).
 
 bin/fd             A program that outputs details of open file descriptors.


@@ -685,7 +691,7 @@ 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
 
 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.
 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.


@@ -699,6 +705,11 @@ Commands with no input
 These commands are not followed by any input data, or by a line of asterisks.
 
 
 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
   dbmbuild <file1> <file1>
 
 This command runs the exim_dbmbuild utility to build a DBM file. It is used


@@ -721,7 +732,8 @@ scripts.
   exim_lock [options] <file name>
 
 This command runs the exim_lock utility with the given options and file name.
   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>
 
 
   exinext <data>


@@ -778,7 +790,7 @@ found, the entire script is skipped, and a comment is output.
   need_largefiles
 
 This command must be at the head of a script. If the Exim binary does not
   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.
 
 
 comment is output.
 
 


@@ -884,7 +896,7 @@ 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 for the connection.
 There are two additional options: -tls-on-connect, that causes the client to
 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.
 
 negotiation to include a certificate-status request.  The latter takes a
 filename argument, the CA info for verifying the stapled response.
 


@@ -966,8 +978,9 @@ connections. Here are some example commands:
 
 The following lines, up to a line of four asterisks, are the server's
 controlling standard input (described below). These lines are read and
 
 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]]*
 
 
   write <file name> [nxm[=start-of-line-text]]*


@@ -1014,24 +1027,38 @@ one-off things to be done.
 CLIENT SCRIPTS
 --------------
 
 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
     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.
 
 
 (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.
 
     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.
 
     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 intto 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.
     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.
     byte value.  Any other character following a \ is sent verbatim.

+    The line is sent with a trailing "\r\n".

 
 Here is a simple example:
 
 
 Here is a simple example:
 


@@ -1135,7 +1162,7 @@ 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.
 
 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.
 
 
 section.