2 # We use env, because in some environments of our build farm
3 # the Perl 5.010 interpreter is only reachable via $PATH
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 ###############################################################################
21 use if $^V >= v5.19.11, experimental => 'smartmatch';
31 use FindBin qw'$RealBin';
33 use lib "$RealBin/lib";
35 use Exim::Utils qw(uniq numerically);
37 use if $ENV{DEBUG} && scalar($ENV{DEBUG} =~ /\bruntest\b/) => 'Smart::Comments' => '####';
38 use if $ENV{DEBUG} && scalar($ENV{DEBUG} =~ /\bruntest\b/) => 'Data::Dumper';
40 use constant TEST_TOP => 8999;
41 use constant TEST_SPECIAL_TOP => 9999;
44 # Start by initializing some global variables
46 chomp(my $testversion = `git describe --always --dirty 2>&1` || '<unknown>');
48 # This gets embedded in the D-H params filename, and the value comes
49 # from asking GnuTLS for "normal", but there appears to be no way to
50 # use certtool/... to ask what that value currently is. *sigh*
51 # We also clamp it because of NSS interop, see addition of tls_dh_max_bits.
52 # This value is correct as of GnuTLS 2.12.18 as clamped by tls_dh_max_bits.
53 # normal = 2432 tls_dh_max_bits = 2236
54 my $gnutls_dh_bits_normal = 2236;
56 my $cf = 'bin/cf -exact';
60 my $f = Exim::Runtest::flavour() // '';
61 (grep { $f eq $_ } Exim::Runtest::flavours()) ? $f : 'FOO';
63 my $force_continue = 0;
65 my $log_failed_filename = 'failed-summary.log';
66 my $log_summary_filename = 'run-summary.log';
67 my @more = qw'less -XF';
76 my $have_largefiles = 0;
81 # Networks to use for DNS tests. We need to choose some networks that will
82 # never be used so that there is no chance that the host on which we are
83 # running is actually in one of the test networks. Private networks such as
84 # the IPv4 10.0.0.0/8 network are no good because hosts may well use them.
85 # Rather than use some unassigned numbers (that might become assigned later),
86 # I have chosen some multicast networks, in the belief that such addresses
87 # won't ever be assigned to hosts. This is the only place where these numbers
88 # are defined, so it is trivially possible to change them should that ever
91 my $parm_ipv4_test_net = 224;
92 my $parm_ipv6_test_net = 'ff00';
94 # Port numbers are currently hard-wired
96 my $parm_port_n = 1223; # Nothing listening on this port
97 my $parm_port_s = 1224; # Used for the "server" command
98 my $parm_port_d = 1225; # Used for the Exim daemon
99 my $parm_port_d2 = 1226; # Additional for daemon
100 my $parm_port_d3 = 1227; # Additional for daemon
101 my $parm_port_d4 = 1228; # Additional for daemon
102 my $dynamic_socket; # allocated later for PORT_DYNAMIC
104 # Find a suiteable group name for test (currently only 0001
105 # uses a group name. A numeric group id would do
106 my $parm_mailgroup = Exim::Runtest::mailgroup('mail');
108 # Manually set locale
111 # In some environments USER does not exist, but we need it for some test(s)
112 $ENV{USER} = getpwuid($>) if not exists $ENV{USER};
114 my ($parm_configure_owner, $parm_configure_group);
115 my ($parm_ipv4, $parm_ipv6, $parm_ipv6_stripped);
118 ###############################################################################
119 ###############################################################################
121 # Define a number of subroutines
123 ###############################################################################
124 ###############################################################################
127 ##################################################
129 ##################################################
131 sub pipehandler { $sigpipehappened = 1; }
133 sub inthandler { print "\n"; tests_exit(-1, "Caught SIGINT"); }
136 ##################################################
137 # Do global macro substitutions #
138 ##################################################
140 # This function is applied to configurations, command lines and data lines in
141 # scripts, and to lines in the files of the aux-var-src and the dnszones-src
142 # directory. It takes one argument: the current test number, or zero when
143 # setting up files before running any tests.
146 s?\bCALLER\b?$parm_caller?g;
147 s?\bCALLERGROUP\b?$parm_caller_group?g;
148 s?\bCALLER_UID\b?$parm_caller_uid?g;
149 s?\bCALLER_GID\b?$parm_caller_gid?g;
150 s?\bCLAMSOCKET\b?$parm_clamsocket?g;
151 s?\bDIR/?$parm_cwd/?g;
152 s?\bEXIMGROUP\b?$parm_eximgroup?g;
153 s?\bEXIMUSER\b?$parm_eximuser?g;
154 s?\bHOSTIPV4\b?$parm_ipv4?g;
155 s?\bHOSTIPV6\b?$parm_ipv6?g;
156 s?\bHOSTNAME\b?$parm_hostname?g;
157 s?\bPORT_D\b?$parm_port_d?g;
158 s?\bPORT_D2\b?$parm_port_d2?g;
159 s?\bPORT_D3\b?$parm_port_d3?g;
160 s?\bPORT_D4\b?$parm_port_d4?g;
161 s?\bPORT_N\b?$parm_port_n?g;
162 s?\bPORT_S\b?$parm_port_s?g;
163 s?\bTESTNUM\b?$_[0]?g;
164 s?(\b|_)V4NET([\._])?$1$parm_ipv4_test_net$2?g;
165 s?\bV6NET:?$parm_ipv6_test_net:?g;
166 s?\bPORT_DYNAMIC\b?$dynamic_socket->sockport()?eg;
167 s?\bMAILGROUP\b?$parm_mailgroup?g;
171 ##################################################
172 # Any state to be preserved across tests #
173 ##################################################
178 ##################################################
179 # Subroutine to tidy up and exit #
180 ##################################################
182 # In all cases, we check for any Exim daemons that have been left running, and
183 # kill them. Then remove all the spool data, test output, and the modified Exim
184 # binary if we are ending normally.
187 # $_[0] = 0 for a normal exit; full cleanup done
188 # $_[0] > 0 for an error exit; no files cleaned up
189 # $_[0] < 0 for a "die" exit; $_[1] contains a message
195 # Search for daemon pid files and kill the daemons. We kill with SIGINT rather
196 # than SIGTERM to stop it outputting "Terminated" to the terminal when not in
199 if (exists $TEST_STATE->{exim_pid})
201 $pid = $TEST_STATE->{exim_pid};
202 print "Tidyup: killing wait-mode daemon pid=$pid\n";
203 system("sudo kill -INT $pid");
206 if (opendir(DIR, "spool"))
208 my(@spools) = sort readdir(DIR);
210 foreach $spool (@spools)
212 next if $spool !~ /^exim-daemon./;
213 open(PID, "spool/$spool") || die "** Failed to open \"spool/$spool\": $!\n";
216 print "Tidyup: killing daemon pid=$pid\n";
217 system("sudo rm -f spool/$spool; sudo kill -INT $pid");
221 { die "** Failed to opendir(\"spool\"): $!\n" unless $!{ENOENT}; }
223 # Close the terminal input and remove the test files if all went well, unless
224 # the option to save them is set. Always remove the patched Exim binary. Then
225 # exit normally, or die.
228 system("sudo /bin/rm -rf ./spool test-* ./dnszones/*")
229 if ($rc == 0 && !$save_output);
231 system("sudo /bin/rm -rf ./eximdir/*")
234 print "\nYou were in test $test at the end there.\n\n" if defined $test;
235 exit $rc if ($rc >= 0);
236 die "** runtest error: $_[1]\n";
241 ##################################################
242 # Subroutines used by the munging subroutine #
243 ##################################################
245 # This function is used for things like message ids, where we want to generate
246 # more than one value, but keep a consistent mapping throughout.
249 # $oldid the value from the file
250 # $base a base string into which we insert a sequence
251 # $sequence the address of the current sequence counter
254 my($oldid, $base, $sequence) = @_;
255 my($newid) = $cache{$oldid};
256 if (! defined $newid)
258 $newid = sprintf($base, $$sequence++);
259 $cache{$oldid} = $newid;
265 # This is used while munging the output from exim_dumpdb.
266 # May go wrong across DST changes.
269 my($day,$month,$year,$hour,$min,$sec) =
270 $_[0] =~ /^(\d\d)-(\w\w\w)-(\d{4})\s(\d\d):(\d\d):(\d\d)/;
272 if ($month =~ /Jan/) {$mon = 0;}
273 elsif($month =~ /Feb/) {$mon = 1;}
274 elsif($month =~ /Mar/) {$mon = 2;}
275 elsif($month =~ /Apr/) {$mon = 3;}
276 elsif($month =~ /May/) {$mon = 4;}
277 elsif($month =~ /Jun/) {$mon = 5;}
278 elsif($month =~ /Jul/) {$mon = 6;}
279 elsif($month =~ /Aug/) {$mon = 7;}
280 elsif($month =~ /Sep/) {$mon = 8;}
281 elsif($month =~ /Oct/) {$mon = 9;}
282 elsif($month =~ /Nov/) {$mon = 10;}
283 elsif($month =~ /Dec/) {$mon = 11;}
284 return timelocal($sec,$min,$hour,$day,$mon,$year);
288 # This is a subroutine to sort maildir files into time-order. The second field
289 # is the microsecond field, and may vary in length, so must be compared
293 return $a cmp $b if ($a !~ /^\d+\.H\d/ || $b !~ /^\d+\.H\d/);
294 my($x1,$y1) = $a =~ /^(\d+)\.H(\d+)/;
295 my($x2,$y2) = $b =~ /^(\d+)\.H(\d+)/;
296 return ($x1 != $x2)? ($x1 <=> $x2) : ($y1 <=> $y2);
301 ##################################################
302 # Subroutine list files below a directory #
303 ##################################################
305 # This is used to build up a list of expected mail files below a certain path
306 # in the directory tree. It has to be recursive in order to deal with multiple
309 sub list_files_below {
314 opendir(DIR, $dir) || tests_exit(-1, "Failed to open $dir: $!");
315 @sublist = sort maildirsort readdir(DIR);
318 foreach $file (@sublist)
320 next if $file eq "." || $file eq ".." || $file eq "CVS";
322 { @yield = (@yield, list_files_below("$dir/$file")); }
324 { push @yield, "$dir/$file"; }
332 ##################################################
333 # Munge a file before comparing #
334 ##################################################
336 # The pre-processing turns all dates, times, Exim versions, message ids, and so
337 # on into standard values, so that the compare works. Perl's substitution with
338 # an expression provides a neat way to do some of these changes.
340 # We keep a global associative array for repeatedly turning the same values
341 # into the same standard values throughout the data from a single test.
342 # Message ids get this treatment (can't be made reliable for times), and
343 # times in dumped retry databases are also handled in a special way, as are
344 # incoming port numbers.
346 # On entry to the subroutine, the file to write to is already opened with the
347 # name MUNGED. The input file name is the only argument to the subroutine.
348 # Certain actions are taken only when the name contains "stderr", "stdout",
349 # or "log". The yield of the function is 1 if a line matching "*** truncated
350 # ***" is encountered; otherwise it is 0.
360 open(IN, "$file") || tests_exit(-1, "Failed to open $file: $!");
362 my($is_log) = $file =~ /log/;
363 my($is_stdout) = $file =~ /stdout/;
364 my($is_stderr) = $file =~ /stderr/;
365 my($is_mail) = $file =~ /mail/;
369 $date = "\\d{2}-\\w{3}-\\d{4}\\s\\d{2}:\\d{2}:\\d{2}";
371 # Pattern for matching pids at start of stderr lines; initially something
374 $spid = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
376 # Scan the file and make the changes. Near the bottom there are some changes
377 # that are specific to certain file types, though there are also some of those
382 RESET_AFTER_EXTRA_LINE_READ:
386 next if $extra =~ m%^/% && eval $extra;
387 eval $extra if $extra =~ m/^s/;
390 # Check for "*** truncated ***"
391 $yield = 1 if /\*\*\* truncated \*\*\*/;
393 # Replace the name of this host
394 s/\Q$parm_hostname\E/the.local.host.name/g;
396 # But convert "name=the.local.host address=127.0.0.1" to use "localhost"
397 s/name=the\.local\.host address=127\.0\.0\.1/name=localhost address=127.0.0.1/g;
399 # The name of the shell may vary
400 s/\s\Q$parm_shell\E\b/ ENV_SHELL/;
402 # Replace the path to the testsuite directory
403 s?\Q$parm_cwd\E?TESTSUITE?g;
405 # Replace the Exim version number (may appear in various places)
406 # patchexim should have fixed this for us
407 #s/Exim \K\d+[._]\d+[\w_-]*/x.yz/i;
409 # Replace Exim message ids by a unique series
410 s/((?:[^\W_]{6}-){2}[^\W_]{2})
411 /new_value($1, "10Hm%s-0005vi-00", \$next_msgid)/egx;
413 # The names of lock files appear in some error and debug messages
414 s/\.lock(\.[-\w]+)+(\.[\da-f]+){2}/.lock.test.ex.dddddddd.pppppppp/;
416 # Unless we are in an IPv6 test, replace IPv4 and/or IPv6 in "listening on
417 # port" message, because it is not always the same.
418 s/port (\d+) \([^)]+\)/port $1/g
419 if !$is_ipv6test && m/listening for SMTP(S?) on port/;
421 # Challenges in SPA authentication
422 s/TlRMTVNTUAACAAAAAAAAAAAoAAABgg[\w+\/]+/TlRMTVNTUAACAAAAAAAAAAAoAAABggAAAEbBRwqFwwIAAAAAAAAAAAAt1sgAAAAA/;
425 s?prvs=([^/]+)/[\da-f]{10}@?prvs=$1/xxxxxxxxxx@?g; # Old form
426 s?prvs=[\da-f]{10}=([^@]+)@?prvs=xxxxxxxxxx=$1@?g; # New form
428 # There are differences in error messages between OpenSSL versions
429 s/SSL_CTX_set_cipher_list/SSL_connect/;
431 # One error test in expansions mentions base 62 or 36
432 s/is not a base (36|62) number/is not a base 36\/62 number/;
434 # This message sometimes has a different number of seconds
435 s/forced fail after \d seconds/forced fail after d seconds/;
437 # This message may contain a different DBM library name
438 s/Failed to open \S+( \([^\)]+\))? file/Failed to open DBM file/;
440 # The message for a non-listening FIFO varies
441 s/:[^:]+: while opening named pipe/: Error: while opening named pipe/;
443 # Debugging output of lists of hosts may have different sort keys
444 s/sort=\S+/sort=xx/ if /^\S+ (?:\d+\.){3}\d+ mx=\S+ sort=\S+/;
446 # Random local part in callout cache testing
447 s/myhost.test.ex-\d+-testing/myhost.test.ex-dddddddd-testing/;
448 s/the.local.host.name-\d+-testing/the.local.host.name-dddddddd-testing/;
450 # File descriptor numbers may vary
451 s/^writing data block fd=\d+/writing data block fd=dddd/;
452 s/(running as transport filter:) fd_write=\d+ fd_read=\d+/$1 fd_write=dddd fd_read=dddd/;
455 # ======== Dumpdb output ========
456 # This must be before the general date/date munging.
457 # Time data lines, which look like this:
458 # 25-Aug-2000 12:11:37 25-Aug-2000 12:11:37 26-Aug-2000 12:11:37
459 if (/^($date)\s+($date)\s+($date)(\s+\*)?\s*$/)
461 my($date1,$date2,$date3,$expired) = ($1,$2,$3,$4);
462 $expired = '' if !defined $expired;
464 # Round the time-difference up to nearest even value
465 my($increment) = ((date_seconds($date3) - date_seconds($date2) + 1) >> 1) << 1;
467 # We used to use globally unique replacement values, but timing
468 # differences make this impossible. Just show the increment on the
471 printf MUNGED ("first failed = time last try = time2 next try = time2 + %s%s\n",
472 $increment, $expired);
476 # more_errno values in exim_dumpdb output which are times
477 s/T:(\S+)\s-22\s(\S+)\s/T:$1 -22 xxxx /;
479 # port numbers in dumpdb output
480 s/T:([a-z.]+(:[0-9.]+)?):$parm_port_n /T:$1:PORT_N /;
482 # port numbers in stderr
483 s/^set_process_info: .*\]:\K$parm_port_d /PORT_D /;
484 s/^set_process_info: .*\]:\K$parm_port_s /PORT_S /;
487 # ======== Dates and times ========
489 # Dates and times are all turned into the same value - trying to turn
490 # them into different ones cannot be done repeatedly because they are
491 # real time stamps generated while running the test. The actual date and
492 # time used was fixed when I first started running automatic Exim tests.
494 # Date/time in header lines and SMTP responses
495 s/[A-Z][a-z]{2},\s\d\d?\s[A-Z][a-z]{2}\s\d{4}\s\d\d\:\d\d:\d\d\s[-+]\d{4}
496 /Tue, 2 Mar 1999 09:44:33 +0000/gx;
497 # and in a French locale
498 s/\S{4},\s\d\d?\s[^,]+\s\d{4}\s\d\d\:\d\d:\d\d\s[-+]\d{4}
499 /dim., 10 f\xE9vr 2019 20:05:49 +0000/gx;
501 # Date/time in logs and in one instance of a filter test
502 s/^\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d(\s[+-]\d\d\d\d)?\s/1999-03-02 09:44:33 /gx;
503 s/^\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d\.\d{3}(\s[+-]\d\d\d\d)?\s/2017-07-30 18:51:05.712 /gx;
504 s/^Logwrite\s"\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d/Logwrite "1999-03-02 09:44:33/gx;
505 # Date/time in syslog test
506 s/^SYSLOG:\s\'\K\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d\s/2017-07-30 18:51:05 /gx;
507 s/^SYSLOG:\s\'\K\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d\.\d{3}\s/2017-07-30 18:51:05.712 /gx;
508 s/^SYSLOG:\s\'\K\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d\s[+-]\d\d\d\d\s/2017-07-30 18:51:05 +9999 /gx;
509 s/^SYSLOG:\s\'\K\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d\.\d{3}\s[+-]\d\d\d\d\s/2017-07-30 18:51:05.712 +9999 /gx;
511 s/((D|[RQD]T)=)\d+s/$1qqs/g;
512 s/((D|[RQD]T)=)\d\.\d{3}s/$1q.qqqs/g;
514 # Date/time in message separators
515 s/(?:[A-Z][a-z]{2}\s){2}\d\d\s\d\d:\d\d:\d\d\s\d\d\d\d
516 /Tue Mar 02 09:44:33 1999/gx;
518 # Date of message arrival in spool file as shown by -Mvh
519 s/^\d{9,10}\s0$/ddddddddd 0/;
521 # Date/time in mbx mailbox files
522 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;
524 # Dates/times in debugging output for writing retry records
525 if (/^ first failed=(\d+) last try=(\d+) next try=(\d+) (.*)$/)
528 $_ = " first failed=dddd last try=dddd next try=+$next $4\n";
530 s/^(\s*)now=\d+ first_failed=\d+ next_try=\d+ expired=(\w)/$1now=tttt first_failed=tttt next_try=tttt expired=$2/;
531 s/^(\s*)received_time=\d+ diff=\d+ timeout=(\d+)/$1received_time=tttt diff=tttt timeout=$2/;
533 # Time to retry may vary
534 s/time to retry = \S+/time to retry = tttt/;
535 s/retry record exists: age=\S+/retry record exists: age=ttt/;
536 s/failing_interval=\S+ message_age=\S+/failing_interval=ttt message_age=ttt/;
538 # Date/time in exim -bV output
539 s/\d\d-[A-Z][a-z]{2}-\d{4}\s\d\d:\d\d:\d\d/07-Mar-2000 12:21:52/g;
542 s/Exim\sstatistics\sfrom\s\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d\sto\s
543 \d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d/Exim statistics from <time> to <time>/x;
545 # Treat ECONNRESET the same as ECONNREFUSED. At least some systems give
546 # us the former on a new connection.
547 s/(could not connect to .*: Connection) reset by peer$/$1 refused/;
549 # ======== TLS certificate algorithms ========
551 # In Received: headers, convert RFC 8314 style ciphersuite to
552 # the older (comment) style, keeping only the Auth element
553 # (discarding kex, cipher, mac). For TLS 1.3 there is no kex
554 # element (and no _WITH); insert a spurious "RSA".
555 # Also in $tls_X_cipher_std reporting.
557 s/^\s+by \S+ with .+ \K \(TLS1(?:\.[0-3])?\) tls TLS_.*?([^_]+)_WITH.+$/(TLS1.x:ke-$1-AES256-SHAnnn:xxx)/;
558 s/^\s+by \S+ with .+ \K \(TLS1(?:\.[0-3])?\) tls TLS_.+$/(TLS1.x:ke-RSA-AES256-SHAnnn:xxx)/;
560 s/ cipher_ TLS_.*?([^_]+)_WITH.+$/ cipher_ TLS1.x:ke_$1_WITH_ci_mac/;
561 s/ cipher_ TLS_.*$/ cipher_ TLS1.x:ke_RSA_WITH_ci_mac/;
563 # Test machines might have various different TLS library versions supporting
564 # different protocols; can't rely upon TLS 1.2's AES256-GCM-SHA384, so we
565 # treat the standard algorithms the same.
567 # TLSversion : KeyExchange? - Authentication/Signature - C_iph_er - MAC : bits
570 # TLSv1:AES128-GCM-SHA256:128
571 # TLSv1:AES256-SHA:256
572 # TLSv1.1:AES256-SHA:256
573 # TLSv1.2:AES256-GCM-SHA384:256
574 # TLSv1.2:DHE-RSA-AES256-SHA:256
575 # TLSv1.3:TLS_AES_256_GCM_SHA384:256
576 # TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128
577 # We also need to handle the ciphersuite without the TLS part present, for
578 # client-ssl's output. We also see some older forced ciphersuites, but
579 # negotiating TLS 1.2 instead of 1.0.
580 # Mail headers (...), log-lines X=..., client-ssl output ...
581 # (and \b doesn't match between ' ' and '(' )
583 # Retain the authentication algorith field as we want to test that.
585 s/( (?: (?:\b|\s) [\(=] ) | \s )TLS1(\.[123])?:/$1TLS1.x:/xg;
586 s/(?<!ke-)((EC)?DHE-)?(RSA|ECDSA)-AES(128|256)-(GCM-SHA(256|384)|SHA)(?!:)/ke-$3-AES256-SHAnnn/g;
587 s/(?<!ke-)((EC)?DHE-)?(RSA|ECDSA)-AES(128|256)-(GCM-SHA(256|384)|SHA):(128|256)/ke-$3-AES256-SHAnnn:xxx/g;
589 # OpenSSL TLSv1.3 - unsure what to do about the authentication-variant testcases now,
590 # as it seems the protocol no longer supports a user choice. Replace the "TLS" field with "RSA".
591 # Also insert a key-exchange field for back-compat, even though 1.3 doesn't do that.
593 # TLSversion : "TLS" - C_iph_er - MAC : ???
595 s/TLS_AES(_256)?_GCM_SHA384(?!:)/ke-RSA-AES256-SHAnnn/g;
596 s/:TLS_AES(_256)?_GCM_SHA384:256/:ke-RSA-AES256-SHAnnn:xxx/g;
599 # TLSv1:AES256-GCM-SHA384:256
600 # TLSv1:ECDHE-RSA-CHACHA20-POLY1305:256
602 # ECDHE-RSA-CHACHA20-POLY1305
605 s/(?<!-)(AES256-GCM-SHA384)/RSA-$1/;
606 s/(?<!ke-)((EC)?DHE-)?(RSA|ECDSA)-(AES256|CHACHA20)-(GCM-SHA384|POLY1305)(?!:)/ke-$3-AES256-SHAnnn/g;
607 s/(?<!ke-)((EC)?DHE-)?(RSA|ECDSA)-(AES256|CHACHA20)-(GCM-SHA384|POLY1305):256/ke-$3-AES256-SHAnnn:xxx/g;
610 # TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256
611 # TLS1.3:ECDHE_SECP256R1__RSA_PSS_RSAE_SHA256__AES_256_GCM__AEAD:256
612 # TLS1.3:ECDHE_X25519__RSA_PSS_RSAE_SHA256__AES_256_GCM:256
613 # TLS1.3:ECDHE_PSK_SECP256R1__AES_256_GCM__AEAD:256
615 # TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256
616 # TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128
617 # TLS1.2:RSA_AES_256_CBC_SHA1:256 (canonical)
618 # TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128
619 # TLS1.2:ECDHE_SECP256R1__RSA_SHA256__AES_256_GCM:256
620 # TLS1.2:ECDHE_SECP256R1__RSA_SHA256__AES_128_CBC__SHA256:128
621 # TLS1.2:ECDHE_SECP256R1__ECDSA_SHA512__AES_256_GCM:256
622 # TLS1.2:ECDHE_SECP256R1__AES_256_GCM:256 (3.6.7 resumption)
623 # TLS1.2:ECDHE_RSA_SECP256R1__AES_256_GCM:256 (! 3.5.18 !)
624 # TLS1.2:RSA__CAMELLIA_256_GCM:256 (leave the cipher name)
625 # TLS1.2-PKIX:RSA__AES_128_GCM__AEAD:128 (the -PKIX seems to be a 3.1.20 thing)
626 # TLS1.2-PKIX:ECDHE_RSA_SECP521R1__AES_256_GCM__AEAD:256
628 # X=TLS1.2:DHE_RSA_AES_256_CBC_SHA256:256
629 # X=TLS1.2:RSA_AES_256_CBC_SHA1:256
630 # X=TLS1.1:RSA_AES_256_CBC_SHA1:256
631 # X=TLS1.0:RSA_AES_256_CBC_SHA1:256
632 # X=TLS1.0:DHE_RSA_AES_256_CBC_SHA1:256
633 # X=TLS1.0-PKIX:RSA__AES_256_CBC__SHA1:256
634 # and as stand-alone cipher:
635 # ECDHE-RSA-AES256-SHA
636 # DHE-RSA-AES256-SHA256
638 # picking latter as canonical simply because regex easier that way.
639 s/\bDHE_RSA_AES_128_CBC_SHA1:128/RSA-AES256-SHA1:256/g;
640 s/TLS1.[x0123](-PKIX)?: # TLS version
641 ((EC)?DHE(_((?<psk>PSK)_)?((?<auth>RSA|ECDSA)_)?
642 (SECP(256|521)R1|X25519))?__?)? # key-exchange
643 ((?<auth>RSA|ECDSA)((_PSS_RSAE)?_SHA(512|256))?__?)? # authentication
644 (?<with>WITH_)? # stdname-with
645 AES_(256|128)_(CBC|GCM) # cipher
646 (__?AEAD)? # pseudo-MAC
647 (__?SHA(1|256|384))? # PRF
648 :(256|128) # cipher strength
650 . (defined($+{psk}) ? $+{psk} : "")
651 . (defined($+{auth}) ? $+{auth} : "")
652 . (defined($+{with}) ? $+{with} : "")
653 . "-AES256-SHAnnn:xxx"/gex;
654 s/TLS1.2:RSA__CAMELLIA_256_GCM(_SHA384)?:256/TLS1.2:RSA_CAMELLIA_256_GCM-SHAnnn:256/g;
655 s/\b(ECDHE-(RSA|ECDSA)-AES256-SHA|DHE-RSA-AES256-SHA256)\b/ke-$2-AES256-SHAnnn/g;
657 # Separate reporting of TLS version
658 s/ver: TLS1(\.[0-3])?$/ver: TLS1.x/;
659 s/ \(TLS1(\.[0-3])?\) / (TLS1.x) /;
661 # GnuTLS library error message changes
662 s/(No certificate was found|Certificate is required)/The peer did not send any certificate/g;
663 #(dodgy test?) s/\(certificate verification failed\): invalid/\(gnutls_handshake\): The peer did not send any certificate./g;
664 s/\(gnutls_priority_set\): No or insufficient priorities were set/\(gnutls_handshake\): Could not negotiate a supported cipher suite/g;
665 s/\(gnutls_handshake\): \KNo supported cipher suites have been found.$/Could not negotiate a supported cipher suite./;
667 # (this new one is a generic channel-read error, but the testsuite
668 # only hits it in one place)
669 s/TLS error on connection \(gnutls_handshake\): Error in the pull function\./a TLS session is required but an attempt to start TLS failed/g;
671 # (replace old with new, hoping that old only happens in one situation)
672 s/TLS error on connection to \d{1,3}(.\d{1,3}){3} \[\d{1,3}(.\d{1,3}){3}\] \(gnutls_handshake\): A TLS packet with unexpected length was received./a TLS session is required for ip4.ip4.ip4.ip4 [ip4.ip4.ip4.ip4], but an attempt to start TLS failed/g;
673 s/TLS error on connection from \[127.0.0.1\] \(recv\): A TLS packet with unexpected length was received./TLS error on connection from [127.0.0.1] (recv): The TLS connection was non-properly terminated./g;
675 # signature algorithm names
679 # ======== Caller's login, uid, gid, home, gecos ========
681 s/\Q$parm_caller_home\E/CALLER_HOME/g; # NOTE: these must be done
682 s/\b\Q$parm_caller\E\b/CALLER/g; # in this order!
683 s/\b\Q$parm_caller_group\E\b/CALLER/g; # In case group name different
685 s/\beuid=$parm_caller_uid\b/euid=CALLER_UID/g;
686 s/\begid=$parm_caller_gid\b/egid=CALLER_GID/g;
688 s/\buid=$parm_caller_uid\b/uid=CALLER_UID/g;
689 s/\bgid=$parm_caller_gid\b/gid=CALLER_GID/g;
691 s/\bname="?$parm_caller_gecos"?/name=CALLER_GECOS/g;
693 # When looking at spool files with -Mvh, we will find not only the caller
694 # login, but also the uid and gid. It seems that $) in some Perls gives all
695 # the auxiliary gids as well, so don't bother checking for that.
697 s/^CALLER $> \d+$/CALLER UID GID/;
699 # There is one case where the caller's login is forced to something else,
700 # in order to test the processing of logins that contain spaces. Weird what
701 # some people do, isn't it?
703 s/^spaced user $> \d+$/CALLER UID GID/;
706 # ======== Exim's login ========
707 # For messages received by the daemon, this is in the -H file, which some
708 # tests inspect. For bounce messages, this will appear on the U= lines in
709 # logs and also after Received: and in addresses. In one pipe test it appears
710 # after "Running as:". It also appears in addresses, and in the names of lock
713 s/U=$parm_eximuser/U=EXIMUSER/;
714 s/user=$parm_eximuser/user=EXIMUSER/;
715 s/login=$parm_eximuser/login=EXIMUSER/;
716 s/Received: from $parm_eximuser /Received: from EXIMUSER /;
717 s/Running as: $parm_eximuser/Running as: EXIMUSER/;
718 s/\b$parm_eximuser@/EXIMUSER@/;
719 s/\b$parm_eximuser\.lock\./EXIMUSER.lock./;
721 s/\beuid=$parm_exim_uid\b/euid=EXIM_UID/g;
722 s/\begid=$parm_exim_gid\b/egid=EXIM_GID/g;
724 s/\buid=$parm_exim_uid\b/uid=EXIM_UID/g;
725 s/\bgid=$parm_exim_gid\b/gid=EXIM_GID/g;
727 s/^$parm_eximuser $parm_exim_uid $parm_exim_gid/EXIMUSER EXIM_UID EXIM_GID/;
730 # ======== General uids, gids, and pids ========
731 # Note: this must come after munges for caller's and exim's uid/gid
733 # These are for systems where long int is 64
734 s/\buid=4294967295/uid=-1/;
735 s/\beuid=4294967295/euid=-1/;
736 s/\bgid=4294967295/gid=-1/;
737 s/\begid=4294967295/egid=-1/;
739 s/\bgid=\d+/gid=gggg/;
740 s/\begid=\d+/egid=gggg/;
741 s/\b(pid=|PID: )\d+/$1pppp/;
742 s/\buid=\d+/uid=uuuu/;
743 s/\beuid=\d+/euid=uuuu/;
744 s/set_process_info:\s+\d+/set_process_info: pppp/;
745 s/queue run pid \d+/queue run pid ppppp/;
746 s/process \d+ running as transport filter/process pppp running as transport filter/;
747 s/process \d+ writing to transport filter/process pppp writing to transport filter/;
748 s/reading pipe for subprocess \d+/reading pipe for subprocess pppp/;
749 s/remote delivery process \d+ ended/remote delivery process pppp ended/;
751 # Pid in temp file in appendfile transport
752 s"test-mail/temp\.\d+\."test-mail/temp.pppp.";
754 # Optional pid in log lines
755 s/^(\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d)(\.\d{3}|)(\s[+-]\d{4}|)(\s\[\d+\])/
756 "$1$2$3 [" . new_value($4, "%s", \$next_pid) . "]"/gxe;
758 # Optional pid in syslog test lines
759 s/^(SYSLOG:\s\'([-0-9]{10}\s[:.0-9]{8,12}\s([-+]\d{4}\s)?|))(\[\d+\] )/
760 "$1\[" . new_value($4, "%s", \$next_pid) . "]"/gxe;
762 # Detect a daemon stderr line with a pid and save the pid for subsequent
763 # removal from following lines.
764 $spid = $1 if /^(\s*\d+) (?:listening|LOG: MAIN|(?:daemon_smtp_port|local_interfaces) overridden by)/;
767 # Queue runner waiting messages
768 s/waiting for children of \d+/waiting for children of pppp/;
769 s/waiting for (\S+) \(\d+\)/waiting for $1 (pppp)/;
771 # Most builds are without HAVE_LOCAL_SCAN
772 next if /^calling local_scan\(\); timeout=300$/;
773 next if /^local_scan\(\) returned 0 NULL$/;
775 # ======== Port numbers ========
776 # Incoming port numbers may vary, but not in daemon startup line.
778 s/^Port: (\d+)/"Port: " . new_value($1, "%s", \$next_port)/e;
779 s/\(port=(\d+)/"(port=" . new_value($1, "%s", \$next_port)/e;
781 # This handles "connection from" and the like, when the port is given
782 if (!/listening for SMTP on/ && !/Connecting to/ && !/=>/ && !/->/
783 && !/\*>/&& !/==/ && !/\*\*/ && !/Connection refused/ && !/in response to/)
785 s/\[([a-z\d:]+|\d+(?:\.\d+){3})\]:(\d+)/"[".$1."]:".new_value($2,"%s",\$next_port)/ie;
788 # Port in host address in spool file output from -Mvh
789 s/^(--?host_address) (.*)\.\d+/$1 $2.9999/;
791 if ($dynamic_socket and $dynamic_socket->opened and my $port = $dynamic_socket->sockport) {
792 s/^Connecting to 127\.0\.0\.1 port \K$port/<dynamic port>/;
796 # ======== Local IP addresses ========
797 # The amount of space between "host" and the address in verification output
798 # depends on the length of the host name. We therefore reduce it to one space
800 # Also, the length of space at the end of the host line is dependent
801 # on the length of the longest line, so strip it also on otherwise
802 # un-rewritten lines like localhost
804 # host 127.0.0.1 [127.0.0.1]
805 # host 10.0.0.1 [10.0.0.1]-
807 # host 127.0.0.1 [127.0.0.1]--
808 # host 169.16.16.16 [169.16.16.10]
810 s/^\s+host\s(\S+)\s+(\S+)/ host $1 $2/;
811 s/^\s+(host\s\S+\s\S+)\s+(port=.*)/ host $1 $2/;
812 s/^\s+(host\s\S+\s\S+)\s+(?=MX=)/ $1 /;
813 s/host\s\Q$parm_ipv4\E\s\[\Q$parm_ipv4\E\]/host ipv4.ipv4.ipv4.ipv4 [ipv4.ipv4.ipv4.ipv4]/;
814 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]/;
815 s/\b\Q$parm_ipv4\E\b/ip4.ip4.ip4.ip4/g;
816 s/(^|\W)\K\Q$parm_ipv6\E/ip6:ip6:ip6:ip6:ip6:ip6:ip6:ip6/g;
817 s/(^|\W)\K\Q$parm_ipv6_stripped\E/ip6:ip6:ip6:ip6:ip6:ip6:ip6:ip6/g;
818 s/\b\Q$parm_ipv4r\E\b/ip4-reverse/g;
819 s/(^|\W)\K\Q$parm_ipv6r\E/ip6-reverse/g;
820 s/^\s+host\s\S+\s+\[\S+\]\K +$//; # strip, not collapse the trailing whitespace
823 # ======== Test network IP addresses ========
824 s/(\b|_)\Q$parm_ipv4_test_net\E(?=\.\d+\.\d+\.\d+\b|_|\.rbl|\.in-addr|\.test\.again\.dns)/$1V4NET/g;
825 s/\b\Q$parm_ipv6_test_net\E(?=:[\da-f]+:[\da-f]+:[\da-f]+)/V6NET/gi;
828 # ======== IP error numbers and messages ========
829 # These vary between operating systems
830 s/Can(no|')t assign requested address/Network Error/;
831 s/Operation timed out/Connection timed out/;
832 s/Address family not supported by protocol family/Network Error/;
833 s/Network( is)? unreachable/Network Error/;
834 s/Invalid argument/Network Error/;
836 s/\(\d+\): Network/(dd): Network/;
837 s/\(\d+\): Connection refused/(dd): Connection refused/;
838 s/\(\d+\): Connection timed out/(dd): Connection timed out/;
839 s/\d+ 65 Connection refused/dd 65 Connection refused/;
840 s/\d+ 321 Connection timed out/dd 321 Connection timed out/;
843 # ======== Other error numbers ========
844 s/errno=\d+/errno=dd/g;
846 # ======== System Error Messages ======
847 # depending on the underlaying file system the error message seems to differ
848 s/(?: is not a regular file)|(?: has too many links \(\d+\))/ not a regular file or too many links/;
850 # ======== Output from ls ========
851 # Different operating systems use different spacing on long output
852 #s/ +/ /g if /^[-rwd]{10} /;
853 # (Bug 1226) SUSv3 allows a trailing printable char for modified access method control.
854 # Handle only the Gnu and MacOS space, dot, plus and at-sign. A full [[:graph:]]
855 # unfortunately matches a non-ls linefull of dashes.
856 # Allow the case where we've already picked out the file protection bits.
857 if (s/^([-d](?:[-r][-w][-SsTtx]){3})[.+@]?( +|$)/$1$2/) {
862 # ======== Message sizes =========
863 # Message sizes vary, owing to different logins and host names that get
864 # automatically inserted. I can't think of any way of even approximately
867 s/([\s,])S=\d+\b/$1S=sss/;
869 s/^(\s*\d+m\s+)\d+(\s+[a-z0-9-]{16} <)/$1sss$2/i if $is_stdout;
870 s/\sSIZE=\d+\b/ SIZE=ssss/;
871 s/\ssize=\d+\b/ size=sss/ if $is_stderr;
872 s/old size = \d+\b/old size = sssss/;
873 s/message size = \d+\b/message size = sss/;
874 s/this message = \d+\b/this message = sss/;
875 s/Size of headers = \d+/Size of headers = sss/;
876 s/sum=(?!0)\d+/sum=dddd/;
877 s/(?<=sum=dddd )count=\d+\b/count=dd/;
878 s/(?<=sum=0 )count=\d+\b/count=dd/;
879 s/,S is \d+\b/,S is ddddd/;
880 s/\+0100,\d+;/+0100,ddd;/;
881 s/\(\d+ bytes written\)/(ddd bytes written)/;
882 s/added '\d+ 1'/added 'ddd 1'/;
883 s/Received\s+\d+/Received nnn/;
884 s/Delivered\s+\d+/Delivered nnn/;
887 # ======== Values in spool space failure message ========
888 s/space=\d+ inodes=[+-]?\d+/space=xxxxx inodes=xxxxx/;
891 # ======== Filter sizes ========
892 # The sizes of filter files may vary because of the substitution of local
893 # filenames, logins, etc.
895 s/^\d+(?= (\(tainted\) )?bytes read from )/ssss/;
898 # ======== OpenSSL error messages ========
899 # Different releases of the OpenSSL libraries seem to give different error
900 # numbers, or handle specific bad conditions in different ways, leading to
901 # different wording in the error messages, so we cannot compare them.
903 #XXX This loses any trailing "deliving unencypted to" which is unfortunate
904 # but I can't work out how to deal with that.
905 s/(TLS session: \(SSL_\w+\): error:)(.*)(?!: delivering)/$1 <<detail omitted>>/;
906 s/(TLS error on connection from .* \(SSL_\w+\): error:)(.*)/$1 <<detail omitted>>/;
907 next if /SSL verify error: depth=0 error=certificate not trusted/;
909 # ======== Maildir things ========
910 # timestamp output in maildir processing
911 s/(timestamp=|\(timestamp_only\): )\d+/$1ddddddd/g;
913 # maildir delivery files appearing in log lines (in cases of error)
914 s/writing to(?: file)? tmp\/\d+\.[^.]+\.(\S+)/writing to tmp\/MAILDIR.$1/;
916 s/renamed tmp\/\d+\.[^.]+\.(\S+) as new\/\d+\.[^.]+\.(\S+)/renamed tmp\/MAILDIR.$1 as new\/MAILDIR.$1/;
918 # Maildir file names in general
919 s/\b\d+\.M\d+P\d+\b/dddddddddd.HddddddPddddd/;
922 while (/^\d+S,\d+C\s*$/)
927 last if !/^\d+ \d+\s*$/;
928 print MUNGED "ddd d\n";
935 # SRS timestamps and signatures vary by hostname and from run to run
937 s/(?i)SRS0=....=.[^=]?=([^=]+)=([^@]+)\@([^ ]+)/SRS0=ZZZZ=YY=$1=$2\@$3/g;
940 # ======== Output from the "fd" program about open descriptors ========
941 # The statuses seem to be different on different operating systems, but
942 # at least we'll still be checking the number of open fd's.
944 s/max fd = \d+/max fd = dddd/;
945 s/status=[0-9a-f]+ (?:RDONLY|WRONLY|RDWR)/STATUS/g;
948 # ======== Contents of spool files ========
949 # A couple of tests dump the contents of the -H file. The length fields
950 # will be wrong because of different user names, etc.
951 s/^\d\d\d(?=[PFS*])/ddd/;
954 # ==========================================================
955 # MIME boundaries in RFC3461 DSN messages
956 s/\d{8,10}-eximdsn-\d+/NNNNNNNNNN-eximdsn-MMMMMMMMMM/;
958 # ==========================================================
959 # Some munging is specific to the specific file types
961 # ======== stdout ========
965 # Skip translate_ip_address and use_classresources in -bP output because
966 # they aren't always there.
968 next if /translate_ip_address =/;
969 next if /use_classresources/;
971 # In certain filter tests, remove initial filter lines because they just
972 # clog up by repetition.
976 next if /^(Sender\staken\sfrom|
977 Return-path\scopied\sfrom|
980 if (/^Testing \S+ filter/)
982 $_ = <IN>; # remove blank line
987 # remote IPv6 addrs vary
988 s/^(Connection request from) \[.*:.*:.*\]$/$1 \[ipv6\]/;
990 # openssl version variances
991 # Error lines on stdout from SSL contain process id values and file names.
992 # They also contain a source file name and line number, which may vary from
993 # release to release.
995 next if /^SSL info:/;
996 next if /SSL verify error: depth=0 error=certificate not trusted/;
997 s/SSL3_READ_BYTES/ssl3_read_bytes/i;
998 s/CONNECT_CR_FINISHED/ssl3_read_bytes/i;
999 s/^\d+:error:\d+(?:E\d+)?(:SSL routines:ssl3_read_bytes:[^:]+:).*(:SSL alert number \d\d)$/pppp:error:dddddddd$1\[...\]$2/;
1000 s/^error:[^:]*:(SSL routines:ssl3_read_bytes:(tls|ssl)v\d+ alert)/error:dddddddd:$1/;
1002 # gnutls version variances
1003 next if /^Error in the pull function./;
1005 # optional IDN2 variant conversions. Accept either IDN1 or IDN2
1006 s/conversion strasse.de/conversion xn--strae-oqa.de/;
1007 s/conversion: german.xn--strae-oqa.de/conversion: german.straße.de/;
1009 # subsecond timstamp info in reported header-files
1010 s/^(-received_time_usec \.)\d{6}$/$1uuuuuu/;
1012 # Postgres server takes varible time to shut down; lives in various places
1013 s/^waiting for server to shut down\.+ done$/waiting for server to shut down.... done/;
1014 s/^\/.*postgres /POSTGRES /;
1016 # DMARC is not always supported by the build
1017 next if /^dmarc_tld_file =/;
1019 # ARC is not always supported by the build
1020 next if /^arc_sign =/;
1022 # TLS resumption is not always supported by the build
1023 next if /^tls_resumption_hosts =/;
1024 next if /^-tls_resumption/;
1026 # gsasl library version may not support some methods
1027 s/250-AUTH ANONYMOUS PLAIN SCRAM-SHA-1\K SCRAM-SHA-256//;
1030 # ======== stderr ========
1034 # The very first line of debugging output will vary
1036 s/^Exim version .*/Exim version x.yz ..../;
1038 # Debugging lines for Exim terminations and process-generation
1040 s/(?<=^>>>>>>>>>>>>>>>> Exim pid=)\d+(?= terminating)/pppp/;
1041 s/^(proxy-proc \w{5}-pid) \d+$/$1 pppp/;
1042 s/^(?:\s*\d+ )(exec .* -oPX)$/pppp $1/;
1043 next if /(?:postfork: | fork(?:ing|ed) for )/;
1045 # IP address lookups use gethostbyname() when IPv6 is not supported,
1046 # and gethostbyname2() or getipnodebyname() when it is.
1048 s/\b(gethostbyname2?|\bgetipnodebyname)(\(af=inet\))?/get[host|ipnode]byname[2]/;
1050 # Extra lookups done when ipv6 is supported
1051 next if /^host_fake_gethostbyname\(af=inet6\) returned 1 \(HOST_NOT_FOUND\)$/;
1053 # we don't care what TZ enviroment the testhost was running
1054 next if /^Reset TZ to/;
1056 # ========= Exim lookups ==================
1057 # Lookups have a char which depends on the number of lookup types compiled in,
1058 # in stderr output. Replace with a "0". Recognising this while avoiding
1059 # other output is fragile; perhaps the debug output should be revised instead.
1060 s%^\s+(:?closing )?\K[0-?]TESTSUITE/aux-fixed/%0TESTSUITE/aux-fixed/%g;
1062 # drop gnutls version strings
1063 next if /GnuTLS compile-time version: \d+[\.\d]+$/;
1064 next if /GnuTLS runtime version: \d+[\.\d]+$/;
1066 # drop openssl version strings
1067 next if /OpenSSL compile-time version: OpenSSL \d+[\.\da-z]+/;
1068 next if /OpenSSL runtime version: OpenSSL \d+[\.\da-z]+/;
1070 # this is timing-dependent
1071 next if /^OpenSSL: creating STEK$/;
1072 next if /^selfsign cert rotate$/;
1075 # only OpenSSL speaks of these
1076 next if /^TLS: (preloading (DH params|ECDH curve|CA bundle) for server|generating selfsigned server cert)/;
1077 next if /^Diffie-Hellman initialized from default/;
1078 next if /^ECDH OpenSSL (< )?[\d.+]+: temp key parameter settings:/;
1079 next if /^ECDH: .*'prime256v1'/;
1080 next if /^tls_verify_certificates: system$/;
1081 next if /^tls_set_watch: .*\/cert.pem/;
1082 next if /^Generating 2048 bit RSA key/;
1085 # only GnuTLS speaks of these
1086 next if /^GnuTLS global init required$/;
1087 next if /^TLS: basic cred init, server/;
1088 next if /^TLS: preloading cipher list for server: NULL$/;
1089 s/^GnuTLS using default session cipher\/priority "NORMAL"$/TLS: not preloading cipher list for server/;
1090 next if /^GnuTLS<2>: added \d+ protocols, \d+ ciphersuites, \d+ sig algos and \d+ groups into priority list$/;
1091 next if /^GnuTLS<2>: (Disabling X.509 extensions|signing structure using RSA-SHA256)/;
1092 next if /^GnuTLS.*(wrap_nettle_mpi_print|gnutls_subject_alt_names_get|get_alt_name)/;
1094 # only kevent platforms (FreeBSD, OpenBSD) say this
1095 next if /^watch dir/;
1096 next if /^watch file .*\/usr\/local/;
1097 next if /^watch file .*\/etc\/ssl/;
1100 # there happen in different orders for OpenSSL/GnuTLS/noTLS
1101 next if /^TLS: generating selfsigned server cert/;
1102 next if /^TLS: not preloading (CA bundle|cipher list) for server$/;
1103 next if /^TLS: not preloading server certs$/;
1106 next if /^Lookups \(built-in\):/;
1107 next if /^Loading lookup modules from/;
1108 next if /^Loaded \d+ lookup modules/;
1109 next if /^Total \d+ lookups/;
1111 # drop compiler information
1112 next if /^Compiler:/;
1115 # different libraries will have different numbers (possibly 0) of follow-up
1116 # lines, indenting with more data
1117 if (/^Library version:/) {
1121 goto RESET_AFTER_EXTRA_LINE_READ;
1125 # drop other build-time controls emitted for debugging
1126 next if /^WHITELIST_D_MACROS:/;
1127 next if /^TRUSTED_CONFIG_LIST:/;
1129 # As of Exim 4.74, we log when a setgid fails; because we invoke Exim
1130 # with -be, privileges will have been dropped, so this will always
1132 next if /^changing group to \d+ failed: (Operation not permitted|Not owner)/;
1134 # We might not keep this check; rather than change all the tests, just
1135 # ignore it as long as it succeeds; then we only need to change the
1136 # TLS tests where tls_require_ciphers has been set.
1137 if (m{^changed uid/gid: calling tls_validate_require_cipher}) {
1141 next if /^tls_validate_require_cipher child \d+ ended: status=0x0/;
1143 # We invoke Exim with -D, so we hit this new message as of Exim 4.73:
1144 next if /^macros_trusted overridden to true by whitelisting/;
1146 # We have to omit the localhost ::1 address so that all is well in
1147 # the IPv4-only case.
1149 print MUNGED "MUNGED: ::1 will be omitted in what follows\n"
1150 if (/looked up these IP addresses/);
1151 next if /name=localhost address=::1/;
1153 # drop pdkim debugging header
1154 next if /^DKIM( <<<<<<<<<<<<<<<<<<<<<<<<<<<<<+|: no signatures)$/;
1156 # Various other IPv6 lines must be omitted too
1158 next if /using host_fake_gethostbyname for \S+ \(IPv6\)/;
1159 next if /get\[host\|ipnode\]byname\[2\]\(af=inet6\)/;
1160 next if /DNS lookup of \S+ \(AAAA\) using fakens/;
1161 next if / in dns_ipv4_lookup?/;
1162 next if / writing neg-cache entry for .*AAAA/;
1163 next if /^faking res_search\(AAAA\) response length as 65535/;
1165 if (/DNS lookup of \S+ \(AAAA\) gave NO_DATA/)
1167 $_= <IN>; # Gets "returning DNS_NODATA"
1171 # Non-TLS bulds have a different Recieved: header expansion
1172 s/^((.*)\t}}}}by \$primary_hostname \$\{if def:received_protocol \{with \$received_protocol }})\(Exim \$version_number\)$/$1\${if def:tls_in_cipher_std { tls \$tls_in_cipher_std\n$2\t}}(Exim \$version_number)/;
1173 s/^((\s*).*considering: with \$received_protocol }})\(Exim \$version_number\)$/$1\${if def:tls_in_cipher_std { tls \$tls_in_cipher_std\n$2\t}}(Exim \$version_number)/;
1174 if (/condition: def:tls_in_cipher_std$/)
1176 $_= <IN>; $_= <IN>; $_= <IN>; $_= <IN>;
1177 $_= <IN>; $_= <IN>; $_= <IN>; $_= <IN>;
1178 $_= <IN>; $_= <IN>; $_= <IN>; next;
1182 # Skip tls_advertise_hosts and hosts_require_tls checks when the options
1183 # are unset, because tls ain't always there.
1185 next if /in\s(?:tls_advertise_hosts\?|hosts_require_tls\?)
1186 \sno\s\((option\sunset|end\sof\slist)\)/x;
1188 # Skip auxiliary group lists because they will vary.
1190 next if /auxiliary group list:/;
1192 # Skip "extracted from gecos field" because the gecos field varies
1194 next if /extracted from gecos field/;
1196 # Skip "waiting for data on socket" and "read response data: size=" lines
1197 # because some systems pack more stuff into packets than others.
1199 next if /waiting for data on socket/;
1200 next if /read response data: size=/;
1202 # If Exim is compiled with readline support but it can't find the library
1203 # to load, there will be an extra debug line. Omit it.
1205 next if /failed to load readline:/;
1207 # Some DBM libraries seem to make DBM files on opening with O_RDWR without
1208 # O_CREAT; other's don't. In the latter case there is some debugging output
1209 # which is not present in the former. Skip the relevant lines (there are
1212 if (/returned from EXIM_DBOPEN: \(nil\)/)
1215 s?\Q$parm_cwd\E?TESTSUITE?g;
1216 if (/TESTSUITE\/spool\/db\/\S+ appears not to exist: trying to create/)
1217 { $_ = <IN>; next; }
1220 # Some tests turn on +expand debugging to check on expansions.
1221 # Unfortunately, the Received: expansion varies, depending on whether TLS
1222 # is compiled or not. So we must remove the relevant debugging if it is.
1224 if (/^condition: def:tls_cipher/)
1226 while (<IN>) { last if /^condition: def:sender_address/; }
1228 elsif (/^expanding: Received: /)
1230 while (<IN>) { last if !/^\s/; }
1233 # remote port numbers vary
1234 s/(Connection request from 127.0.0.1 port) \d{1,5}/$1 sssss/;
1236 # Platform-dependent error strings
1237 s/Operation timed out/Connection timed out/;
1239 # Platform differences on disconnect
1240 s/unexpected disconnection while reading SMTP command from \[127.0.0.1\] \K\(error: Connection reset by peer\) //;
1242 # Platform-dependent resolver option bits
1243 s/^ (?:writing|update) neg-cache entry for [^,]+-\K[0-9a-f]+, ttl/xxxx, ttl/;
1245 # timing variance, run-to-run
1246 s/^time on queue = \K1s/0s/;
1248 # content-scan: file order can vary in directory
1249 s%unspool_mbox\(\): unlinking 'TESTSUITE/spool/scan/[^/]*/\K[^\']*%FFFFFFFFF%;
1251 # Skip hosts_require_dane checks when the options
1252 # are unset, because dane ain't always there.
1253 next if /in\shosts_require_dane\?\sno\s\(option\sunset\)/x;
1255 # daemon notifier socket
1256 s/^(\s*\d+|ppppp) (creating notifier socket)$/ppppp $2/;
1257 s/^ \@(.*exim_daemon_notify)$/ $1/;
1258 s/^(\s*\d+|ppppp) \@?(.*exim_daemon_notify)$/ppppp $2/;
1259 next if /unlinking notifier socket/;
1261 # daemon notifier socket
1262 # Timing variance over runs. Collapse repeated memssages.
1263 if (/notify triggered queue run/)
1266 while (/notify triggered queue run/) { $_ = <IN>; }
1271 next if /in hosts_requ(est|ire)_ocsp\? (no|yes)/;
1274 next if /host in hosts_proxy\?/;
1277 next if / in (pipelining_connect_advertise_hosts|hosts_pipe_connect)?\? no /;
1279 # Experimental_International
1280 next if / in smtputf8_advertise_hosts\? no \(option unset\)/;
1282 # Experimental_REQUIRETLS
1283 next if / in tls_advertise_requiretls?\? no \(end of list\)/;
1286 next if /^(ppppp )?setsockopt FASTOPEN: Network Error/;
1288 # Environment cleaning
1289 next if /\w+ in keep_environment\? (yes|no)/;
1291 # Sizes vary with test hostname
1292 s/^cmd buf flush \d+ bytes$/cmd buf flush ddd bytes/;
1294 # Spool filesystem free space changes on different systems.
1295 s/^((?:spool|log) directory space =) -?\d+K (inodes =)\s*-?\d+/$1 nnnnnK $2 nnnnn/;
1297 # Non-TLS builds have different expansions for received_header_text
1298 if (s/(with \$received_protocol)\}\} \$\{if def:tls_cipher \{\(\$tls_cipher\)\n$/$1/)
1301 s/[\sâ•Ž]+\}\}(?=\(Exim )/\}\} /;
1303 if (/^ ├──condition: def:tls_cipher$/)
1305 <IN>; <IN>; <IN>; <IN>; <IN>; <IN>;
1306 <IN>; <IN>; <IN>; <IN>; <IN>; next;
1309 # Not all platforms build with DKIM enabled
1310 next if /^DKIM >> Body data for hash, canonicalized/;
1312 # Not all platforms build with SPF enabled
1313 next if /^(spf_conn_init|SPF_dns_exim_new|spf_compile\.c)/;
1315 # Not all platforms have sendfile support
1316 next if /^cannot use sendfile for body: no support$/;
1318 # Parts of DKIM-specific debug output depend on the time/date
1319 next if /^date:\w+,\{SP\}/;
1320 next if /^DKIM \[[^[]+\] (Header hash|b) computed:/;
1322 # Not all platforms support TCP Fast Open, and the compile omits the check
1323 if (s/\S+ in hosts_try_fastopen\? (no \(option unset\)|no \(end of list\)|yes \(matched "\*"\))\n$//)
1327 s/ \.\.\. >>> / ... /;
1328 if (s/ non-TFO mode connection attempt to 224.0.0.0, 0 data\b$//) { chomp; $_ .= <IN>; }
1329 s/Address family not supported by protocol family/Network Error/;
1330 s/Network is unreachable/Network Error/;
1332 next if /^(ppppp )?setsockopt FASTOPEN: Protocol not available$/;
1333 s/^(Connecting to .* \.\.\. sending) \d+ (nonTFO early-data)$/$1 dd $2/;
1335 if (/^([0-9: ]* # possible timestamp
1336 Connecting\ to\ [^ ]+\ [^ ]+(\ from\ [^ ]+)?)\ \.\.\.
1338 (sendto,\ no\ data:\ EINPROGRESS # Linux
1339 |connection\ attempt\ to\ [^,]+,\ 0\ data) # MacOS & no-support
1342 $_ = $1 . " ... " . <IN>;
1343 s/^(.* \.\.\.) [0-9: ]*connected$/$1 connected/;
1345 if (/^Connecting to .* \.\.\. connected$/)
1348 if (/^(Connecting to .* \.\.\. )connected\n\s+SMTP(\(close\)>>|\(Connection refused\)<<)$/)
1350 $_ = $1 . "failed: Connection refused\n" . <IN>;
1351 s/^(Connecting .*)\n\s+SMTP\(close\)>>$/$1/;
1353 elsif (/^(Connecting to .* \.\.\. connected\n)read response data: size=/)
1356 # Date/time in SMTP banner
1357 s/[A-Z][a-z]{2},\s\d\d?\s[A-Z][a-z]{2}\s\d{4}\s\d\d\:\d\d:\d\d\s[-+]\d{4}
1358 /Tue, 2 Mar 1999 09:44:33 +0000/gx;
1362 # Specific pointer values reported for DB operations change from run to run
1363 s/^(\s*returned from EXIM_DBOPEN: )(0x)?[0-9a-f]+/${1}0xAAAAAAAA/;
1364 s/^(\s*EXIM_DBCLOSE.)(0x)?[0-9a-f]+/${1}0xAAAAAAAA/;
1366 # Platform-dependent output during MySQL startup
1367 next if /PerconaFT file system space/;
1368 next if /^Waiting for MySQL server to answer/;
1369 next if /mysqladmin: CREATE DATABASE failed; .* database exists/;
1371 # Postgres version-dependent differences
1372 s/^initdb: warning: (enabling "trust" authentication for local connections)$/\nWARNING: $1/;
1374 # Not all builds include DMARC
1375 next if /^DMARC: no (dmarc_tld_file|sender_host_address)$/ ;
1377 # TLS resumption is not always supported by the build
1378 next if /in tls_resumption_hosts\?/;
1380 # Platform differences in errno strings
1381 s/ SMTP\(Operation timed out\)<</ SMTP(Connection timed out)<</;
1383 # Platform differences for errno values (eg. Hurd)
1384 s/^errno = \d+$/errno = EEE/;
1385 s/^writing error \d+: /writing error EEE: /;
1387 # Some platforms have to flip to slow-mode taint-checking
1388 next if /switching to slow-mode taint checking/;
1390 # When Exim is checking the size of directories for maildir, it uses
1391 # the check_dir_size() function to scan directories. Of course, the order
1392 # of the files that are obtained using readdir() varies from system to
1393 # system. We therefore buffer up debugging lines from check_dir_size()
1394 # and sort them before outputting them.
1396 if (/^check_dir_size:/ || /^skipping TESTSUITE\/test-mail\//)
1404 print MUNGED "MUNGED: the check_dir_size lines have been sorted " .
1405 "to ensure consistency\n";
1406 @saved = sort(@saved);
1407 print MUNGED @saved;
1411 # Skip some lines that Exim puts out at the start of debugging output
1412 # because they will be different in different binaries.
1415 unless (/^Berkeley DB: / ||
1416 /^Probably (?:Berkeley DB|ndbm|GDBM)/ ||
1417 /^Authenticators:/ ||
1423 /^log selectors =/ ||
1425 /^Fixed never_users:/ ||
1426 /^Configure owner:/ ||
1436 # ======== log ========
1440 # Berkeley DB version differences
1441 next if / Berkeley DB error: /;
1443 # CHUNKING: exact sizes depend on hostnames in headers
1444 s/(=>.* K C="250- \d)\d+ (byte chunk, total \d)\d+/$1nn $2nn/;
1446 # openssl version variances
1447 s/(TLS error on connection [^:]*: error:)[0-9A-F]{8}(:system library):(?:fopen|func\(4095\)):(No such file or directory)$/$1xxxxxxxx$2:fopen:$3/;
1448 s/(DANE attempt failed.*error:)[0-9A-F]{8}(:SSL routines:)(?:(?i)ssl3_get_server_certificate|tls_process_server_certificate|CONNECT_CR_CERT)(?=:certificate verify failed$)/$1xxxxxxxx$2ssl3_get_server_certificate/;
1449 s/(DKIM: validation error: )error:[0-9A-F]{8}:rsa routines:(?:(?i)int_rsa_verify|CRYPTO_internal):(?:bad signature|algorithm mismatch)$/$1Public key signature verification has failed./;
1450 s/ARC: AMS signing: privkey PEM-block import: error:\K[0-9A-F]{8}:(PEM routines):get_name:(no start line)/0906D06C:$1:PEM_read_bio:$2/;
1452 # gnutls version variances
1453 if (/TLS error on connection \(recv\): .* (Decode error|peer did not send any certificate)/)
1457 if (/error on first read/)
1459 s/TLS session: \Kerror on first read:/(gnutls_handshake): A TLS fatal alert has been received.:/;
1460 goto RESET_AFTER_EXTRA_LINE_READ;
1465 # translate gnutls error into the openssl one
1466 s/ARC: AMS signing: privkey PEM-block import: \KThe requested data were not available.$/error:0906D06C:PEM routines:PEM_read_bio:no start line/;
1469 if ( /(DKIM: d=.*) t=([0-9]*) x=([0-9]*) / )
1471 my ($prefix, $t_diff) = ($1, $3 - $2);
1472 s/DKIM: d=.* t=[0-9]* x=[0-9]* /${prefix} t=T x=T+${t_diff} /;
1474 # GnuTLS reports a different keysize vs. OpenSSL, for ed25519 keys
1475 s/signer: [^ ]* bits:\K 256/ 253/;
1476 s/public key too short:\K 256 bits/ 253 bits/;
1479 s/(?:\[[^\]]*\]:|port )\K$parm_port_d/PORT_D/;
1480 s/(?:\[[^\]]*\]:|port )\K$parm_port_d2/PORT_D2/;
1481 s/(?:\[[^\]]*\]:|port )\K$parm_port_d3/PORT_D3/;
1482 s/(?:\[[^\]]*\]:|port )\K$parm_port_d4/PORT_D4/;
1483 s/(?:\[[^\]]*\]:|port )\K$parm_port_s/PORT_S/;
1484 s/(?:\[[^\]]*\]:|port )\K$parm_port_n/PORT_N/;
1485 s/I=\[[^\]]*\]:\K\d+/ppppp/;
1487 # Platform differences for errno values (eg. Hurd). Leave 0 and negative numbers alone.
1488 s/R=\w+ T=\w+ defer\K \([1-9]\d*\): / (EEE): /;
1490 # Platform differences in errno strings
1491 s/Arg list too long/Argument list too long/;
1494 # ======== mail ========
1498 # DKIM timestamps, and signatures depending thereon
1499 if ( /^(\s+)t=([0-9]*); x=([0-9]*); b=[A-Za-z0-9+\/]+$/ )
1501 my ($indent, $t_diff) = ($1, $3 - $2);
1502 s/.*/${indent}t=T; x=T+${t_diff}; b=bbbb;/;
1508 # ======== All files other than stderr ========
1520 ##################################################
1521 # Subroutine to interact with caller #
1522 ##################################################
1524 # Arguments: [0] the prompt string
1525 # [1] if there is a U in the prompt and $force_update is true
1526 # [2] if there is a C in the prompt and $force_continue is true
1527 # Returns: returns the answer
1530 my ($prompt, $have_u, $have_c) = @_;
1535 print "... update forced\n";
1540 print "... continue forced\n";
1549 ##################################################
1550 # Subroutine to log in force_continue mode #
1551 ##################################################
1553 # In force_continue mode, we just want a terse output to a statically
1554 # named logfile. If multiple files in same batch (stdout, stderr, etc)
1555 # all have mismatches, it will log multiple times.
1557 # Arguments: [0] the logfile to append to
1558 # [1] the testno that failed
1564 my ($logfile, $testno, $detail) = @_;
1566 open(my $fh, '>>', $logfile) or return;
1568 print $fh "Test $testno "
1569 . (defined $detail ? "$detail " : '')
1573 # Computer-readable summary results logfile
1576 my ($logfile, $testno, $resultchar) = @_;
1578 open(my $fh, '>>', $logfile) or return;
1579 print $fh "$testno $resultchar\n";
1584 ##################################################
1585 # Subroutine to compare one output file #
1586 ##################################################
1588 # When an Exim server is part of the test, its output is in separate files from
1589 # an Exim client. The server data is concatenated with the client data as part
1590 # of the munging operation.
1592 # Arguments: [0] the name of the main raw output file
1593 # [1] the name of the server raw output file or undef
1594 # [2] where to put the munged copy
1595 # [3] the name of the saved file
1596 # [4] TRUE if this is a log file whose deliveries must be sorted
1597 # [5] optionally, a custom munge command
1599 # Returns: 0 comparison succeeded
1600 # 1 comparison failed; differences to be ignored
1601 # 2 comparison failed; files may have been updated (=> re-compare)
1603 # Does not return if the user replies "Q" to a prompt.
1606 my($rf,$rsf,$mf,$sf,$sortfile,$extra) = @_;
1608 # If there is no saved file, the raw files must either not exist, or be
1609 # empty. The test ! -s is TRUE if the file does not exist or is empty.
1611 # we check if there is a flavour specific file, but we remember
1612 # the original file name as "generic"
1614 $sf_flavour = "$sf_generic.$flavour";
1615 $sf_current = -e $sf_flavour ? $sf_flavour : $sf_generic;
1617 if (! -e $sf_current)
1619 return 0 if (! -s $rf && (! defined $rsf || ! -s $rsf));
1622 print "** $rf is not empty\n" if (-s $rf);
1623 print "** $rsf is not empty\n" if (defined $rsf && -s $rsf);
1627 $_ = interact('Continue, Show, or Quit? [Q] ', undef, $force_continue);
1628 tests_exit(1) if /^q?$/;
1629 if (/^c$/ && $force_continue) {
1630 log_failure($log_failed_filename, $testno, $rf);
1631 log_test($log_summary_filename, $testno, 'F') if ($force_continue);
1633 return 1 if /^c$/i && $rf !~ /paniclog/ && (!defined $rsf || $rsf !~ /paniclog/);
1637 foreach $f ($rf, $rsf)
1639 if (defined $f && -s $f)
1642 print "------------ $f -----------\n"
1643 if (defined $rf && -s $rf && defined $rsf && -s $rsf);
1651 $_ = interact('Continue, Update & retry, Quit? [Q] ', $force_update, $force_continue);
1652 tests_exit(1) if /^q?$/;
1653 if (/^c$/ && $force_continue) {
1654 log_failure($log_failed_filename, $testno, $rf);
1655 log_test($log_summary_filename, $testno, 'F')
1664 # Control reaches here if either (a) there is a saved file ($sf), or (b) there
1665 # was a request to create a saved file. First, create the munged file from any
1666 # data that does exist.
1668 open(MUNGED, '>', $mf) || tests_exit(-1, "Failed to open $mf: $!");
1669 my($truncated) = munge($rf, $extra) if -e $rf;
1671 # Append the raw server log, if it is non-empty
1672 if (defined $rsf && -e $rsf)
1674 print MUNGED "\n******** SERVER ********\n";
1675 $truncated |= munge($rsf, $extra);
1679 # If a saved file exists, do the comparison. There are two awkward cases:
1681 # If "*** truncated ***" was found in the new file, it means that a log line
1682 # was overlong, and truncated. The problem is that it may be truncated at
1683 # different points on different systems, because of different user name
1684 # lengths. We reload the file and the saved file, and remove lines from the new
1685 # file that precede "*** truncated ***" until we reach one that matches the
1686 # line that precedes it in the saved file.
1688 # If $sortfile is set, we are dealing with a mainlog file where the deliveries
1689 # for an individual message might vary in their order from system to system, as
1690 # a result of parallel deliveries. We load the munged file and sort sequences
1691 # of delivery lines.
1695 # Deal with truncated text items
1699 my(@munged, @saved, $i, $j, $k);
1701 open(MUNGED, $mf) || tests_exit(-1, "Failed to open $mf: $!");
1704 open(SAVED, $sf_current) || tests_exit(-1, "Failed to open $sf_current: $!");
1709 for ($i = 0; $i < @munged; $i++)
1711 if ($munged[$i] =~ /\*\*\* truncated \*\*\*/)
1713 for (; $j < @saved; $j++)
1714 { last if $saved[$j] =~ /\*\*\* truncated \*\*\*/; }
1715 last if $j >= @saved; # not found in saved
1717 for ($k = $i - 1; $k >= 0; $k--)
1718 { last if $munged[$k] eq $saved[$j - 1]; }
1720 last if $k <= 0; # failed to find previous match
1721 splice @munged, $k + 1, $i - $k - 1;
1726 open(my $fh, '>', $mf) or tests_exit(-1, "Failed to open $mf: $!");
1730 # Deal with log sorting
1736 open(my $fh, '<', $mf) or tests_exit(-1, "Failed to open $mf: $!");
1740 for (my $i = 0; $i < @munged; $i++)
1742 if ($munged[$i] =~ /^[-\d]{10}\s[:\d]{8}\s[-A-Za-z\d]{16}\s[-=*]>/)
1745 for ($j = $i + 1; $j < @munged; $j++)
1747 last if $munged[$j] !~
1748 /^[-\d]{10}\s[:\d]{8}\s[-A-Za-z\d]{16}\s[-=*]>/;
1750 @temp = splice(@munged, $i, $j - $i);
1751 @temp = sort(@temp);
1752 splice(@munged, $i, 0, @temp);
1756 open(my $fh, '>', $mf) or tests_exit(-1, "Failed to open $mf: $!");
1757 print $fh "**NOTE: The delivery lines in this file have been sorted.\n";
1763 return 0 if (system("$cf '$mf' '$sf_current' >test-cf") == 0);
1765 # Handle comparison failure
1767 print "** Comparison of $mf with $sf_current failed";
1768 system @more => 'test-cf';
1773 $_ = interact('Continue, Retry, Update current'
1774 . ($sf_current ne $sf_flavour ? "/Save for flavour '$flavour'" : '')
1775 . ' & retry, Quit? [Q] ', $force_update, $force_continue);
1776 tests_exit(1) if /^q?$/;
1777 if (/^c$/ && $force_continue) {
1778 log_failure($log_failed_filename, $testno, $sf_current);
1779 log_test($log_summary_filename, $testno, 'F')
1783 last if (/^[us]$/i);
1787 # Update or delete the saved file, and give the appropriate return code.
1791 my $sf = /^u/i ? $sf_current : $sf_flavour;
1792 tests_exit(-1, "Failed to cp $mf $sf") if system("cp '$mf' '$sf'") != 0;
1796 # if we deal with a flavour file, we can't delete it, because next time the generic
1797 # file would be used again
1798 if ($sf_current eq $sf_flavour) {
1799 open(my $fh, '>', $sf_current);
1802 tests_exit(-1, "Failed to unlink $sf_current") if !unlink($sf_current);
1811 ##################################################
1813 # keyed by name of munge; value is a ref to a hash
1814 # which is keyed by file, value a string to look for.
1816 # paniclog, rejectlog, mainlog, stdout, stderr, msglog, mail
1817 # Search strings starting with 's' do substitutions;
1818 # with '/' do line-skips.
1819 # Triggered by a scriptfile line "munge <name>"
1820 ##################################################
1823 { 'stderr' => '/^Reverse DNS security status: unverified\n/' },
1825 'gnutls_unexpected' =>
1826 { 'mainlog' => '/\(recv\): A TLS packet with unexpected length was received./' },
1828 'gnutls_handshake' =>
1829 { 'mainlog' => 's/\(gnutls_handshake\): Error in the push function/\(gnutls_handshake\): A TLS packet with unexpected length was received/' },
1831 'gnutls_bad_clientcert' =>
1832 { 'mainlog' => 's/\(certificate verification failed\): certificate invalid/\(gnutls_handshake\): The peer did not send any certificate./',
1833 'stdout' => 's/Succeeded in starting TLS/A TLS fatal alert has been received.\nFailed to start TLS'
1836 'optional_events' =>
1837 { 'stdout' => '/event_action =/' },
1840 { 'stderr' => '/127.0.0.1 in hosts_requ(ire|est)_ocsp/' },
1842 'optional_cert_hostnames' =>
1843 { 'stderr' => '/in tls_verify_cert_hostnames\? no/' },
1846 { 'stdout' => 's/[[](127\.0\.0\.1|::1)]/[IP_LOOPBACK_ADDR]/' },
1849 { 'stdout' => 's/(Content-length:) \d\d\d/$1 ddd/' },
1852 { 'stderr' => 's/(1[5-9]|23\d)\d\d msec/ssss msec/' },
1855 { 'mainlog' => 's! X=TLS\S+ ! X=TLS_proto_and_cipher !;
1856 s! DN="C=! DN="/C=!;
1857 s! DN="[^,"]*\K,!/!;
1858 s! DN="[^,"]*\K,!/!;
1859 s! DN="[^,"]*\K,!/!;
1861 'rejectlog' => 's/ X=TLS\S+ / X=TLS_proto_and_cipher /',
1865 { 'stderr' => 's/(^\s{0,4}|(?<=Process )|(?<=child ))\d+/ppppp/g' },
1867 'optional_dsn_info' =>
1868 { 'mail' => '/^(X-(Remote-MTA-(smtp-greeting|helo-response)|Exim-Diagnostic|(body|message)-linecount):|Remote-MTA: X-ip;)/'
1871 'optional_config' =>
1873 dkim_(canon|domain|private_key|selector|sign_headers|strict|hash|identity|timestamps)
1874 |gnutls_require_(kx|mac|protocols)
1876 |hosts_(requ(est|ire)|try)_(dane|ocsp)
1877 |dane_require_tls_ciphers
1878 |hosts_(avoid|nopass|noproxy|require|verify_avoid)_tls
1879 |pipelining_connect_advertise_hosts
1887 { 'mainlog' => 's%/(usr/(local/)?)?bin/%SYSBINDIR/%' },
1889 'sync_check_data' =>
1890 { 'mainlog' => 's/^(.* SMTP protocol synchronization error .* next input=.{8}).*$/$1<suppressed>/',
1891 'rejectlog' => 's/^(.* SMTP protocol synchronization error .* next input=.{8}).*$/$1<suppressed>/'},
1893 'debuglog_stdout' =>
1894 { 'stdout' => 's/^\d\d:\d\d:\d\d\s+\d+ //;
1895 s/Process \d+ is ready for new message/Process pppp is ready for new message/'
1898 'timeout_errno' => # actual errno differs Solaris vs. Linux
1899 { 'mainlog' => 's/((?:host|message) deferral .* errno) <\d+> /$1 <EEE> /' },
1901 'peer_terminated_conn' => # actual error differs FreedBSD vs. Linux
1902 { 'stderr' => 's/^( SMTP\()Connection reset by peer(\)<<)$/$1closed$2/' },
1904 'perl_variants' => # result of hash-in-scalar-context changed from bucket-fill to keycount
1905 { 'stdout' => 's%^> X/X$%> X%' },
1911 return $a if ($a > $b);
1915 ##################################################
1916 # Subroutine to check the output of a test #
1917 ##################################################
1919 # This function is called when the series of subtests is complete. It makes
1920 # use of check_file(), whose arguments are:
1922 # [0] the name of the main raw output file
1923 # [1] the name of the server raw output file or undef
1924 # [2] where to put the munged copy
1925 # [3] the name of the saved file
1926 # [4] TRUE if this is a log file whose deliveries must be sorted
1927 # [5] an optional custom munge command
1929 # Arguments: Optionally, name of a single custom munge to run.
1930 # Returns: 0 if the output compared equal
1931 # 1 if comparison failed; differences to be ignored
1932 # 2 if re-run needed (files may have been updated)
1935 my($mungename) = $_[0];
1937 my($munge) = $munges->{$mungename} if defined $mungename;
1939 $yield = max($yield, check_file("spool/log/paniclog",
1940 "spool/log/serverpaniclog",
1941 "test-paniclog-munged",
1942 "paniclog/$testno", 0,
1943 $munge->{paniclog}));
1945 $yield = max($yield, check_file("spool/log/rejectlog",
1946 "spool/log/serverrejectlog",
1947 "test-rejectlog-munged",
1948 "rejectlog/$testno", 0,
1949 $munge->{rejectlog}));
1951 $yield = max($yield, check_file("spool/log/mainlog",
1952 "spool/log/servermainlog",
1953 "test-mainlog-munged",
1954 "log/$testno", $sortlog,
1955 $munge->{mainlog}));
1959 $yield = max($yield, check_file("test-stdout",
1960 "test-stdout-server",
1961 "test-stdout-munged",
1962 "stdout/$testno", 0,
1968 $yield = max($yield, check_file("test-stderr",
1969 "test-stderr-server",
1970 "test-stderr-munged",
1971 "stderr/$testno", 0,
1975 # Compare any delivered messages, unless this test is skipped.
1977 if (! $message_skip)
1981 # Get a list of expected mailbox files for this script. We don't bother with
1982 # directories, just the files within them.
1984 foreach $oldmail (@oldmails)
1986 next unless $oldmail =~ /^mail\/$testno\./;
1987 print ">> EXPECT $oldmail\n" if $debug;
1988 $expected_mails{$oldmail} = 1;
1991 # If there are any files in test-mail, compare them. Note that "." and
1992 # ".." are automatically omitted by list_files_below().
1994 @mails = list_files_below("test-mail");
1996 foreach $mail (@mails)
1998 next if $mail eq "test-mail/oncelog";
2000 $saved_mail = substr($mail, 10); # Remove "test-mail/"
2001 $saved_mail =~ s/^$parm_caller(\/|$)/CALLER/; # Convert caller name
2003 if ($saved_mail =~ /(\d+\.[^.]+\.)/)
2006 $saved_mail =~ s/(\d+\.[^.]+\.)/$msgno./gx;
2009 print ">> COMPARE $mail mail/$testno.$saved_mail\n" if $debug;
2010 $yield = max($yield, check_file($mail, undef, "test-mail-munged",
2011 "mail/$testno.$saved_mail", 0,
2013 delete $expected_mails{"mail/$testno.$saved_mail"};
2016 # Complain if not all expected mails have been found
2018 if (scalar(keys %expected_mails) != 0)
2020 foreach $key (keys %expected_mails)
2021 { print "** no test file found for $key\n"; }
2025 $_ = interact('Continue, Update & retry, or Quit? [Q] ', $force_update, $force_continue);
2026 tests_exit(1) if /^q?$/;
2027 if (/^c$/ && $force_continue) {
2028 log_failure($log_failed_filename, $testno, "missing email");
2029 log_test($log_summary_filename, $testno, 'F')
2033 # For update, we not only have to unlink the file, but we must also
2034 # remove it from the @oldmails vector, as otherwise it will still be
2035 # checked for when we re-run the test.
2039 foreach $key (keys %expected_mails)
2042 tests_exit(-1, "Failed to unlink $key") if !unlink("$key");
2043 for ($i = 0; $i < @oldmails; $i++)
2045 if ($oldmails[$i] eq $key)
2047 splice @oldmails, $i, 1;
2058 # Compare any remaining message logs, unless this test is skipped.
2062 # Get a list of expected msglog files for this test
2064 foreach $oldmsglog (@oldmsglogs)
2066 next unless $oldmsglog =~ /^$testno\./;
2067 $expected_msglogs{$oldmsglog} = 1;
2070 # If there are any files in spool/msglog, compare them. However, we have
2071 # to munge the file names because they are message ids, which are
2074 if (opendir(DIR, "spool/msglog"))
2076 @msglogs = sort readdir(DIR);
2079 foreach $msglog (@msglogs)
2081 next if ($msglog eq "." || $msglog eq ".." || $msglog eq "CVS");
2082 ($munged_msglog = $msglog) =~
2083 s/((?:[^\W_]{6}-){2}[^\W_]{2})
2084 /new_value($1, "10Hm%s-0005vi-00", \$next_msgid)/egx;
2085 $yield = max($yield, check_file("spool/msglog/$msglog", undef,
2086 "test-msglog-munged", "msglog/$testno.$munged_msglog", 0,
2088 delete $expected_msglogs{"$testno.$munged_msglog"};
2092 # Complain if not all expected msglogs have been found
2094 if (scalar(keys %expected_msglogs) != 0)
2096 foreach $key (keys %expected_msglogs)
2098 print "** no test msglog found for msglog/$key\n";
2099 ($msgid) = $key =~ /^\d+\.(.*)$/;
2100 foreach $cachekey (keys %cache)
2102 if ($cache{$cachekey} eq $msgid)
2104 print "** original msgid $cachekey\n";
2112 $_ = interact('Continue, Update, or Quit? [Q] ', $force_update, $force_continue);
2113 tests_exit(1) if /^q?$/;
2114 if (/^c$/ && $force_continue) {
2115 log_failure($log_failed_filename, $testno, "missing msglog");
2116 log_test($log_summary_filename, $testno, 'F')
2121 foreach $key (keys %expected_msglogs)
2123 tests_exit(-1, "Failed to unlink msglog/$key")
2124 if !unlink("msglog/$key");
2137 ##################################################
2138 # Subroutine to run one "system" command #
2139 ##################################################
2141 # We put this in a subroutine so that the command can be reflected when
2144 # Argument: the command to be run
2152 $prcmd =~ s/; /;\n>> /;
2153 print ">> $prcmd\n";
2160 ##################################################
2161 # Subroutine to run one script command #
2162 ##################################################
2164 # The <SCRIPT> file is open for us to read an optional return code line,
2165 # followed by the command line and any following data lines for stdin. The
2166 # command line can be continued by the use of \. Data lines are not continued
2167 # in this way. In all lines, the following substitutions are made:
2169 # DIR => the current directory
2170 # CALLER => the caller of this script
2172 # Arguments: the current test number
2173 # reference to the subtest number, holding previous value
2174 # reference to the expected return code value
2175 # reference to where to put the command name (for messages)
2176 # auxiliary information returned from a previous run
2178 # Returns: 0 the command was executed inline, no subprocess was run
2179 # 1 a non-exim command was run and waited for
2180 # 2 an exim command was run and waited for
2181 # 3 a command was run and not waited for (daemon, server, exim_lock)
2182 # 4 EOF was encountered after an initial return code line
2183 # Optionally also a second parameter, a hash-ref, with auxiliary information:
2184 # exim_pid: pid of a run process
2185 # munge: name of a post-script results munger
2188 my($testno) = $_[0];
2189 my($subtestref) = $_[1];
2190 my($commandnameref) = $_[3];
2191 my($aux_info) = $_[4];
2194 our %ENV = map { $_ => $ENV{$_} } grep { /^(?:USER|SHELL|PATH|TERM|EXIM_TEST_.*)$/ } keys %ENV;
2196 if (/^(\d+)\s*$/) # Handle unusual return code
2201 return 4 if !defined $_; # Missing command
2208 # Handle concatenated command lines
2211 while (substr($_, -1) eq"\\")
2214 $_ = substr($_, 0, -1);
2215 chomp($temp = <SCRIPT>);
2227 do_substitute($testno);
2228 if ($debug) { printf ">> $_\n"; }
2230 # Pass back the command name (for messages)
2232 ($$commandnameref) = /^(\S+)/;
2234 # Here follows code for handling the various different commands that are
2235 # supported by this script. The first group of commands are all freestanding
2236 # in that they share no common code and are not followed by any data lines.
2242 # The "dbmbuild" command runs exim_dbmbuild. This is used both to test the
2243 # utility and to make DBM files for testing DBM lookups.
2245 if (/^dbmbuild\s+(\S+)\s+(\S+)/)
2247 run_system("(./eximdir/exim_dbmbuild $parm_cwd/$1 $parm_cwd/$2;" .
2248 "echo exim_dbmbuild exit code = \$?)" .
2254 # The "dump" command runs exim_dumpdb. On different systems, the output for
2255 # some types of dump may appear in a different order because it's just hauled
2256 # out of the DBM file. We can solve this by sorting. Ignore the leading
2257 # date/time, as it will be flattened later during munging.
2259 if (/^dump\s+(\S+)/)
2262 print ">> ./eximdir/exim_dumpdb $parm_cwd/spool $which\n" if $debug;
2263 open(my $in, "-|", './eximdir/exim_dumpdb', "$parm_cwd/spool", $which) or die "Can't run exim_dumpdb: $!";
2264 open(my $out, ">>test-stdout");
2265 print $out "+++++++++++++++++++++++++++\n";
2267 if ($which eq "retry")
2269 # the sort key is the first part of the retry db dump line, but for
2270 # sorting we (temporarly) replace the own hosts ipv4 with a munged
2271 # version, which matches the munging that is done later
2272 # Why? We must ensure sure, that 127.0.0.1 always sorts first
2273 # map-sort-map: Schwartz's transformation
2275 my @temp = map { $_->[1] }
2276 sort { $a->[0] cmp $b->[0] }
2277 #map { [ (split)[0] =~ s/\Q$parm_ipv4/ip4.ip4.ip4.ip4/gr, $_ ] } # this is too modern for 5.10.1
2279 (my $k = (split)[0]) =~ s/\Q$parm_ipv4/ip4.ip4.ip4.ip4/g;
2282 do { local $/ = "\n "; <$in> };
2283 foreach $item (@temp)
2285 $item =~ s/^\s*(.*)\n(.*)\n?\s*$/$1\n$2/m;
2286 print $out " $item\n";
2292 if ($which eq "callout")
2295 my($aa) = substr $a, 21;
2296 my($bb) = substr $b, 21;
2302 close($in); # close it explicitly, otherwise $? does not get set
2307 # verbose comments start with ###
2309 for my $file (qw(test-stdout test-stderr test-stderr-server test-stdout-server)) {
2310 open my $fh, '>>', $file or die "Can't open >>$file: $!\n";
2316 # The "echo" command is a way of writing comments to the screen.
2317 if (/^echo\s+(.*)$/)
2324 # The "exim_lock" command runs exim_lock in the same manner as "server",
2325 # but it doesn't use any input.
2327 if (/^exim_lock\s+(.*)$/)
2329 $cmd = "./eximdir/exim_lock $1 >>test-stdout";
2330 $server_pid = open SERVERCMD, "|$cmd" ||
2331 tests_exit(-1, "Failed to run $cmd\n");
2333 # This gives the process time to get started; otherwise the next
2334 # process may not find it there when it expects it.
2336 select(undef, undef, undef, 0.1);
2341 # The "exinext" command runs exinext
2343 if (/^exinext\s+(.*)/)
2345 run_system("(./eximdir/exinext " .
2346 "-DEXIM_PATH=$parm_cwd/eximdir/exim " .
2347 "-C $parm_cwd/test-config $1;" .
2348 "echo exinext exit code = \$?)" .
2354 # The "exigrep" command runs exigrep on the current mainlog
2356 if (/^exigrep\s+(.*)/)
2358 run_system("(./eximdir/exigrep " .
2359 "$1 $parm_cwd/spool/log/mainlog;" .
2360 "echo exigrep exit code = \$?)" .
2366 # The "eximstats" command runs eximstats on the current mainlog
2368 if (/^eximstats\s+(.*)/)
2370 run_system("(./eximdir/eximstats " .
2371 "$1 $parm_cwd/spool/log/mainlog;" .
2372 "echo eximstats exit code = \$?)" .
2378 # The "gnutls" command makes a copy of saved GnuTLS parameter data in the
2379 # spool directory, to save Exim from re-creating it each time.
2383 my $gen_fn = "spool/gnutls-params-$gnutls_dh_bits_normal";
2384 run_system "sudo cp -p aux-fixed/gnutls-params $gen_fn;" .
2385 "sudo chown $parm_eximuser:$parm_eximgroup $gen_fn;" .
2386 "sudo chmod 0400 $gen_fn";
2391 # The "killdaemon" command should ultimately follow the starting of any Exim
2392 # daemon with the -bd option.
2396 my $return_extra = {};
2397 if (exists $aux_info->{exim_pid})
2399 $pid = $aux_info->{exim_pid};
2400 $return_extra->{exim_pid} = undef;
2401 print ">> killdaemon: recovered pid $pid\n" if $debug;
2404 run_system("sudo /bin/kill -TERM $pid");
2408 $pid = `cat $parm_cwd/spool/exim-daemon.*`;
2411 run_system("sudo /bin/kill -TERM $pid");
2412 close DAEMONCMD; # Waits for process
2415 run_system("sudo /bin/rm -f spool/exim-daemon.*");
2416 return (1, $return_extra);
2420 # The "millisleep" command is like "sleep" except that its argument is in
2421 # milliseconds, thus allowing for a subsecond sleep, which is, in fact, all it
2424 elsif (/^millisleep\s+(.*)$/)
2426 select(undef, undef, undef, $1/1000);
2431 # The "munge" command selects one of a hardwired set of test-result modifications
2432 # to be made before result compares are run against the golden set. This lets
2433 # us account for test-system dependent things which only affect a few, but known,
2435 # Currently only the last munge takes effect.
2437 if (/^munge\s+(.*)$/)
2439 return (0, { munge => $1 });
2443 # The "sleep" command does just that. For sleeps longer than 1 second we
2444 # tell the user what's going on.
2446 if (/^sleep\s+(.*)$/)
2454 printf(" Test %d sleep $1 ", $$subtestref);
2460 printf("\r Test %d $cr", $$subtestref);
2466 # Various Unix management commands are recognized
2468 if (/^(ln|ls|du|mkdir|mkfifo|touch|cp|cat)\s/ ||
2469 /^sudo\s(rmdir|rm|mv|chown|chmod)\s/)
2471 run_system("$_ >>test-stdout 2>>test-stderr");
2480 # The next group of commands are also freestanding, but they are all followed
2484 # The "server" command starts up a script-driven server that runs in parallel
2485 # with the following exim command. Therefore, we want to run a subprocess and
2486 # not yet wait for it to complete. The waiting happens after the next exim
2487 # command, triggered by $server_pid being non-zero. The server sends its output
2488 # to a different file. The variable $server_opts, if not empty, contains
2489 # options to disable IPv4 or IPv6 if necessary.
2490 # This works because "server" swallows its stdin before waiting for a connection.
2492 if (/^server\s+(.*)$/)
2494 $pidfile = "$parm_cwd/aux-var/server-daemon.pid";
2495 $cmd = "./bin/server $server_opts -oP $pidfile $1 >>test-stdout-server";
2496 print ">> $cmd\n" if ($debug);
2497 $server_pid = open SERVERCMD, "|$cmd" || tests_exit(-1, "Failed to run $cmd");
2498 SERVERCMD->autoflush(1);
2499 print ">> Server pid is $server_pid\n" if $debug;
2503 last if /^\*{4}\s*$/;
2506 print SERVERCMD "++++\n"; # Send end to server; can't send EOF yet
2507 # because close() waits for the process.
2509 # Interlock the server startup; otherwise the next
2510 # process may not find it there when it expects it.
2511 while (! stat("$pidfile") ) { select(undef, undef, undef, 0.3); }
2516 # The "write" command is a way of creating files of specific sizes for
2517 # buffering tests, or containing specific data lines from within the script
2518 # (rather than hold lots of little files). The "catwrite" command does the
2519 # same, but it also copies the lines to test-stdout.
2521 if (/^(cat)?write\s+(\S+)(?:\s+(.*))?\s*$/)
2523 my($cat) = defined $1;
2525 @sizes = split /\s+/, $3 if defined $3;
2526 open FILE, ">$2" || tests_exit(-1, "Failed to open \"$2\": $!");
2530 open CAT, ">>test-stdout" ||
2531 tests_exit(-1, "Failed to open test-stdout: $!");
2532 print CAT "==========\n";
2535 if (scalar @sizes > 0)
2542 last if /^\+{4}\s*$/;
2549 while (scalar @sizes > 0)
2551 ($count,$len,$leadin) = (shift @sizes) =~ /(\d+)x(\d+)(?:=(.*))?/;
2552 $leadin = '' if !defined $leadin;
2554 $len -= length($leadin) + 1;
2555 while ($count-- > 0)
2557 print FILE $leadin, "a" x $len, "\n";
2558 print CAT $leadin, "a" x $len, "\n" if $cat;
2563 # Post data, or only data if no sized data
2568 last if /^\*{4}\s*$/;
2576 print CAT "==========\n";
2587 # From this point on, script commands are implemented by setting up a shell
2588 # command in the variable $cmd. Shared code to run this command and handle its
2589 # input and output follows.
2591 # The "client", "client-gnutls", and "client-ssl" commands run a script-driven
2592 # program that plays the part of an email client. We also have the availability
2593 # of running Perl for doing one-off special things. Note that all these
2594 # commands expect stdin data to be supplied.
2596 if (/^client/ || /^(sudo\s+)?perl\b/)
2598 s"client"./bin/client";
2599 $cmd = "$_ >>test-stdout 2>>test-stderr";
2602 # For the "exim" command, replace the text "exim" with the path for the test
2603 # binary, plus -D options to pass over various parameters, and a -C option for
2604 # the testing configuration file. When running in the test harness, Exim does
2605 # not drop privilege when -C and -D options are present. To run the exim
2606 # command as root, we use sudo.
2608 elsif (/^((?i:[A-Z\d_]+=\S+\s+)+)?(\d+)?\s*(sudo(?:\s+-u\s+(\w+))?\s+)?exim(_\S+)?\s+(.*)$/)
2611 my($envset) = (defined $1)? $1 : '';
2612 my($sudo) = (defined $3)? "sudo " . (defined $4 ? "-u $4 ":'') : '';
2613 my($special)= (defined $5)? $5 : '';
2614 $wait_time = (defined $2)? $2 : 0;
2616 # Return 2 rather than 1 afterwards
2620 # Update the test number
2622 $$subtestref = $$subtestref + 1;
2623 printf(" Test %d $cr", $$subtestref);
2625 # Copy the configuration file, making the usual substitutions.
2627 open (IN, "$parm_cwd/confs/$testno") ||
2628 tests_exit(-1, "Couldn't open $parm_cwd/confs/$testno: $!\n");
2629 open (OUT, ">test-config") ||
2630 tests_exit(-1, "Couldn't open test-config: $!\n");
2633 do_substitute($testno);
2639 # The string $msg1 in args substitutes the message id of the first
2640 # message on the queue, and so on. */
2642 if ($args =~ /\$msg/)
2645 if ($args =~ /-qG\w+/) { $queuespec = $&; }
2649 if (defined $queuespec)
2651 @listcmd = ("$parm_cwd/eximdir/exim", '-bp',
2653 "-DEXIM_PATH=$parm_cwd/eximdir/exim",
2654 -C => "$parm_cwd/test-config");
2658 @listcmd = ("$parm_cwd/eximdir/exim", '-bp',
2659 "-DEXIM_PATH=$parm_cwd/eximdir/exim",
2660 -C => "$parm_cwd/test-config");
2662 print ">> Getting queue list from:\n>> @listcmd\n" if $debug;
2663 # We need the message ids sorted in ascending order.
2664 # Message id is: <timestamp>-<pid>-<fractional-time>. On some systems (*BSD) the
2665 # PIDs are randomized, so sorting just the whole PID doesn't work.
2666 # We do the Schartz' transformation here (sort on
2667 # <timestamp><fractional-time>). Thanks to Kirill Miazine
2669 map { $_->[1] } # extract the values
2670 sort { $a->[0] cmp $b->[0] } # sort by key
2671 map { [join('.' => (split /-/, $_)[0,2]) => $_] } # key (timestamp.fractional-time) => value(message_id)
2672 map { /^\s*\d+[smhdw]\s+\S+\s+(\S+)/ } `@listcmd` or tests_exit(-1, "No output from `exim -bp` (@listcmd)\n");
2674 # Done backwards just in case there are more than 9
2676 for (my $i = @msglist; $i > 0; $i--) { $args =~ s/\$msg$i/$msglist[$i-1]/g; }
2677 if ( $args =~ /\$msg\d/ )
2679 tests_exit(-1, "Not enough messages in spool, for test $testno line $lineno\n")
2680 unless $force_continue;
2684 # If -d is specified in $optargs, remove it from $args; i.e. let
2685 # the command line for runtest override. Then run Exim.
2687 $args =~ s/(?:^|\s)-d\S*// if $optargs =~ /(?:^|\s)-d/;
2689 my $opt_valgrind = $valgrind ? "valgrind --leak-check=yes --suppressions=$parm_cwd/aux-fixed/valgrind.supp " : '';
2691 $cmd = "$envset$sudo$opt_valgrind" .
2692 "$parm_cwd/eximdir/exim$special$optargs " .
2693 "-DEXIM_PATH=$parm_cwd/eximdir/exim$special " .
2694 "-C $parm_cwd/test-config $args " .
2695 ">>test-stdout 2>>test-stderr";
2696 # If the command is starting an Exim daemon, we run it in the same
2697 # way as the "server" command above, that is, we don't want to wait
2698 # for the process to finish. That happens when "killdaemon" is obeyed later
2699 # in the script. We also send the stderr output to test-stderr-server. The
2700 # daemon has its log files put in a different place too (by configuring with
2701 # log_file_path). This requires the directory to be set up in advance.
2703 # There are also times when we want to run a non-daemon version of Exim
2704 # (e.g. a queue runner) with the server configuration. In this case,
2705 # we also define -DNOTDAEMON.
2707 if ($cmd =~ /\s-DSERVER=server\s/ && $cmd !~ /\s-DNOTDAEMON\s/)
2709 if ($debug) { printf ">> daemon: $cmd\n"; }
2710 run_system("sudo mkdir spool/log 2>/dev/null");
2711 run_system("sudo chown $parm_eximuser:$parm_eximgroup spool/log");
2713 # Before running the command, convert the -bd option into -bdf so that an
2714 # Exim daemon doesn't double fork. This means that when we wait close
2715 # DAEMONCMD, it waits for the correct process. Also, ensure that the pid
2716 # file is written to the spool directory, in case the Exim binary was
2717 # built with PID_FILE_PATH pointing somewhere else.
2719 if ($cmd =~ /\s-oP\s/)
2721 ($pidfile = $cmd) =~ s/^.*-oP ([^ ]+).*$/$1/;
2722 $cmd =~ s!\s-bd\s! -bdf !;
2726 $pidfile = "$parm_cwd/spool/exim-daemon.pid";
2727 $cmd =~ s!\s-bd\s! -bdf -oP $pidfile !;
2729 print ">> |${cmd}-server\n" if ($debug);
2730 open DAEMONCMD, "|${cmd}-server" || tests_exit(-1, "Failed to run $cmd");
2731 DAEMONCMD->autoflush(1);
2732 while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; } # Ignore any input
2734 # Interlock with daemon startup
2735 for (my $count = 0; ! stat("$pidfile") && $count < 30; $count++ )
2736 { select(undef, undef, undef, 0.3); }
2737 return 3; # Don't wait
2739 elsif ($cmd =~ /\s-DSERVER=wait:(\d+)\s/)
2742 # The port and the $dynamic_socket was already allocated while parsing the
2743 # script file, where -DSERVER=wait:PORT_DYNAMIC was encountered.
2745 my $listen_port = $1;
2746 if ($debug) { printf ">> wait-mode daemon: $cmd\n"; }
2747 run_system("sudo mkdir spool/log 2>/dev/null");
2748 run_system("sudo chown $parm_eximuser:$parm_eximgroup spool/log");
2751 if (not defined $pid) { die "** fork failed: $!\n" }
2754 open(STDIN, '<&', $dynamic_socket) or die "** dup sock to stdin failed: $!\n";
2755 close($dynamic_socket);
2756 print "[$$]>> ${cmd}-server\n" if ($debug);
2757 exec "exec ${cmd}-server";
2758 die "Can't exec ${cmd}-server: $!\n";
2760 while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; } # Ignore any input
2761 select(undef, undef, undef, 0.3); # Let the daemon get going
2762 return (3, { exim_pid => $pid }); # Don't wait
2766 # The "background" command is run but not waited-for, like exim -DSERVER=server.
2767 # One script line is read and fork-exec'd. The PID is stored for a later
2770 elsif (/^background$/)
2773 # $pidfile = "$parm_cwd/aux-var/server-daemon.pid";
2775 $_ = <SCRIPT>; $lineno++;
2777 do_substitute($testno);
2779 if ($debug) { printf ">> daemon: $line >>test-stdout 2>>test-stderr\n"; }
2782 if (not defined $pid) { die "** fork failed: $!\n" }
2784 print "[$$]>> ${line}\n" if ($debug);
2786 open(STDIN, "<", "test-stdout");
2788 open(STDOUT, ">>", "test-stdout");
2790 open(STDERR, ">>", "test-stderr-server");
2791 exec "exec ${line}";
2795 # open(my $fh, ">", $pidfile) ||
2796 # tests_exit(-1, "Failed to open $pidfile: $!");
2797 # printf($fh, "%d\n", $pid);
2800 while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; } # Ignore any input
2801 select(undef, undef, undef, 0.3); # Let the daemon get going
2802 return (3, { exim_pid => $pid }); # Don't wait
2809 else { tests_exit(-1, "Command unrecognized in line $lineno: $_"); }
2812 # Run the command, with stdin connected to a pipe, and write the stdin data
2813 # to it, with appropriate substitutions. If a starts with '>>> ', process it
2814 # via Perl's string eval().
2815 # If the command contains
2816 # -DSERVER=server add "-server" to the command, where it will adjoin the name
2817 # for the stderr file. See comment above about the use of -DSERVER.
2819 $stderrsuffix = ($cmd =~ /\s-DSERVER=server\s/)? "-server" : '';
2820 print ">> |${cmd}${stderrsuffix}\n" if ($debug);
2821 open CMD, "|${cmd}${stderrsuffix}" || tests_exit(1, "Failed to run $cmd");
2824 LINE: while (<SCRIPT>)
2827 last if /^\*{4}\s*$/;
2828 do_substitute($testno);
2829 if (my ($cmd, $line) = /^(:\S+?:)(.*)/) {
2832 $cmd eq ':eval:' and do {
2836 $cmd eq ':noeol:' and do {
2840 $cmd eq ':sleep:' and do {
2849 # For timeout tests, wait before closing the pipe; we expect a
2850 # SIGPIPE error in this case.
2854 printf(" Test %d sleep $wait_time ", $$subtestref);
2855 while ($wait_time-- > 0)
2860 printf("\r Test %d $cr", $$subtestref);
2863 $sigpipehappened = 0;
2864 close CMD; # Waits for command to finish
2865 return $yield; # Ran command and waited
2871 ###############################################################################
2872 ###############################################################################
2874 # Here begins the Main Program ...
2876 ###############################################################################
2877 ###############################################################################
2881 print "Exim tester $testversion\n";
2883 # extend the PATH with .../sbin
2884 # we map all (.../bin) to (.../sbin:.../bin)
2886 my %seen = map { $_, 1 } split /:/, $ENV{PATH};
2887 join ':' => map { m{(.*)/bin$}
2888 ? ( $seen{"$1/sbin"} ? () : ("$1/sbin"), $_)
2890 split /:/, $ENV{PATH};
2893 ##################################################
2894 # Some tests check created file modes #
2895 ##################################################
2900 ##################################################
2901 # Check for the "less" command #
2902 ##################################################
2904 @more = 'more' if system('which less >/dev/null 2>&1') != 0;
2908 ##################################################
2909 # See if an Exim binary has been given #
2910 ##################################################
2912 # If the first character of the first argument is '/', the argument is taken
2913 # as the path to the binary. If the first argument does not start with a
2914 # '/' but exists in the file system, it's assumed to be the Exim binary.
2917 ##################################################
2918 # Sort out options and which tests are to be run #
2919 ##################################################
2921 # There are a few possible options for the test script itself; after these, any
2922 # options are passed on to Exim calls within the tests. Typically, this is used
2923 # to turn on Exim debugging while setting up a test.
2925 Getopt::Long::Configure qw(no_getopt_compat);
2927 'debug' => sub { $debug = 1; $cr = "\n" },
2928 'diff' => sub { $cf = 'diff -u' },
2929 'continue' => sub { $force_continue = 1; @more = 'cat' },
2930 'update' => \$force_update,
2931 'ipv4!' => \$have_ipv4,
2932 'ipv6!' => \$have_ipv6,
2933 'keep' => \$save_output,
2935 'valgrind' => \$valgrind,
2936 'range=s{2}' => \my @range_wanted,
2937 'test=i@' => \my @tests_wanted,
2938 'flavor|flavour=s' => \$flavour,
2939 'help' => sub { pod2usage(-exit => 0) },
2944 -noperldoc => system('perldoc -V 2>/dev/null 1>&2')
2949 ($parm_exim, @ARGV) = Exim::Runtest::exim_binary(@ARGV);
2950 print "Exim binary is `$parm_exim'\n" if defined $parm_exim;
2953 my @wanted = sort numerically uniq
2954 @tests_wanted ? @tests_wanted : (),
2955 @range_wanted ? $range_wanted[0] .. $range_wanted[1] : (),
2956 @ARGV ? @ARGV == 1 ? $ARGV[0] :
2957 $ARGV[1] eq '+' ? $ARGV[0]..($ARGV[0] >= 9000 ? TEST_SPECIAL_TOP : TEST_TOP) :
2958 0+$ARGV[0]..0+$ARGV[1] # add 0 to cope with test numbers starting with zero
2960 @wanted = 1..TEST_TOP if not @wanted;
2962 ##################################################
2963 # Check for sudo access to root #
2964 ##################################################
2966 print "You need to have sudo access to root to run these tests. Checking ...\n";
2967 if (system('sudo true >/dev/null') != 0)
2969 die "** Test for sudo failed: testing abandoned.\n";
2973 print "Test for sudo OK\n";
2979 ##################################################
2980 # Make the command's directory current #
2981 ##################################################
2983 # After doing so, we find its absolute path name.
2986 $cwd = '.' if ($cwd !~ s|/[^/]+$||);
2987 chdir($cwd) || die "** Failed to chdir to \"$cwd\": $!\n";
2988 $parm_cwd = Cwd::getcwd();
2991 ##################################################
2992 # Search for an Exim binary to test #
2993 ##################################################
2995 # If an Exim binary hasn't been provided, try to find one. We can handle the
2996 # case where exim-testsuite is installed alongside Exim source directories. For
2997 # PH's private convenience, if there's a directory just called "exim4", that
2998 # takes precedence; otherwise exim-snapshot takes precedence over any numbered
3001 # If $parm_exim is still empty, ask the caller
3005 print "** Did not find an Exim binary to test\n";
3006 for ($i = 0; $i < 5; $i++)
3009 print "** Enter pathname for Exim binary: ";
3010 chomp($trybin = <STDIN>);
3013 $parm_exim = $trybin;
3018 print "** $trybin does not exist\n";
3021 die "** Too many tries\n" if $parm_exim eq '';
3026 ##################################################
3027 # Find what is in the binary #
3028 ##################################################
3030 # deal with TRUSTED_CONFIG_LIST restrictions
3031 unlink("$parm_cwd/test-config") if -e "$parm_cwd/test-config";
3032 open (IN, "$parm_cwd/confs/0000") ||
3033 tests_exit(-1, "Couldn't open $parm_cwd/confs/0000: $!\n");
3034 open (OUT, ">test-config") ||
3035 tests_exit(-1, "Couldn't open test-config: $!\n");
3036 while (<IN>) { print OUT; }
3040 print("Probing with config file: $parm_cwd/test-config\n");
3042 my $eximinfo = "$parm_exim -d -C $parm_cwd/test-config -DDIR=$parm_cwd -bP exim_user exim_group";
3043 chomp(my @eximinfo = `$eximinfo 2>&1`);
3044 die "$0: Can't run $eximinfo\n" if $? == -1;
3046 warn 'Got ' . $?>>8 . " from $eximinfo\n" if $?;
3049 if (my ($version) = /^Exim version (\S+)/) {
3050 my $git = `git describe --dirty=-XX --match 'exim-4*'`;
3051 if (defined $git and $? == 0) {
3053 $git =~ s/^exim-//i;
3054 $git =~ s/.*-\Kg([[:xdigit:]]+(?:-XX)?)/$1/;
3057 *** Version mismatch
3058 *** Exim binary: $version
3062 if not $version eq $git;
3065 $parm_eximuser = $1 if /^exim_user = (.*)$/;
3066 $parm_eximgroup = $1 if /^exim_group = (.*)$/;
3067 $parm_trusted_config_list = $1 if /^TRUSTED_CONFIG_LIST:.*?"(.*?)"$/;
3068 ($parm_configure_owner, $parm_configure_group) = ($1, $2)
3069 if /^Configure owner:\s*(\d+):(\d+)/;
3070 print if /wrong owner/;
3073 if (not defined $parm_eximuser) {
3074 die <<XXX, map { "|$_\n" } @eximinfo;
3075 Unable to extract exim_user from binary.
3076 Check if Exim refused to run; if so, consider:
3077 TRUSTED_CONFIG_LIST ALT_CONFIG_PREFIX WHITELIST_D_MACROS
3078 If debug permission denied, are you in the exim group?
3079 Failing to get information from binary.
3080 Output from $eximinfo:
3085 if ($parm_eximuser =~ /^\d+$/) { $parm_exim_uid = $parm_eximuser; }
3086 else { $parm_exim_uid = getpwnam($parm_eximuser); }
3088 if (defined $parm_eximgroup)
3090 if ($parm_eximgroup =~ /^\d+$/) { $parm_exim_gid = $parm_eximgroup; }
3091 else { $parm_exim_gid = getgrnam($parm_eximgroup); }
3094 # check the permissions on the TRUSTED_CONFIG_LIST
3095 if (defined $parm_trusted_config_list)
3097 die "TRUSTED_CONFIG_LIST: $parm_trusted_config_list: $!\n"
3098 if not -f $parm_trusted_config_list;
3100 die "TRUSTED_CONFIG_LIST $parm_trusted_config_list must not be world writable!\n"
3101 if 02 & (stat _)[2];
3103 die sprintf "TRUSTED_CONFIG_LIST: $parm_trusted_config_list %d is group writable, but not owned by group '%s' or '%s'.\n",
3105 scalar(getgrgid 0), scalar(getgrgid $>)
3106 if (020 & (stat _)[2]) and not ((stat _)[5] == $> or (stat _)[5] == 0);
3108 die sprintf "TRUSTED_CONFIG_LIST: $parm_trusted_config_list is not owned by user '%s' or '%s'.\n",
3109 scalar(getpwuid 0), scalar(getpwuid $>)
3110 if (not (-o _ or (stat _)[4] == 0));
3112 open(TCL, $parm_trusted_config_list) or die "Can't open $parm_trusted_config_list: $!\n";
3113 my $test_config = getcwd() . '/test-config';
3114 die "Can't find '$test_config' in TRUSTED_CONFIG_LIST $parm_trusted_config_list."
3115 if not grep { /^\Q$test_config\E$/ } <TCL>;
3119 die "Unable to check the TRUSTED_CONFIG_LIST, seems to be empty?\n";
3122 die "CONFIGURE_OWNER ($parm_configure_owner) does not match the user invoking $0 ($>)\n"
3123 if $parm_configure_owner != $>;
3125 die "CONFIGURE_GROUP ($parm_configure_group) does not match the group invoking $0 ($))\n"
3126 if 0020 & (stat "$parm_cwd/test-config")[2]
3127 and $parm_configure_group != $);
3129 die "aux-fixed file is group-writeable; best to strip them all, recursively\n"
3130 if 0020 & (stat "aux-fixed/0037.f-1")[2];
3133 open(EXIMINFO, "$parm_exim -d-all+transport -bV -C $parm_cwd/test-config -DDIR=$parm_cwd |") ||
3134 die "** Cannot run $parm_exim: $!\n";
3136 print "-" x 78, "\n";
3142 if (/^(Exim|Library) version/) { print; }
3143 if (/Runtime: /) {print; }
3145 elsif (/^Size of off_t: (\d+)/)
3148 $have_largefiles = 1 if $1 > 4;
3149 die "** Size of off_t > 32 which seems improbable, not running tests\n"
3153 elsif (/^Support for: (.*)/)
3156 @temp = split /(\s+)/, $1;
3158 %parm_support = @temp;
3161 elsif (/^Lookups \(built-in\): (.*)/)
3164 @temp = split /(\s+)/, $1;
3166 %parm_lookups = @temp;
3169 elsif (/^Authenticators: (.*)/)
3172 @temp = split /(\s+)/, $1;
3174 %parm_authenticators = @temp;
3177 elsif (/^Routers: (.*)/)
3180 @temp = split /(\s+)/, $1;
3182 %parm_routers = @temp;
3185 # Some transports have options, e.g. appendfile/maildir. For those, ensure
3186 # that the basic transport name is set, and then the name with each of the
3189 elsif (/^Transports: (.*)/)
3192 @temp = split /(\s+)/, $1;
3195 %parm_transports = @temp;
3196 foreach $k (keys %parm_transports)
3200 @temp = split /\//, $k;
3201 $parm_transports{$temp[0]} = " ";
3202 for ($i = 1; $i < @temp; $i++)
3203 { $parm_transports{"$temp[0]/$temp[$i]"} = " "; }
3208 elsif (/^Malware: (.*)/)
3211 @temp = split /(\s+)/, $1;
3213 %parm_malware = @temp;
3218 print "-" x 78, "\n";
3220 unlink("$parm_cwd/test-config");
3222 ##################################################
3223 # Check for SpamAssassin and ClamAV #
3224 ##################################################
3226 # These are crude tests. If they aren't good enough, we'll have to improve
3227 # them, for example by actually passing a message through spamc or clamscan.
3229 if (defined $parm_support{Content_Scanning})
3231 my $sock = new FileHandle;
3233 if (system("spamc -h 2>/dev/null >/dev/null") == 0)
3235 print "The spamc command works:\n";
3237 # This test for an active SpamAssassin is courtesy of John Jetmore.
3238 # The tests are hard coded to localhost:783, so no point in making
3239 # this test flexible like the clamav test until the test scripts are
3240 # changed. spamd doesn't have the nice PING/PONG protocol that
3241 # clamd does, but it does respond to errors in an informative manner,
3244 my($sint,$sport) = ('127.0.0.1',783);
3247 my $sin = sockaddr_in($sport, inet_aton($sint))
3248 or die "** Failed packing $sint:$sport\n";
3249 socket($sock, PF_INET, SOCK_STREAM, getprotobyname('tcp'))
3250 or die "** Unable to open socket $sint:$sport\n";
3253 sub { die "** Timeout while connecting to socket $sint:$sport\n"; };
3255 connect($sock, $sin)
3256 or die "** Unable to connect to socket $sint:$sport\n";
3259 select((select($sock), $| = 1)[0]);
3260 print $sock "bad command\r\n";
3263 sub { die "** Timeout while reading from socket $sint:$sport\n"; };
3269 or die "** Did not get SPAMD from socket $sint:$sport. "
3276 print " Assume SpamAssassin (spamd) is not running\n";
3280 $parm_running{SpamAssassin} = ' ';
3281 print " SpamAssassin (spamd) seems to be running\n";
3286 print "The spamc command failed: assume SpamAssassin (spamd) is not running\n";
3289 # For ClamAV, we need to find the clamd socket for use in the Exim
3290 # configuration. Search for the clamd configuration file.
3292 if (system("clamscan -h 2>/dev/null >/dev/null") == 0)
3294 my($f, $clamconf, $test_prefix);
3296 print "The clamscan command works";
3298 $test_prefix = $ENV{EXIM_TEST_PREFIX};
3299 $test_prefix = '' if !defined $test_prefix;
3301 foreach $f ("$test_prefix/etc/clamd.conf",
3302 "$test_prefix/usr/local/etc/clamd.conf",
3303 "$test_prefix/etc/clamav/clamd.conf", '')
3312 # Read the ClamAV configuration file and find the socket interface.
3314 if ($clamconf ne '')
3317 open(IN, "$clamconf") || die "\n** Unable to open $clamconf: $!\n";
3320 if (/^LocalSocket\s+(.*)/)
3322 $parm_clamsocket = $1;
3323 $socket_domain = AF_UNIX;
3326 if (/^TCPSocket\s+(\d+)/)
3328 if (defined $parm_clamsocket)
3330 $parm_clamsocket .= " $1";
3331 $socket_domain = AF_INET;
3336 $parm_clamsocket = " $1";
3339 elsif (/^TCPAddr\s+(\S+)/)
3341 if (defined $parm_clamsocket)
3343 $parm_clamsocket = $1 . $parm_clamsocket;
3344 $socket_domain = AF_INET;
3349 $parm_clamsocket = $1;
3355 if (defined $socket_domain)
3357 print ":\n The clamd socket is $parm_clamsocket\n";
3358 # This test for an active ClamAV is courtesy of Daniel Tiefnig.
3362 if ($socket_domain == AF_UNIX)
3364 $socket = sockaddr_un($parm_clamsocket) or die "** Failed packing '$parm_clamsocket'\n";
3366 elsif ($socket_domain == AF_INET)
3368 my ($ca_host, $ca_port) = split(/\s+/,$parm_clamsocket);
3369 my $ca_hostent = gethostbyname($ca_host) or die "** Failed to get raw address for host '$ca_host'\n";
3370 $socket = sockaddr_in($ca_port, $ca_hostent) or die "** Failed packing '$parm_clamsocket'\n";
3374 die "** Unknown socket domain '$socket_domain' (should not happen)\n";
3376 socket($sock, $socket_domain, SOCK_STREAM, 0) or die "** Unable to open socket '$parm_clamsocket'\n";
3377 local $SIG{ALRM} = sub { die "** Timeout while connecting to socket '$parm_clamsocket'\n"; };
3379 connect($sock, $socket) or die "** Unable to connect to socket '$parm_clamsocket'\n";
3382 my $ofh = select $sock; $| = 1; select $ofh;
3383 print $sock "PING\n";
3385 $SIG{ALRM} = sub { die "** Timeout while reading from socket '$parm_clamsocket'\n"; };
3390 $res =~ /PONG/ or die "** Did not get PONG from socket '$parm_clamsocket'. It said: $res\n";
3397 print " Assume ClamAV is not running\n";
3401 $parm_running{ClamAV} = ' ';
3402 print " ClamAV seems to be running\n";
3407 print ", but the socket for clamd could not be determined\n";
3408 print "Assume ClamAV is not running\n";
3414 print ", but I can't find a configuration for clamd\n";
3415 print "Assume ClamAV is not running\n";
3421 ##################################################
3423 ##################################################
3424 if (defined $parm_lookups{redis})
3426 if (system("redis-server -v 2>/dev/null >/dev/null") == 0)
3428 print "The redis-server command works\n";
3429 $parm_running{redis} = ' ';
3433 print "The redis-server command failed: assume Redis not installed\n";
3437 ##################################################
3438 # Test for the basic requirements #
3439 ##################################################
3441 # This test suite assumes that Exim has been built with at least the "usual"
3442 # set of routers, transports, and lookups. Ensure that this is so.
3446 $missing .= " Lookup: lsearch\n" if (!defined $parm_lookups{lsearch});
3448 $missing .= " Router: accept\n" if (!defined $parm_routers{accept});
3449 $missing .= " Router: dnslookup\n" if (!defined $parm_routers{dnslookup});
3450 $missing .= " Router: manualroute\n" if (!defined $parm_routers{manualroute});
3451 $missing .= " Router: redirect\n" if (!defined $parm_routers{redirect});
3453 $missing .= " Transport: appendfile\n" if (!defined $parm_transports{appendfile});
3454 $missing .= " Transport: autoreply\n" if (!defined $parm_transports{autoreply});
3455 $missing .= " Transport: pipe\n" if (!defined $parm_transports{pipe});
3456 $missing .= " Transport: smtp\n" if (!defined $parm_transports{smtp});
3461 print "** Many features can be included or excluded from Exim binaries.\n";
3462 print "** This test suite requires that Exim is built to contain a certain\n";
3463 print "** set of basic facilities. It seems that some of these are missing\n";
3464 print "** from the binary that is under test, so the test cannot proceed.\n";
3465 print "** The missing facilities are:\n";
3467 die "** Test script abandoned\n";
3471 ##################################################
3472 # Check for the auxiliary programs #
3473 ##################################################
3475 # These are always required:
3477 for $prog ("cf", "checkaccess", "client", "client-ssl", "client-gnutls",
3478 "fakens", "iefbr14", "server")
3480 next if ($prog eq "client-ssl" && !defined $parm_support{OpenSSL});
3481 next if ($prog eq "client-gnutls" && !defined $parm_support{GnuTLS});
3482 if (!-e "bin/$prog")
3485 print "** bin/$prog does not exist. Have you run ./configure and make?\n";
3486 die "** Test script abandoned\n";
3490 # If the "loaded" binary is missing, we cut out tests for ${dlfunc. It isn't
3491 # compiled on systems where we don't know how to. However, if Exim does not
3492 # have that functionality compiled, we needn't bother.
3494 $dlfunc_deleted = 0;
3495 if (defined $parm_support{Expand_dlfunc} && !-e 'bin/loaded')
3497 delete $parm_support{Expand_dlfunc};
3498 $dlfunc_deleted = 1;
3502 ##################################################
3503 # Find environmental details #
3504 ##################################################
3506 # Find the caller of this program.
3508 ($parm_caller,$pwpw,$parm_caller_uid,$parm_caller_gid,$pwquota,$pwcomm,
3509 $parm_caller_gecos, $parm_caller_home) = getpwuid($>);
3511 $pwpw = $pwpw; # Kill Perl warnings
3512 $pwquota = $pwquota;
3515 $parm_caller_group = getgrgid($parm_caller_gid);
3517 print "Program caller is $parm_caller ($parm_caller_uid), whose group is $parm_caller_group ($parm_caller_gid)\n";
3518 print "Home directory is $parm_caller_home\n";
3520 unless (defined $parm_eximgroup)
3522 print "Unable to derive \$parm_eximgroup.\n";
3523 die "** ABANDONING.\n";
3526 if ($parm_caller_home eq $parm_cwd)
3528 print "will confuse working dir with homedir; change homedir\n";
3529 die "** ABANDONING.\n";
3532 print "You need to be in the Exim group to run these tests. Checking ...";
3534 if (`groups` =~ /\b\Q$parm_eximgroup\E\b/)
3540 print "\nOh dear, you are not in the Exim group.\n";
3541 die "** Testing abandoned.\n";
3544 # Find this host's IP addresses - there may be many, of course, but we keep
3545 # one of each type (IPv4 and IPv6).
3546 #XXX it would be good to avoid non-UP interfaces
3548 open(IFCONFIG, '-|', (grep { -x "$_/ip" } split /:/, $ENV{PATH}) ? 'ip address' : 'ifconfig -a')
3549 or die "** Cannot run 'ip address' or 'ifconfig -a'\n";
3550 while (not ($parm_ipv4 and $parm_ipv6) and defined($_ = <IFCONFIG>))
3552 if (/^(?:[0-9]+: )?([a-z0-9]+): /) { $ifname = $1; }
3554 if (not $parm_ipv4 and /^\s*inet(?:\saddr(?:ess))?:?\s*(\d+\.\d+\.\d+\.\d+)(?:\/\d+)?\s/i)
3556 # It would be nice to be able to vary the /16 used for manyhome; we could take
3557 # an option to runtest used here - but we'd also have to pass it on to fakens.
3558 # Possibly an environment variable?
3559 next if $1 eq '0.0.0.0' or $1 =~ /^(?:127|10\.250)\./;
3563 if ( (not $parm_ipv6 or $parm_ipv6 =~ /%/)
3564 and /^\s*inet6(?:\saddr(?:ess))?:?\s*([abcdef\d:]+)(?:%[^ \/]+)?(?:\/\d+)?/i)
3566 next if $1 eq '::' or $1 eq '::1' or $1 =~ /^ff00/i or $1 =~ /^fe80::1/i;
3568 if ($1 =~ /^fe80/i) { $parm_ipv6 .= '%' . $ifname; }
3573 # Use private IP addresses if there are no public ones.
3575 # If either type of IP address is missing, we need to set the value to
3576 # something other than empty, because that wrecks the substitutions. The value
3577 # is reflected, so use a meaningful string. Set appropriate options for the
3578 # "server" command. In practice, however, many tests assume 127.0.0.1 is
3579 # available, so things will go wrong if there is no IPv4 address. The lack
3580 # of IPV4 or IPv6 can be simulated by command options, which force $have_ipv4
3581 # and $have_ipv6 false.
3586 $parm_ipv4 = "<no IPv4 address found>";
3587 $server_opts .= " -noipv4";
3589 elsif ($have_ipv4 == 0)
3591 $parm_ipv4 = "<IPv4 testing disabled>";
3592 $server_opts .= " -noipv4";
3596 $parm_running{IPv4} = " ";
3602 $parm_ipv6 = "<no IPv6 address found>";
3603 $server_opts .= " -noipv6";
3604 delete($parm_support{IPv6});
3606 elsif ($have_ipv6 == 0)
3608 $parm_ipv6 = "<IPv6 testing disabled>";
3609 $server_opts .= " -noipv6";
3610 delete($parm_support{IPv6});
3612 elsif (!defined $parm_support{IPv6})
3615 $parm_ipv6 = "<no IPv6 support in Exim binary>";
3616 $server_opts .= " -noipv6";
3620 $parm_running{IPv6} = " ";
3623 print "IPv4 address is $parm_ipv4\n";
3624 print "IPv6 address is $parm_ipv6\n";
3625 $parm_ipv6 =~ /^[^%\/]*/;
3626 # drop any %scope from the ipv6, for some uses
3627 ($parm_ipv6_stripped = $parm_ipv6) =~ s/%.*//g;
3629 # For munging test output, we need the reversed IP addresses.
3631 $parm_ipv4r = ($parm_ipv4 !~ /^\d/)? '' :
3632 join(".", reverse(split /\./, $parm_ipv4));
3634 $parm_ipv6r = $parm_ipv6; # Appropriate if not in use
3635 if ($parm_ipv6 =~ /^[\da-f]/)
3637 my(@comps) = split /:/, $parm_ipv6_stripped;
3639 foreach $comp (@comps)
3641 push @nibbles, sprintf("%lx", hex($comp) >> 8);
3642 push @nibbles, sprintf("%lx", hex($comp) & 0xff);
3644 $parm_ipv6r = join(".", reverse(@nibbles));
3647 # Find the host name, fully qualified.
3649 chomp($temp = `hostname`);
3650 die "'hostname' didn't return anything\n" unless defined $temp and length $temp;
3653 $parm_hostname = $temp;
3657 $parm_hostname = (gethostbyname($temp))[0];
3658 $parm_hostname = "no.host.name.found" unless defined $parm_hostname and length $parm_hostname;
3660 print "Hostname is $parm_hostname\n";
3662 if ($parm_hostname !~ /\./)
3664 print "\n*** Host name is not fully qualified: this may cause problems ***\n\n";
3667 if ($parm_hostname =~ /[[:upper:]]/)
3669 print "\n*** Host name has upper case characters: this may cause problems ***\n\n";
3672 if ($parm_hostname =~ /\.example\.com$/)
3674 die "\n*** Host name ends in .example.com; this conflicts with the testsuite use of that domain.\n"
3675 . " Please change the host's name (or comment out this check, and fail several testcases)\n";
3680 ##################################################
3681 # Create a testing version of Exim #
3682 ##################################################
3684 # We want to be able to run Exim with a variety of configurations. Normally,
3685 # the use of -C to change configuration causes Exim to give up its root
3686 # privilege (unless the caller is exim or root). For these tests, we do not
3687 # want this to happen. Also, we want Exim to know that it is running in its
3690 # We achieve this by copying the binary and patching it as we go. The new
3691 # binary knows it is a testing copy, and it allows -C and -D without loss of
3692 # privilege. Clearly, this file is dangerous to have lying around on systems
3693 # where there are general users with login accounts. To protect against this,
3694 # we put the new binary in a special directory that is accessible only to the
3695 # caller of this script, who is known to have sudo root privilege from the test
3696 # that was done above. Furthermore, we ensure that the binary is deleted at the
3697 # end of the test. First ensure the directory exists.
3700 { unlink "eximdir/exim"; } # Just in case
3703 mkdir("eximdir", 0710) || die "** Unable to mkdir $parm_cwd/eximdir: $!\n";
3704 system("sudo chgrp $parm_eximgroup eximdir");
3707 # The construction of the patched binary must be done as root, so we use
3708 # a separate script. As well as indicating that this is a test-harness binary,
3709 # the version number is patched to "x.yz" so that its length is always the
3710 # same. Otherwise, when it appears in Received: headers, it affects the length
3711 # of the message, which breaks certain comparisons.
3713 die "** Unable to make patched exim: $!\n"
3714 if (system("sudo ./patchexim $parm_exim") != 0);
3716 # From this point on, exits from the program must go via the subroutine
3717 # tests_exit(), so that suitable cleaning up can be done when required.
3718 # Arrange to catch interrupting signals, to assist with this.
3720 $SIG{INT} = \&inthandler;
3721 $SIG{PIPE} = \&pipehandler;
3723 # For some tests, we need another copy of the binary that is setuid exim rather
3726 system("sudo cp eximdir/exim eximdir/exim_exim;" .
3727 "sudo chown $parm_eximuser eximdir/exim_exim;" .
3728 "sudo chgrp $parm_eximgroup eximdir/exim_exim;" .
3729 "sudo chmod 06755 eximdir/exim_exim");
3731 ##################################################
3732 # Make copies of utilities we might need #
3733 ##################################################
3735 # Certain of the tests make use of some of Exim's utilities. We do not need
3736 # to be root to copy these.
3738 ($parm_exim_dir) = $parm_exim =~ m?^(.*)/exim?;
3740 $dbm_build_deleted = 0;
3741 if (defined $parm_lookups{dbm} &&
3742 system("cp $parm_exim_dir/exim_dbmbuild eximdir") != 0)
3744 delete $parm_lookups{dbm};
3745 $dbm_build_deleted = 1;
3748 if (system("cp $parm_exim_dir/exim_dumpdb eximdir") != 0)
3750 tests_exit(-1, "Failed to make a copy of exim_dumpdb: $!");
3753 if (system("cp $parm_exim_dir/exim_lock eximdir") != 0)
3755 tests_exit(-1, "Failed to make a copy of exim_lock: $!");
3758 if (system("cp $parm_exim_dir/exinext eximdir") != 0)
3760 tests_exit(-1, "Failed to make a copy of exinext: $!");
3763 if (system("cp $parm_exim_dir/exigrep eximdir") != 0)
3765 tests_exit(-1, "Failed to make a copy of exigrep: $!");
3768 if (system("cp $parm_exim_dir/eximstats eximdir") != 0)
3770 tests_exit(-1, "Failed to make a copy of eximstats: $!");
3773 # Collect some version information
3774 print '-' x 78, "\n";
3775 print "Perl version for runtest: $]\n";
3776 foreach (map { "./eximdir/$_" } qw(exigrep exinext eximstats)) {
3777 # fold (or unfold?) multiline output into a one-liner
3778 print join(', ', map { chomp; $_ } `$_ --version`), "\n";
3780 print '-' x 78, "\n";
3783 ##################################################
3784 # Check that the Exim user can access stuff #
3785 ##################################################
3787 # We delay this test till here so that we can check access to the actual test
3788 # binary. This will be needed when Exim re-exec's itself to do deliveries.
3790 print "Exim user is $parm_eximuser ($parm_exim_uid)\n";
3791 print "Exim group is $parm_eximgroup ($parm_exim_gid)\n";
3793 if ($parm_caller_uid eq $parm_exim_uid) {
3794 tests_exit(-1, "Exim user ($parm_eximuser,$parm_exim_uid) cannot be "
3795 ."the same as caller ($parm_caller,$parm_caller_uid)");
3797 if ($parm_caller_gid eq $parm_exim_gid) {
3798 tests_exit(-1, "Exim group ($parm_eximgroup,$parm_exim_gid) cannot be "
3799 ."the same as caller's ($parm_caller) group as it confuses "
3800 ."results analysis");
3803 print "The Exim user needs access to the test suite directory. Checking ...";
3805 if (($rc = system("sudo bin/checkaccess $parm_cwd/eximdir/exim $parm_eximuser $parm_eximgroup")) != 0)
3807 my($why) = "unknown failure $rc";
3809 $why = "Couldn't find user \"$parm_eximuser\"" if $rc == 1;
3810 $why = "Couldn't find group \"$parm_eximgroup\"" if $rc == 2;
3811 $why = "Couldn't read auxiliary group list" if $rc == 3;
3812 $why = "Couldn't get rid of auxiliary groups" if $rc == 4;
3813 $why = "Couldn't set gid" if $rc == 5;
3814 $why = "Couldn't set uid" if $rc == 6;
3815 $why = "Couldn't open \"$parm_cwd/eximdir/exim\"" if $rc == 7;
3816 print "\n** $why\n";
3817 tests_exit(-1, "$parm_eximuser cannot access the test suite directory");
3824 tests_exit(-1, "Failed to unlink $log_summary_filename: $!")
3825 if not unlink($log_summary_filename) and -e $log_summary_filename;
3827 ##################################################
3828 # Create a list of available tests #
3829 ##################################################
3831 # The scripts directory contains a number of subdirectories whose names are
3832 # of the form 0000-xxxx, 1100-xxxx, 2000-xxxx, etc. Each set of tests apart
3833 # from the first requires certain optional features to be included in the Exim
3834 # binary. These requirements are contained in a file called "REQUIRES" within
3835 # the directory. We scan all these tests, discarding those that cannot be run
3836 # because the current binary does not support the right facilities, and also
3837 # those that are outside the numerical range selected.
3839 printf "\nWill run %d tests between %d and %d for flavour %s\n",
3840 scalar(@wanted), $wanted[0], $wanted[-1], $flavour;
3842 print "Omitting \${dlfunc expansion tests (loadable module not present)\n"
3844 print "Omitting dbm tests (unable to copy exim_dbmbuild)\n"
3845 if $dbm_build_deleted;
3848 my @test_dirs = grep { not /^CVS$/ } map { basename $_ } glob 'scripts/*'
3849 or die tests_exit(-1, "Failed to find test scripts in 'scripts/*`: $!");
3851 # Scan for relevant tests
3852 # HS12: Needs to be reworked.
3853 DIR: for (my $i = 0; $i < @test_dirs; $i++)
3855 my($testdir) = $test_dirs[$i];
3858 print ">>Checking $testdir\n" if $debug;
3860 # Skip this directory if the first test is equal or greater than the first
3861 # test in the next directory.
3863 next DIR if ($i < @test_dirs - 1) &&
3864 ($wanted[0] >= substr($test_dirs[$i+1], 0, 4));
3866 # No need to carry on if the end test is less than the first test in this
3869 last DIR if $wanted[-1] < substr($testdir, 0, 4);
3871 # Check requirements, if any.
3873 if (open(my $requires, "scripts/$testdir/REQUIRES"))
3879 if (/^support (.*)$/)
3881 if (!defined $parm_support{$1}) { $wantthis = 0; last; }
3883 elsif (/^running (.*)$/)
3885 if (!defined $parm_running{$1}) { $wantthis = 0; last; }
3887 elsif (/^lookup (.*)$/)
3889 if (!defined $parm_lookups{$1}) { $wantthis = 0; last; }
3891 elsif (/^authenticators? (.*)$/)
3893 if (!defined $parm_authenticators{$1}) { $wantthis = 0; last; }
3895 elsif (/^router (.*)$/)
3897 if (!defined $parm_routers{$1}) { $wantthis = 0; last; }
3899 elsif (/^transport (.*)$/)
3901 if (!defined $parm_transports{$1}) { $wantthis = 0; last; }
3903 elsif (/^malware (.*)$/)
3905 if (!defined $parm_malware{$1}) { $wantthis = 0; last; }
3907 elsif (/^feature (.*)$/)
3909 # move to a subroutine?
3910 my $eximinfo = "$parm_exim -C $parm_cwd/test-config -DDIR=$parm_cwd -bP macro $1";
3912 open (IN, "$parm_cwd/confs/0000") ||
3913 tests_exit(-1, "Couldn't open $parm_cwd/confs/0000: $!\n");
3914 open (OUT, ">test-config") ||
3915 tests_exit(-1, "Couldn't open test-config: $!\n");
3918 do_substitute($testno);
3924 system($eximinfo . " >/dev/null 2>&1");
3926 unlink("$parm_cwd/test-config");
3931 unlink("$parm_cwd/test-config");
3933 elsif (/^ipv6-non-linklocal/)
3935 if ($parm_ipv6 =~ /%/) { $wantthis = 0; last; }
3939 tests_exit(-1, "Unknown line in \"scripts/$testdir/REQUIRES\": \"$_\"");
3945 tests_exit(-1, "Failed to open \"scripts/$testdir/REQUIRES\": $!")
3949 # Loop if we do not want the tests in this subdirectory.
3954 print "Omitting tests in $testdir (missing $_)\n";
3957 # We want the tests from this subdirectory, provided they are in the
3958 # range that was selected.
3960 @testlist = grep { $_ ~~ @wanted } grep { /^\d+(?:\.\d+)?$/ } map { basename $_ } glob "scripts/$testdir/*";
3961 tests_exit(-1, "Failed to read test scripts from `scripts/$testdir/*': $!")
3964 foreach $test (@testlist)
3968 log_test($log_summary_filename, $test, '.');
3972 push @test_list, "$testdir/$test";
3977 print ">>Test List:\n", join "\n", @test_list, '' if $debug;
3980 ##################################################
3981 # Munge variable auxiliary data #
3982 ##################################################
3984 # Some of the auxiliary data files have to refer to the current testing
3985 # directory and other parameter data. The generic versions of these files are
3986 # stored in the aux-var-src directory. At this point, we copy each of them
3987 # to the aux-var directory, making appropriate substitutions. There aren't very
3988 # many of them, so it's easiest just to do this every time. Ensure the mode
3989 # is standardized, as this path is used as a test for the ${stat: expansion.
3991 # A similar job has to be done for the files in the dnszones-src directory, to
3992 # make the fake DNS zones for testing. Most of the zone files are copied to
3993 # files of the same name, but db.ipv4.V4NET and db.ipv6.V6NET use the testing
3994 # networks that are defined by parameter.
3996 foreach $basedir ("aux-var", "dnszones")
3998 system("sudo rm -rf $parm_cwd/$basedir");
3999 mkdir("$parm_cwd/$basedir", 0777);
4000 chmod(0755, "$parm_cwd/$basedir");
4002 opendir(AUX, "$parm_cwd/$basedir-src") ||
4003 tests_exit(-1, "Failed to opendir $parm_cwd/$basedir-src: $!");
4004 my(@filelist) = readdir(AUX);
4007 foreach $file (@filelist)
4009 my($outfile) = $file;
4010 next if $file =~ /^\./;
4012 if ($file eq "db.ip4.V4NET")
4014 $outfile = "db.ip4.$parm_ipv4_test_net";
4016 elsif ($file eq "db.ip6.V6NET")
4018 my(@nibbles) = reverse(split /\s*/, $parm_ipv6_test_net);
4020 $outfile = "db.ip6.@nibbles";
4024 print ">>Copying $basedir-src/$file to $basedir/$outfile\n" if $debug;
4025 open(IN, "$parm_cwd/$basedir-src/$file") ||
4026 tests_exit(-1, "Failed to open $parm_cwd/$basedir-src/$file: $!");
4027 open(OUT, ">$parm_cwd/$basedir/$outfile") ||
4028 tests_exit(-1, "Failed to open $parm_cwd/$basedir/$outfile: $!");
4039 # Set a user's shell, distinguishable from /bin/sh
4041 symlink('/bin/sh' => 'aux-var/sh');
4042 $ENV{SHELL} = $parm_shell = "$parm_cwd/aux-var/sh";
4044 ##################################################
4045 # Create fake DNS zones for this host #
4046 ##################################################
4048 # There are fixed zone files for 127.0.0.1 and ::1, but we also want to be
4049 # sure that there are forward and reverse registrations for this host, using
4050 # its real IP addresses. Dynamically created zone files achieve this.
4052 if ($have_ipv4 || $have_ipv6)
4054 my($shortname,$domain) = $parm_hostname =~ /^([^.]+)(.*)/;
4055 open(OUT, ">$parm_cwd/dnszones/db$domain") ||
4056 tests_exit(-1, "Failed to open $parm_cwd/dnszones/db$domain: $!");
4057 print OUT "; This is a dynamically constructed fake zone file.\n" .
4058 "; The following line causes fakens to return PASS_ON\n" .
4059 "; for queries that it cannot answer\n\n" .
4060 "PASS ON NOT FOUND\n\n";
4061 print OUT "$shortname A $parm_ipv4\n" if $have_ipv4;
4062 print OUT "$shortname AAAA $parm_ipv6_stripped\n" if $have_ipv6;
4063 print OUT "\n; End\n";
4067 if ($have_ipv4 && $parm_ipv4 ne "127.0.0.1")
4069 my(@components) = $parm_ipv4 =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)/;
4071 if ($components[0]=='10')
4073 open(OUT, ">>$parm_cwd/dnszones/db.ip4.$components[0]") ||
4074 tests_exit(-1, "Failed to open $parm_cwd/dnszones/db.ip4.$components[0]: $!");
4075 print OUT "$components[3].$components[2].$components[1] PTR $parm_hostname.\n\n";
4080 open(OUT, ">$parm_cwd/dnszones/db.ip4.$components[0]") ||
4082 "Failed to open $parm_cwd/dnszones/db.ip4.$components[0]: $!");
4083 print OUT "; This is a dynamically constructed fake zone file.\n" .
4084 "; The zone is $components[0].in-addr.arpa.\n\n" .
4085 "$components[3].$components[2].$components[1] PTR $parm_hostname.\n\n" .
4091 if ($have_ipv6 && $parm_ipv6_stripped ne "::1")
4093 my($exp_v6) = $parm_ipv6_stripped;
4094 $exp_v6 =~ s/[^:]//g;
4095 if ( $parm_ipv6_stripped =~ /^([^:].+)::$/ ) {
4096 $exp_v6 = $1 . ':0' x (9-length($exp_v6));
4097 } elsif ( $parm_ipv6_stripped =~ /^(.+)::(.+)$/ ) {
4098 $exp_v6 = $1 . ':0' x (8-length($exp_v6)) . ':' . $2;
4099 } elsif ( $parm_ipv6_stripped =~ /^::(.+[^:])$/ ) {
4100 $exp_v6 = '0:' x (9-length($exp_v6)) . $1;
4102 $exp_v6 = $parm_ipv6_stripped;
4104 my(@components) = split /:/, $exp_v6;
4105 my(@nibbles) = reverse (split /\s*/, shift @components);
4109 open(OUT, ">$parm_cwd/dnszones/db.ip6.@nibbles") ||
4111 "Failed to open $parm_cwd/dnszones/db.ip6.@nibbles: $!");
4112 print OUT "; This is a dynamically constructed fake zone file.\n" .
4113 "; The zone is @nibbles.ip6.arpa.\n\n";
4115 @components = reverse @components;
4116 foreach $c (@components)
4118 $c = "0$c" until $c =~ /^..../;
4119 @nibbles = reverse(split /\s*/, $c);
4120 print OUT "$sep@nibbles";
4124 print OUT " PTR $parm_hostname.\n\n; End\n";
4131 ##################################################
4132 # Create lists of mailboxes and message logs #
4133 ##################################################
4135 # We use these lists to check that a test has created the expected files. It
4136 # should be faster than looking for the file each time. For mailboxes, we have
4137 # to scan a complete subtree, in order to handle maildirs. For msglogs, there
4138 # is just a flat list of files.
4140 @oldmails = list_files_below("mail");
4141 opendir(DIR, "msglog") || tests_exit(-1, "Failed to opendir msglog: $!");
4142 @oldmsglogs = readdir(DIR);
4147 ##################################################
4148 # Run the required tests #
4149 ##################################################
4151 # Each test script contains a number of tests, separated by a line that
4152 # contains ****. We open input from the terminal so that we can read responses
4155 if (not $force_continue) {
4156 # runtest needs to interact if we're not in continue
4157 # mode. It does so by communicate to /dev/tty
4158 open(T, '<', '/dev/tty') or tests_exit(-1, "Failed to open /dev/tty: $!");
4159 print "\nPress RETURN to run the tests: ";
4164 foreach $test (@test_list)
4166 state $lasttestdir = '';
4169 local $commandno = 0;
4170 local $subtestno = 0;
4173 (local $testno = $test) =~ s|.*/||;
4175 # Leaving traces in the process table and in the environment
4176 # gives us a chance to identify hanging processes (exim daemons)
4177 local $0 = "[runtest $testno]";
4178 local $ENV{EXIM_TEST_NUMBER} = $testno;
4182 my $thistestdir = substr($test, 0, -5);
4184 $dynamic_socket->close() if $dynamic_socket;
4186 if ($lasttestdir ne $thistestdir)
4189 if (-s "scripts/$thistestdir/REQUIRES")
4192 print "\n>>> The following tests require: ";
4193 open(my $requires, '<', "scripts/$thistestdir/REQUIRES") ||
4194 tests_exit(-1, "Failed to open scripts/$thistestdir/REQUIRES: $!");
4197 $gnutls = 1 if /^support GnuTLS/;
4202 $lasttestdir = $thistestdir;
4205 # Remove any debris in the spool directory and the test-mail directory
4206 # and also the files for collecting stdout and stderr. Then put back
4207 # the test-mail directory for appendfile deliveries.
4209 system "sudo /bin/rm -rf spool test-*";
4210 system "mkdir test-mail 2>/dev/null";
4212 # A privileged Exim will normally make its own spool directory, but some of
4213 # the tests run in unprivileged modes that don't always work if the spool
4214 # directory isn't already there. What is more, we want anybody to be able
4215 # to read it in order to find the daemon's pid.
4217 system "mkdir spool; " .
4218 "sudo chown $parm_eximuser:$parm_eximgroup spool; " .
4219 "sudo chmod 0755 spool";
4221 # Empty the cache that keeps track of things like message id mappings, and
4222 # set up the initial sequence strings.
4234 $TEST_STATE->{munge} = '';
4236 # Remove the associative arrays used to hold checked mail files and msglogs
4238 undef %expected_mails;
4239 undef %expected_msglogs;
4241 # Open the test's script
4242 open(SCRIPT, "scripts/$test") ||
4243 tests_exit(-1, "Failed to open \"scripts/$test\": $!");
4244 # Run through the script once to set variables which should be global
4247 if (/^no_message_check/) { $message_skip = 1; next; }
4248 if (/^no_msglog_check/) { $msglog_skip = 1; next; }
4249 if (/^no_stderr_check/) { $stderr_skip = 1; next; }
4250 if (/^no_stdout_check/) { $stdout_skip = 1; next; }
4251 if (/^rmfiltertest/) { $rmfiltertest = 1; next; }
4252 if (/^sortlog/) { $sortlog = 1; next; }
4253 if (/\bPORT_DYNAMIC\b/) { $dynamic_socket = Exim::Runtest::dynamic_socket(); next; }
4255 # Reset to beginning of file for per test interpreting/processing
4258 # The first line in the script must be a comment that is used to identify
4259 # the set of tests as a whole.
4263 tests_exit(-1, "Missing identifying comment at start of $test") if (!/^#/);
4264 printf("%s %s", (substr $test, 5), (substr $_, 2));
4266 # Loop for each of the subtests within the script. The variable $server_pid
4267 # is used to remember the pid of a "server" process, for which we do not
4268 # wait until we have waited for a subsequent command.
4270 local($server_pid) = 0;
4271 for ($commandno = 1; !eof SCRIPT; $commandno++)
4273 # Skip further leading comments and blank lines, handle the flag setting
4274 # commands, and deal with tests for IP support.
4279 # Could remove these variable settings because they are already
4280 # set above, but doesn't hurt to leave them here.
4281 if (/^no_message_check/) { $message_skip = 1; next; }
4282 if (/^no_msglog_check/) { $msglog_skip = 1; next; }
4283 if (/^no_stderr_check/) { $stderr_skip = 1; next; }
4284 if (/^no_stdout_check/) { $stdout_skip = 1; next; }
4285 if (/^rmfiltertest/) { $rmfiltertest = 1; next; }
4286 if (/^sortlog/) { $sortlog = 1; next; }
4288 if (/^need_largefiles/)
4290 next if $have_largefiles;
4291 print ">>> Large file support is needed for test $testno, but is not available: skipping\n";
4292 $docheck = 0; # don't check output
4293 undef $_; # pretend EOF
4300 print ">>> IPv4 is needed for test $testno, but is not available: skipping\n";
4301 $docheck = 0; # don't check output
4302 undef $_; # pretend EOF
4313 print ">>> IPv6 is needed for test $testno, but is not available: skipping\n";
4314 $docheck = 0; # don't check output
4315 undef $_; # pretend EOF
4319 if (/^need_move_frozen_messages/)
4321 next if defined $parm_support{move_frozen_messages};
4322 print ">>> move frozen message support is needed for test $testno, " .
4323 "but is not\n>>> available: skipping\n";
4324 $docheck = 0; # don't check output
4325 undef $_; # pretend EOF
4329 last unless /^(?:#(?!##\s)|\s*$)/;
4331 last if !defined $_; # Hit EOF
4333 my($subtest_startline) = $lineno;
4335 # Now run the command. The function returns 0 for an inline command,
4336 # 1 if a non-exim command was run and waited for, 2 if an exim
4337 # command was run and waited for, and 3 if a command
4338 # was run and not waited for (usually a daemon or server startup).
4340 my($commandname) = '';
4342 my($rc, $run_extra) = run_command($testno, \$subtestno, \$expectrc, \$commandname, $TEST_STATE);
4346 print ">> rc=$rc cmdrc=$cmdrc\n";
4347 if (defined $run_extra) {
4348 foreach my $k (keys %$run_extra) {
4349 my $v = defined $run_extra->{$k} ? qq!"$run_extra->{$k}"! : '<undef>';
4350 print ">> $k -> $v\n";
4354 $run_extra = {} unless defined $run_extra;
4355 foreach my $k (keys %$run_extra) {
4356 if (exists $TEST_STATE->{$k}) {
4357 my $nv = defined $run_extra->{$k} ? qq!"$run_extra->{$k}"! : 'removed';
4358 print ">> override of $k; was $TEST_STATE->{$k}, now $nv\n" if $debug;
4360 if (defined $run_extra->{$k}) {
4361 $TEST_STATE->{$k} = $run_extra->{$k};
4362 } elsif (exists $TEST_STATE->{$k}) {
4363 delete $TEST_STATE->{$k};
4367 # Hit EOF after an initial return code number
4369 tests_exit(-1, "Unexpected EOF in script") if ($rc == 4);
4371 # Carry on with the next command if we did not wait for this one. $rc == 0
4372 # if no subprocess was run; $rc == 3 if we started a process but did not
4375 next if ($rc == 0 || $rc == 3);
4377 # We ran and waited for a command. Check for the expected result unless
4380 if ($cmdrc != $expectrc && !$sigpipehappened)
4382 printf("** Command $commandno (\"$commandname\", starting at line $subtest_startline)\n");
4383 if (($cmdrc & 0xff) == 0)
4385 printf("** Return code %d (expected %d)", $cmdrc/256, $expectrc/256);
4387 elsif (($cmdrc & 0xff00) == 0)
4388 { printf("** Killed by signal %d", $cmdrc & 255); }
4390 { printf("** Status %x", $cmdrc); }
4394 print "\nshow stdErr, show stdOut, Retry, Continue (without file comparison), or Quit? [Q] ";
4395 $_ = $force_continue ? "c" : <T>;
4396 tests_exit(1) if /^q?$/i;
4397 if (/^c$/ && $force_continue) {
4398 log_failure($log_failed_filename, $testno, "exit code unexpected");
4399 log_test($log_summary_filename, $testno, 'F')
4401 if ($force_continue)
4403 print "\nstdout tail:\n";
4404 print "==================>\n";
4405 system("tail -20 test-stdout");
4406 print "===================\n";
4408 print "stderr tail:\n";
4409 print "==================>\n";
4410 system("tail -30 test-stderr");
4411 print "===================\n";
4413 print "stdout-server tail:\n";
4414 print "==================>\n";
4415 system("tail -20 test-stdout-server");
4416 print "===================\n";
4418 print "stderr-server tail:\n";
4419 print "==================>\n";
4420 system("tail -30 test-stderr-server");
4421 print "===================\n";
4423 print "... continue forced\n";
4429 system @more => 'test-stderr';
4433 system @more => 'test-stdout';
4437 $retry = 1 if /^r$/i;
4441 # If the command was exim, and a listening server is running, we can now
4442 # close its input, which causes us to wait for it to finish, which is why
4443 # we didn't close it earlier.
4445 if ($rc == 2 && $server_pid != 0)
4451 if (($? & 0xff) == 0)
4452 { printf("Server return code %d for test %d starting line %d", $?/256,
4453 $testno, $subtest_startline); }
4454 elsif (($? & 0xff00) == 0)
4455 { printf("Server killed by signal %d", $? & 255); }
4457 { printf("Server status %x", $?); }
4461 print "\nShow server stdout, Retry, Continue, or Quit? [Q] ";
4462 $_ = $force_continue ? "c" : <T>;
4463 tests_exit(1) if /^q?$/i;
4464 if (/^c$/ && $force_continue) {
4465 log_failure($log_failed_filename, $testno, "exit code unexpected");
4466 log_test($log_summary_filename, $testno, 'F')
4468 print "... continue forced\n" if $force_continue;
4473 open(S, "test-stdout-server") ||
4474 tests_exit(-1, "Failed to open test-stdout-server: $!");
4479 $retry = 1 if /^r$/i;
4486 # The script has finished. Check the all the output that was generated. The
4487 # function returns 0 for a perfect pass, 1 if imperfect but ok, 2 if we should
4488 # rerun the test (the files # have been updated).
4489 # It does not return if the user responds Q to a prompt.
4494 print (("#" x 79) . "\n");
4501 my $rc = check_output($TEST_STATE->{munge});
4502 log_test($log_summary_filename, $testno, 'P') if ($rc == 0);
4505 print (" Script completed\n");
4509 print (("#" x 79) . "\n");
4516 ##################################################
4517 # Exit from the test script #
4518 ##################################################
4520 tests_exit(-1, "No runnable tests selected") if not @test_list;
4527 runtest - run the exim testsuite
4531 runtest [exim-path] [options] [test0 [test1]]
4535 B<runtest> runs the Exim testsuite.
4539 For legacy reasons the options are not case sensitive.
4545 Do not stop for user interaction or on errors. (default: off)
4549 This option enables the output of debug information when running the
4550 various test commands. (default: off)
4554 Use C<diff -u> for comparing the expected output with the produced
4555 output. (default: use a built-in routine)
4557 =item B<--flavor>|B<--flavour> I<flavour>
4559 Override the expected results for results for a specific (OS) flavour.
4564 Skip IPv4 related setup and tests (default: use ipv4)
4568 Skip IPv6 related setup and tests (default: use ipv6)
4572 Keep the various output files produced during a test run. (default: don't keep)
4574 =item B<--range> I<n0> I<n1>
4576 Run tests between (including) I<n0> and I<n1>. A "+" may be used to specify the "last
4581 Insert some delays to compensate for a slow host system. (default: off)
4583 =item B<--test> I<n>
4585 Run the specified test. This option may used multiple times.
4589 Automatically update the recorded (expected) data on mismatch. (default: off)
4593 Start Exim wrapped by I<valgrind>. (default: don't use valgrind)
4600 # End of runtest script