Apply timeout consistently to all malware scanner types

[exim.git] / test / README

diff --git a/test/README b/test/README
index a6bfb00b99470c8a898da2de58dbf0a3da4d5692..80c35117b4de9f0605df5de522563a19cfa3954a 100644 (file)
--- a/test/README
+++ b/test/README
@@ -81,7 +81,8 @@ In order to run this test suite, the following requirements must be met:
     gecos field is empty but there may be anomalies.
 
 (4) The directory into which you unpack the test suite must be accessible by
     gecos field is empty but there may be anomalies.
 
 (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. A
+    the Exim user, so that code running as exim can access the files therein.
+    This includes search-access on all path elements leading to it. A

     world-readable directory is fine. However, there may be problems if the
     path name of the directory is excessively long. This is because it
     sometimes appears in log lines or debug output, and if it is truncated, it
     world-readable directory is fine. However, there may be problems if the
     path name of the directory is excessively long. This is because it
     sometimes appears in log lines or debug output, and if it is truncated, it


@@ -90,9 +91,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.
 


@@ -113,9 +115,9 @@ In order to run this test suite, the following requirements must be met:
     message).
 
 (9) Exim must be built with TRUSTED_CONFIG_LIST support, so that the test
     message).
 
 (9) Exim must be built with TRUSTED_CONFIG_LIST support, so that the test

-    configs can be placed into it. 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:
+    configs can be placed into it.  A suitable file location is .../exim/test/trusted_configs
+    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:

     
      DIR:EXIM_PATH:AA:ACL:ACLRCPT:ACL_MAIL:ACL_PREDATA:ACL_RCPT:AFFIX:ALLOW:ARG1:ARG2:AUTHF:AUTHS:AUTH_ID_DOMAIN:BAD:BANNER:BB:BR:BRB:CERT:COM:COMMAND_USER:CONNECTCOND:CONTROL:CREQCIP:CREQMAC:CRL:CSS:D6:DATA:DCF:DDF:DEFAULTDWC:DELAY:DETAILS:DRATELIMIT:DYNAMIC_OPTION:ELI:ERROR_DETAILS:ERT:FAKE:FALLBACK:FILTER:FILTER_PREPEND_HOME:FORBID:FORBID_SMTP_CODE:FUSER:HAI:HAP:HARDLIMIT:HEADER_LINE_MAXSIZE:HEADER_MAXSIZE:HELO_MSG:HL:HOSTS:HOSTS_AVOID_TLS:HOSTS_MAX_TRY:HVH:IFACE:IGNORE_QUOTA:INC:INSERT:IP1:IP2:LAST:LDAPSERVERS:LENCHECK:LIMIT:LIST:LOG_SELECTOR:LS:MAXNM:MESSAGE_LOGS:MSIZE:NOTDAEMON:ONCE:ONLY:OPT:OPTION:ORDER:PAH:PEX:PORT:PTBC:QDG:QOLL:QUOTA:QUOTA_FILECOUNT:QWM:RCPT_MSG:REMEMBER:REQUIRE:RETRY:RETRY1:RETRY2:RETURN:RETURN_ERROR_DETAILS:REWRITE:ROUTE_DATA:RRATELIMIT:RT:S:SELECTOR:SELF:SERVER:SERVERS:SREQCIP:SREQMAC:SRV:STD:STRICT:SUB:SUBMISSION_OPTIONS:TIMEOUTDEFER:TIMES:TRUSTED:TRYCLEAR:UL:USE_SENDER:UTF8:VALUE:WMF:X:Y
 
     
      DIR:EXIM_PATH:AA:ACL:ACLRCPT:ACL_MAIL:ACL_PREDATA:ACL_RCPT:AFFIX:ALLOW:ARG1:ARG2:AUTHF:AUTHS:AUTH_ID_DOMAIN:BAD:BANNER:BB:BR:BRB:CERT:COM:COMMAND_USER:CONNECTCOND:CONTROL:CREQCIP:CREQMAC:CRL:CSS:D6:DATA:DCF:DDF:DEFAULTDWC:DELAY:DETAILS:DRATELIMIT:DYNAMIC_OPTION:ELI:ERROR_DETAILS:ERT:FAKE:FALLBACK:FILTER:FILTER_PREPEND_HOME:FORBID:FORBID_SMTP_CODE:FUSER:HAI:HAP:HARDLIMIT:HEADER_LINE_MAXSIZE:HEADER_MAXSIZE:HELO_MSG:HL:HOSTS:HOSTS_AVOID_TLS:HOSTS_MAX_TRY:HVH:IFACE:IGNORE_QUOTA:INC:INSERT:IP1:IP2:LAST:LDAPSERVERS:LENCHECK:LIMIT:LIST:LOG_SELECTOR:LS:MAXNM:MESSAGE_LOGS:MSIZE:NOTDAEMON:ONCE:ONLY:OPT:OPTION:ORDER:PAH:PEX:PORT:PTBC:QDG:QOLL:QUOTA:QUOTA_FILECOUNT:QWM:RCPT_MSG:REMEMBER:REQUIRE:RETRY:RETRY1:RETRY2:RETURN:RETURN_ERROR_DETAILS:REWRITE:ROUTE_DATA:RRATELIMIT:RT:S:SELECTOR:SELF:SERVER:SERVERS:SREQCIP:SREQMAC:SRV:STD:STRICT:SUB:SUBMISSION_OPTIONS:TIMEOUTDEFER:TIMES:TRUSTED:TRYCLEAR:UL:USE_SENDER:UTF8:VALUE:WMF:X:Y
 


