3 # $Cambridge: exim/test/runtest,v 1.37 2010/06/14 20:30:12 jetmore Exp $
5 ###############################################################################
6 # This is the controlling script for the "new" test suite for Exim. It should #
7 # be possible to export this suite for running on a wide variety of hosts, in #
8 # contrast to the old suite, which was very dependent on the environment of #
9 # Philip Hazel's desktop computer. This implementation inspects the version #
10 # of Exim that it finds, and tests only those features that are included. The #
11 # surrounding environment is also tested to discover what is available. See #
12 # the README file for details of how it all works. #
14 # Implementation started: 03 August 2005 by Philip Hazel #
15 # Placed in the Exim CVS: 06 February 2006 #
16 ###############################################################################
24 # Start by initializing some global variables
26 $testversion = "4.72 (02-Jun-10)";
28 $cf = "bin/cf -exact";
42 $test_end = $test_top = 8999;
43 $test_special_top = 9999;
48 # Networks to use for DNS tests. We need to choose some networks that will
49 # never be used so that there is no chance that the host on which we are
50 # running is actually in one of the test networks. Private networks such as
51 # the IPv4 10.0.0.0/8 network are no good because hosts may well use them.
52 # Rather than use some unassigned numbers (that might become assigned later),
53 # I have chosen some multicast networks, in the belief that such addresses
54 # won't ever be assigned to hosts. This is the only place where these numbers
55 # are defined, so it is trivially possible to change them should that ever
58 $parm_ipv4_test_net = "224";
59 $parm_ipv6_test_net = "ff00";
61 # Port numbers are currently hard-wired
63 $parm_port_n = 1223; # Nothing listening on this port
64 $parm_port_s = 1224; # Used for the "server" command
65 $parm_port_d = 1225; # Used for the Exim daemon
66 $parm_port_d2 = 1226; # Additional for daemon
67 $parm_port_d3 = 1227; # Additional for daemon
68 $parm_port_d4 = 1228; # Additional for daemon
72 ###############################################################################
73 ###############################################################################
75 # Define a number of subroutines
77 ###############################################################################
78 ###############################################################################
81 ##################################################
83 ##################################################
85 sub pipehandler { $sigpipehappened = 1; }
87 sub inthandler { print "\n"; tests_exit(-1, "Caught SIGINT"); }
90 ##################################################
91 # Do global macro substitutions #
92 ##################################################
94 # This function is applied to configurations, command lines and data lines in
95 # scripts, and to lines in the files of the aux-var-src and the dnszones-src
96 # directory. It takes one argument: the current test number, or zero when
97 # setting up files before running any tests.
100 s?\bCALLER\b?$parm_caller?g;
101 s?\bCALLERGROUP\b?$parm_caller_group?g;
102 s?\bCALLER_UID\b?$parm_caller_uid?g;
103 s?\bCALLER_GID\b?$parm_caller_gid?g;
104 s?\bCLAMSOCKET\b?$parm_clamsocket?g;
105 s?\bDIR/?$parm_cwd/?g;
106 s?\bEXIMGROUP\b?$parm_eximgroup?g;
107 s?\bEXIMUSER\b?$parm_eximuser?g;
108 s?\bHOSTIPV4\b?$parm_ipv4?g;
109 s?\bHOSTIPV6\b?$parm_ipv6?g;
110 s?\bHOSTNAME\b?$parm_hostname?g;
111 s?\bPORT_D\b?$parm_port_d?g;
112 s?\bPORT_D2\b?$parm_port_d2?g;
113 s?\bPORT_D3\b?$parm_port_d3?g;
114 s?\bPORT_D4\b?$parm_port_d4?g;
115 s?\bPORT_N\b?$parm_port_n?g;
116 s?\bPORT_S\b?$parm_port_s?g;
117 s?\bTESTNUM\b?$_[0]?g;
118 s?(\b|_)V4NET([\._])?$1$parm_ipv4_test_net$2?g;
119 s?\bV6NET:?$parm_ipv6_test_net:?g;
124 ##################################################
125 # Subroutine to tidy up and exit #
126 ##################################################
128 # In all cases, we check for any Exim daemons that have been left running, and
129 # kill them. Then remove all the spool data, test output, and the modified Exim
130 # binary if we are ending normally.
133 # $_[0] = 0 for a normal exit; full cleanup done
134 # $_[0] > 0 for an error exit; no files cleaned up
135 # $_[0] < 0 for a "die" exit; $_[1] contains a message
141 # Search for daemon pid files and kill the daemons. We kill with SIGINT rather
142 # than SIGTERM to stop it outputting "Terminated" to the terminal when not in
145 if (opendir(DIR, "spool"))
147 my(@spools) = sort readdir(DIR);
149 foreach $spool (@spools)
151 next if $spool !~ /^exim-daemon./;
152 open(PID, "spool/$spool") || die "** Failed to open \"spool/$spool\": $!\n";
155 print "Tidyup: killing daemon pid=$pid\n";
156 system("sudo rm -f spool/$spool; sudo kill -SIGINT $pid");
160 { die "** Failed to opendir(\"spool\"): $!\n" unless $!{ENOENT}; }
162 # Close the terminal input and remove the test files if all went well, unless
163 # the option to save them is set. Always remove the patched Exim binary. Then
164 # exit normally, or die.
167 system("sudo /bin/rm -rf ./spool test-* ./dnszones/*")
168 if ($rc == 0 && !$save_output);
170 system("sudo /bin/rm -rf ./eximdir/*");
171 exit $rc if ($rc >= 0);
172 die "** runtest error: $_[1]\n";
177 ##################################################
178 # Subroutines used by the munging subroutine #
179 ##################################################
181 # This function is used for things like message ids, where we want to generate
182 # more than one value, but keep a consistent mapping throughout.
185 # $oldid the value from the file
186 # $base a base string into which we insert a sequence
187 # $sequence the address of the current sequence counter
190 my($oldid, $base, $sequence) = @_;
191 my($newid) = $cache{$oldid};
192 if (! defined $newid)
194 $newid = sprintf($base, $$sequence++);
195 $cache{$oldid} = $newid;
201 # This is used while munging the output from exim_dumpdb. We cheat by assuming
202 # that the date always the same, and just return the number of seconds since
206 my($day,$month,$year,$hour,$min,$sec) =
207 $_[0] =~ /^(\d\d)-(\w\w\w)-(\d{4})\s(\d\d):(\d\d):(\d\d)/;
208 return $hour * 60 * 60 + $min * 60 + $sec;
212 # This is a subroutine to sort maildir files into time-order. The second field
213 # is the microsecond field, and may vary in length, so must be compared
217 return $a cmp $b if ($a !~ /^\d+\.H\d/ || $b !~ /^\d+\.H\d/);
218 my($x1,$y1) = $a =~ /^(\d+)\.H(\d+)/;
219 my($x2,$y2) = $b =~ /^(\d+)\.H(\d+)/;
220 return ($x1 != $x2)? ($x1 <=> $x2) : ($y1 <=> $y2);
225 ##################################################
226 # Subroutine list files below a directory #
227 ##################################################
229 # This is used to build up a list of expected mail files below a certain path
230 # in the directory tree. It has to be recursive in order to deal with multiple
233 sub list_files_below {
238 opendir(DIR, $dir) || tests_exit(-1, "Failed to open $dir: $!");
239 @sublist = sort maildirsort readdir(DIR);
242 foreach $file (@sublist)
244 next if $file eq "." || $file eq ".." || $file eq "CVS";
246 { @yield = (@yield, list_files_below("$dir/$file")); }
248 { push @yield, "$dir/$file"; }
256 ##################################################
257 # Munge a file before comparing #
258 ##################################################
260 # The pre-processing turns all dates, times, Exim versions, message ids, and so
261 # on into standard values, so that the compare works. Perl's substitution with
262 # an expression provides a neat way to do some of these changes.
264 # We keep a global associative array for repeatedly turning the same values
265 # into the same standard values throughout the data from a single test.
266 # Message ids get this treatment (can't be made reliable for times), and
267 # times in dumped retry databases are also handled in a special way, as are
268 # incoming port numbers.
270 # On entry to the subroutine, the file to write to is already opened with the
271 # name MUNGED. The input file name is the only argument to the subroutine.
272 # Certain actions are taken only when the name contains "stderr", "stdout",
273 # or "log". The yield of the function is 1 if a line matching "*** truncated
274 # ***" is encountered; otherwise it is 0.
281 open(IN, "$file") || tests_exit(-1, "Failed to open $file: $!");
283 my($is_log) = $file =~ /log/;
284 my($is_stdout) = $file =~ /stdout/;
285 my($is_stderr) = $file =~ /stderr/;
289 $date = "\\d{2}-\\w{3}-\\d{4}\\s\\d{2}:\\d{2}:\\d{2}";
291 # Pattern for matching pids at start of stderr lines; initially something
294 $spid = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
296 # Scan the file and make the changes. Near the bottom there are some changes
297 # that are specific to certain file types, though there are also some of those
302 # Check for "*** truncated ***"
303 $yield = 1 if /\*\*\* truncated \*\*\*/;
305 # Replace the name of this host
306 s/\Q$parm_hostname\E/the.local.host.name/g;
308 # But convert "name=the.local.host address=127.0.0.1" to use "localhost"
309 s/name=the\.local\.host address=127\.0\.0\.1/name=localhost address=127.0.0.1/g;
311 # Replace the path to the testsuite directory
312 s?\Q$parm_cwd\E?TESTSUITE?g;
314 # Replace the Exim version number (may appear in various places)
315 s/Exim \d+\.\d+[\w-]*/Exim x.yz/i;
317 # Replace Exim message ids by a unique series
318 s/((?:[^\W_]{6}-){2}[^\W_]{2})
319 /new_value($1, "10Hm%s-0005vi-00", \$next_msgid)/egx;
321 # The names of lock files appear in some error and debug messages
322 s/\.lock(\.[-\w]+)+(\.[\da-f]+){2}/.lock.test.ex.dddddddd.pppppppp/;
324 # Unless we are in an IPv6 test, replace IPv4 and/or IPv6 in "listening on
325 # port" message, because it is not always the same.
326 s/port (\d+) \([^)]+\)/port $1/g
327 if !$is_ipv6test && m/listening for SMTP(S?) on port/;
329 # Challenges in SPA authentication
330 s/TlRMTVNTUAACAAAAAAAAAAAoAAABgg[\w+\/]+/TlRMTVNTUAACAAAAAAAAAAAoAAABggAAAEbBRwqFwwIAAAAAAAAAAAAt1sgAAAAA/;
333 s?prvs=([^/]+)/[\da-f]{10}@?prvs=$1/xxxxxxxxxx@?g; # Old form
334 s?prvs=[\da-f]{10}=([^@]+)@?prvs=xxxxxxxxxx=$1@?g; # New form
336 # Error lines on stdout from SSL contain process id values and file names.
337 # They also contain a source file name and line number, which may vary from
338 # release to release.
339 s/^\d+:error:/pppp:error:/;
340 s/:(?:\/[^\s:]+\/)?([^\/\s]+\.c):\d+:/:$1:dddd:/;
342 # There are differences in error messages between OpenSSL versions
343 s/SSL_CTX_set_cipher_list/SSL_connect/;
345 # One error test in expansions mentions base 62 or 36
346 s/is not a base (36|62) number/is not a base 36\/62 number/;
348 # This message sometimes has a different number of seconds
349 s/forced fail after \d seconds/forced fail after d seconds/;
351 # This message may contain a different DBM library name
352 s/Failed to open \S+( \([^\)]+\))? file/Failed to open DBM file/;
354 # The message for a non-listening FIFO varies
355 s/:[^:]+: while opening named pipe/: Error: while opening named pipe/;
357 # The name of the shell may vary
358 s/\s\Q$parm_shell\E\b/ SHELL/;
360 # Debugging output of lists of hosts may have different sort keys
361 s/sort=\S+/sort=xx/ if /^\S+ (?:\d+\.){3}\d+ mx=\S+ sort=\S+/;
363 # Random local part in callout cache testing
364 s/myhost.test.ex-\d+-testing/myhost.test.ex-dddddddd-testing/;
366 # File descriptor numbers may vary
367 s/^writing data block fd=\d+/writing data block fd=dddd/;
368 s/running as transport filter: write=\d+ read=\d+/running as transport filter: write=dddd read=dddd/;
371 # ======== Dumpdb output ========
372 # This must be before the general date/date munging.
373 # Time data lines, which look like this:
374 # 25-Aug-2000 12:11:37 25-Aug-2000 12:11:37 26-Aug-2000 12:11:37
375 if (/^($date)\s+($date)\s+($date)(\s+\*)?\s*$/)
377 my($date1,$date2,$date3,$expired) = ($1,$2,$3,$4);
378 $expired = "" if !defined $expired;
379 my($increment) = date_seconds($date3) - date_seconds($date2);
381 # We used to use globally unique replacement values, but timing
382 # differences make this impossible. Just show the increment on the
385 printf MUNGED ("first failed = time last try = time2 next try = time2 + %s%s\n",
386 $increment, $expired);
390 # more_errno values in exim_dumpdb output which are times
391 s/T:(\S+)\s-22\s(\S+)\s/T:$1 -22 xxxx /;
394 # ======== Dates and times ========
396 # Dates and times are all turned into the same value - trying to turn
397 # them into different ones cannot be done repeatedly because they are
398 # real time stamps generated while running the test. The actual date and
399 # time used was fixed when I first started running automatic Exim tests.
401 # Date/time in header lines and SMTP responses
402 s/[A-Z][a-z]{2},\s\d\d?\s[A-Z][a-z]{2}\s\d\d\d\d\s\d\d\:\d\d:\d\d\s[-+]\d{4}
403 /Tue, 2 Mar 1999 09:44:33 +0000/gx;
405 # Date/time in logs and in one instance of a filter test
406 s/^\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d(\s[+-]\d\d\d\d)?/1999-03-02 09:44:33/gx;
407 s/^Logwrite\s"\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d/Logwrite "1999-03-02 09:44:33/gx;
409 # Date/time in message separators
410 s/(?:[A-Z][a-z]{2}\s){2}\d\d\s\d\d:\d\d:\d\d\s\d\d\d\d
411 /Tue Mar 02 09:44:33 1999/gx;
413 # Date of message arrival in spool file as shown by -Mvh
414 s/^\d{9,10}\s0$/ddddddddd 0/;
416 # Date/time in mbx mailbox files
417 s/\d\d-\w\w\w-\d\d\d\d\s\d\d:\d\d:\d\d\s[-+]\d\d\d\d,/06-Sep-1999 15:52:48 +0100,/gx;
419 # Dates/times in debugging output for writing retry records
420 if (/^ first failed=(\d+) last try=(\d+) next try=(\d+) (.*)$/)
423 $_ = " first failed=dddd last try=dddd next try=+$next $4\n";
425 s/^(\s*)now=\d+ first_failed=\d+ next_try=\d+ expired=(\d)/$1now=tttt first_failed=tttt next_try=tttt expired=$2/;
426 s/^(\s*)received_time=\d+ diff=\d+ timeout=(\d+)/$1received_time=tttt diff=tttt timeout=$2/;
428 # Time to retry may vary
429 s/time to retry = \S+/time to retry = tttt/;
430 s/retry record exists: age=\S+/retry record exists: age=ttt/;
431 s/failing_interval=\S+ message_age=\S+/failing_interval=ttt message_age=ttt/;
433 # Date/time in exim -bV output
434 s/\d\d-[A-Z][a-z]{2}-\d{4}\s\d\d:\d\d:\d\d/07-Mar-2000 12:21:52/g;
436 # Time on queue tolerance
440 s/Exim\sstatistics\sfrom\s\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d\sto\s
441 \d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d/Exim statistics from <time> to <time>/x;
444 # ======== Caller's login, uid, gid, home, gecos ========
446 s/\Q$parm_caller_home\E/CALLER_HOME/g; # NOTE: these must be done
447 s/\b\Q$parm_caller\E\b/CALLER/g; # in this order!
448 s/\b\Q$parm_caller_group\E\b/CALLER/g; # In case group name different
450 s/\beuid=$parm_caller_uid\b/euid=CALLER_UID/g;
451 s/\begid=$parm_caller_gid\b/egid=CALLER_GID/g;
453 s/\buid=$parm_caller_uid\b/uid=CALLER_UID/g;
454 s/\bgid=$parm_caller_gid\b/gid=CALLER_GID/g;
456 s/\bname=$parm_caller_gecos\b/name=CALLER_GECOS/g;
458 # When looking at spool files with -Mvh, we will find not only the caller
459 # login, but also the uid and gid. It seems that $) in some Perls gives all
460 # the auxiliary gids as well, so don't bother checking for that.
462 s/^CALLER $> \d+$/CALLER UID GID/;
464 # There is one case where the caller's login is forced to something else,
465 # in order to test the processing of logins that contain spaces. Weird what
466 # some people do, isn't it?
468 s/^spaced user $> \d+$/CALLER UID GID/;
471 # ======== Exim's login ========
472 # For messages received by the daemon, this is in the -H file, which some
473 # tests inspect. For bounce messages, this will appear on the U= lines in
474 # logs and also after Received: and in addresses. In one pipe test it appears
475 # after "Running as:". It also appears in addresses, and in the names of lock
478 s/U=$parm_eximuser/U=EXIMUSER/;
479 s/user=$parm_eximuser/user=EXIMUSER/;
480 s/login=$parm_eximuser/login=EXIMUSER/;
481 s/Received: from $parm_eximuser /Received: from EXIMUSER /;
482 s/Running as: $parm_eximuser/Running as: EXIMUSER/;
483 s/\b$parm_eximuser@/EXIMUSER@/;
484 s/\b$parm_eximuser\.lock\./EXIMUSER.lock./;
486 s/\beuid=$parm_exim_uid\b/euid=EXIM_UID/g;
487 s/\begid=$parm_exim_gid\b/egid=EXIM_GID/g;
489 s/\buid=$parm_exim_uid\b/uid=EXIM_UID/g;
490 s/\bgid=$parm_exim_gid\b/gid=EXIM_GID/g;
492 s/^$parm_eximuser $parm_exim_uid $parm_exim_gid/EXIMUSER EXIM_UID EXIM_GID/;
495 # ======== General uids, gids, and pids ========
496 # Note: this must come after munges for caller's and exim's uid/gid
498 # These are for systems where long int is 64
499 s/\buid=4294967295/uid=-1/;
500 s/\beuid=4294967295/euid=-1/;
501 s/\bgid=4294967295/gid=-1/;
502 s/\begid=4294967295/egid=-1/;
504 s/\bgid=\d+/gid=gggg/;
505 s/\begid=\d+/egid=gggg/;
506 s/\bpid=\d+/pid=pppp/;
507 s/\buid=\d+/uid=uuuu/;
508 s/\beuid=\d+/euid=uuuu/;
509 s/set_process_info:\s+\d+/set_process_info: pppp/;
510 s/queue run pid \d+/queue run pid ppppp/;
511 s/process \d+ running as transport filter/process pppp running as transport filter/;
512 s/process \d+ writing to transport filter/process pppp writing to transport filter/;
513 s/reading pipe for subprocess \d+/reading pipe for subprocess pppp/;
514 s/remote delivery process \d+ ended/remote delivery process pppp ended/;
516 # Pid in temp file in appendfile transport
517 s"test-mail/temp\.\d+\."test-mail/temp.pppp.";
519 # Optional pid in log lines
520 s/^(\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d)(\s[+-]\d\d\d\d|)(\s\[\d+\])/
521 "$1$2 [" . new_value($3, "%s", \$next_pid) . "]"/gxe;
523 # Detect a daemon stderr line with a pid and save the pid for subsequent
524 # removal from following lines.
525 $spid = $1 if /^(\s*\d+) (?:listening|LOG: MAIN|(?:daemon_smtp_port|local_interfaces) overridden by)/;
528 # Queue runner waiting messages
529 s/waiting for children of \d+/waiting for children of pppp/;
530 s/waiting for (\S+) \(\d+\)/waiting for $1 (pppp)/;
532 # ======== Port numbers ========
533 # Incoming port numbers may vary, but not in daemon startup line.
535 s/^Port: (\d+)/"Port: " . new_value($1, "%s", \$next_port)/e;
536 s/\(port=(\d+)/"(port=" . new_value($1, "%s", \$next_port)/e;
538 # This handles "connection from" and the like, when the port is given
539 if (!/listening for SMTP on/ && !/Connecting to/ && !/=>/ && !/->/
540 && !/\*>/ && !/Connection refused/)
542 s/\[([a-z\d:]+|\d+(?:\.\d+){3})\]:(\d+)/"[".$1."]:".new_value($2,"%s",\$next_port)/ie;
545 # Port in host address in spool file output from -Mvh
546 s/^-host_address (.*)\.\d+/-host_address $1.9999/;
549 # ======== Local IP addresses ========
550 # The amount of space between "host" and the address in verification output
551 # depends on the length of the host name. We therefore reduce it to one space
553 # Also, the length of space at the end of the host line is dependent
554 # on the length of the longest line, so strip it also on otherwise
555 # un-rewritten lines like localhost
557 s/^\s+host\s(\S+)\s+(\S+)/ host $1 $2/;
558 s/^\s+(host\s\S+\s\S+)\s+(port=.*)/ host $1 $2/;
559 s/^\s+(host\s\S+\s\S+)\s+(?=MX=)/ $1 /;
560 s/host\s\Q$parm_ipv4\E\s\[\Q$parm_ipv4\E\]/host ipv4.ipv4.ipv4.ipv4 [ipv4.ipv4.ipv4.ipv4]/;
561 s/host\s\Q$parm_ipv6\E\s\[\Q$parm_ipv6\E\]/host ip6:ip6:ip6:ip6:ip6:ip6:ip6:ip6 [ip6:ip6:ip6:ip6:ip6:ip6:ip6:ip6]/;
562 s/\b\Q$parm_ipv4\E\b/ip4.ip4.ip4.ip4/g;
563 s/\b\Q$parm_ipv6\E\b/ip6:ip6:ip6:ip6:ip6:ip6:ip6:ip6/g;
564 s/\b\Q$parm_ipv4r\E\b/ip4-reverse/g;
565 s/\b\Q$parm_ipv6r\E\b/ip6-reverse/g;
566 s/^(\s+host\s\S+\s+\[\S+\]) +$/$1 /;
569 # ======== Test network IP addresses ========
570 s/(\b|_)\Q$parm_ipv4_test_net\E(?=\.\d+\.\d+\.\d+\b|_|\.rbl|\.in-addr|\.test\.again\.dns)/$1V4NET/g;
571 s/\b\Q$parm_ipv6_test_net\E(?=:[\da-f]+:[\da-f]+:[\da-f]+)/V6NET/gi;
574 # ======== IP error numbers and messages ========
575 # These vary between operating systems
576 s/Can't assign requested address/Network Error/;
577 s/Cannot assign requested address/Network Error/;
578 s/Operation timed out/Connection timed out/;
579 s/Address family not supported by protocol family/Network Error/;
580 s/Network is unreachable/Network Error/;
581 s/Invalid argument/Network Error/;
583 s/\(\d+\): Network/(dd): Network/;
584 s/\(\d+\): Connection refused/(dd): Connection refused/;
585 s/\(\d+\): Connection timed out/(dd): Connection timed out/;
586 s/\d+ 65 Connection refused/dd 65 Connection refused/;
587 s/\d+ 321 Connection timed out/dd 321 Connection timed out/;
590 # ======== Other error numbers ========
591 s/errno=\d+/errno=dd/g;
594 # ======== Output from ls ========
595 # Different operating systems use different spacing on long output
596 s/ +/ /g if /^[-rwd]{10} /;
599 # ======== Message sizes =========
600 # Message sizes vary, owing to different logins and host names that get
601 # automatically inserted. I can't think of any way of even approximately
604 s/([\s,])S=\d+\b/$1S=sss/;
606 s/^(\s*\d+m\s+)\d+(\s+[a-z0-9-]{16} <)/$1sss$2/i if $is_stdout;
607 s/\sSIZE=\d+\b/ SIZE=ssss/;
608 s/\ssize=\d+\b/ size=sss/ if $is_stderr;
609 s/old size = \d+\b/old size = sssss/;
610 s/message size = \d+\b/message size = sss/;
611 s/this message = \d+\b/this message = sss/;
612 s/Size of headers = \d+/Size of headers = sss/;
613 s/sum=(?!0)\d+/sum=dddd/;
614 s/(?<=sum=dddd )count=(?!0)\d+\b/count=dd/;
615 s/(?<=sum=0 )count=(?!0)\d+\b/count=dd/;
616 s/,S is \d+\b/,S is ddddd/;
617 s/\+0100,\d+;/+0100,ddd;/;
618 s/\(\d+ bytes written\)/(ddd bytes written)/;
619 s/added '\d+ 1'/added 'ddd 1'/;
620 s/Received\s+\d+/Received nnn/;
621 s/Delivered\s+\d+/Delivered nnn/;
624 # ======== Values in spool space failure message ========
625 s/space=\d+ inodes=[+-]?\d+/space=xxxxx inodes=xxxxx/;
628 # ======== Filter sizes ========
629 # The sizes of filter files may vary because of the substitution of local
630 # filenames, logins, etc.
632 s/^\d+(?= bytes read from )/ssss/;
635 # ======== OpenSSL error messages ========
636 # Different releases of the OpenSSL libraries seem to give different error
637 # numbers, or handle specific bad conditions in different ways, leading to
638 # different wording in the error messages, so we cannot compare them.
640 s/(TLS error on connection (?:from|to) .*? \(SSL_\w+\): error:)(.*)/$1 <<detail omitted>>/;
643 # ======== Maildir things ========
644 # timestamp output in maildir processing
645 s/(timestamp=|\(timestamp_only\): )\d+/$1ddddddd/g;
647 # maildir delivery files appearing in log lines (in cases of error)
648 s/writing to(?: file)? tmp\/\d+\.[^.]+\.(\S+)/writing to tmp\/MAILDIR.$1/;
650 s/renamed tmp\/\d+\.[^.]+\.(\S+) as new\/\d+\.[^.]+\.(\S+)/renamed tmp\/MAILDIR.$1 as new\/MAILDIR.$1/;
652 # Maildir file names in general
653 s/\b\d+\.H\d+P\d+\b/dddddddddd.HddddddPddddd/;
656 while (/^\d+S,\d+C\s*$/)
661 last if !/^\d+ \d+\s*$/;
662 print MUNGED "ddd d\n";
669 # ======== Output from the "fd" program about open descriptors ========
670 # The statuses seem to be different on different operating systems, but
671 # at least we'll still be checking the number of open fd's.
673 s/max fd = \d+/max fd = dddd/;
674 s/status=0 RDONLY/STATUS/g;
675 s/status=1 WRONLY/STATUS/g;
676 s/status=2 RDWR/STATUS/g;
679 # ======== Contents of spool files ========
680 # A couple of tests dump the contents of the -H file. The length fields
681 # will be wrong because of different user names, etc.
682 s/^\d\d\d(?=[PFS*])/ddd/;
685 # ==========================================================
686 # Some munging is specific to the specific file types
688 # ======== stdout ========
692 # Skip translate_ip_address and use_classresources in -bP output because
693 # they aren't always there.
695 next if /translate_ip_address =/;
696 next if /use_classresources/;
698 # In certain filter tests, remove initial filter lines because they just
699 # clog up by repetition.
703 next if /^(Sender\staken\sfrom|
704 Return-path\scopied\sfrom|
707 if (/^Testing \S+ filter/)
709 $_ = <IN>; # remove blank line
715 # ======== stderr ========
719 # The very first line of debugging output will vary
721 s/^Exim version .*/Exim version x.yz ..../;
723 # Debugging lines for Exim terminations
725 s/(?<=^>>>>>>>>>>>>>>>> Exim pid=)\d+(?= terminating)/pppp/;
727 # IP address lookups use gethostbyname() when IPv6 is not supported,
728 # and gethostbyname2() or getipnodebyname() when it is.
730 s/\bgethostbyname2?|\bgetipnodebyname/get[host|ipnode]byname[2]/;
732 # drop gnutls version strings
733 next if /GnuTLS compile-time version: \d+[\.\d]+$/;
734 next if /GnuTLS runtime version: \d+[\.\d]+$/;
736 # drop openssl version strings
737 next if /OpenSSL compile-time version: OpenSSL \d+[\.\da-z]+/;
738 next if /OpenSSL runtime version: OpenSSL \d+[\.\da-z]+/;
740 # We have to omit the localhost ::1 address so that all is well in
741 # the IPv4-only case.
743 print MUNGED "MUNGED: ::1 will be omitted in what follows\n"
744 if (/looked up these IP addresses/);
745 next if /name=localhost address=::1/;
747 # drop pdkim debugging header
748 next if /^PDKIM <<<<<<<<<<<<<<<<<<<<<<<<<<<<<+$/;
750 # Various other IPv6 lines must be omitted too
752 next if /using host_fake_gethostbyname for \S+ \(IPv6\)/;
753 next if /get\[host\|ipnode\]byname\[2\]\(af=inet6\)/;
754 next if /DNS lookup of \S+ \(AAAA\) using fakens/;
755 next if / in dns_ipv4_lookup?/;
757 if (/DNS lookup of \S+ \(AAAA\) gave NO_DATA/)
759 $_= <IN>; # Gets "returning DNS_NODATA"
763 # Skip tls_advertise_hosts and hosts_require_tls checks when the options
764 # are unset, because tls ain't always there.
766 next if /in\s(?:tls_advertise_hosts\?|hosts_require_tls\?)
767 \sno\s\(option\sunset\)/x;
769 # Skip auxiliary group lists because they will vary.
771 next if /auxiliary group list:/;
773 # Skip "extracted from gecos field" because the gecos field varies
775 next if /extracted from gecos field/;
777 # Skip "waiting for data on socket" and "read response data: size=" lines
778 # because some systems pack more stuff into packets than others.
780 next if /waiting for data on socket/;
781 next if /read response data: size=/;
783 # If Exim is compiled with readline support but it can't find the library
784 # to load, there will be an extra debug line. Omit it.
786 next if /failed to load readline:/;
788 # Some DBM libraries seem to make DBM files on opening with O_RDWR without
789 # O_CREAT; other's don't. In the latter case there is some debugging output
790 # which is not present in the former. Skip the relevant lines (there are
793 if (/TESTSUITE\/spool\/db\/\S+ appears not to exist: trying to create/)
799 # Some tests turn on +expand debugging to check on expansions.
800 # Unfortunately, the Received: expansion varies, depending on whether TLS
801 # is compiled or not. So we must remove the relevant debugging if it is.
803 if (/^condition: def:tls_cipher/)
805 while (<IN>) { last if /^condition: def:sender_address/; }
807 elsif (/^expanding: Received: /)
809 while (<IN>) { last if !/^\s/; }
812 # When Exim is checking the size of directories for maildir, it uses
813 # the check_dir_size() function to scan directories. Of course, the order
814 # of the files that are obtained using readdir() varies from system to
815 # system. We therefore buffer up debugging lines from check_dir_size()
816 # and sort them before outputting them.
818 if (/^check_dir_size:/ || /^skipping TESTSUITE\/test-mail\//)
826 print MUNGED "MUNGED: the check_dir_size lines have been sorted " .
827 "to ensure consistency\n";
828 @saved = sort(@saved);
833 # Skip some lines that Exim puts out at the start of debugging output
834 # because they will be different in different binaries.
837 unless (/^Berkeley DB: / ||
838 /^Probably (?:Berkeley DB|ndbm|GDBM)/ ||
839 /^Authenticators:/ ||
844 /^log selectors =/ ||
846 /^Fixed never_users:/ ||
854 # ======== All files other than stderr ========
866 ##################################################
867 # Subroutine to interact with caller #
868 ##################################################
870 # Arguments: [0] the prompt string
871 # [1] if there is a U in the prompt and $force_update is true
872 # Returns: nothing (it sets $_)
876 if ($_[1]) { $_ = "u"; print "... update forced\n"; }
883 ##################################################
884 # Subroutine to compare one output file #
885 ##################################################
887 # When an Exim server is part of the test, its output is in separate files from
888 # an Exim client. The server data is concatenated with the client data as part
889 # of the munging operation.
891 # Arguments: [0] the name of the main raw output file
892 # [1] the name of the server raw output file or undef
893 # [2] where to put the munged copy
894 # [3] the name of the saved file
895 # [4] TRUE if this is a log file whose deliveries must be sorted
897 # Returns: 0 comparison succeeded or differences to be ignored
898 # 1 comparison failed; files were updated (=> re-compare)
900 # Does not return if the user replies "Q" to a prompt.
903 my($rf,$rsf,$mf,$sf,$sortfile) = @_;
905 # If there is no saved file, the raw files must either not exist, or be
906 # empty. The test ! -s is TRUE if the file does not exist or is empty.
910 return 0 if (! -s $rf && (! defined $rsf || ! -s $rsf));
913 print "** $rf is not empty\n" if (-s $rf);
914 print "** $rsf is not empty\n" if (defined $rsf && -s $rsf);
918 print "Continue, Show, or Quit? [Q] ";
920 tests_exit(1) if /^q?$/i;
925 foreach $f ($rf, $rsf)
927 if (defined $f && -s $f)
930 print "------------ $f -----------\n"
931 if (defined $rf && -s $rf && defined $rsf && -s $rsf);
932 system("$more '$f'");
939 interact("Continue, Update & retry, Quit? [Q] ", $force_update);
940 tests_exit(1) if /^q?$/i;
946 # Control reaches here if either (a) there is a saved file ($sf), or (b) there
947 # was a request to create a saved file. First, create the munged file from any
948 # data that does exist.
950 open(MUNGED, ">$mf") || tests_exit(-1, "Failed to open $mf: $!");
951 my($truncated) = munge($rf) if -e $rf;
952 if (defined $rsf && -e $rsf)
954 print MUNGED "\n******** SERVER ********\n";
955 $truncated |= munge($rsf);
959 # If a saved file exists, do the comparison. There are two awkward cases:
961 # If "*** truncated ***" was found in the new file, it means that a log line
962 # was overlong, and truncated. The problem is that it may be truncated at
963 # different points on different systems, because of different user name
964 # lengths. We reload the file and the saved file, and remove lines from the new
965 # file that precede "*** truncated ***" until we reach one that matches the
966 # line that precedes it in the saved file.
968 # If $sortfile is set, we are dealing with a mainlog file where the deliveries
969 # for an individual message might vary in their order from system to system, as
970 # a result of parallel deliveries. We load the munged file and sort sequences
975 # Deal with truncated text items
979 my(@munged, @saved, $i, $j, $k);
981 open(MUNGED, "$mf") || tests_exit(-1, "Failed to open $mf: $!");
984 open(SAVED, "$sf") || tests_exit(-1, "Failed to open $sf: $!");
989 for ($i = 0; $i < @munged; $i++)
991 if ($munged[$i] =~ /\*\*\* truncated \*\*\*/)
993 for (; $j < @saved; $j++)
994 { last if $saved[$j] =~ /\*\*\* truncated \*\*\*/; }
995 last if $j >= @saved; # not found in saved
997 for ($k = $i - 1; $k >= 0; $k--)
998 { last if $munged[$k] eq $saved[$j - 1]; }
1000 last if $k <= 0; # failed to find previous match
1001 splice @munged, $k + 1, $i - $k - 1;
1006 open(MUNGED, ">$mf") || tests_exit(-1, "Failed to open $mf: $!");
1007 for ($i = 0; $i < @munged; $i++)
1008 { print MUNGED $munged[$i]; }
1012 # Deal with log sorting
1016 my(@munged, $i, $j);
1018 open(MUNGED, "$mf") || tests_exit(-1, "Failed to open $mf: $!");
1022 for ($i = 0; $i < @munged; $i++)
1024 if ($munged[$i] =~ /^[-\d]{10}\s[:\d]{8}\s[-A-Za-z\d]{16}\s[-=*]>/)
1026 for ($j = $i + 1; $j < @munged; $j++)
1028 last if $munged[$j] !~
1029 /^[-\d]{10}\s[:\d]{8}\s[-A-Za-z\d]{16}\s[-=*]>/;
1031 @temp = splice(@munged, $i, $j - $i);
1032 @temp = sort(@temp);
1033 splice(@munged, $i, 0, @temp);
1037 open(MUNGED, ">$mf") || tests_exit(-1, "Failed to open $mf: $!");
1038 print MUNGED "**NOTE: The delivery lines in this file have been sorted.\n";
1039 for ($i = 0; $i < @munged; $i++)
1040 { print MUNGED $munged[$i]; }
1046 return 0 if (system("$cf '$mf' '$sf' >test-cf") == 0);
1048 # Handle comparison failure
1050 print "** Comparison of $mf with $sf failed";
1051 system("$more test-cf");
1056 interact("Continue, Update & retry, Quit? [Q] ", $force_update);
1057 tests_exit(1) if /^q?$/i;
1063 # Update or delete the saved file, and give the appropriate return code.
1066 { tests_exit(-1, "Failed to cp $mf $sf") if system("cp '$mf' '$sf'") != 0; }
1068 { tests_exit(-1, "Failed to unlink $sf") if !unlink($sf); }
1075 ##################################################
1076 # Subroutine to check the output of a test #
1077 ##################################################
1079 # This function is called when the series of subtests is complete. It makes
1080 # use of check() file, whose arguments are:
1082 # [0] the name of the main raw output file
1083 # [1] the name of the server raw output file or undef
1084 # [2] where to put the munged copy
1085 # [3] the name of the saved file
1086 # [4] TRUE if this is a log file whose deliveries must be sorted
1089 # Returns: 0 if the output compared equal
1090 # 1 if files were updated and the test must be re-run
1095 $yield = 1 if check_file("spool/log/paniclog",
1096 "spool/log/serverpaniclog",
1097 "test-paniclog-munged",
1098 "paniclog/$testno", 0);
1100 $yield = 1 if check_file("spool/log/rejectlog",
1101 "spool/log/serverrejectlog",
1102 "test-rejectlog-munged",
1103 "rejectlog/$testno", 0);
1105 $yield = 1 if check_file("spool/log/mainlog",
1106 "spool/log/servermainlog",
1107 "test-mainlog-munged",
1108 "log/$testno", $sortlog);
1112 $yield = 1 if check_file("test-stdout",
1113 "test-stdout-server",
1114 "test-stdout-munged",
1115 "stdout/$testno", 0);
1120 $yield = 1 if check_file("test-stderr",
1121 "test-stderr-server",
1122 "test-stderr-munged",
1123 "stderr/$testno", 0);
1126 # Compare any delivered messages, unless this test is skipped.
1128 if (! $message_skip)
1132 # Get a list of expected mailbox files for this script. We don't bother with
1133 # directories, just the files within them.
1135 foreach $oldmail (@oldmails)
1137 next unless $oldmail =~ /^mail\/$testno\./;
1138 print ">> EXPECT $oldmail\n" if $debug;
1139 $expected_mails{$oldmail} = 1;
1142 # If there are any files in test-mail, compare them. Note that "." and
1143 # ".." are automatically omitted by list_files_below().
1145 @mails = list_files_below("test-mail");
1147 foreach $mail (@mails)
1149 next if $mail eq "test-mail/oncelog";
1151 $saved_mail = substr($mail, 10); # Remove "test-mail/"
1152 $saved_mail =~ s/^$parm_caller(\/|$)/CALLER/; # Convert caller name
1154 if ($saved_mail =~ /(\d+\.[^.]+\.)/)
1157 $saved_mail =~ s/(\d+\.[^.]+\.)/$msgno./gx;
1160 print ">> COMPARE $mail mail/$testno.$saved_mail\n" if $debug;
1161 $yield = 1 if check_file($mail, undef, "test-mail-munged",
1162 "mail/$testno.$saved_mail", 0);
1163 delete $expected_mails{"mail/$testno.$saved_mail"};
1166 # Complain if not all expected mails have been found
1168 if (scalar(keys %expected_mails) != 0)
1170 foreach $key (keys %expected_mails)
1171 { print "** no test file found for $key\n"; }
1175 interact("Continue, Update & retry, or Quit? [Q] ", $force_update);
1176 tests_exit(1) if /^q?$/i;
1179 # For update, we not only have to unlink the file, but we must also
1180 # remove it from the @oldmails vector, as otherwise it will still be
1181 # checked for when we re-run the test.
1185 foreach $key (keys %expected_mails)
1188 tests_exit(-1, "Failed to unlink $key") if !unlink("$key");
1189 for ($i = 0; $i < @oldmails; $i++)
1191 if ($oldmails[$i] eq $key)
1193 splice @oldmails, $i, 1;
1204 # Compare any remaining message logs, unless this test is skipped.
1208 # Get a list of expected msglog files for this test
1210 foreach $oldmsglog (@oldmsglogs)
1212 next unless $oldmsglog =~ /^$testno\./;
1213 $expected_msglogs{$oldmsglog} = 1;
1216 # If there are any files in spool/msglog, compare them. However, we have
1217 # to munge the file names because they are message ids, which are
1220 if (opendir(DIR, "spool/msglog"))
1222 @msglogs = sort readdir(DIR);
1225 foreach $msglog (@msglogs)
1227 next if ($msglog eq "." || $msglog eq ".." || $msglog eq "CVS");
1228 ($munged_msglog = $msglog) =~
1229 s/((?:[^\W_]{6}-){2}[^\W_]{2})
1230 /new_value($1, "10Hm%s-0005vi-00", \$next_msgid)/egx;
1231 $yield = 1 if check_file("spool/msglog/$msglog", undef,
1232 "test-msglog-munged", "msglog/$testno.$munged_msglog", 0);
1233 delete $expected_msglogs{"$testno.$munged_msglog"};
1237 # Complain if not all expected msglogs have been found
1239 if (scalar(keys %expected_msglogs) != 0)
1241 foreach $key (keys %expected_msglogs)
1243 print "** no test msglog found for msglog/$key\n";
1244 ($msgid) = $key =~ /^\d+\.(.*)$/;
1245 foreach $cachekey (keys %cache)
1247 if ($cache{$cachekey} eq $msgid)
1249 print "** original msgid $cachekey\n";
1257 interact("Continue, Update, or Quit? [Q] ", $force_update);
1258 tests_exit(1) if /^q?$/i;
1262 foreach $key (keys %expected_msglogs)
1264 tests_exit(-1, "Failed to unlink msglog/$key")
1265 if !unlink("msglog/$key");
1278 ##################################################
1279 # Subroutine to run one "system" command #
1280 ##################################################
1282 # We put this in a subroutine so that the command can be reflected when
1285 # Argument: the command to be run
1293 $prcmd =~ s/; /;\n>> /;
1294 print ">> $prcmd\n";
1301 ##################################################
1302 # Subroutine to run one script command #
1303 ##################################################
1305 # The <SCRIPT> file is open for us to read an optional return code line,
1306 # followed by the command line and any following data lines for stdin. The
1307 # command line can be continued by the use of \. Data lines are not continued
1308 # in this way. In all lines, the following substutions are made:
1310 # DIR => the current directory
1311 # CALLER => the caller of this script
1313 # Arguments: the current test number
1314 # reference to the subtest number, holding previous value
1315 # reference to the expected return code value
1316 # reference to where to put the command name (for messages)
1318 # Returns: 0 the commmand was executed inline, no subprocess was run
1319 # 1 a non-exim command was run and waited for
1320 # 2 an exim command was run and waited for
1321 # 3 a command was run and not waited for (daemon, server, exim_lock)
1322 # 4 EOF was encountered after an initial return code line
1325 my($testno) = $_[0];
1326 my($subtestref) = $_[1];
1327 my($commandnameref) = $_[3];
1330 if (/^(\d+)\s*$/) # Handle unusual return code
1335 return 4 if !defined $_; # Missing command
1342 # Handle concatenated command lines
1345 while (substr($_, -1) eq"\\")
1348 $_ = substr($_, 0, -1);
1349 chomp($temp = <SCRIPT>);
1361 do_substitute($testno);
1362 if ($debug) { printf ">> $_\n"; }
1364 # Pass back the command name (for messages)
1366 ($$commandnameref) = /^(\S+)/;
1368 # Here follows code for handling the various different commands that are
1369 # supported by this script. The first group of commands are all freestanding
1370 # in that they share no common code and are not followed by any data lines.
1376 # The "dbmbuild" command runs exim_dbmbuild. This is used both to test the
1377 # utility and to make DBM files for testing DBM lookups.
1379 if (/^dbmbuild\s+(\S+)\s+(\S+)/)
1381 run_system("(./eximdir/exim_dbmbuild $parm_cwd/$1 $parm_cwd/$2;" .
1382 "echo exim_dbmbuild exit code = \$?)" .
1388 # The "dump" command runs exim_dumpdb. On different systems, the output for
1389 # some types of dump may appear in a different order because it's just hauled
1390 # out of the DBM file. We can solve this by sorting. Ignore the leading
1391 # date/time, as it will be flattened later during munging.
1393 if (/^dump\s+(\S+)/)
1397 print ">> ./eximdir/exim_dumpdb $parm_cwd/spool $which\n" if $debug;
1398 open(IN, "./eximdir/exim_dumpdb $parm_cwd/spool $which |");
1401 if ($which eq "callout")
1404 my($aa) = substr $a, 21;
1405 my($bb) = substr $b, 21;
1409 open(OUT, ">>test-stdout");
1410 print OUT "+++++++++++++++++++++++++++\n";
1417 # The "echo" command is a way of writing comments to the screen.
1419 if (/^echo\s+(.*)$/)
1426 # The "exim_lock" command runs exim_lock in the same manner as "server",
1427 # but it doesn't use any input.
1429 if (/^exim_lock\s+(.*)$/)
1431 $cmd = "./eximdir/exim_lock $1 >>test-stdout";
1432 $server_pid = open SERVERCMD, "|$cmd" ||
1433 tests_exit(-1, "Failed to run $cmd\n");
1435 # This gives the process time to get started; otherwise the next
1436 # process may not find it there when it expects it.
1438 select(undef, undef, undef, 0.1);
1443 # The "exinext" command runs exinext
1445 if (/^exinext\s+(.*)/)
1447 run_system("(./eximdir/exinext " .
1448 "-DEXIM_PATH=$parm_cwd/eximdir/exim " .
1449 "-C $parm_cwd/test-config $1;" .
1450 "echo exinext exit code = \$?)" .
1456 # The "exigrep" command runs exigrep on the current mainlog
1458 if (/^exigrep\s+(.*)/)
1460 run_system("(./eximdir/exigrep " .
1461 "$1 $parm_cwd/spool/log/mainlog;" .
1462 "echo exigrep exit code = \$?)" .
1468 # The "eximstats" command runs eximstats on the current mainlog
1470 if (/^eximstats\s+(.*)/)
1472 run_system("(./eximdir/eximstats " .
1473 "$1 $parm_cwd/spool/log/mainlog;" .
1474 "echo eximstats exit code = \$?)" .
1480 # The "gnutls" command makes a copy of saved GnuTLS parameter data in the
1481 # spool directory, to save Exim from re-creating it each time.
1485 run_system "sudo cp -p aux-fixed/gnutls-params spool/gnutls-params;" .
1486 "sudo chown $parm_eximuser:$parm_eximgroup spool/gnutls-params;" .
1487 "sudo chmod 0400 spool/gnutls-params";
1492 # The "killdaemon" command should ultimately follow the starting of any Exim
1493 # daemon with the -bd option. We kill with SIGINT rather than SIGTERM to stop
1494 # it outputting "Terminated" to the terminal when not in the background.
1498 $pid = `cat $parm_cwd/spool/exim-daemon.*`;
1499 run_system("sudo /bin/kill -SIGINT $pid");
1500 close DAEMONCMD; # Waits for process
1501 run_system("sudo /bin/rm -f spool/exim-daemon.*");
1506 # The "millisleep" command is like "sleep" except that its argument is in
1507 # milliseconds, thus allowing for a subsecond sleep, which is, in fact, all it
1510 elsif (/^millisleep\s+(.*)$/)
1512 select(undef, undef, undef, $1/1000);
1517 # The "sleep" command does just that. For sleeps longer than 1 second we
1518 # tell the user what's going on.
1520 if (/^sleep\s+(.*)$/)
1528 printf(" Test %d sleep $1 ", $$subtestref);
1534 printf("\r Test %d $cr", $$subtestref);
1540 # Various Unix management commands are recognized
1542 if (/^(ln|ls|du|mkdir|mkfifo|touch|cp|cat)\s/ ||
1543 /^sudo (rmdir|rm|chown|chmod)\s/)
1545 run_system("$_ >>test-stdout 2>>test-stderr");
1554 # The next group of commands are also freestanding, but they are all followed
1558 # The "server" command starts up a script-driven server that runs in parallel
1559 # with the following exim command. Therefore, we want to run a subprocess and
1560 # not yet wait for it to complete. The waiting happens after the next exim
1561 # command, triggered by $server_pid being non-zero. The server sends its output
1562 # to a different file. The variable $server_opts, if not empty, contains
1563 # options to disable IPv4 or IPv6 if necessary.
1565 if (/^server\s+(.*)$/)
1567 $cmd = "./bin/server $server_opts $1 >>test-stdout-server";
1568 print ">> $cmd\n" if ($debug);
1569 $server_pid = open SERVERCMD, "|$cmd" || tests_exit(-1, "Failed to run $cmd");
1570 SERVERCMD->autoflush(1);
1571 print ">> Server pid is $server_pid\n" if $debug;
1575 last if /^\*{4}\s*$/;
1578 print SERVERCMD "++++\n"; # Send end to server; can't send EOF yet
1579 # because close() waits for the process.
1581 # This gives the server time to get started; otherwise the next
1582 # process may not find it there when it expects it.
1584 select(undef, undef, undef, 0.5);
1589 # The "write" command is a way of creating files of specific sizes for
1590 # buffering tests, or containing specific data lines from within the script
1591 # (rather than hold lots of little files). The "catwrite" command does the
1592 # same, but it also copies the lines to test-stdout.
1594 if (/^(cat)?write\s+(\S+)(?:\s+(.*))?\s*$/)
1596 my($cat) = defined $1;
1598 @sizes = split /\s+/, $3 if defined $3;
1599 open FILE, ">$2" || tests_exit(-1, "Failed to open \"$2\": $!");
1603 open CAT, ">>test-stdout" ||
1604 tests_exit(-1, "Failed to open test-stdout: $!");
1605 print CAT "==========\n";
1608 if (scalar @sizes > 0)
1615 last if /^\+{4}\s*$/;
1622 while (scalar @sizes > 0)
1624 ($count,$len,$leadin) = (shift @sizes) =~ /(\d+)x(\d+)(?:=(.*))?/;
1625 $leadin = "" if !defined $leadin;
1627 $len -= length($leadin) + 1;
1628 while ($count-- > 0)
1630 print FILE $leadin, "a" x $len, "\n";
1631 print CAT $leadin, "a" x $len, "\n" if $cat;
1636 # Post data, or only data if no sized data
1641 last if /^\*{4}\s*$/;
1649 print CAT "==========\n";
1660 # From this point on, script commands are implemented by setting up a shell
1661 # command in the variable $cmd. Shared code to run this command and handle its
1662 # input and output follows.
1664 # The "client", "client-gnutls", and "client-ssl" commands run a script-driven
1665 # program that plays the part of an email client. We also have the availability
1666 # of running Perl for doing one-off special things. Note that all these
1667 # commands expect stdin data to be supplied.
1669 if (/^client/ || /^(sudo\s+)?perl\b/)
1671 s"client"./bin/client";
1672 $cmd = "$_ >>test-stdout 2>>test-stderr";
1675 # For the "exim" command, replace the text "exim" with the path for the test
1676 # binary, plus -D options to pass over various parameters, and a -C option for
1677 # the testing configuration file. When running in the test harness, Exim does
1678 # not drop privilege when -C and -D options are present. To run the exim
1679 # command as root, we use sudo.
1681 elsif (/^([A-Z_]+=\S+\s+)?(\d+)?\s*(sudo\s+)?exim(_\S+)?\s+(.*)$/)
1684 my($envset) = (defined $1)? $1 : "";
1685 my($sudo) = (defined $3)? "sudo " : "";
1686 my($special)= (defined $4)? $4 : "";
1687 $wait_time = (defined $2)? $2 : 0;
1689 # Return 2 rather than 1 afterwards
1693 # Update the test number
1695 $$subtestref = $$subtestref + 1;
1696 printf(" Test %d $cr", $$subtestref);
1698 # Copy the configuration file, making the usual substitutions.
1700 open (IN, "$parm_cwd/confs/$testno") ||
1701 tests_exit(-1, "Couldn't open $parm_cwd/confs/$testno: $!\n");
1702 open (OUT, ">test-config") ||
1703 tests_exit(-1, "Couldn't open test-config: $!\n");
1706 do_substitute($testno);
1712 # The string $msg1 in args substitutes the message id of the first
1713 # message on the queue, and so on. */
1715 if ($args =~ /\$msg/)
1717 my($listcmd) = "$parm_cwd/eximdir/exim -bp " .
1718 "-DEXIM_PATH=$parm_cwd/eximdir/exim " .
1719 "-C $parm_cwd/test-config |";
1720 print ">> Getting queue list from:\n>> $listcmd\n" if ($debug);
1721 open (QLIST, $listcmd) || tests_exit(-1, "Couldn't run \"exim -bp\": $!\n");
1723 while (<QLIST>) { push (@msglist, $1) if /^\s*\d+[smhdw]\s+\S+\s+(\S+)/; }
1726 # Done backwards just in case there are more than 9
1729 for ($i = @msglist; $i > 0; $i--) { $args =~ s/\$msg$i/$msglist[$i-1]/g; }
1732 # If -d is specified in $optargs, remove it from $args; i.e. let
1733 # the command line for runtest override. Then run Exim.
1735 $args =~ s/(?:^|\s)-d\S*// if $optargs =~ /(?:^|\s)-d/;
1737 $cmd = "$envset$sudo$parm_cwd/eximdir/exim$special$optargs " .
1738 "-DEXIM_PATH=$parm_cwd/eximdir/exim$special " .
1739 "-C $parm_cwd/test-config $args " .
1740 ">>test-stdout 2>>test-stderr";
1742 # If the command is starting an Exim daemon, we run it in the same
1743 # way as the "server" command above, that is, we don't want to wait
1744 # for the process to finish. That happens when "killdaemon" is obeyed later
1745 # in the script. We also send the stderr output to test-stderr-server. The
1746 # daemon has its log files put in a different place too (by configuring with
1747 # log_file_path). This requires the directory to be set up in advance.
1749 # There are also times when we want to run a non-daemon version of Exim
1750 # (e.g. a queue runner) with the server configuration. In this case,
1751 # we also define -DNOTDAEMON.
1753 if ($cmd =~ /\s-DSERVER=server\s/ && $cmd !~ /\s-DNOTDAEMON\s/)
1755 if ($debug) { printf ">> daemon: $cmd\n"; }
1756 run_system("sudo mkdir spool/log 2>/dev/null");
1757 run_system("sudo chown $parm_eximuser:$parm_eximgroup spool/log");
1759 # Before running the command, convert the -bd option into -bdf so that an
1760 # Exim daemon doesn't double fork. This means that when we wait close
1761 # DAEMONCMD, it waits for the correct process. Also, ensure that the pid
1762 # file is written to the spool directory, in case the Exim binary was
1763 # built with PID_FILE_PATH pointing somewhere else.
1765 $cmd =~ s!\s-bd\s! -bdf -oP $parm_cwd/spool/exim-daemon.pid !;
1766 print ">> |${cmd}-server\n" if ($debug);
1767 open DAEMONCMD, "|${cmd}-server" || tests_exit(-1, "Failed to run $cmd");
1768 DAEMONCMD->autoflush(1);
1769 while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; } # Ignore any input
1770 select(undef, undef, undef, 0.3); # Let the daemon get going
1771 return 3; # Don't wait
1778 else { tests_exit(-1, "Command unrecognized in line $lineno: $_"); }
1781 # Run the command, with stdin connected to a pipe, and write the stdin data
1782 # to it, with appropriate substitutions. If a line ends with \NONL\, chop off
1783 # the terminating newline (and the \NONL\). If the command contains
1784 # -DSERVER=server add "-server" to the command, where it will adjoin the name
1785 # for the stderr file. See comment above about the use of -DSERVER.
1787 $stderrsuffix = ($cmd =~ /\s-DSERVER=server\s/)? "-server" : "";
1788 print ">> |${cmd}${stderrsuffix}\n" if ($debug);
1789 open CMD, "|${cmd}${stderrsuffix}" || tests_exit(1, "Failed to run $cmd");
1795 last if /^\*{4}\s*$/;
1796 do_substitute($testno);
1797 if (/^(.*)\\NONL\\\s*$/) { print CMD $1; } else { print CMD; }
1800 # For timeout tests, wait before closing the pipe; we expect a
1801 # SIGPIPE error in this case.
1805 printf(" Test %d sleep $wait_time ", $$subtestref);
1806 while ($wait_time-- > 0)
1811 printf("\r Test %d $cr", $$subtestref);
1814 $sigpipehappened = 0;
1815 close CMD; # Waits for command to finish
1816 return $yield; # Ran command and waited
1822 ###############################################################################
1823 ###############################################################################
1825 # Here beginneth the Main Program ...
1827 ###############################################################################
1828 ###############################################################################
1832 print "Exim tester $testversion\n";
1835 ##################################################
1836 # Check for the "less" command #
1837 ##################################################
1839 $more = "more" if system("which less >/dev/null 2>&1") != 0;
1843 ##################################################
1844 # Check for sudo access to root #
1845 ##################################################
1847 print "You need to have sudo access to root to run these tests. Checking ...\n";
1848 if (system("sudo date >/dev/null") != 0)
1850 die "** Test for sudo failed: testing abandoned.\n";
1854 print "Test for sudo OK\n";
1859 ##################################################
1860 # See if an Exim binary has been given #
1861 ##################################################
1863 # If the first character of the first argument is '/', the argument is taken
1864 # as the path to the binary.
1866 $parm_exim = (@ARGV > 0 && $ARGV[0] =~ ?^/?)? shift @ARGV : "";
1867 print "Exim binary is $parm_exim\n" if $parm_exim ne "";
1871 ##################################################
1872 # Sort out options and which tests are to be run #
1873 ##################################################
1875 # There are a few possible options for the test script itself; after these, any
1876 # options are passed on to Exim calls within the tests. Typically, this is used
1877 # to turn on Exim debugging while setting up a test.
1879 while (@ARGV > 0 && $ARGV[0] =~ /^-/)
1881 my($arg) = shift @ARGV;
1884 if ($arg eq "-DEBUG") { $debug = 1; $cr = "\n"; next; }
1885 if ($arg eq "-DIFF") { $cf = "diff -u"; next; }
1886 if ($arg eq "-UPDATE") { $force_update = 1; next; }
1887 if ($arg eq "-NOIPV4") { $have_ipv4 = 0; next; }
1888 if ($arg eq "-NOIPV6") { $have_ipv6 = 0; next; }
1889 if ($arg eq "-KEEP") { $save_output = 1; next; }
1891 $optargs .= " $arg";
1894 # Any subsequent arguments are a range of test numbers.
1898 $test_end = $test_start = $ARGV[0];
1899 $test_end = $ARGV[1] if (@ARGV > 1);
1900 $test_end = ($test_start >= 9000)? $test_special_top : $test_top
1901 if $test_end eq "+";
1902 die "** Test numbers out of order\n" if ($test_end < $test_start);
1906 ##################################################
1907 # Make the command's directory current #
1908 ##################################################
1910 # After doing so, we find its absolute path name.
1913 $cwd = '.' if ($cwd !~ s|/[^/]+$||);
1914 chdir($cwd) || die "** Failed to chdir to \"$cwd\": $!\n";
1915 $parm_cwd = Cwd::getcwd();
1918 ##################################################
1919 # Search for an Exim binary to test #
1920 ##################################################
1922 # If an Exim binary hasn't been provided, try to find one. We can handle the
1923 # case where exim-testsuite is installed alongside Exim source directories. For
1924 # PH's private convenience, if there's a directory just called "exim4", that
1925 # takes precedence; otherwise exim-snapshot takes precedence over any numbered
1928 if ($parm_exim eq "")
1930 my($use_srcdir) = "";
1932 opendir DIR, ".." || die "** Failed to opendir \"..\": $!\n";
1933 while ($f = readdir(DIR))
1937 # Try this directory if it is "exim4" or if it is exim-snapshot or exim-n.m
1938 # possibly followed by -RCx where n.m is greater than any previously tried
1939 # directory. Thus, we should choose the highest version of Exim that has
1942 if ($f eq "exim4" || $f eq "exim-snapshot")
1946 if ($f =~ /^exim-\d+\.\d+(-RC\d+)?$/ && $f gt $use_srcdir); }
1948 # Look for a build directory with a binary in it. If we find a binary,
1949 # accept this source directory.
1953 opendir SRCDIR, "../$srcdir" ||
1954 die "** Failed to opendir \"$cwd/../$srcdir\": $!\n";
1955 while ($f = readdir(SRCDIR))
1957 if ($f =~ /^build-/ && -e "../$srcdir/$f/exim")
1959 $use_srcdir = $srcdir;
1960 $parm_exim = "$cwd/../$srcdir/$f/exim";
1961 $parm_exim =~ s'/[^/]+/\.\./'/';
1968 # If we have found "exim4" or "exim-snapshot", that takes precedence.
1969 # Otherwise, continue to see if there's a later version.
1971 last if $use_srcdir eq "exim4" || $use_srcdir eq "exim-snapshot";
1974 print "Exim binary found in $parm_exim\n" if $parm_exim ne "";
1977 # If $parm_exim is still empty, ask the caller
1979 if ($parm_exim eq "")
1981 print "** Did not find an Exim binary to test\n";
1982 for ($i = 0; $i < 5; $i++)
1985 print "** Enter pathname for Exim binary: ";
1986 chomp($trybin = <STDIN>);
1989 $parm_exim = $trybin;
1994 print "** $trybin does not exist\n";
1997 die "** Too many tries\n" if $parm_exim eq "";
2002 ##################################################
2003 # Find what is in the binary #
2004 ##################################################
2006 open(EXIMINFO, "$parm_exim -C confs/0000 -DDIR=$parm_cwd " .
2007 "-bP exim_user exim_group|") ||
2008 die "** Cannot run $parm_exim: $!\n";
2011 $parm_eximuser = $1 if /^exim_user = (.*)$/;
2012 $parm_eximgroup = $1 if /^exim_group = (.*)$/;
2016 if (defined $parm_eximuser)
2018 if ($parm_eximuser =~ /^\d+$/) { $parm_exim_uid = $parm_eximuser; }
2019 else { $parm_exim_uid = getpwnam($parm_eximuser); }
2022 if (defined $parm_eximgroup)
2024 if ($parm_eximgroup =~ /^\d+$/) { $parm_exim_gid = $parm_eximgroup; }
2025 else { $parm_exim_gid = getgrnam($parm_eximgroup); }
2028 open(EXIMINFO, "$parm_exim -bV -C confs/0000 -DDIR=$parm_cwd |") ||
2029 die "** Cannot run $parm_exim: $!\n";
2031 print "-" x 78, "\n";
2037 if (/^Exim version/) { print; }
2039 elsif (/^Size of off_t: (\d+)/)
2042 $have_largefiles = 1 if $1 > 4;
2043 die "** Size of off_t > 32 which seems improbable, not running tests\n"
2047 elsif (/^Support for: (.*)/)
2050 @temp = split /(\s+)/, $1;
2052 %parm_support = @temp;
2055 elsif (/^Lookups: (.*)/)
2058 @temp = split /(\s+)/, $1;
2060 %parm_lookups = @temp;
2063 elsif (/^Authenticators: (.*)/)
2066 @temp = split /(\s+)/, $1;
2068 %parm_authenticators = @temp;
2071 elsif (/^Routers: (.*)/)
2074 @temp = split /(\s+)/, $1;
2076 %parm_routers = @temp;
2079 # Some transports have options, e.g. appendfile/maildir. For those, ensure
2080 # that the basic transport name is set, and then the name with each of the
2083 elsif (/^Transports: (.*)/)
2086 @temp = split /(\s+)/, $1;
2089 %parm_transports = @temp;
2090 foreach $k (keys %parm_transports)
2094 @temp = split /\//, $k;
2095 $parm_transports{"$temp[0]"} = " ";
2096 for ($i = 1; $i < @temp; $i++)
2097 { $parm_transports{"$temp[0]/$temp[$i]"} = " "; }
2103 print "-" x 78, "\n";
2106 ##################################################
2107 # Check for SpamAssassin and ClamAV #
2108 ##################################################
2110 # These are crude tests. If they aren't good enough, we'll have to improve
2111 # them, for example by actually passing a message through spamc or clamscan.
2113 if (defined $parm_support{'Content_Scanning'})
2115 if (system("spamc -h 2>/dev/null >/dev/null") == 0)
2117 print "The spamc command works:\n";
2119 # This test for an active SpamAssassin is courtesy of John Jetmore.
2120 # The tests are hard coded to localhost:783, so no point in making
2121 # this test flexible like the clamav test until the test scripts are
2122 # changed. spamd doesn't have the nice PING/PONG protoccol that
2123 # clamd does, but it does respond to errors in an informative manner,
2126 my($sint,$sport) = ('127.0.0.1',783);
2129 my $sin = sockaddr_in($sport, inet_aton($sint))
2130 or die "** Failed packing $sint:$sport\n";
2131 socket(SOCK, PF_INET, SOCK_STREAM, getprotobyname('tcp'))
2132 or die "** Unable to open socket $sint:$sport\n";
2135 sub { die "** Timeout while connecting to socket $sint:$sport\n"; };
2138 or die "** Unable to connect to socket $sint:$sport\n";
2141 select((select(SOCK), $| = 1)[0]);
2142 print SOCK "bad command\r\n";
2145 sub { die "** Timeout while reading from socket $sint:$sport\n"; };
2151 or die "** Did not get SPAMD from socket $sint:$sport. "
2158 print " Assume SpamAssassin (spamd) is not running\n";
2162 $parm_running{'SpamAssassin'} = ' ';
2163 print " SpamAssassin (spamd) seems to be running\n";
2168 print "The spamc command failed: assume SpamAssassin (spamd) is not running\n";
2171 # For ClamAV, we need to find the clamd socket for use in the Exim
2172 # configuration. Search for the clamd configuration file.
2174 if (system("clamscan -h 2>/dev/null >/dev/null") == 0)
2176 my($f, $clamconf, $test_prefix);
2178 print "The clamscan command works";
2180 $test_prefix = $ENV{EXIM_TEST_PREFIX};
2181 $test_prefix = "" if !defined $test_prefix;
2183 foreach $f ("$test_prefix/etc/clamd.conf",
2184 "$test_prefix/usr/local/etc/clamd.conf",
2185 "$test_prefix/etc/clamav/clamd.conf", "")
2194 # Read the ClamAV configuration file and find the socket interface.
2196 if ($clamconf ne "")
2199 open(IN, "$clamconf") || die "\n** Unable to open $clamconf: $!\n";
2202 if (/^LocalSocket\s+(.*)/)
2204 $parm_clamsocket = $1;
2205 $socket_domain = AF_UNIX;
2208 if (/^TCPSocket\s+(\d+)/)
2210 if (defined $parm_clamsocket)
2212 $parm_clamsocket .= " $1";
2213 $socket_domain = AF_INET;
2218 $parm_clamsocket = " $1";
2221 elsif (/^TCPAddr\s+(\S+)/)
2223 if (defined $parm_clamsocket)
2225 $parm_clamsocket = $1 . $parm_clamsocket;
2226 $socket_domain = AF_INET;
2231 $parm_clamsocket = $1;
2237 if (defined $socket_domain)
2239 print ":\n The clamd socket is $parm_clamsocket\n";
2240 # This test for an active ClamAV is courtesy of Daniel Tiefnig.
2244 if ($socket_domain == AF_UNIX)
2246 $socket = sockaddr_un($parm_clamsocket) or die "** Failed packing '$parm_clamsocket'\n";
2248 elsif ($socket_domain == AF_INET)
2250 my ($ca_host, $ca_port) = split(/\s+/,$parm_clamsocket);
2251 my $ca_hostent = gethostbyname($ca_host) or die "** Failed to get raw address for host '$ca_host'\n";
2252 $socket = sockaddr_in($ca_port, $ca_hostent) or die "** Failed packing '$parm_clamsocket'\n";
2256 die "** Unknown socket domain '$socket_domain' (should not happen)\n";
2258 socket(SOCK, $socket_domain, SOCK_STREAM, 0) or die "** Unable to open socket '$parm_clamsocket'\n";
2259 local $SIG{ALRM} = sub { die "** Timeout while connecting to socket '$parm_clamsocket'\n"; };
2261 connect(SOCK, $socket) or die "** Unable to connect to socket '$parm_clamsocket'\n";
2264 my $ofh = select SOCK; $| = 1; select $ofh;
2265 print SOCK "PING\n";
2267 $SIG{ALRM} = sub { die "** Timeout while reading from socket '$parm_clamsocket'\n"; };
2272 $res =~ /PONG/ or die "** Did not get PONG from socket '$parm_clamsocket'. It said: $res\n";
2279 print " Assume ClamAV is not running\n";
2283 $parm_running{'ClamAV'} = ' ';
2284 print " ClamAV seems to be running\n";
2289 print ", but the socket for clamd could not be determined\n";
2290 print "Assume ClamAV is not running\n";
2296 print ", but I can't find a configuration for clamd\n";
2297 print "Assume ClamAV is not running\n";
2303 ##################################################
2304 # Test for the basic requirements #
2305 ##################################################
2307 # This test suite assumes that Exim has been built with at least the "usual"
2308 # set of routers, transports, and lookups. Ensure that this is so.
2312 $missing .= " Lookup: lsearch\n" if (!defined $parm_lookups{'lsearch'});
2314 $missing .= " Router: accept\n" if (!defined $parm_routers{'accept'});
2315 $missing .= " Router: dnslookup\n" if (!defined $parm_routers{'dnslookup'});
2316 $missing .= " Router: manualroute\n" if (!defined $parm_routers{'manualroute'});
2317 $missing .= " Router: redirect\n" if (!defined $parm_routers{'redirect'});
2319 $missing .= " Transport: appendfile\n" if (!defined $parm_transports{'appendfile'});
2320 $missing .= " Transport: autoreply\n" if (!defined $parm_transports{'autoreply'});
2321 $missing .= " Transport: pipe\n" if (!defined $parm_transports{'pipe'});
2322 $missing .= " Transport: smtp\n" if (!defined $parm_transports{'smtp'});
2327 print "** Many features can be included or excluded from Exim binaries.\n";
2328 print "** This test suite requires that Exim is built to contain a certain\n";
2329 print "** set of basic facilities. It seems that some of these are missing\n";
2330 print "** from the binary that is under test, so the test cannot proceed.\n";
2331 print "** The missing facilities are:\n";
2333 die "** Test script abandoned\n";
2337 ##################################################
2338 # Check for the auxiliary programs #
2339 ##################################################
2341 # These are always required:
2343 for $prog ("cf", "checkaccess", "client", "client-ssl", "client-gnutls",
2344 "fakens", "iefbr14", "server")
2346 next if ($prog eq "client-ssl" && !defined $parm_support{'OpenSSL'});
2347 next if ($prog eq "client-gnutls" && !defined $parm_support{'GnuTLS'});
2348 if (!-e "bin/$prog")
2351 print "** bin/$prog does not exist. Have you run ./configure and make?\n";
2352 die "** Test script abandoned\n";
2356 # If the "loaded" binary is missing, we cut out tests for ${dlfunc. It isn't
2357 # compiled on systems where we don't know how to. However, if Exim does not
2358 # have that functionality compiled, we needn't bother.
2360 $dlfunc_deleted = 0;
2361 if (defined $parm_support{'Expand_dlfunc'} && !-e "bin/loaded")
2363 delete $parm_support{'Expand_dlfunc'};
2364 $dlfunc_deleted = 1;
2368 ##################################################
2369 # Find environmental details #
2370 ##################################################
2372 # Find the caller of this program.
2374 ($parm_caller,$pwpw,$parm_caller_uid,$parm_caller_gid,$pwquota,$pwcomm,
2375 $parm_caller_gecos, $parm_caller_home) = getpwuid($>);
2377 $pwpw = $pwpw; # Kill Perl warnings
2378 $pwquota = $pwquota;
2381 $parm_caller_group = getgrgid($parm_caller_gid);
2383 print "Program caller is $parm_caller, whose group is $parm_caller_group\n";
2384 print "Home directory is $parm_caller_home\n";
2386 print "You need to be in the Exim group to run these tests. Checking ...";
2388 if (`groups` =~ /\b\Q$parm_eximgroup\E\b/)
2394 print "\nOh dear, you are not in the Exim group.\n";
2395 die "** Testing abandoned.\n";
2398 # Find this host's IP addresses - there may be many, of course, but we keep
2399 # one of each type (IPv4 and IPv6).
2407 open(IFCONFIG, "ifconfig -a|") || die "** Cannot run \"ifconfig\": $!\n";
2408 while (($parm_ipv4 eq "" || $parm_ipv6 eq "") && ($_ = <IFCONFIG>))
2411 if ($parm_ipv4 eq "" &&
2412 $_ =~ /^\s*inet(?:\saddr)?:?\s?(\d+\.\d+\.\d+\.\d+)\s/i)
2415 next if ($ip eq "127.0.0.1");
2419 if ($parm_ipv6 eq "" &&
2420 $_ =~ /^\s*inet6(?:\saddr)?:?\s?([abcdef\d:]+)/i)
2423 next if ($ip eq "::1" || $ip =~ /^fe80/i);
2429 # Use private IP addresses if there are no public ones.
2431 $parm_ipv4 = $local_ipv4 if ($parm_ipv4 eq "");
2432 $parm_ipv6 = $local_ipv6 if ($parm_ipv6 eq "");
2434 # If either type of IP address is missing, we need to set the value to
2435 # something other than empty, because that wrecks the substitutions. The value
2436 # is reflected, so use a meaningful string. Set appropriate options for the
2437 # "server" command. In practice, however, many tests assume 127.0.0.1 is
2438 # available, so things will go wrong if there is no IPv4 address. The lack
2439 # of IPV4 or IPv6 can be simulated by command options, which force $have_ipv4
2440 # and $have_ipv6 false.
2442 if ($parm_ipv4 eq "")
2445 $parm_ipv4 = "<no IPv4 address found>";
2446 $server_opts .= " -noipv4";
2448 elsif ($have_ipv4 == 0)
2450 $parm_ipv4 = "<IPv4 testing disabled>";
2451 $server_opts .= " -noipv4";
2455 $parm_running{"IPv4"} = " ";
2458 if ($parm_ipv6 eq "")
2461 $parm_ipv6 = "<no IPv6 address found>";
2462 $server_opts .= " -noipv6";
2463 delete($parm_support{"IPv6"});
2465 elsif ($have_ipv6 == 0)
2467 $parm_ipv6 = "<IPv6 testing disabled>";
2468 $server_opts .= " -noipv6";
2469 delete($parm_support{"IPv6"});
2471 elsif (!defined $parm_support{'IPv6'})
2474 $parm_ipv6 = "<no IPv6 support in Exim binary>";
2475 $server_opts .= " -noipv6";
2479 $parm_running{"IPv6"} = " ";
2482 print "IPv4 address is $parm_ipv4\n";
2483 print "IPv6 address is $parm_ipv6\n";
2485 # For munging test output, we need the reversed IP addresses.
2487 $parm_ipv4r = ($parm_ipv4 !~ /^\d/)? "" :
2488 join(".", reverse(split /\./, $parm_ipv4));
2490 $parm_ipv6r = $parm_ipv6; # Appropriate if not in use
2491 if ($parm_ipv6 =~ /^[\da-f]/)
2493 my(@comps) = split /:/, $parm_ipv6;
2495 foreach $comp (@comps)
2497 push @nibbles, sprintf("%lx", hex($comp) >> 8);
2498 push @nibbles, sprintf("%lx", hex($comp) & 0xff);
2500 $parm_ipv6r = join(".", reverse(@nibbles));
2503 # Find the host name, fully qualified.
2505 chomp($temp = `hostname`);
2506 $parm_hostname = (gethostbyname($temp))[0];
2507 $parm_hostname = "no.host.name.found" if $parm_hostname eq "";
2508 print "Hostname is $parm_hostname\n";
2510 if ($parm_hostname !~ /\./)
2512 print "\n*** Host name is not fully qualified: this may cause problems ***\n\n";
2515 # Find the user's shell
2517 $parm_shell = $ENV{'SHELL'};
2520 ##################################################
2521 # Create a testing version of Exim #
2522 ##################################################
2524 # We want to be able to run Exim with a variety of configurations. Normally,
2525 # the use of -C to change configuration causes Exim to give up its root
2526 # privilege (unless the caller is exim or root). For these tests, we do not
2527 # want this to happen. Also, we want Exim to know that it is running in its
2530 # We achieve this by copying the binary and patching it as we go. The new
2531 # binary knows it is a testing copy, and it allows -C and -D without loss of
2532 # privilege. Clearly, this file is dangerous to have lying around on systems
2533 # where there are general users with login accounts. To protect against this,
2534 # we put the new binary in a special directory that is accessible only to the
2535 # caller of this script, who is known to have sudo root privilege from the test
2536 # that was done above. Furthermore, we ensure that the binary is deleted at the
2537 # end of the test. First ensure the directory exists.
2540 { unlink "eximdir/exim"; } # Just in case
2543 mkdir("eximdir", 0710) || die "** Unable to mkdir $parm_cwd/eximdir: $!\n";
2544 system("sudo chgrp $parm_eximgroup eximdir");
2547 # The construction of the patched binary must be done as root, so we use
2548 # a separate script. As well as indicating that this is a test-harness binary,
2549 # the version number is patched to "x.yz" so that its length is always the
2550 # same. Otherwise, when it appears in Received: headers, it affects the length
2551 # of the message, which breaks certain comparisons.
2553 die "** Unable to make patched exim: $!\n"
2554 if (system("sudo ./patchexim $parm_exim") != 0);
2556 # From this point on, exits from the program must go via the subroutine
2557 # tests_exit(), so that suitable cleaning up can be done when required.
2558 # Arrange to catch interrupting signals, to assist with this.
2560 $SIG{'INT'} = \&inthandler;
2561 $SIG{'PIPE'} = \&pipehandler;
2563 # For some tests, we need another copy of the binary that is setuid exim rather
2566 system("sudo cp eximdir/exim eximdir/exim_exim;" .
2567 "sudo chown $parm_eximuser eximdir/exim_exim;" .
2568 "sudo chgrp $parm_eximgroup eximdir/exim_exim;" .
2569 "sudo chmod 06755 eximdir/exim_exim");
2572 ##################################################
2573 # Make copies of utilities we might need #
2574 ##################################################
2576 # Certain of the tests make use of some of Exim's utilities. We do not need
2577 # to be root to copy these.
2579 ($parm_exim_dir) = $parm_exim =~ ?^(.*)/exim?;
2581 $dbm_build_deleted = 0;
2582 if (defined $parm_lookups{'dbm'} &&
2583 system("cp $parm_exim_dir/exim_dbmbuild eximdir") != 0)
2585 delete $parm_lookups{'dbm'};
2586 $dbm_build_deleted = 1;
2589 if (system("cp $parm_exim_dir/exim_dumpdb eximdir") != 0)
2591 tests_exit(-1, "Failed to make a copy of exim_dumpdb: $!");
2594 if (system("cp $parm_exim_dir/exim_lock eximdir") != 0)
2596 tests_exit(-1, "Failed to make a copy of exim_lock: $!");
2599 if (system("cp $parm_exim_dir/exinext eximdir") != 0)
2601 tests_exit(-1, "Failed to make a copy of exinext: $!");
2604 if (system("cp $parm_exim_dir/exigrep eximdir") != 0)
2606 tests_exit(-1, "Failed to make a copy of exigrep: $!");
2609 if (system("cp $parm_exim_dir/eximstats eximdir") != 0)
2611 tests_exit(-1, "Failed to make a copy of eximstats: $!");
2615 ##################################################
2616 # Check that the Exim user can access stuff #
2617 ##################################################
2619 # We delay this test till here so that we can check access to the actual test
2620 # binary. This will be needed when Exim re-exec's itself to do deliveries.
2622 print "Exim user is $parm_eximuser ($parm_exim_uid)\n";
2623 print "Exim group is $parm_eximgroup ($parm_exim_gid)\n";
2625 if ($parm_caller_uid eq $parm_exim_uid) {
2626 tests_exit(-1, "Exim user ($parm_eximuser,$parm_exim_uid) cannot be "
2627 ."the same as caller ($parm_caller,$parm_caller_uid)");
2630 print "The Exim user needs access to the test suite directory. Checking ...";
2632 if (($rc = system("sudo bin/checkaccess $parm_cwd/eximdir/exim $parm_eximuser $parm_eximgroup")) != 0)
2634 my($why) = "unknown failure $rc";
2636 $why = "Couldn't find user \"$parm_eximuser\"" if $rc == 1;
2637 $why = "Couldn't find group \"$parm_eximgroup\"" if $rc == 2;
2638 $why = "Couldn't read auxiliary group list" if $rc == 3;
2639 $why = "Couldn't get rid of auxiliary groups" if $rc == 4;
2640 $why = "Couldn't set gid" if $rc == 5;
2641 $why = "Couldn't set uid" if $rc == 6;
2642 $why = "Couldn't open \"$parm_cwd/eximdir/exim\"" if $rc == 7;
2643 print "\n** $why\n";
2644 tests_exit(-1, "$parm_eximuser cannot access the test suite directory");
2652 ##################################################
2653 # Create a list of available tests #
2654 ##################################################
2656 # The scripts directory contains a number of subdirectories whose names are
2657 # of the form 0000-xxxx, 1100-xxxx, 2000-xxxx, etc. Each set of tests apart
2658 # from the first requires certain optional features to be included in the Exim
2659 # binary. These requirements are contained in a file called "REQUIRES" within
2660 # the directory. We scan all these tests, discarding those that cannot be run
2661 # because the current binary does not support the right facilities, and also
2662 # those that are outside the numerical range selected.
2664 print "\nTest range is $test_start to $test_end\n";
2665 print "Omitting \${dlfunc expansion tests (loadable module not present)\n"
2667 print "Omitting dbm tests (unable to copy exim_dbmbuild)\n"
2668 if $dbm_build_deleted;
2670 opendir(DIR, "scripts") || tests_exit(-1, "Failed to opendir(\"scripts\"): $!");
2671 @test_dirs = sort readdir(DIR);
2674 # Remove . and .. and CVS from the list.
2676 for ($i = 0; $i < @test_dirs; $i++)
2678 my($d) = $test_dirs[$i];
2679 if ($d eq "." || $d eq ".." || $d eq "CVS")
2681 splice @test_dirs, $i, 1;
2686 # Scan for relevant tests
2688 for ($i = 0; $i < @test_dirs; $i++)
2690 my($testdir) = $test_dirs[$i];
2693 print ">>Checking $testdir\n" if $debug;
2695 # Skip this directory if the first test is equal or greater than the first
2696 # test in the next directory.
2698 next if ($i < @test_dirs - 1) &&
2699 ($test_start >= substr($test_dirs[$i+1], 0, 4));
2701 # No need to carry on if the end test is less than the first test in this
2704 last if $test_end < substr($testdir, 0, 4);
2706 # Check requirements, if any.
2708 if (open(REQUIRES, "scripts/$testdir/REQUIRES"))
2714 if (/^support (.*)$/)
2716 if (!defined $parm_support{$1}) { $wantthis = 0; last; }
2718 elsif (/^running (.*)$/)
2720 if (!defined $parm_running{$1}) { $wantthis = 0; last; }
2722 elsif (/^lookup (.*)$/)
2724 if (!defined $parm_lookups{$1}) { $wantthis = 0; last; }
2726 elsif (/^authenticators? (.*)$/)
2728 if (!defined $parm_authenticators{$1}) { $wantthis = 0; last; }
2730 elsif (/^router (.*)$/)
2732 if (!defined $parm_routers{$1}) { $wantthis = 0; last; }
2734 elsif (/^transport (.*)$/)
2736 if (!defined $parm_transports{$1}) { $wantthis = 0; last; }
2740 tests_exit(-1, "Unknown line in \"scripts/$testdir/REQUIRES\": \"$_\"");
2747 tests_exit(-1, "Failed to open \"scripts/$testdir/REQUIRES\": $!")
2751 # Loop if we do not want the tests in this subdirectory.
2756 print "Omitting tests in $testdir (missing $_)\n";
2760 # We want the tests from this subdirectory, provided they are in the
2761 # range that was selected.
2763 opendir(SUBDIR, "scripts/$testdir") ||
2764 tests_exit(-1, "Failed to opendir(\"scripts/$testdir\"): $!");
2765 @testlist = sort readdir(SUBDIR);
2768 foreach $test (@testlist)
2770 next if $test !~ /^\d{4}$/;
2771 next if $test < $test_start || $test > $test_end;
2772 push @test_list, "$testdir/$test";
2776 print ">>Test List: @test_list\n", if $debug;
2779 ##################################################
2780 # Munge variable auxiliary data #
2781 ##################################################
2783 # Some of the auxiliary data files have to refer to the current testing
2784 # directory and other parameter data. The generic versions of these files are
2785 # stored in the aux-var-src directory. At this point, we copy each of them
2786 # to the aux-var directory, making appropriate substitutions. There aren't very
2787 # many of them, so it's easiest just to do this every time. Ensure the mode
2788 # is standardized, as this path is used as a test for the ${stat: expansion.
2790 # A similar job has to be done for the files in the dnszones-src directory, to
2791 # make the fake DNS zones for testing. Most of the zone files are copied to
2792 # files of the same name, but db.ipv4.V4NET and db.ipv6.V6NET use the testing
2793 # networks that are defined by parameter.
2795 foreach $basedir ("aux-var", "dnszones")
2797 system("sudo rm -rf $parm_cwd/$basedir");
2798 mkdir("$parm_cwd/$basedir", 0777);
2799 chmod(0755, "$parm_cwd/$basedir");
2801 opendir(AUX, "$parm_cwd/$basedir-src") ||
2802 tests_exit(-1, "Failed to opendir $parm_cwd/$basedir-src: $!");
2803 my(@filelist) = readdir(AUX);
2806 foreach $file (@filelist)
2808 my($outfile) = $file;
2809 next if $file =~ /^\./;
2811 if ($file eq "db.ip4.V4NET")
2813 $outfile = "db.ip4.$parm_ipv4_test_net";
2815 elsif ($file eq "db.ip6.V6NET")
2817 my(@nibbles) = reverse(split /\s*/, $parm_ipv6_test_net);
2819 $outfile = "db.ip6.@nibbles";
2823 print ">>Copying $basedir-src/$file to $basedir/$outfile\n" if $debug;
2824 open(IN, "$parm_cwd/$basedir-src/$file") ||
2825 tests_exit(-1, "Failed to open $parm_cwd/$basedir-src/$file: $!");
2826 open(OUT, ">$parm_cwd/$basedir/$outfile") ||
2827 tests_exit(-1, "Failed to open $parm_cwd/$basedir/$outfile: $!");
2839 ##################################################
2840 # Create fake DNS zones for this host #
2841 ##################################################
2843 # There are fixed zone files for 127.0.0.1 and ::1, but we also want to be
2844 # sure that there are forward and reverse registrations for this host, using
2845 # its real IP addresses. Dynamically created zone files achieve this.
2847 if ($have_ipv4 || $have_ipv6)
2849 my($shortname,$domain) = $parm_hostname =~ /^([^.]+)(.*)/;
2850 open(OUT, ">$parm_cwd/dnszones/db$domain") ||
2851 tests_exit(-1, "Failed to open $parm_cwd/dnszones/db$domain: $!");
2852 print OUT "; This is a dynamically constructed fake zone file.\n" .
2853 "; The following line causes fakens to return PASS_ON\n" .
2854 "; for queries that it cannot answer\n\n" .
2855 "PASS ON NOT FOUND\n\n";
2856 print OUT "$shortname A $parm_ipv4\n" if $have_ipv4;
2857 print OUT "$shortname AAAA $parm_ipv6\n" if $have_ipv6;
2858 print OUT "\n; End\n";
2862 if ($have_ipv4 && $parm_ipv4 ne "127.0.0.1")
2864 my(@components) = $parm_ipv4 =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)/;
2865 open(OUT, ">$parm_cwd/dnszones/db.ip4.$components[0]") ||
2867 "Failed to open $parm_cwd/dnszones/db.ip4.$components[0]: $!");
2868 print OUT "; This is a dynamically constructed fake zone file.\n" .
2869 "; The zone is $components[0].in-addr.arpa.\n\n" .
2870 "$components[3].$components[2].$components[1] PTR $parm_hostname.\n\n" .
2875 if ($have_ipv6 && $parm_ipv6 ne "::1")
2877 my(@components) = split /:/, $parm_ipv6;
2878 my(@nibbles) = reverse (split /\s*/, shift @components);
2882 open(OUT, ">$parm_cwd/dnszones/db.ip6.@nibbles") ||
2884 "Failed to open $parm_cwd/dnszones/db.ip6.@nibbles: $!");
2885 print OUT "; This is a dynamically constructed fake zone file.\n" .
2886 "; The zone is @nibbles.ip6.arpa.\n\n";
2888 @components = reverse @components;
2889 foreach $c (@components)
2891 $c = "0$c" until $c =~ /^..../;
2892 @nibbles = reverse(split /\s*/, $c);
2893 print OUT "$sep@nibbles";
2897 print OUT " PTR $parm_hostname.\n\n; End\n";
2904 ##################################################
2905 # Create lists of mailboxes and message logs #
2906 ##################################################
2908 # We use these lists to check that a test has created the expected files. It
2909 # should be faster than looking for the file each time. For mailboxes, we have
2910 # to scan a complete subtree, in order to handle maildirs. For msglogs, there
2911 # is just a flat list of files.
2913 @oldmails = list_files_below("mail");
2914 opendir(DIR, "msglog") || tests_exit(-1, "Failed to opendir msglog: $!");
2915 @oldmsglogs = readdir(DIR);
2920 ##################################################
2921 # Run the required tests #
2922 ##################################################
2924 # Each test script contains a number of tests, separated by a line that
2925 # contains ****. We open input from the terminal so that we can read responses
2928 open(T, "/dev/tty") || tests_exit(-1, "Failed to open /dev/tty: $!");
2930 print "\nPress RETURN to run the tests: ";
2936 foreach $test (@test_list)
2939 local($commandno) = 0;
2940 local($subtestno) = 0;
2941 local($testno) = substr($test, -4);
2942 local($sortlog) = 0;
2946 my($thistestdir) = substr($test, 0, -5);
2948 if ($lasttestdir ne $thistestdir)
2951 if (-s "scripts/$thistestdir/REQUIRES")
2954 print "\n>>> The following tests require: ";
2955 open(IN, "scripts/$thistestdir/REQUIRES") ||
2956 tests_exit(-1, "Failed to open scripts/$thistestdir/REQUIRES: $1");
2959 $gnutls = 1 if /^support GnuTLS/;
2966 $lasttestdir = $thistestdir;
2968 # Remove any debris in the spool directory and the test-mail directory
2969 # and also the files for collecting stdout and stderr. Then put back
2970 # the test-mail directory for appendfile deliveries.
2972 system "sudo /bin/rm -rf spool test-*";
2973 system "mkdir test-mail 2>/dev/null";
2975 # A privileged Exim will normally make its own spool directory, but some of
2976 # the tests run in unprivileged modes that don't always work if the spool
2977 # directory isn't already there. What is more, we want anybody to be able
2978 # to read it in order to find the daemon's pid.
2980 system "mkdir spool; " .
2981 "sudo chown $parm_eximuser:$parm_eximgroup spool; " .
2982 "sudo chmod 0755 spool";
2984 # Empty the cache that keeps track of things like message id mappings, and
2985 # set up the initial sequence strings.
2998 # Remove the associative arrays used to hold checked mail files and msglogs
3000 undef %expected_mails;
3001 undef %expected_msglogs;
3003 # Open the test's script
3005 open(SCRIPT, "scripts/$test") ||
3006 tests_exit(-1, "Failed to open \"scripts/$test\": $!");
3008 # The first line in the script must be a comment that is used to identify
3009 # the set of tests as a whole.
3013 tests_exit(-1, "Missing identifying comment at start of $test") if (!/^#/);
3014 printf("%s %s", (substr $test, 5), (substr $_, 2));
3016 # Loop for each of the subtests within the script. The variable $server_pid
3017 # is used to remember the pid of a "server" process, for which we do not
3018 # wait until we have waited for a subsequent command.
3020 local($server_pid) = 0;
3021 for ($commandno = 1; !eof SCRIPT; $commandno++)
3023 # Skip further leading comments and blank lines, handle the flag setting
3024 # commands, and deal with tests for IP support.
3029 if (/^no_message_check/) { $message_skip = 1; next; }
3030 if (/^no_msglog_check/) { $msglog_skip = 1; next; }
3031 if (/^no_stderr_check/) { $stderr_skip = 1; next; }
3032 if (/^no_stdout_check/) { $stdout_skip = 1; next; }
3033 if (/^rmfiltertest/) { $rmfiltertest = 1; next; }
3034 if (/^sortlog/) { $sortlog = 1; next; }
3036 if (/^need_largefiles/)
3038 next if $have_largefiles;
3039 print ">>> Large file support is needed for test $testno, but is not available: skipping\n";
3040 $docheck = 0; # don't check output
3041 undef $_; # pretend EOF
3048 print ">>> IPv4 is needed for test $testno, but is not available: skipping\n";
3049 $docheck = 0; # don't check output
3050 undef $_; # pretend EOF
3061 print ">>> IPv6 is needed for test $testno, but is not available: skipping\n";
3062 $docheck = 0; # don't check output
3063 undef $_; # pretend EOF
3067 if (/^need_move_frozen_messages/)
3069 next if defined $parm_support{"move_frozen_messages"};
3070 print ">>> move frozen message support is needed for test $testno, " .
3071 "but is not\n>>> available: skipping\n";
3072 $docheck = 0; # don't check output
3073 undef $_; # pretend EOF
3077 last unless /^(#|\s*$)/;
3079 last if !defined $_; # Hit EOF
3081 my($subtest_startline) = $lineno;
3083 # Now run the command. The function returns 0 if exim was run and waited
3084 # for, 1 if any other command was run and waited for, and 2 if a command
3085 # was run and not waited for (usually a daemon or server startup).
3087 my($commandname) = "";
3089 my($rc) = run_command($testno, \$subtestno, \$expectrc, \$commandname);
3092 print ">> rc=$rc cmdrc=$cmdrc\n" if $debug;
3094 # Hit EOF after an initial return code number
3096 tests_exit(-1, "Unexpected EOF in script") if ($rc == 4);
3098 # Carry on with the next command if we did not wait for this one. $rc == 0
3099 # if no subprocess was run; $rc == 3 if we started a process but did not
3102 next if ($rc == 0 || $rc == 3);
3104 # We ran and waited for a command. Check for the expected result unless
3107 if ($cmdrc != $expectrc && !$sigpipehappened)
3109 printf("** Command $commandno (\"$commandname\", starting at line $subtest_startline)\n");
3110 if (($cmdrc & 0xff) == 0)
3112 printf("** Return code %d (expected %d)", $cmdrc/256, $expectrc/256);
3114 elsif (($cmdrc & 0xff00) == 0)
3115 { printf("** Killed by signal %d", $cmdrc & 255); }
3117 { printf("** Status %x", $cmdrc); }
3121 print "\nshow stdErr, show stdOut, Continue (without file comparison), or Quit? [Q] ";
3123 tests_exit(1) if /^q?$/i;
3127 system("$more test-stderr");
3131 system("$more test-stdout");
3138 # If the command was exim, and a listening server is running, we can now
3139 # close its input, which causes us to wait for it to finish, which is why
3140 # we didn't close it earlier.
3142 if ($rc == 2 && $server_pid != 0)
3148 if (($? & 0xff) == 0)
3149 { printf("Server return code %d", $?/256); }
3150 elsif (($? & 0xff00) == 0)
3151 { printf("Server killed by signal %d", $? & 255); }
3153 { printf("Server status %x", $?); }
3157 print "\nShow server stdout, Continue, or Quit? [Q] ";
3159 tests_exit(1) if /^q?$/i;
3164 open(S, "test-stdout-server") ||
3165 tests_exit(-1, "Failed to open test-stdout-server: $!");
3176 # The script has finished. Check the all the output that was generated. The
3177 # function returns 0 if all is well, 1 if we should rerun the test (the files
3178 # have been updated). It does not return if the user responds Q to a prompt.
3182 if (check_output() != 0)
3184 print (("#" x 79) . "\n");
3189 print (" Script completed\n");
3195 ##################################################
3196 # Exit from the test script #
3197 ##################################################
3199 tests_exit(-1, "No runnable tests selected") if @test_list == 0;
3202 # End of runtest script