Testsuite: munge for OpenSSL 3.2.1

[exim.git] / test / README

diff --git a/test/README b/test/README
index a6bcfd89768d3ace2cf513bcaf3a03ecf4fa03a5..67df4745371a3902827cf4e8e7bbeeb725d1d426 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


@@ -301,6 +301,11 @@ There are some options for the ./runtest script itself:
   -SLOW     For very slow hosts that appear to have Heisenbugs, delay before
             comparing output files from a testcase
 
   -SLOW     For very slow hosts that appear to have Heisenbugs, delay before
             comparing output files from a testcase
 

+  -TLS <client>  For cross-library testing. Specify 'openssl" or 'gnutls'
+            as the client; the other is used as the server (assumes that
+           both have been built: set up Local/Makefile for OpenSSL and
+           "make exim_openssl", then for GnuTLS and "make exim_gnutls")
+

 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


@@ -517,6 +522,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.


@@ -673,7 +681,12 @@ script. For example:
   # -bS Use of HELO/RSET
 
 A line consisting just of digits is interpreted as the expected return code
   # -bS Use of HELO/RSET
 
 A line consisting just of digits is interpreted as the expected return code

-for the command that follows. The default expectation when no such line exists
+for the command that follows.
+
+A line consisting of a tilde (~) followed by digits indicates a non-expected
+return code for the command that follows.
+
+The default expectation when neither such line exists

 is a zero return code. For example, here is a complete test script, containing
 just one command:
 
 is a zero return code. For example, here is a complete test script, containing
 just one command:
 


@@ -693,6 +706,17 @@ 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.
 
 several lines by using \ as a continuation character. This does *not* apply to
 data lines.
 

+A line with a leading number followed by a space and then an uppercase
+word, equals character, value sets an expected return code as above
+plus an environment variable.  Example:
+
+  255 TZ=GB
+  exim_msgdate -l -u -z -localhost_number=20 000000 1PANS3 ZZZZZZ
+  ****
+
+
+
+

 Here follows a 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:
 
 


@@ -729,7 +753,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>


@@ -743,6 +768,12 @@ This command runs the exigrep utility with the given data (the search pattern)
 on the current mainlog file.
 
 
 on the current mainlog file.
 
 

+  exiqgrep <data>
+
+This command runs the exiqgrep utility with the given options
+on the current spool directory.
+
+

   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


@@ -810,6 +841,14 @@ are still in existence at the end of the run (for messages that were not
 delivered) are not compared with saved versions.
 
 
 delivered) are not compared with saved versions.
 
 

+  no_munge
+
+If this command is encountered anywhere in the script, the output is not
+munged before it is compared with a saved version.
+This option allows meaningful tests of the exim_msgdate utility;
+without it all date comparison checks would succeed.
+
+

   no_stderr_check
 
 If this command is encountered anywhere in the script, the stderr output from
   no_stderr_check
 
 If this command is encountered anywhere in the script, the stderr output from


@@ -855,9 +894,25 @@ Commands with input
 -------------------
 
 The remaining commands are followed by data lines for their standard input,
 -------------------
 
 The remaining commands are followed by data lines for their standard input,

-terminated by four asterisks. Even if no data is required for the particular
+terminated by four asterisks ("****"). Even if no data is required for the particular

 usage, the asterisks must be given.
 
 usage, the asterisks must be given.
 

+If the input line starts with ':<cmd>:', this prefix is removed and the
+line is processed by the runtest script before sending. The following
+commands are recognised:
+
+- "eval": process the reset of the line with Perl's string eval()
+  function. This can be used to send arbitrary data by encoding it as
+  escape sequences (e.g. "\x41\101"). If you need a line ending, you have
+  to append it accordingly (e.g. "\r\n").
+
+- "noeol": do not terminate the data sent to the application with an end
+  of line character.
+
+- "sleep": interpret the rest of the line as an integer and sleep for
+  that number of seconds before proceeding. No data will be output to
+  the application.
+

 
   background
 
 
   background
 


@@ -872,7 +927,6 @@ except that the data it generates is copied to the end of the test-stdout file
 as well as to the named file.
 
 
 as well as to the named file.
 
 

-

   client [<options>] <ip address> <port> [<outgoing interface>]
 
 This command runs the auxiliary "client" program that simulates an SMTP client.
   client [<options>] <ip address> <port> [<outgoing interface>]
 
 This command runs the auxiliary "client" program that simulates an SMTP client.


@@ -974,8 +1028,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]]*


@@ -1024,28 +1079,28 @@ CLIENT SCRIPTS
 
 Lines in client scripts are of several 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
+(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.
 
     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 begins with three question marks and an asterisk, the server
+(2) "???*": If a line begins with three question marks and an asterisk, the server

     is expected to close the connection.
 
     is expected to close the connection.
 

-(3) If a line begins with four question marks, the rest of the line defines
+(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.
 
     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
+(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.
 

-(5) 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.
 

-(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
+(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 into the script

     at this point.
 
 (7) Otherwise, the line is an input line line that is sent to the server. Any
     at this point.
 
 (7) Otherwise, the line is an input line line that is sent to the server. Any


@@ -1099,13 +1154,16 @@ are of the following kinds:
 (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.
 

-(3) A line containing "*eof" specifies that the client is expected to close
+(3) A line containing "*data" and a number specifies that the client is
+    expected to send that many bytes; the server discards them
+
+(4) A line containing "*eof" specifies that the client is expected to close

     the connection at this point.
 
     the connection at this point.
 

-(4) A line containing just '.' specifies that the client is expected to send
+(5) A line containing just '.' specifies that the client is expected to send

     many lines, terminated by one that contains just a dot.
 
     many lines, terminated by one that contains just a dot.
 

-(5) Otherwise, the line defines the start of an input line that the client
+(6) 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
     lines starts with '<<' then only the characters are expected; no return-
     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
     lines starts with '<<' then only the characters are expected; no return-