Use ALARM() to set deadline on reading the proxy header (Bug 2656)

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

diff --git a/test/README b/test/README
index f4eeddbb454dc0096b05154a3c083a33bba893e1..7a852ee43ed074956c17ae8eb81f3f6b3fd2c5d7 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


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


@@ -702,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


@@ -724,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>


@@ -853,6 +862,16 @@ 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
 usage, the asterisks must be given.
 
 terminated by four asterisks. Even if no data is required for the particular
 usage, the asterisks must be given.
 

+If the input line starts with '>>> ', this prefix and any trailing spaces
+(including line feed) are removed. The reminder is processed with Perl's
+string eval() function, effectivly evaluatiing escape sequences like
+'\x41', or '\r'.  If you need a line feed there, you need to encode it
+according to your needs.
+
+If the input line starts with '\>>> ', the backslash is removed and the
+rest of the line is passed as input. This is used by the client tool,
+which understands the '>>> ' prefix for similar processing.
+

 
   background
 
 
   background
 


@@ -867,7 +886,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.


@@ -969,8 +987,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]]*


@@ -1023,21 +1042,33 @@ Lines in client scripts are of several kinds:
     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 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
     line is input to be sent to the server.  Backslash escaping is done as

-    described below, but no trailing "\r\n" is sent.
+    described below, but no trailing "\r\n" is sent. As the runtest's 
+    input processing catches the '>>> ' for its string eval, you may
+    want to escape from this first stage processing by prefixing your
+    line with '\'.

 
 

-(4) 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.
 
     at this point.
 

-(5) Otherwise, the line is an input line line that is sent to the server. Any
+(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.
     The line is sent with a trailing "\r\n".
 
     byte value.  Any other character following a \ is sent verbatim.
     The line is sent with a trailing "\r\n".