Testsuite: missing file

[exim.git] / test / README

diff --git a/test/README b/test/README
index 38972042fa8b5b9f8b27bb21099fe9f2422ba6b4..bca17eb18c4abe9fb7d0765068558ad742c92297 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


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


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


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


@@ -847,9 +859,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
 


@@ -864,7 +892,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.


@@ -966,8 +993,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 +1042,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
+(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 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 into 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:
 


@@ -1077,13 +1119,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 byte; 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-