X-Git-Url: https://git.exim.org/users/heiko/exim.git/blobdiff_plain/1b781f48b407ebb827db510c4b50d5ce348265f6..159f52d231c010cbc4e149502b7f906293233f94:/test/README diff --git a/test/README b/test/README index 232b9e96c..b93deb4c5 100644 --- a/test/README +++ b/test/README @@ -1,12 +1,12 @@ -$Cambridge: exim/test/README,v 1.4 2006/07/26 14:39:13 ph10 Exp $ +$Cambridge: exim/test/README,v 1.8 2007/02/20 15:58:02 ph10 Exp $ EXPORTABLE EXIM TEST SUITE -------------------------- This document last updated for: -Test Suite Version: 4.63 -Date: 25 July 2006 +Test Suite Version: 4.67 +Date: 20 February 2007 BACKGROUND @@ -65,8 +65,9 @@ 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. (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 +108,14 @@ 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 + + OPTIONAL EXTRAS --------------- @@ -128,9 +137,11 @@ RUNNING THE TEST SUITE (3) Run "./configure" and then "make". This builds a few auxiliary programs that are written in C. -(4) Run "./runtest" (a Perl script) as described below. +(4) ls -1 $PWD/confs/* >> your_TRUSTED_CONFIG_LIST_filename + +(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 @@ -436,7 +447,11 @@ bin/iefbr14 A program that does nothing, and returns 0. It's just like bin/loaded Some dynamically loaded functions for testing dlfunc support. -bin/server A script-driven SMTP server simulation. +bin/mtpscript A script-driven SMTP/LMTP server simulation, on std{in,out}. + +bin/server A script-driven SMTP server simulation, over a socket. + +bin/showids Output the current uid, gid, euid, egid. The runtest script also makes use of a number of ordinary commands such as "cp", "kill", "more", and "rm", via the system() call. In some cases these are @@ -602,6 +617,7 @@ Commands with no input These commands are not followed by any input data, or by a line of asterisks. + dbmbuild This command runs the exim_dbmbuild utility to build a DBM file. It is used @@ -609,19 +625,41 @@ 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 + +This command runs the exim_dumpdb utility on the testing spool directory, using +the database name given, for example: "dumpdb retry". + + echo The text is written to the screen; this is used to output comments from scripts. + exim_lock [options] + +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. + + + exinext + +This command runs the exinext utility with the given argument data. + + + exigrep + +This command runs the exigrep utility with the given data (the search pattern) +on the current mainlog file. + + gnutls This command is present at the start of all but one of the tests that use GnuTLS. It copies a pre-existing parameter file into the spool directory, so that Exim does not have to re-create the file each time. The first GnuTLS test -does not do this, in order to test that Exim can create the file (it takes some -time). +does not do this, in order to test that Exim can create the file. killdaemon @@ -676,6 +714,7 @@ If this command is encountered anywhere in the script, message log files that are still in existence at the end of the run (for messages that were not delivered) are not compared with saved versions. + no_stderr_check If this command is encountered anywhere in the script, the stderr output from @@ -712,9 +751,9 @@ deliveries because on different systems the processes may terminate in a different order. -A number of standard file management commands are recognized. These are cat, -chmod, chown, cp, ln, ls, du, mkdir, mkfifo, rm, rmdir, and touch. Some are run -as root using "sudo". +A number of standard file management commands are also recognized. These are +cat, chmod, chown, cp, du, ln, ls, du, mkdir, mkfifo, rm, rmdir, and touch. +Some are run as root using "sudo". Commands with input @@ -737,9 +776,12 @@ as well as to the named file. 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. The only option is -t, which must be followed by a number, to -specify the command timeout in seconds. The program connects to the given IP -address and port, using the specified interface, if one is given. +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 +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-ssl [] [] \ @@ -933,7 +975,7 @@ are of the following kinds: may start with '<', which is not taken as part of the input data. If the input does not match, the server bombs out with an error message. -Here is a simple server example: +Here is a simple example of server use in a test script: server PORT_S 220 Greetings @@ -956,6 +998,11 @@ After a "server" command in a test script, the server runs in parallel until an messages to port PORT_S on the local host. When it has finished, the test script waits for the "server" process to finish. +The "mtpscript" program is like "server", except that it uses stdin/stdout for +its input and output instead of a script. However, it is not called from test +scripts; instead it is used as the command for pipe transports in some +configurations, to simulate non-socket LMTP servers. + AUXILIARY DATA FILES --------------------