@@ -142,10 +144,11 @@ RUNNING THE TEST SUITE
 
 (2) cd into the exim-testsuite-x.xx directory.
 
 
 (2) cd into the exim-testsuite-x.xx directory.
 

-(3) Run "sutoconf" then "./configure" and then "make". This builds a few
+(3) Run "autoconf" then "./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
     auxiliary programs that are written in C.
 
 (4) echo $PWD/test-config >> your_TRUSTED_CONFIG_LIST_filename

+    Typically that is .../exim/test/trusted_configs

 
 (5) Run "./runtest" (a Perl script) as described below.
 
 
 (5) Run "./runtest" (a Perl script) as described below.
 


@@ -235,6 +238,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.
 


@@ -419,6 +427,40 @@ OTHER ISSUES
 
 . Test 0142 tests open file descriptors; on some hosts the output may vary.
 
 
 . Test 0142 tests open file descriptors; on some hosts the output may vary.
 

+. Some tests may fail, for example 0022, because it says it uses cached data
+  when the expected output thinks it should not be in cache.  Item #5 in the
+  Requirements section has:
+    "Exim must be built with its user and group specified at build time"
+  This means that you cannot use the "ref:username" in your Local/Makefile
+  when building the exim binary, in any of the following fields:
+    EXIM_USER  EXIM_GROUP  CONFIGURE_OWNER  CONFIGURE_GROUP
+
+. If the runtest script warns that the hostname is not a Fully Qualified
+  Domain Name (FQDN), expect that some tests will fail, for example 0036,
+  with an extra log line saying the hostname doesn't resolve.  You must use a
+  FQDN for the hostname for proper test functionality.
+
+. If you change your hostname to a FQDN, you must delete the test/dnszones
+  subdirectory.  When you next run the runtest script, it will rebuild the
+  content to use the new hostname.
+
+. If your hostname has an uppercase characters in it, expect that some tests
+  will fail, for example, 0036, because some log lines will have the hostname
+  in all lowercase.  The regex which extracts the hostname from the log lines
+  will not match the lowercased version.
+
+. Some tests may fail, for example 0015, with a cryptic error message:
+    Server return code 99
+  Due to security concerns, some specific files MUST have the group write bit
+  off.  For the purposes of the test suite, some test/aux-fixed/* files MUST
+  have the group write bit off, so it's easier to just remove the group write
+  bit for all of them.  If your umask is set to 002, the group write bit will
+  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
 --------------------------


@@ -635,7 +677,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".


@@ -686,6 +728,12 @@ This command causes the script to sleep for m milliseconds. Nothing is output
 to the screen.
 
 
 to the screen.
 
 

+  munge <name>
+
+This command requests custom munging of the test outputs.  The munge names
+used are coded in the runtest script (look for 'name of munge').
+
+

   need_ipv4
 
 This command must be at the head of a script. If no IPv4 interface has been
   need_ipv4
 
 This command must be at the head of a script. If no IPv4 interface has been


@@ -788,7 +836,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.


@@ -799,9 +847,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>] \