FAQ of running test suite
[exim.git] / test / README
index c1398329df67b430aeac93bf4c08eabe009c92ba..7a7e904a669b77ce9f1cb51951f7c3ce6f8aa17f 100644 (file)
@@ -1,5 +1,3 @@
-$Cambridge: exim/test/README,v 1.8 2007/02/20 15:58:02 ph10 Exp $
-
 EXPORTABLE EXIM TEST SUITE
 --------------------------
 
@@ -65,8 +63,15 @@ In order to run this test suite, the following requirements must be met:
       Defaults timestamp_timeout=480
 
     in /etc/sudoers, a password lasts for 8 hours (a working day). It is
-    probably not a good idea to run the tests as the Exim user, as this is
-    recognized as special by Exim.
+    not permitted to run the tests as the Exim user because the test suite
+    tracks the two users independently.  Using the same user would result
+    in false positives on some tests.
+
+    Further, some tests invoke sudo in an environment where there might not be
+    a TTY, so tickets should be global, not per-TTY.  Taking this all together
+    and assuming a user of "exim-build", you might have this in sudoers:
+
+      Defaults:exim-build     timestamp_timeout=480,!tty_tickets
 
 (3) The login under which you run the tests must be in the exim group so that
     it has access to logs, spool files, etc. The login should not be one of the
@@ -107,6 +112,18 @@ In order to run this test suite, the following requirements must be met:
     interface; when one is not found, some tests are skipped (with a warning
     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:
+    
+     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
+
+(10) Exim must *not* be built with USE_READLINE, as the test-suite's automation
+     assumes the simpler I/O model.
+     Exim must *not* be built with HEADERS_CHARSET set to UTF-8.
+
+
 
 OPTIONAL EXTRAS
 ---------------
@@ -125,12 +142,14 @@ 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
 
-(4) Run "./runtest" (a Perl script) as described below.
+(5) Run "./runtest" (a Perl script) as described below.
 
-(5) If you want to see what tests are available, run "./listtests".
+(6) If you want to see what tests are available, run "./listtests".
 
 
 BREAKING OUT OF THE TEST SCRIPT
@@ -342,7 +361,7 @@ default, the output is from the "cf" program, and might look like this:
   1 difference found.
   "test-stdout-munged" contains 16 lines; "stdout/1300" contains 18 lines.
 
-  Continue, Update & retry, Quit? [Q]
+  Continue, Retry, Update & retry, Quit? [Q]
 
 This example was generated by running the test with a version of Exim
 that had a bug in the exim_dbmbuild utility (the bug was fixed at release
@@ -351,7 +370,7 @@ used. In this case, the standard output differed from what was expected.
 
 The reply to the prompt must either be empty, in which case it takes the
 default that is given in brackets (in this case Q), or a single letter, in
-upper or lower case (in this case, one of C, U, or Q). If you type anything
+upper or lower case (in this case, one of C, R, U, or Q). If you type anything
 else, the prompt is repeated.
 
 "Continue" carries on as if the files had matched; that is, it ignores the
@@ -361,6 +380,8 @@ moving on to the next test.
 "Update & retry" copies the new file to the saved file, and reruns the test
 after doing any further comparisons that may be necessary.
 
+"Retry" does the same apart from the file copy.
+
 Other circumstances give rise to other prompts. If a test generates output for
 which there is no saved data, the prompt (after a message stating which file is
 unexpectely not empty) is:
@@ -398,6 +419,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
 --------------------------