X-Git-Url: https://git.exim.org/users/jgh/exim.git/blobdiff_plain/cc442294b8c9abfd87bdcb8019574f4e1ed23ea9..12f6998964d44c0a40783162fc37eabe770f4382:/test/README

diff --git a/test/README b/test/README
index b6d06e540..3628da98a 100644
--- 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
-    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
@@ -113,9 +114,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
-    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
 
@@ -142,10 +143,11 @@ RUNNING THE TEST SUITE
 
 (2) cd into the exim-testsuite-x.xx directory.
 
-(3) Run "./configure" and then "make". This builds a few auxiliary programs
-    that are written in C.
+(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
+    Typically that is .../exim/test/trusted_configs
 
 (5) Run "./runtest" (a Perl script) as described below.
 
@@ -419,6 +421,33 @@ OTHER ISSUES
 
 . 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 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.
+
 
 OTHER SCRIPTS AND PROGRAMS
 --------------------------