X-Git-Url: https://git.exim.org/users/jgh/exim.git/blobdiff_plain/05e0ef266cca7b7d72dfb60d8e12c5ff4cf2125a..65f1c92a5c06bb7de867f8d72c7eef5f829daeb4:/test/README diff --git a/test/README b/test/README index 7a7e904a6..e54485788 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 @@ -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: - 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. @@ -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 - 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 @@ -146,6 +148,7 @@ RUNNING THE TEST SUITE 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. @@ -235,6 +238,11 @@ is as follows: 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. @@ -432,6 +440,10 @@ OTHER ISSUES 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 @@ -446,6 +458,9 @@ OTHER ISSUES 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 -------------------------- @@ -662,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. - dumpdb + dump This command runs the exim_dumpdb utility on the testing spool directory, using the database name given, for example: "dumpdb retry". @@ -713,6 +728,12 @@ This command causes the script to sleep for m milliseconds. Nothing is output to the screen. + munge + +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 @@ -815,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 -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. @@ -826,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 -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 [] [] \ @@ -874,13 +897,15 @@ input, details of which are given below. A number of options are implemented: -d causes the server to output debugging information - -t sets a timeout in seconds (default 5) for when the server is + -t sets a timeout (default 5) for when the server is awaiting an incoming connection -noipv4 causes the server not to set up an IPv4 socket -noipv6 causes the server not to set up an IPv6 socket + -i sets an initial pause, to delay before creating the listen sockets + By default, in an IPv6 environment, both kinds of socket are set up. However, the test script knows which interfaces actually exist on the host, and it adds -noipv4 or -noipv6 to the server command as required. An error occurs if both