2 # We use env, because in some environments of our build farm
3 # the Perl 5.010 interpreter is only reachable via $PATH
5 # Copyright (c) The Exim Maintainers 2024
6 # SPDX-License-Identifier: GPL-2.0-or-later
8 ###############################################################################
9 # This is the controlling script for the "new" test suite for Exim. It should #
10 # be possible to export this suite for running on a wide variety of hosts, in #
11 # contrast to the old suite, which was very dependent on the environment of #
12 # Philip Hazel's desktop computer. This implementation inspects the version #
13 # of Exim that it finds, and tests only those features that are included. The #
14 # surrounding environment is also tested to discover what is available. See #
15 # the README file for details of how it all works. #
17 # Implementation started: 03 August 2005 by Philip Hazel #
18 # Placed in the Exim CVS: 06 February 2006 #
19 ###############################################################################
33 use FindBin qw'$RealBin';
36 use lib "$RealBin/lib";
38 use Exim::Utils qw(uniq numerically cp);
40 use if $ENV{DEBUG} && scalar($ENV{DEBUG} =~ /\bruntest\b/) => 'Smart::Comments' => '####';
41 use if $ENV{DEBUG} && scalar($ENV{DEBUG} =~ /\bruntest\b/) => 'Data::Dumper';
43 use constant TEST_TOP => 8999;
44 use constant TEST_SPECIAL_TOP => 9999;
47 # Start by initializing some global variables
49 chomp(my $testversion = `git describe --always --dirty 2>&1` || '<unknown>');
51 # This gets embedded in the D-H params filename, and the value comes
52 # from asking GnuTLS for "normal", but there appears to be no way to
53 # use certtool/... to ask what that value currently is. *sigh*
54 # We also clamp it because of NSS interop, see addition of tls_dh_max_bits.
55 # This value is correct as of GnuTLS 2.12.18 as clamped by tls_dh_max_bits.
56 # normal = 2432 tls_dh_max_bits = 2236
57 my $gnutls_dh_bits_normal = 2236;
59 my $cf = 'bin/cf -exact';
63 my $f = Exim::Runtest::flavour() // '';
64 (grep { $f eq $_ } Exim::Runtest::flavours()) ? $f : 'FOO';
66 my $force_continue = 0;
68 my $log_failed_filename = 'failed-summary.log';
69 my $log_summary_filename = 'run-summary.log';
70 my @more = qw'less -XF';
79 my $have_largefiles = 0;
84 # Networks to use for DNS tests. We need to choose some networks that will
85 # never be used so that there is no chance that the host on which we are
86 # running is actually in one of the test networks. Private networks such as
87 # the IPv4 10.0.0.0/8 network are no good because hosts may well use them.
88 # Rather than use some unassigned numbers (that might become assigned later),
89 # I have chosen some multicast networks, in the belief that such addresses
90 # won't ever be assigned to hosts. This is the only place where these numbers
91 # are defined, so it is trivially possible to change them should that ever
94 my $parm_ipv4_test_net = 224;
95 my $parm_ipv6_test_net = 'ff00';
97 # Port numbers are currently hard-wired
99 my $parm_port_n = 1223; # Nothing listening on this port
100 my $parm_port_s = 1224; # Used for the "server" command
101 my $parm_port_d = 1225; # Used for the Exim daemon
102 my $parm_port_d2 = 1226; # Additional for daemon
103 my $parm_port_d3 = 1227; # Additional for daemon
104 my $parm_port_d4 = 1228; # Additional for daemon
105 my $dynamic_socket; # allocated later for PORT_DYNAMIC
107 # Find a suiteable group name for test (currently only 0001
108 # uses a group name. A numeric group id would do
109 my $parm_mailgroup = Exim::Runtest::mailgroup('mail');
111 # Manually set locale
114 # In some environments USER does not exist, but we need it for some test(s)
115 $ENV{USER} = getpwuid($>) if not exists $ENV{USER};
117 my ($parm_configure_owner, $parm_configure_group);
118 my ($parm_ipv4, $parm_ipv6, $parm_ipv6_stripped);
121 # Convenience for regex'
122 # for tighter, see https://metacpan.org/dist/IO-Socket-IP/source/lib/IO/Socket/IP.pm#L37
123 my $re_ipv4 = qr/\d{1,3}(?:\.\d{1,3}){3}/;
124 my $re_6g = qr/[[:xdigit:]]{1,4}/;
125 my $re_6s = qr/${re_6g}:/;
126 my $re_ipv6 = qr/${re_6s}{0,7}${re_6g}(?:::${re_6s}{0,5}${re_6g})?/;
127 my $re_ip = qr/(?:${re_ipv4}|${re_ipv6})/;
129 ###############################################################################
130 ###############################################################################
132 # Define a number of subroutines
134 ###############################################################################
135 ###############################################################################
138 ##################################################
140 ##################################################
142 sub pipehandler { $sigpipehappened = 1; }
144 sub inthandler { print "\n"; tests_exit(-1, "Caught SIGINT"); }
147 ##################################################
148 # Do global macro substitutions #
149 ##################################################
151 # This function is applied to configurations, command lines and data lines in
152 # scripts, and to lines in the files of the aux-var-src and the dnszones-src
153 # directory. It takes one argument: the current test number, or zero when
154 # setting up files before running any tests.
157 s?\bCALLER\b?$parm_caller?g;
158 s?\bCALLERGROUP\b?$parm_caller_group?g;
159 s?\bCALLER_UID\b?$parm_caller_uid?g;
160 s?\bCALLER_GID\b?$parm_caller_gid?g;
161 s?\bCLAMSOCKET\b?$parm_clamsocket?g;
162 s?\bDIR/?$parm_cwd/?g;
163 s?\bEXIMGROUP\b?$parm_eximgroup?g;
164 s?\bEXIMUSER\b?$parm_eximuser?g;
165 s?\bHOSTIPV4\b?$parm_ipv4?g;
166 s?\bHOSTIPV6\b?$parm_ipv6?g;
167 s?\bHOSTNAME\b?$parm_hostname?g;
168 s?\bPORT_D\b?$parm_port_d?g;
169 s?\bPORT_D2\b?$parm_port_d2?g;
170 s?\bPORT_D3\b?$parm_port_d3?g;
171 s?\bPORT_D4\b?$parm_port_d4?g;
172 s?\bPORT_N\b?$parm_port_n?g;
173 s?\bPORT_S\b?$parm_port_s?g;
174 s?\bTESTNUM\b?$_[0]?g;
175 s?(\b|_)V4NET([\._])?$1$parm_ipv4_test_net$2?g;
176 s?\bV6NET:?$parm_ipv6_test_net:?g;
177 s?\bPORT_DYNAMIC\b?$dynamic_socket->sockport()?eg;
178 s?\bMAILGROUP\b?$parm_mailgroup?g;
182 ##################################################
183 # Any state to be preserved across tests #
184 ##################################################
189 ##################################################
190 # Subroutine to tidy up and exit #
191 ##################################################
193 # In all cases, we check for any Exim daemons that have been left running, and
194 # kill them. Then remove all the spool data, test output, and the modified Exim
195 # binary if we are ending normally.
198 # $_[0] = 0 for a normal exit; full cleanup done
199 # $_[0] > 0 for an error exit; no files cleaned up
200 # $_[0] < 0 for a "die" exit; $_[1] contains a message
206 # Search for daemon pid files and kill the daemons. We kill with SIGINT rather
207 # than SIGTERM to stop it outputting "Terminated" to the terminal when not in
210 if (exists $TEST_STATE->{exim_pid})
212 $pid = $TEST_STATE->{exim_pid};
213 print "Tidyup: killing wait-mode daemon pid=$pid\n";
214 system("sudo kill -INT $pid");
217 if (opendir(DIR, "spool"))
219 my(@spools) = sort readdir(DIR);
221 foreach $spool (@spools)
223 next if $spool !~ /^exim-daemon./;
224 open(PID, "spool/$spool") || die "** Failed to open \"spool/$spool\": $!\n";
227 print "Tidyup: killing daemon pid=$pid\n";
228 system("sudo rm -f spool/$spool; sudo kill -INT $pid");
232 { die "** Failed to opendir(\"spool\"): $!\n" unless $!{ENOENT}; }
234 # Close the terminal input and remove the test files if all went well, unless
235 # the option to save them is set. Always remove the patched Exim binary. Then
236 # exit normally, or die.
239 system("sudo /bin/rm -rf ./spool test-* ./dnszones/*")
240 if ($rc == 0 && !$save_output);
242 system("sudo /bin/rm -rf ./eximdir/*")
245 print "\nYou were in test $test at the end there.\n\n" if defined $test;
246 exit $rc if ($rc >= 0);
247 die "** runtest error: $_[1]\n";
252 ##################################################
253 # Subroutines used by the munging subroutine #
254 ##################################################
256 # This function is used for things like message ids, where we want to generate
257 # more than one value, but keep a consistent mapping throughout.
260 # $oldid the value from the file
261 # $base a base string into which we insert a sequence
262 # $sequence the address of the current sequence counter
265 my($oldid, $base, $sequence) = @_;
266 my($newid) = $cache{$oldid};
267 print ">> replace $oldid -> $newid\n" if ($debug && defined $newid);
268 if (! defined $newid)
270 $newid = sprintf($base, $$sequence++);
271 print ">> new $oldid -> $newid\n" if $debug;
272 $cache{$oldid} = $newid;
278 # This is used while munging the output from exim_dumpdb.
279 # May go wrong across DST changes.
282 my($day,$month,$year,$hour,$min,$sec) =
283 $_[0] =~ /^(\d\d)-(\w\w\w)-(\d{4})\s(\d\d):(\d\d):(\d\d)/;
285 if ($month =~ /Jan/) {$mon = 0;}
286 elsif($month =~ /Feb/) {$mon = 1;}
287 elsif($month =~ /Mar/) {$mon = 2;}
288 elsif($month =~ /Apr/) {$mon = 3;}
289 elsif($month =~ /May/) {$mon = 4;}
290 elsif($month =~ /Jun/) {$mon = 5;}
291 elsif($month =~ /Jul/) {$mon = 6;}
292 elsif($month =~ /Aug/) {$mon = 7;}
293 elsif($month =~ /Sep/) {$mon = 8;}
294 elsif($month =~ /Oct/) {$mon = 9;}
295 elsif($month =~ /Nov/) {$mon = 10;}
296 elsif($month =~ /Dec/) {$mon = 11;}
297 return timelocal($sec,$min,$hour,$day,$mon,$year);
301 # This is a subroutine to sort maildir files into time-order. The second field
302 # is the microsecond field, and may vary in length, so must be compared
306 return $a cmp $b if ($a !~ /^\d+\.H\d/ || $b !~ /^\d+\.H\d/);
307 my($x1,$y1) = $a =~ /^(\d+)\.H(\d+)/;
308 my($x2,$y2) = $b =~ /^(\d+)\.H(\d+)/;
309 return ($x1 != $x2)? ($x1 <=> $x2) : ($y1 <=> $y2);
314 ##################################################
315 # Subroutine list files below a directory #
316 ##################################################
318 # This is used to build up a list of expected mail files below a certain path
319 # in the directory tree. It has to be recursive in order to deal with multiple
322 sub list_files_below {
327 opendir(DIR, $dir) || tests_exit(-1, "Failed to open $dir: $!");
328 @sublist = sort maildirsort readdir(DIR);
331 foreach $file (@sublist)
333 next if $file eq "." || $file eq ".." || $file eq "CVS";
335 { @yield = (@yield, list_files_below("$dir/$file")); }
337 { push @yield, "$dir/$file"; }
345 ##################################################
346 # Munge a file before comparing #
347 ##################################################
349 # The pre-processing turns all dates, times, Exim versions, message ids, and so
350 # on into standard values, so that the compare works. Perl's substitution with
351 # an expression provides a neat way to do some of these changes.
353 # We keep a global associative array for repeatedly turning the same values
354 # into the same standard values throughout the data from a single test.
355 # Message ids get this treatment (can't be made reliable for times), and
356 # times in dumped retry databases are also handled in a special way, as are
357 # incoming port numbers and PIDs.
359 # On entry to the subroutine, the file to write to is already opened with the
360 # name MUNGED. The input file name is the only argument to the subroutine.
361 # Certain actions are taken only when the name contains "stderr", "stdout",
362 # or "log". The yield of the function is 1 if a line matching "*** truncated
363 # ***" is encountered; otherwise it is 0.
373 open(IN, "$file") || tests_exit(-1, "Failed to open $file: $!");
375 my($is_log) = $file =~ /log/;
376 my($is_stdout) = $file =~ /stdout/;
377 my($is_stderr) = $file =~ /stderr/;
378 my($is_mail) = $file =~ /mail/;
382 $date = "\\d{2}-\\w{3}-\\d{4}\\s\\d{2}:\\d{2}:\\d{2}";
386 $time_pid = "(?:\\d{2}:\\d{2}:\\d{2}\\s+\\d+\\s)";
388 # Pattern for matching pids at start of stderr lines; initially something
391 $spid = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
393 # Scan the file and make the changes. Near the bottom there are some changes
394 # that are specific to certain file types, though there are also some of those
399 RESET_AFTER_EXTRA_LINE_READ:
402 # Munging is a no-op, except for exim_msgdate specials.
403 # Useful when testing exim_msgdate so that
404 # we compare unmunged dates and message-ids.
405 s%^localhost \d+ from message-id != given number \d+ at \K/.+(?=/test/eximdir/exim_msgdate line 387.$)%DIR%;
414 next if $extra =~ m%^/% && eval $extra;
415 eval $extra if $extra =~ m/^s/;
416 eval substr($extra, 1) if $extra =~ m/^R/;
419 # Check for "*** truncated ***"
420 $yield = 1 if /\*\*\* truncated \*\*\*/;
422 # Replace the name of this host
423 s/\Q$parm_hostname\E/the.local.host.name/g;
425 # But convert "name=the.local.host address=127.0.0.1" to use "localhost"
426 s/name=the\.local\.host address=127\.0\.0\.1/name=localhost address=127.0.0.1/g;
428 # The name of the shell may vary
429 s/\s\Q$parm_shell\E\b/ ENV_SHELL/;
431 # Replace the path to the testsuite directory
432 s?\Q$parm_cwd\E?TESTSUITE?g;
434 # Replace the Exim version number (may appear in various places)
435 # patchexim should have fixed this for us
436 #s/Exim \K\d+[._]\d+[\w_-]*/x.yz/i;
438 # Replace Exim message ids by a unique series.
439 # Both old and new formats, with separate replace series, for now.
440 s/(\d[^\W_]{5}-[^\W_]{6}-[^\W_]{2})
441 /new_value($1, "10Hm%s-0005vi-00", \$next_msgid_old)/egx;
442 s/(\d[^\W_]{5}-[^\W_]{11}-[^\W_]{4})
443 /new_value($1, "10Hm%s-000000005vi-0000", \$next_msgid)/egx;
445 # The names of lock files appear in some error and debug messages
446 s/\.lock(\.[-\w]+)+(\.[\da-f]+){2}/.lock.test.ex.dddddddd.pppppppp/;
448 # Unless we are in an IPv6 test, replace IPv4 and/or IPv6 in "listening on
449 # port" message, because it is not always the same.
450 s/port (\d+) \([^)]+\)/port $1/g
451 if !$is_ipv6test && m/listening for SMTP(S?) on port/;
453 # Challenges in SPA authentication
454 s/TlRMTVNTUAACAAAAAAAAAAAoAAABgg[\w+\/]+/TlRMTVNTUAACAAAAAAAAAAAoAAABggAAAEbBRwqFwwIAAAAAAAAAAAAt1sgAAAAA/;
457 s?prvs=([^/]+)/[\da-f]{10}@?prvs=$1/xxxxxxxxxx@?g; # Old form
458 s?prvs=[\da-f]{10}=([^@]+)@?prvs=xxxxxxxxxx=$1@?g; # New form
460 # There are differences in error messages between OpenSSL versions
461 s/SSL_CTX_set_cipher_list/SSL_connect/;
462 s/error=\Kauthority and subject key identifier mismatch/self signed certificate/;
463 s/error=\Kself-signed certificate/self signed certificate/;
465 # One error test in expansions mentions base 62 or 36
466 s/is not a base (36|62) number/is not a base 36\/62 number/;
468 # This message sometimes has a different number of seconds
469 s/forced fail after \d seconds/forced fail after d seconds/;
471 # This message may contain a different DBM library name
472 s/Failed to open \S+( \([^\)]+\))? file/Failed to open hintsdb file/;
474 # The message for a non-listening FIFO varies
475 s/:[^:]+: while opening named pipe/: Error: while opening named pipe/;
477 # Debugging output of lists of hosts may have different sort keys
478 s/^\s*\S+ (?:\d+\.){3}\d+ mx=\S+ sort=\K\S+/xx/;
480 # Random local part in callout cache testing
481 s/myhost.test.ex-\d+-testing/myhost.test.ex-dddddddd-testing/;
482 s/the.local.host.name-\d+-testing/the.local.host.name-dddddddd-testing/;
484 # File descriptor numbers may vary
485 s/^writing data block fd=\d+/writing data block fd=dddd/;
486 s/(running as transport filter:) fd_write=\d+ fd_read=\d+/$1 fd_write=dddd fd_read=dddd/;
489 # ======== Dumpdb output ========
490 # This must be before the general date/date munging.
491 # Time data lines, which look like this:
492 # 25-Aug-2000 12:11:37 25-Aug-2000 12:11:37 26-Aug-2000 12:11:37
493 if (/^($date)\s+($date)\s+($date)(\s+\*)?\s*$/)
495 my($date1,$date2,$date3,$expired) = ($1,$2,$3,$4);
496 $expired = '' if !defined $expired;
498 # Make time-difference minimum 2, and rounded up to even value
499 my($increment) = date_seconds($date3) - date_seconds($date2) + 1;
500 $increment = 2 if ($increment == 0);
501 $increment = ($increment >> 1) << 1;
503 # We used to use globally unique replacement values, but timing
504 # differences make this impossible. Just show the increment on the
507 printf MUNGED ("first failed = time last try = time2 next try = time2 + %s%s\n",
508 $increment, $expired);
512 # more_errno values in exim_dumpdb output which are times
513 s/T:(\S+)\s-22\s(\S+)\s/T:$1 -22 xxxx /;
515 # port numbers in dumpdb output
516 s/T:([a-z0-9.]+(:[0-9.]+|:\[[^]]+])?):$parm_port_n /T:$1:PORT_N /;
517 s/T:([a-z0-9.[\]]+(:[0-9.]+|:\[[^]]+])?):$parm_port_s /T:$1:PORT_S /;
519 s/Transport: (?:[a-z0-9.]+|\[[^\]]+]) (?:[0-9.]+|\[[^\]]+]):\K$parm_port_s /PORT_S /;
521 # port numbers in stderr
522 s/^set_process_info: .*\]:\K$parm_port_d /PORT_D /;
523 s/^set_process_info: .*\]:\K$parm_port_s /PORT_S /;
526 # ======== Dates and times ========
528 # Dates and times are all turned into the same value - trying to turn
529 # them into different ones cannot be done repeatedly because they are
530 # real time stamps generated while running the test. The actual date and
531 # time used was fixed when I first started running automatic Exim tests.
533 # Date/time in header lines and SMTP responses
545 /Tue,${1}2${2}Mar${3}1999${4}09:44:33${5}+0000/gx;
546 # and in a French locale
547 s/\S{4},\s\d\d?\s[^,]+\s\d{4}\s\d\d\:\d\d:\d\d\s[-+]\d{4}
548 /dim., 10 f\xE9vr 2019 20:05:49 +0000/gx;
550 # Date/time in logs and in one instance of a filter test
551 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;
552 s/^\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d\.\d{3}(?:\s(?:[+-]\d\d\d\d|[A-Z]{2}T))?\s/2017-07-30 18:51:05.712 /gx;
553 s/^Logwrite\s"\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d/Logwrite "1999-03-02 09:44:33/gx;
554 # Date/time in syslog test
555 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;
556 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;
557 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;
558 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;
560 s/((D|[RQD]T)=)\d+s/$1qqs/g;
561 s/((D|[RQD]T)=)\d\.\d{3}s/$1q.qqqs/g;
563 # Date/time in message separators
571 /Tue${1}Mar${1}02${2}09:44:33${3}1999/gx;
573 # Date of message arrival in spool file as shown by -Mvh
574 s/^\d{9,10}\s0$/ddddddddd 0/;
576 # Date/time in mbx mailbox files
577 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;
579 # Dates/times in debugging output for writing retry records
580 if (/^(.+)first failed=(\d+) last try=(\d+) next try=(\d+) (.*)$/)
583 $_ = "$1first failed=dddd last try=dddd next try=+$next $5\n";
585 s/^(.*)now=\d+ first_failed=\d+ next_try=\d+ expired=(\w)/$1now=tttt first_failed=tttt next_try=tttt expired=$2/;
586 s/^(.*)received_time=\d+ diff=\d+ timeout=(\d+)/$1received_time=tttt diff=tttt timeout=$2/;
588 # Time to retry may vary
589 s/time to retry = \S+/time to retry = tttt/;
590 s/retry record exists: age=\S+/retry record exists: age=ttt/;
591 s/failing_interval=\S+ message_age=\S+/failing_interval=ttt message_age=ttt/;
593 # Date/time in exim -bV output
594 s/\d\d-[A-Z][a-z]{2}-\d{4}\s\d\d:\d\d:\d\d/07-Mar-2000 12:21:52/g;
597 s/Exim\sstatistics\sfrom\s\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d\sto\s
598 \d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d/Exim statistics from <time> to <time>/x;
600 # Treat ECONNRESET the same as ECONNREFUSED. At least some systems give
601 # us the former on a new connection.
602 s/(could not connect to .*: Connection) reset by peer$/$1 refused/;
604 # ======== TLS certificate algorithms ========
606 # In Received: headers, convert RFC 8314 style ciphersuite to
607 # the older (comment) style, keeping only the Auth element
608 # (discarding kex, cipher, mac). For TLS 1.3 there is no kex
609 # element (and no _WITH); insert a spurious "RSA".
610 # Also in $tls_X_cipher_std reporting.
612 s/^\s+by \S+ with .+ \K \(TLS1(?:\.[0-3])?\) tls TLS_.*?([^_]+)_WITH.+$/(TLS1.x:ke-$1-AES256-SHAnnn:xxx)/;
613 s/^\s+by \S+ with .+ \K \(TLS1(?:\.[0-3])?\) tls TLS_.+$/(TLS1.x:ke-RSA-AES256-SHAnnn:xxx)/;
615 s/ cipher_ TLS_.*?([^_]+)_WITH.+$/ cipher_ TLS1.x:ke_$1_WITH_ci_mac/;
616 s/ cipher_ TLS_.*$/ cipher_ TLS1.x:ke_RSA_WITH_ci_mac/;
618 # Test machines might have various different TLS library versions supporting
619 # different protocols; can't rely upon TLS 1.2's AES256-GCM-SHA384, so we
620 # treat the standard algorithms the same.
622 # TLSversion : KeyExchange? - Authentication/Signature - C_iph_er - MAC : bits
625 # TLSv1:AES128-GCM-SHA256:128
626 # TLSv1:AES256-SHA:256
627 # TLSv1.1:AES256-SHA:256
628 # TLSv1.2:AES256-GCM-SHA384:256
629 # TLSv1.2:DHE-RSA-AES256-SHA:256
630 # TLSv1.3:TLS_AES_256_GCM_SHA384:256
631 # TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128
632 # We also need to handle the ciphersuite without the TLS part present, for
633 # client-ssl's output. We also see some older forced ciphersuites, but
634 # negotiating TLS 1.2 instead of 1.0.
635 # Mail headers (...), log-lines X=..., client-ssl output ...
636 # (and \b doesn't match between ' ' and '(' )
638 # Retain the authentication algorith field as we want to test that.
640 s/( (?: (?:\b|\s) [\(=] ) | \s )TLS1(\.[123])?:/$1TLS1.x:/xg;
641 s/(?<!ke-)((EC)?DHE-)?(RSA|ECDSA)-AES(128|256)-(GCM-SHA(256|384)|SHA)(?!:)/ke-$3-AES256-SHAnnn/g;
642 s/(?<!ke-)((EC)?DHE-)?(RSA|ECDSA)-AES(128|256)-(GCM-SHA(256|384)|SHA):(128|256)/ke-$3-AES256-SHAnnn:xxx/g;
644 # OpenSSL TLSv1.3 - unsure what to do about the authentication-variant testcases now,
645 # as it seems the protocol no longer supports a user choice. Replace the "TLS" field with "RSA".
646 # Also insert a key-exchange field for back-compat, even though 1.3 doesn't do that.
648 # TLSversion : "TLS" - C_iph_er - MAC : ???
650 s/TLS_AES(_256)?_GCM_SHA384(?!:)/ke-RSA-AES256-SHAnnn/g;
651 s/:TLS_AES(_256)?_GCM_SHA384:256/:ke-RSA-AES256-SHAnnn:xxx/g;
654 # TLSv1:AES256-GCM-SHA384:256
655 # TLSv1:ECDHE-RSA-CHACHA20-POLY1305:256
656 # TLS1.3:AEAD-AES256-GCM-SHA384:256
658 # ECDHE-RSA-CHACHA20-POLY1305
661 s/(?<!-)(AES256-GCM-SHA384)/RSA-$1/;
662 s/AEAD-(AES256-GCM-SHA384)/RSA-$1/g;
663 s/(?<!ke-)((EC)?DHE-)?(RSA|ECDSA)-(AES256|CHACHA20)-(GCM-SHA384|POLY1305)(?!:)/ke-$3-AES256-SHAnnn/g;
664 s/(?<!ke-)((EC)?DHE-)?(RSA|ECDSA)-(AES256|CHACHA20)-(GCM-SHA384|POLY1305):256/ke-$3-AES256-SHAnnn:xxx/g;
667 # TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256
668 # TLS1.3:ECDHE_SECP256R1__RSA_PSS_RSAE_SHA256__AES_256_GCM__AEAD:256
669 # TLS1.3:ECDHE_X25519__RSA_PSS_RSAE_SHA256__AES_256_GCM:256
670 # TLS1.3:ECDHE_PSK_SECP256R1__AES_256_GCM__AEAD:256
672 # TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256
673 # TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128
674 # TLS1.2:RSA_AES_256_CBC_SHA1:256 (canonical)
675 # TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128
676 # TLS1.2:ECDHE_SECP256R1__RSA_SHA256__AES_256_GCM:256
677 # TLS1.2:ECDHE_SECP256R1__RSA_SHA256__AES_128_CBC__SHA256:128
678 # TLS1.2:ECDHE_SECP256R1__ECDSA_SHA512__AES_256_GCM:256
679 # TLS1.2:ECDHE_SECP256R1__AES_256_GCM:256 (3.6.7 resumption)
680 # TLS1.2:ECDHE_RSA_SECP256R1__AES_256_GCM:256 (! 3.5.18 !)
681 # TLS1.2:RSA__CAMELLIA_256_GCM:256 (leave the cipher name)
682 # TLS1.2-PKIX:RSA__AES_128_GCM__AEAD:128 (the -PKIX seems to be a 3.1.20 thing)
683 # TLS1.2-PKIX:ECDHE_RSA_SECP521R1__AES_256_GCM__AEAD:256
685 # X=TLS1.2:DHE_RSA_AES_256_CBC_SHA256:256
686 # X=TLS1.2:RSA_AES_256_CBC_SHA1:256
687 # X=TLS1.1:RSA_AES_256_CBC_SHA1:256
688 # X=TLS1.0:RSA_AES_256_CBC_SHA1:256
689 # X=TLS1.0:DHE_RSA_AES_256_CBC_SHA1:256
690 # X=TLS1.0-PKIX:RSA__AES_256_CBC__SHA1:256
691 # and as stand-alone cipher:
692 # ECDHE-RSA-AES256-SHA
693 # DHE-RSA-AES256-SHA256
695 # picking latter as canonical simply because regex easier that way.
696 s/\bDHE_RSA_AES_128_CBC_SHA1:128/RSA-AES256-SHA1:256/g;
697 s/TLS1.[x0123](-PKIX)?: # TLS version
698 ((EC)?DHE(_((?<psk>PSK)_)?((?<auth>RSA|ECDSA)_)?
699 (SECP(256|521)R1|X25519))?__?)? # key-exchange
700 ((?<auth>RSA|ECDSA)((_PSS_RSAE)?_SHA(512|256))?__?)? # authentication
701 (?<with>WITH_)? # stdname-with
702 AES_(256|128)_(CBC|GCM) # cipher
703 (__?AEAD)? # pseudo-MAC
704 (__?SHA(1|256|384))? # PRF
705 :(256|128) # cipher strength
707 . (defined($+{psk}) ? $+{psk} : "")
708 . (defined($+{auth}) ? $+{auth} : "")
709 . (defined($+{with}) ? $+{with} : "")
710 . "-AES256-SHAnnn:xxx"/gex;
711 s/TLS1.2:RSA__CAMELLIA_256_GCM(_SHA384)?:256/TLS1.2:RSA_CAMELLIA_256_GCM-SHAnnn:256/g;
712 s/\b(ECDHE-(RSA|ECDSA)-AES256-SHA|DHE-RSA-AES256-SHA256)\b/ke-$2-AES256-SHAnnn/g;
714 # Separate reporting of TLS version
715 s/ver: TLS1(\.[0-3])?$/ver: TLS1.x/;
716 s/ \(TLS1(\.[0-3])?\) / (TLS1.x) /;
718 # GnuTLS library error message changes
719 s/(No certificate was found|Certificate is required)/The peer did not send any certificate/g;
720 #(dodgy test?) s/\(certificate verification failed\): invalid/\(gnutls_handshake\): The peer did not send any certificate./g;
721 s/\(gnutls_priority_set\): No or insufficient priorities were set/\(gnutls_handshake\): Could not negotiate a supported cipher suite/g;
722 s/\(gnutls_handshake\): \KNo supported cipher suites have been found.$/Could not negotiate a supported cipher suite./;
724 # (this new one is a generic channel-read error, but the testsuite
725 # only hits it in one place)
726 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;
728 # (replace old with new, hoping that old only happens in one situation)
729 s/TLS error on connection to ${re_ipv4} \[${re_ipv4}\] \(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;
730 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;
732 # signature algorithm names
736 # ======== Caller's login, uid, gid, home, gecos ========
738 s/\Q$parm_caller_home\E/CALLER_HOME/g; # NOTE: these must be done
739 s/\b\Q$parm_caller\E\b/CALLER/g; # in this order!
740 s/\b\Q$parm_caller_group\E\b/CALLER/g; # In case group name different
742 s/\beuid=$parm_caller_uid\b/euid=CALLER_UID/g;
743 s/\begid=$parm_caller_gid\b/egid=CALLER_GID/g;
745 s/\buid=$parm_caller_uid\b/uid=CALLER_UID/g;
746 s/\bgid=$parm_caller_gid\b/gid=CALLER_GID/g;
748 s/\bname="?$parm_caller_gecos"?/name=CALLER_GECOS/g;
750 # When looking at spool files with -Mvh, we will find not only the caller
751 # login, but also the uid and gid. It seems that $) in some Perls gives all
752 # the auxiliary gids as well, so don't bother checking for that.
754 s/^CALLER $> \d+$/CALLER UID GID/;
756 # There is one case where the caller's login is forced to something else,
757 # in order to test the processing of logins that contain spaces. Weird what
758 # some people do, isn't it?
760 s/^spaced user $> \d+$/CALLER UID GID/;
763 # ======== Exim's login ========
764 # For messages received by the daemon, this is in the -H file, which some
765 # tests inspect. For bounce messages, this will appear on the U= lines in
766 # logs and also after Received: and in addresses. In one pipe test it appears
767 # after "Running as:". It also appears in addresses, and in the names of lock
770 s/U=$parm_eximuser/U=EXIMUSER/;
771 s/user=$parm_eximuser/user=EXIMUSER/;
772 s/login=$parm_eximuser/login=EXIMUSER/;
773 s/Received: from $parm_eximuser /Received: from EXIMUSER /;
774 s/Running as: $parm_eximuser/Running as: EXIMUSER/;
775 s/\b$parm_eximuser@/EXIMUSER@/;
776 s/\b$parm_eximuser\.lock\./EXIMUSER.lock./;
778 s/\beuid=$parm_exim_uid\b/euid=EXIM_UID/g;
779 s/\begid=$parm_exim_gid\b/egid=EXIM_GID/g;
781 s/\buid=$parm_exim_uid\b/uid=EXIM_UID/g;
782 s/\bgid=$parm_exim_gid\b/gid=EXIM_GID/g;
784 s/^$parm_eximuser $parm_exim_uid $parm_exim_gid/EXIMUSER EXIM_UID EXIM_GID/;
787 # ======== General uids, gids, and pids ========
788 # Note: this must come after munges for caller's and exim's uid/gid
790 # These are for systems where long int is 64
791 s/\buid=4294967295/uid=-1/;
792 s/\beuid=4294967295/euid=-1/;
793 s/\bgid=4294967295/gid=-1/;
794 s/\begid=4294967295/egid=-1/;
796 s/\bgid=\d+/gid=gggg/;
797 s/\begid=\d+/egid=gggg/;
798 s/\b(?:pid=|pid\s|PID:\s|Process\s|child\s)\K(\d+)/new_value($1, "p%s", \$next_pid)/gxe;
799 s/ Ci=\K(\d+)/new_value($1, "p%s", \$next_pid)/gxe;
800 s/\buid=\d+/uid=uuuu/;
801 s/\beuid=\d+/euid=uuuu/;
802 s/set_process_info:\s+\d+/set_process_info: pppp/;
803 s/process \d+ running as transport filter/process pppp running as transport filter/;
804 s/process \d+ writing to transport filter/process pppp writing to transport filter/;
805 s/reading pipe for subprocess \d+/reading pipe for subprocess pppp/;
806 s/remote delivery process \d+ ended/remote delivery process pppp ended/;
808 # Pid in temp file in appendfile transport
809 s"test-mail/(subdir/)?temp\K\.\d+\.".pppp.";
811 # Optional pid in log lines
812 s/^(\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d)(\.\d{3}|)(\s[+-]\d{4}|)(\s\[\d+\])/
813 "$1$2$3 [" . new_value($4, "%s", \$next_pid) . "]"/gxe;
815 # Optional pid in syslog test lines
816 s/^(SYSLOG:\s\'([-0-9]{10}\s[:.0-9]{8,12}\s([-+]\d{4}\s)?|))(\[\d+\] )/
817 "$1\[" . new_value($4, "%s", \$next_pid) . "]"/gxe;
819 # Detect a daemon stderr line with a pid and save the pid for subsequent
820 # removal from following lines.
821 $spid = $1 if /^(\s*\d+) (?:listening|LOG: MAIN|(?:daemon_smtp_port|local_interfaces) overridden by)/;
824 # Queue runner waiting messages
825 s/waiting for children of \d+/waiting for children of pppp/;
826 s/waiting for (\S+) \(\d+\)/waiting for $1 (pppp)/;
828 # Most builds are without HAVE_LOCAL_SCAN
829 next if /^calling local_scan\(\); timeout=300$/;
830 next if /^local_scan\(\) returned 0 NULL$/;
832 # ======== Port numbers ========
833 # Incoming port numbers may vary, but not in daemon startup line.
835 s/^Port: (\d+)/"Port: " . new_value($1, "%s", \$next_port)/e;
836 s/\(port=(\d+)/"(port=" . new_value($1, "%s", \$next_port)/e;
838 # This handles "connection from" and the like, when the port is given
839 s/(\[${re_ip}\]:)(\d+)/$1.new_value($2,"%s",\$next_port)/ie
840 unless ( /listening for SMTP on/ || /Connecting to/
841 || /[=*-]>/ || /==/ || /\*\*/
842 || /Connection refused/ || /in response to/
846 # Port in host address in spool file output from -Mvh
847 s/^(--?host_address) (.*[:.])\d+$/$1 ${2}9999/;
849 if ($dynamic_socket and $dynamic_socket->opened and my $port = $dynamic_socket->sockport) {
850 s/^Connecting to 127\.0\.0\.1 port \K$port/<dynamic port>/;
854 # ======== Local IP addresses ========
855 # The amount of space between "host" and the address in verification output
856 # depends on the length of the host name. We therefore reduce it to one space
858 # Also, the length of space at the end of the host line is dependent
859 # on the length of the longest line, so strip it also on otherwise
860 # un-rewritten lines like localhost
862 # host 127.0.0.1 [127.0.0.1]
863 # host 10.0.0.1 [10.0.0.1]-
865 # host 127.0.0.1 [127.0.0.1]--
866 # host 169.16.16.16 [169.16.16.10]
868 s/^\s+host\s(\S+)\s+(\S+)/ host $1 $2/;
869 s/^\s+(host\s\S+\s\S+)\s+(port=.*)/ host $1 $2/;
870 s/^\s+(host\s\S+\s\S+)\s+(?=MX=)/ $1 /;
871 s/host\s\Q$parm_ipv4\E\s\[\Q$parm_ipv4\E\]/host ipv4.ipv4.ipv4.ipv4 [ipv4.ipv4.ipv4.ipv4]/;
872 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]/;
873 s/\b\Q$parm_ipv4\E\b/ip4.ip4.ip4.ip4/g;
874 s/(^|\W)\K\Q$parm_ipv6\E/ip6:ip6:ip6:ip6:ip6:ip6:ip6:ip6/g;
875 s/(^|\W)\K\Q$parm_ipv6_stripped\E/ip6:ip6:ip6:ip6:ip6:ip6:ip6:ip6/g;
876 s/\b\Q$parm_ipv4r\E\b/ip4-reverse/g;
877 s/(^|\W)\K\Q$parm_ipv6r\E/ip6-reverse/g;
878 s/^\s+host\s\S+\s+\[\S+\]\K +$//; # strip, not collapse the trailing whitespace
881 # ======== Test network IP addresses ========
882 s/(\b|_)\Q$parm_ipv4_test_net\E(?=\.\d+\.\d+\.\d+\b|_|\.rbl|\.in-addr|\.test\.again\.dns)/$1V4NET/g;
883 s/\b\Q$parm_ipv6_test_net\E(?=:[\da-f]+:[\da-f]+:[\da-f]+)/V6NET/gi;
886 # ======== IP error numbers and messages ========
887 # These vary between operating systems
888 s/(?:Can(?:no|')t assign requested address|Address not available)/Netwk addr not available/;
889 s/Operation timed out/Connection timed out/;
890 s/Address family not supported by protocol family/Network Error/;
891 s/Network(?: is)? unreachable/Network Error/;
892 s/Invalid argument/Network Error/;
894 s/\(\d+\): Network/(dd): Network/;
895 s/\(\d+\): Connection refused/(dd): Connection refused/;
896 s/\(\d+\): Connection timed out/(dd): Connection timed out/;
897 s/\d+ 65 Connection refused/dd 65 Connection refused/;
898 s/\d+ 321 Connection timed out/dd 321 Connection timed out/;
901 # ======== Other error numbers ========
902 s/errno=\d+/errno=dd/g;
904 # ======== System Error Messages ======
905 # depending on the underlaying file system the error message seems to differ
906 s/(?: is not a regular file)|(?: has too many links \(\d+\))/ not a regular file or too many links/;
908 # ======== Output from ls ========
909 # Different operating systems use different spacing on long output
910 #s/ +/ /g if /^[-rwd]{10} /;
911 # (Bug 1226) SUSv3 allows a trailing printable char for modified access method control.
912 # Handle only the Gnu and MacOS space, dot, plus and at-sign. A full [[:graph:]]
913 # unfortunately matches a non-ls linefull of dashes.
914 # Allow the case where we've already picked out the file protection bits.
915 if (s/^([-d](?:[-r][-w][-SsTtx]){3})[.+@]?( +|$)/$1$2/) {
920 # ======== Message sizes =========
921 # Message sizes vary, owing to different logins and host names that get
922 # automatically inserted. I can't think of any way of even approximately
925 s/([\s,])S=\d+\b/$1S=sss/;
927 s/^(\s*\d+[mhd]\s+)\d+(\s+(?:[[:alnum:]-]{23}|[[:alnum:]-]{16}) <)/TTT sss$2/i if $is_stdout;
928 s/\sSIZE=\d+\b/ SIZE=ssss/;
929 s/\ssize=\d+\b/ size=sss/ if $is_stderr;
930 s/old size = \d+\b/old size = sssss/;
931 s/message size = \d+\b/message size = sss/;
932 s/this message = \d+\b/this message = sss/;
933 s/Size of headers = \d+/Size of headers = sss/;
934 s/sum=(?!0)\d+/sum=dddd/;
935 s/(?<=sum=dddd )count=\d+\b/count=dd/;
936 s/(?<=sum=0 )count=\d+\b/count=dd/;
937 s/,S is \d+\b/,S is ddddd/;
938 s/\+0100,\d+;/+0100,ddd;/;
939 s/\(\d+ bytes written\)/(ddd bytes written)/;
940 s/added '\d+ 1'/added 'ddd 1'/;
941 s/Received\s+\d+/Received nnn/;
942 s/Delivered\s+\d+/Delivered nnn/;
945 # ======== Values in spool space failure message ========
946 s/space=\d+ inodes=[+-]?\d+/space=xxxxx inodes=xxxxx/;
949 # ======== Filter sizes ========
950 # The sizes of filter files may vary because of the substitution of local
951 # filenames, logins, etc.
953 s/^\d+(?= (\(tainted\) )?bytes read from )/ssss/;
956 # ======== OpenSSL error messages ========
957 # Different releases of the OpenSSL libraries seem to give different error
958 # numbers, or handle specific bad conditions in different ways, leading to
959 # different wording in the error messages, so we cannot compare them.
961 #XXX This loses any trailing "delivering unencypted to" which is unfortunate
962 # but I can't work out how to deal with that.
963 s/(TLS session: \(SSL_\w+\): error:)(.*)(?!: delivering)/$1 <<detail omitted>>/;
964 s/TLS error on connection from .*\K\(SSL_accept\): error:.*:unexpected eof while reading$/(tls lib accept fn): TCP connection closed by peer/;
965 s/(TLS error on connection from .* \(SSL_\w+\): error:)(.*)/$1 <<detail omitted>>/;
966 next if /SSL verify error: depth=0 error=certificate not trusted/;
970 s/TLS\ error\ \(D-H\ param\ setting\ .*\ error:\K
972 (?:dh\ key\ too\ small|unknown\ security\ bits)
973 /xxxxxxxx:SSL routines::dh key too small/x;
976 s/error:\K0B080074:x509 certificate routines:X509_check_private_key(?=:key values mismatch$)/05800074:x509 certificate routines:/;
977 s/error:\K02001002:system library:fopen(?=:No such file or directory$)/80000002:system library:/;
978 s/error:\K0909006C:PEM routines:get_name(?=:no start line$)/0480006C:PEM routines:/;
980 # ======== Maildir things ========
981 # timestamp output in maildir processing
982 s/(timestamp=|\(timestamp_only\): )\d+/$1ddddddd/g;
984 # maildir delivery files appearing in log lines (in cases of error)
985 s/writing to(?: file)? tmp\/\d+\.[^.]+\.(\S+)/writing to tmp\/MAILDIR.$1/;
987 s/renamed tmp\/\d+\.[^.]+\.(\S+) as new\/\d+\.[^.]+\.(\S+)/renamed tmp\/MAILDIR.$1 as new\/MAILDIR.$1/;
989 # Maildir file names in general
990 s/\b\d+\.M\d+P\d+\b/dddddddddd.HddddddPddddd/;
993 while (/^\d+S,\d+C\s*$/)
998 last if !/^\d+ \d+\s*$/;
999 print MUNGED "ddd d\n";
1001 last if !defined $_;
1003 last if !defined $_;
1006 # SRS timestamps and signatures vary by hostname and from run to run
1008 s/(?i)SRS0=....=.[^=]?=([^=]+)=([^@]+)\@([^ ]+)/SRS0=ZZZZ=YY=$1=$2\@$3/g;
1011 # ======== Output from the "fd" program about open descriptors ========
1012 # The statuses seem to be different on different operating systems, but
1013 # at least we'll still be checking the number of open fd's.
1015 s/max fd = \d+/max fd = dddd/;
1016 s/status=[0-9a-f]+ (?:RDONLY|WRONLY|RDWR)/STATUS/g;
1019 # ======== Contents of spool files ========
1020 # A couple of tests dump the contents of the -H file. The length fields
1021 # will be wrong because of different user names, etc.
1022 s/^\d\d\d(?=[PFS*])/ddd/;
1025 # ==========================================================
1026 # MIME boundaries in RFC3461 DSN messages
1027 s/\d{8,10}-eximdsn-\d+/NNNNNNNNNN-eximdsn-MMMMMMMMMM/;
1029 # Cyrus SASL library version differences (rejectlog)
1030 s/Cyrus SASL permanent failure: \Kuser not found$/generic failure/;
1032 # ==========================================================
1033 # Some munging is specific to the specific file types
1035 # ======== stdout ========
1039 # Skip translate_ip_address and use_classresources in -bP output because
1040 # they aren't always there.
1042 next if /translate_ip_address =/;
1043 next if /use_classresources/;
1045 # In certain filter tests, remove initial filter lines because they just
1046 # clog up by repetition.
1050 next if /^(Sender\staken\sfrom|
1051 Return-path\scopied\sfrom|
1054 if (/^Testing \S+ filter/)
1056 $_ = <IN>; # remove blank line
1061 # remote IPv6 addrs vary
1062 s/^(Connection request from) \[.*:.*:.*\]$/$1 \[ipv6\]/;
1064 # Hints DB use of lockfiles is provider-dependent
1065 s/Failed to open \K(?:hintsdb|database lock) file (.*\/spool\/db\/[^. ]*)(?:.lockfile)?(?: for reading)?(?=: No such file or directory$)/hintsdb $1/;
1067 # openssl version variances
1068 # Error lines on stdout from SSL contain process id values and file names.
1069 # They also contain a source file name and line number, which may vary from
1070 # release to release.
1072 next if /^SSL info:/;
1073 next if /SSL verify error: depth=0 error=certificate not trusted/;
1074 s/SSL3_READ_BYTES/ssl3_read_bytes/i;
1075 s/CONNECT_CR_FINISHED/ssl3_read_bytes/i;
1076 s/^[[:xdigit:]]+:error:[[:xdigit:]]+(?:E[[:xdigit:]]+)?
1077 (:SSL\ routines:ssl3_read_bytes:)
1081 (:SSL\ alert\ number\ \d\d)$
1082 /pppp:error:dddddddd$1sslv3$2\[...\]$3/x;
1083 s/^error:\K[^:]*:(SSL routines:ssl3_read_bytes:(tls|ssl)v\d+ alert)/dddddddd:$1/;
1084 s/^error:\K[[:xdigit:]]+:SSL routines::(tlsv13 alert certificate required)$/dddddddd:SSL routines:ssl3_read_bytes:$1/;
1086 [[:xdigit:]]+:SSL\ routines::
1087 ((?:tlsv1|sslv3)\ alert\ (?:unknown\ ca|certificate\ revoked))$
1088 /dddddddd:SSL routines:ssl3_read_bytes:$1/x;
1090 [[:xdigit:]]+:SSL\ routines::
1091 ssl\/tls\ (alert\ (?:unknown\ ca|certificate\ revoked))$
1092 /dddddddd:SSL routines:ssl3_read_bytes:sslv3 $1/x;
1094 # gnutls version variances
1095 next if /^Error in the pull function./;
1097 # Retry DB record gets truncated when TESTDIR is a long string
1098 s/T:.*\(MTA-imposed quota exceeded while writing to\K.*$/ <elided>)/;
1100 # optional IDN2 variant conversions. Accept either IDN1 or IDN2
1101 s/conversion strasse.de/conversion xn--strae-oqa.de/;
1102 s/conversion: german.xn--strae-oqa.de/conversion: german.straße.de/;
1104 # subsecond timstamp info in reported header-files
1105 s/^-received_time_usec \.\K\d{6}$/uuuuuu/;
1106 s/^-received_time_complete \K\d+\.\d{6}$/tttt.uuuuuu/;
1108 # Postgres server takes varible time to shut down; lives in various places
1109 s/^waiting for server to shut down\.+ done$/waiting for server to shut down.... done/;
1110 s/^\/.*postgres /POSTGRES /;
1112 # DMARC is not always supported by the build
1113 next if /^dmarc_tld_file =/;
1114 # timestamp in dmarc history file
1115 s/received \K\d{10}$/1692480217/;
1117 # ARC is not always supported by the build
1118 next if /^arc_sign =/;
1120 # LIMITS is not always supported by the build
1121 next if /^limits_advertise_hosts =/;
1124 next if /^hosts_try_prdr = \*$/;
1126 # TLS resumption is not always supported by the build
1127 next if /^tls_resumption_hosts =/;
1128 next if /^-tls_resumption/;
1129 next if /^host_name_extract = /;
1131 # gsasl library version may not support some methods
1132 s/250-AUTH ANONYMOUS PLAIN SCRAM-SHA-1\K SCRAM-SHA-256//;
1134 # mailq times change with when the run is done, vs. static-source spoolfiles
1135 s/\s*\d*[hd](?= 317 (?:[-0-9A-Za-z]{23}|[-0-9A-Za-z]{16}) <nobody\@test.ex>)/DDd/;
1136 # mailq sizes change with caller running the test
1137 s/\s[01]m [34]\d\d(?= (?:[-0-9A-Za-z]{23}|[-0-9A-Za-z]{16}) <CALLER\@the.local.host.name>)/ 1m 396/;
1139 # Not all builds include EXPERIMENTAL_DSN_INFO (1 of 2)
1140 if (/^X-Exim-Diagnostic:/)
1143 last if (/^$/ || !/^\s/);
1145 goto RESET_AFTER_EXTRA_LINE_READ;
1149 # ======== stderr ========
1153 # The very first line of debugging output will vary
1154 s/^Exim version .*/Exim version x.yz ..../;
1156 # Skip some lines that Exim puts out at the start of debugging output
1157 # because they will be different in different binaries.
1159 next if /^$time_pid?
1160 (?: .*\sBerkeley\ DB
1161 | \sProbably\ (?:Berkeley\ DB|ndbm|GDBM)
1162 | \sUsing\ (?:tdb|sqlite3)
1164 | Lookups(?:\(built-in\))?:
1166 | Routers\ \((?:built-in|dynamic)\):
1171 | Fixed\ never_users
1177 # Hints DB use of lockfiles is provider-dependent
1178 next if /lock(?:ing|ed) .*\/spool\/db\/[^.]+\.lockfile$/;
1179 s/closed hints database\K and lockfile$//;
1181 # Hints DBs with transactions are provider-dependent, and flow changes
1182 # to take advantage of them need different opens and different flags.
1183 # Drop all the debug output for opens and closes.
1184 if (/EXIM_DBOPEN(_MULTI)?: file <.*spool\/db\/retry>/)
1187 next if (/returned from EXIM_DBOPEN(_MULTI)?: 0x[[:xdigit:]]+$/);
1189 <IN> if (/returned from EXIM_DBOPEN(_MULTI)?: \(nil\)$/);
1192 if (/EXIM_DBCLOSE(_MULTI)?/) { <IN>; next; }
1193 next if /retaining retry hintsdb handle$/;
1194 next if /using cached retry hintsdb (?:handle|nonpresence)$/;
1195 if (/final close of cached retry db$/) { <IN>; <IN>; next; }
1196 next if /dbfn_transaction_(?:start|commit)$/;
1198 # Various hintsdb backends
1199 s/(?:bdb|tdb|gdbm|ndbm|sqlite)
1200 _open\(flags\ 0x(\d)
1202 \ (?:No\ such\ file\ or\ directory|unable\ to\ open\ database\ file)$
1203 /hintsdb_open(flags 0x$1 mode 0640) No such file or directory/x;
1205 # Lines with a leading pid. Only handle >= 4-digit PIDs to avoid converting SMTP respose codes
1206 s/^\s*(\d{4,})\s(?!(?:previous message|in\s|bytes remain in|SMTP accept process running))/new_value($1, "p%s", \$next_pid) . ' '/e;
1209 s/connection_id: \K(\d+)$/new_value($1, "conn%s", \$next_conn)/e;
1211 # Debugging lines for Exim terminations and process-generation
1212 next if /(?:postfork: | fork(?:ing|ed) for )/;
1214 # IP address lookups use gethostbyname() when IPv6 is not supported,
1215 # and gethostbyname2() or getipnodebyname() when it is.
1217 s/\b(gethostbyname2?|\bgetipnodebyname)(\(af=inet\))?/get[host|ipnode]byname[2]/;
1219 # Extra lookups done when ipv6 is supported
1220 next if /^host_fake_gethostbyname\(af=inet6\) returned 1 \(HOST_NOT_FOUND\)$/;
1222 # we don't care what TZ enviroment the testhost was running
1223 next if /^Reset TZ to/;
1226 s/(?:\[[^\]]*\]:|V4NET\.0\.0\.0:|localhost::?|127\.0\.0\.1[.:]:?|port[= ])\K$parm_port_d/PORT_D/;
1227 s/(?:\[[^\]]*\]:|V4NET\.0\.0\.0:|localhost::?|127\.0\.0\.1[.:]:?|port[= ])\K$parm_port_d2/PORT_D2/;
1228 s/(?:\[[^\]]*\]:|V4NET\.0\.0\.0:|localhost::?|127\.0\.0\.1[.:]:?|port[= ])\K$parm_port_d3/PORT_D3/;
1229 s/(?:\[[^\]]*\]:|V4NET\.0\.0\.0:|localhost::?|127\.0\.0\.1[.:]:?|port[= ])\K$parm_port_d4/PORT_D4/;
1230 s/(?:\[[^\]]*\]:|V4NET\.0\.0\.0:|localhost::?|127\.0\.0\.1[.:]:?|port[= ])\K$parm_port_s/PORT_S/;
1231 s/(?:\[[^\]]*\]:|V4NET\.0\.0\.0:|localhost::?|127\.0\.0\.1[.:]:?|port[= ])\K$parm_port_n/PORT_N/;
1233 # ========= Exim lookups ==================
1234 # Lookups have a char which depends on the number of lookup types compiled in,
1235 # in stderr output. Replace with a "0". Recognising this while avoiding
1236 # other output is fragile; perhaps the debug output should be revised instead.
1237 s%^\s+(:?closing )?\K[0-?]TESTSUITE/aux-fixed/%0TESTSUITE/aux-fixed/%g;
1239 # drop gnutls version strings
1240 next if /GnuTLS compile-time version: \d+[\.\d]+$/;
1241 next if /GnuTLS runtime version: \d+[\.\d]+$/;
1242 # and unwanted debug
1243 next if /^GnuTLS<2>: FIPS140-2 (context is not set|operation mode switched from initial to not-approved)$/;
1244 next if /^GnuTLS<3>: ASSERT: sign.c\[_gnutls_sign_is_secure2\]:\d+$/;
1245 next if /^GnuTLS<3>: ASSERT: \.\.\/\.\.\/lib\/pkcs11.c\[find_multi_objs_cb\]:/;
1246 next if /^GnuTLS<3>: ASSERT: \.\.\/\.\.\/lib\/pkcs11.c\[gnutls_pkcs11_obj_list_import_url3\]:/;
1248 # drop openssl version strings
1249 next if /OpenSSL compile-time version: OpenSSL \d+[\.\da-z]+/;
1250 next if /OpenSSL runtime version: OpenSSL \d+[\.\da-z]+/;
1252 # this is timing-dependent
1253 next if /^OpenSSL: creating STEK$/;
1254 next if /^selfsign cert rotate$/;
1257 # only OpenSSL speaks of these
1258 next if /^TLS: (preloading (DH params \S+|ECDH curve \S+|CA bundle) for server|generating selfsigned server cert)/;
1259 next if /^ Diffie-Hellman initialized from default/;
1260 next if /^ ECDH OpenSSL (< )?[\d.+]+: temp key parameter settings:/;
1261 next if /^ ECDH: .*'prime256v1'/;
1262 next if /^tls_verify_certificates: system$/;
1263 next if /^tls_set_watch: .*\/cert.pem/;
1264 next if /^Generating 2048 bit RSA key/;
1267 # only GnuTLS speaks of these
1268 next if /^GnuTLS global init required$/;
1269 next if /^TLS: basic cred init, server/;
1270 next if /^TLS: preloading cipher list for server: NULL$/;
1271 s/^GnuTLS using default session cipher\/priority "NORMAL"$/TLS: not preloading cipher list for server/;
1272 next if /^GnuTLS<2>: added \d+ protocols, \d+ ciphersuites, \d+ sig algos and \d+ groups into priority list$/;
1273 next if /^GnuTLS<2>: (Disabling X.509 extensions|signing structure using RSA-SHA256)/;
1274 next if /^GnuTLS.*(wrap_nettle_mpi_print|gnutls_subject_alt_names_get|get_alt_name)/;
1275 next if /^GnuTLS<[23]>: (p11|ASSERT: pkcs11.c|Initializing needed PKCS #11 modules)/;
1276 next if /^GnuTLS<2>: Intel (AES|GCM) accelerator was detected/;
1277 next if /^Added \d{3} certificate authorities/;
1278 next if /^TLS: not preloading CRL for server/;
1279 next if /^GnuTLS<3>: ASSERT: extensions.c\[_gnutls_get_extension/;
1280 next if /^GnuTLS<3>: ASSERT: \.\.\/\.\.\/\.\.\/lib\/x509\//;
1281 next if /^GnuTLS<2>: Initializing PKCS #11 modules/;
1284 # only kevent platforms (FreeBSD, OpenBSD) say this
1285 next if /^watch dir/;
1286 next if /^watch file .*\/usr\/local/;
1287 next if /^watch file .*\/etc\/ssl/;
1288 next if /^closing watch fd:/;
1291 # there happen in different orders for OpenSSL/GnuTLS/noTLS
1292 next if /^TLS: generating selfsigned server cert/;
1293 next if /^TLS: not preloading (CA bundle|cipher list) for server$/;
1294 next if /^TLS: not preloading server certs$/;
1296 # some platforms are missing the standard CA bundle file
1297 next if /^tls_set_watch\(\) fail on '\/usr\/(?:lib\/ssl|local\/openssl3\/etc\/pki\/tls)\/cert.pem': No such file or directory$/;
1300 next if /^$time_pid?(?: Lookups\ \((?:built-in|dynamic)\):
1301 | Loaded\ "[^.]+\.so"\ \(\d+\ lookup\ types\)
1302 | Loading\ lookup\ modules\ from
1303 | Loaded\ \d+\ lookup\ modules
1304 | Total\ \d+\ lookups)/x;
1306 # drop loads of dyn-module drivers
1307 next if /^$time_pid?(?:Loading\ \w+\ (?:router|transport|auth)\ driver\ from
1308 | Loaded\ \w+\ (?:router|transport|auth)$)/x;
1310 # drop compiler information
1311 next if /^$time_pid?Compiler:/;
1314 # different libraries will have different numbers (possibly 0) of follow-up
1315 # lines, indenting with more data
1316 if (/^$time_pid?Library version:/) {
1319 next if /^$time_pid?\s/;
1320 goto RESET_AFTER_EXTRA_LINE_READ;
1324 # drop other build-time controls emitted for debugging
1325 next if /^$time_pid?WHITELIST_D_MACROS:/;
1326 next if /^$time_pid?TRUSTED_CONFIG_LIST:/;
1328 # As of Exim 4.74, we log when a setgid fails; because we invoke Exim
1329 # with -be, privileges will have been dropped, so this will always
1331 next if /^changing group to \d+ failed: (Operation not permitted|Not owner)/;
1333 # We might not keep this check; rather than change all the tests, just
1334 # ignore it as long as it succeeds; then we only need to change the
1335 # TLS tests where tls_require_ciphers has been set.
1336 if (m{^changed uid/gid: calling tls_validate_require_cipher}) {
1340 next if /^tls_validate_require_cipher child \d+ ended: status=0x0/;
1342 # We invoke Exim with -D, so we hit this new message as of Exim 4.73:
1343 next if /^macros_trusted overridden to true by whitelisting/;
1345 # We have to omit the localhost ::1 address so that all is well in
1346 # the IPv4-only case.
1348 print MUNGED "MUNGED: ::1 will be omitted in what follows\n"
1349 if (/looked up these IP addresses/);
1350 next if /name=localhost address=::1/;
1352 # DKIM: Not all builds include
1353 next if /^DKIM( <<<<<<<<<<<<<<<<<<<<<<<<<<<<<+|: no signatures)$/;
1354 next if /try option acl_smtp_dkim$/;
1356 # Some platforms have TIOCOUT, some do not
1357 next if /\d+ bytes remain in socket output buffer$/;
1358 # Various other IPv6 lines must be omitted too
1360 next if /using host_fake_gethostbyname for \S+ \(IPv6\)/;
1361 next if /get\[host\|ipnode\]byname\[2\]\(af=inet6\)/;
1362 next if /DNS lookup of \S+ \(AAAA\) using fakens/;
1363 next if / writing neg-cache entry for .*AAAA/;
1364 next if /^ *faking res_search\(AAAA\) response length as 65535/;
1366 if (/ in dns_ipv4_lookup\?$/)
1369 if (/ list element: \*$/)
1372 next if / in dns_ipv4_lookup\? yes \(matched "\*"\)/;
1374 goto RESET_AFTER_EXTRA_LINE_READ;
1376 if (/DNS lookup of \S+ \(AAAA\) gave NO_DATA/)
1378 $_= <IN>; # Gets "returning DNS_NODATA"
1382 # Non-TLS builds have a different default Recieved: header expansion
1383 s/^((.*)\t}}}}by \$primary_hostname \$\{if def:received_protocol \{with \$received_protocol }})\(Exim \$version_number\)$/$1\${if def:tls_in_ver { (\$tls_in_ver)}}\${if def:tls_in_cipher_std { tls \$tls_in_cipher_std\n$2\t}}(Exim \$version_number)/;
1384 s/^((\s*).*considering: with \$received_protocol }})\(Exim \$version_number\)$/$1\${if def:tls_in_ver { (\$tls_in_ver)}}\${if def:tls_in_cipher_std { tls \$tls_in_cipher_std\n$2\t}}(Exim \$version_number)/;
1385 if (/condition: def:tls_in_ver$/)
1387 $_= <IN>; $_= <IN>; $_= <IN>; $_= <IN>;
1388 $_= <IN>; $_= <IN>; $_= <IN>; $_= <IN>;
1389 $_= <IN>; $_= <IN>; $_= <IN>; $_= <IN>;
1390 $_= <IN>; $_= <IN>; $_= <IN>; $_= <IN>;
1391 $_= <IN>; $_= <IN>; $_= <IN>; $_= <IN>; $_= <IN>; next;
1395 # Skip tls_advertise_hosts and hosts_require_tls checks when the options
1396 # are unset, because tls ain't always there.
1398 next if /^((>>>)?\s*host)? in tls_advertise_hosts\?$/;
1399 next if /in\s(?:tls_advertise_hosts\?|hosts_require_tls\?)
1400 \sno\s\((option\sunset|end\sof\slist)\)/x;
1402 # non-TLS builds cannot have DANE
1404 next if /lack of DNSSEC traceability precludes DANE$/;
1406 # Skip auxiliary group lists because they will vary.
1408 next if /auxiliary group list:/;
1410 # Skip "extracted from gecos field" because the gecos field varies
1412 next if /extracted from gecos field/;
1414 # Skip "waiting for data on socket" and "read response data: size=" lines
1415 # because some systems pack more stuff into packets than others.
1417 next if /waiting for data on socket/;
1418 next if /read response data: size=/;
1420 # If Exim is compiled with readline support but it can't find the library
1421 # to load, there will be an extra debug line. Omit it.
1423 next if /failed to load readline:/;
1425 # Some tests turn on +expand debugging to check on expansions.
1426 # Unfortunately, the Received: expansion varies, depending on whether TLS
1427 # is compiled or not. So we must remove the relevant debugging if it is.
1429 if (/^condition: def:tls_cipher/)
1431 while (<IN>) { last if /^condition: def:sender_address/; }
1433 elsif (/^expanding: Received: /)
1435 while (<IN>) { last if !/^\s/; }
1438 # remote port numbers vary
1439 s/(Connection request from 127.0.0.1 port) \d{1,5}/$1 sssss/;
1441 # Platform-dependent error strings
1442 s/Operation timed out/Connection timed out/;
1444 # Platform differences on disconnect
1445 s/unexpected disconnection while reading SMTP command from \[127.0.0.1\] \K\(error: Connection reset by peer\) //;
1447 # Platform-dependent resolver option bits
1448 s/(?:writing|update) neg-cache entry for [^,]+-\K[0-9a-f]+, ttl/xxxx, ttl/;
1450 # timing variance, run-to-run
1451 s/^time on queue = \K1s/0s/;
1453 # content-scan: file order can vary in directory
1454 s%unspool_mbox\(\): unlinking 'TESTSUITE/spool/scan/[^/]*/\K[^\']*%FFFFFFFFF%;
1456 # Skip hosts_require_dane checks when the options
1457 # are unset, because dane ain't always there.
1458 next if /in\shosts_require_dane\?\sno\s\(option\sunset\)/x;
1460 # daemon notifier socket
1461 s% \@(?=[^ @]+/spool/exim_daemon_notify$)% %;
1462 next if /unlinking notifier socket/;
1464 # daemon notifier socket
1465 # Timing variance over runs. Collapse repeated memssages.
1466 if (/notify triggered queue run/)
1469 while (/notify triggered queue run/) { $_ = <IN>; }
1473 # Different builds will have different lookup types included
1474 s/search_type \K\d+ \((\w+)\) quoting -1 \(none\)$/NN ($1) quoting -1 (none)/;
1475 # and different numbers of lookup types result in different type-code letters,
1476 # so convert them all to "0"
1477 s%(?<!lsearch)[^ ](?=TESTSUITE/aux-fixed/(?:0414.list[12]|0464.domains)$)%0%;
1479 # Environment cleaning
1480 next if /\w+ in keep_environment\? (yes|no)/;
1482 # Sizes vary with test hostname
1483 s/^cmd buf flush \d+ bytes/cmd buf flush ddd bytes/;
1485 # Different platforms put different error messages into retry records
1486 s/dbfn_write: key=.* datalen \K\d{2,3}$/nn/;
1487 s/dbfn_read: size \K\d{2,3}(?= return$)/nnn/;
1489 # Spool filesystem free space changes on different systems.
1490 s/((?:spool|log) directory space =) -?\d+K (inodes =)\s*-?\d+/$1 nnnnnK $2 nnnnn/;
1493 next if /try option acl_(?:not_)?smtp_mime$/;
1496 next if /in hosts_requ(est|ire)_ocsp\? (no|yes)/;
1499 next if / in wellknown_advertise_hosts\?/;
1502 next if /host in hosts_proxy\?/;
1505 if ( /^(>>>)?\s*host in pipelining_connect_advertise_hosts\?$/ )
1508 while ( /^(>>>)?\s*list element:/ ) { $_ = <IN>; }
1509 goto RESET_AFTER_EXTRA_LINE_READ;
1511 next if / in (?:pipelining_connect_advertise_hosts|hosts_pipe_connect)?\? no /;
1513 # Experimental_International
1514 next if / in smtputf8_advertise_hosts\? no \(option unset\)/;
1516 # Experimental_REQUIRETLS
1517 next if / in tls_advertise_requiretls?\? no \(end of list\)/;
1519 # Experimental_LIMITS
1520 if ( /^((>>>)?\s*host)? in limits_advertise_hosts\?$/ )
1523 while ( /^(>>>)?\s*list element: !\*$/ ) { $_ = <IN>; }
1524 goto RESET_AFTER_EXTRA_LINE_READ;
1526 next if / in limits_advertise_hosts?\? no \(matched "!\*"\)/;
1528 # Experimental_XCLIENT
1529 next if / in hosts_xclient\? no \(option unset\)/;
1531 # Experimental_WELLKNOWN
1532 next if / in hosts_wellknown\? no \(option unset\)/;
1535 next if /^(ppppp )?setsockopt FASTOPEN: Network Error/;
1537 # DISABLE_TLS_RESUME
1538 # TLS resumption is not always supported by the build
1539 next if /in tls_resumption_hosts\?/;
1540 next if /RE '.outlook.com/;
1542 # Non-TLS builds have different expansions for received_header_text
1543 if (s/(with \$received_protocol)\}\} \$\{if def:tls_cipher \{\(\$tls_cipher\)\n$/$1/)
1546 s/[\sâ•Ž]+\}\}(?=\(Exim )/\}\} /;
1548 if (/^ ├──condition: def:tls_cipher$/)
1550 <IN>; <IN>; <IN>; <IN>; <IN>; <IN>;
1551 <IN>; <IN>; <IN>; <IN>; <IN>; next;
1554 # Not all platforms build with DKIM enabled
1555 next if /^DKIM >> Body data for hash, canonicalized/;
1557 # Not all platforms build with SPF enabled
1558 next if /(^spf_conn_init|^SPF_dns_exim_new|spf_compile\.c)/;
1559 next if /try option spf_smtp_comment_template$/;
1561 # Not all platforms have sendfile support
1562 next if /^cannot use sendfile for body: no support$/;
1564 # Parts of DKIM-specific debug output depend on the time/date
1565 next if /^date:\w+,\{SP\}/;
1566 next if /^DKIM \[[^[]+\] (Header hash|b) computed:/;
1568 # Not all platforms support TCP Fast Open, and the compile omits the check
1569 next if /\S+ in hosts_try_fastopen\? (no \(option unset\)|no \(end of list\)|yes \(matched "\*"\))\n$/ ;
1571 # if (s/\S+ in hosts_try_fastopen\? (no \(option unset\)|no \(end of list\)|yes \(matched "\*"\))\n$//)
1575 # s/ \.\.\. >>> / ... /;
1576 if (s/ non-TFO mode connection attempt to 224.0.0.0, 0 data\b$//) { chomp; $_ .= <IN>; }
1577 s/Address family not supported by protocol family/Network Error/;
1578 s/Network(?: is)? unreachable/Network Error/;
1580 next if /^(ppppp |\d+ )?setsockopt FASTOPEN: Protocol not available$/;
1581 s/^(sending) \d+ (nonTFO early-data)$/$1 dd $2/;
1583 if (/^[0-9: ]* # possible timestamp
1585 (sendto,\ no\ data:\ EINPROGRESS # Linux
1586 |connection\ attempt\ to\ [^,]+,\ 0\ data) # MacOS & no-support
1593 if (/^connected\n\s+SMTP(\(close\)>>|\(Connection refused\)<<)$/)
1595 $_ = "failed: Connection refused\n" . <IN>;
1596 s/^\n\s+SMTP\(close\)>>$/$1/;
1598 elsif (/^(connected\n)read response data: size=/)
1601 # Date/time in SMTP banner
1602 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}
1603 /Tue, 2 Mar 1999 09:44:33 +0000/gx;
1607 # Specific pointer values reported for DB operations change from run to run
1608 s/(returned from EXIM_DBOPEN: )(0x)?[0-9a-f]+/${1}0xAAAAAAAA/;
1609 s/(EXIM_DBCLOSE.)(0x)?[0-9a-f]+/${1}0xAAAAAAAA/;
1611 # Platform-dependent output during MySQL startup
1612 next if /PerconaFT file system space/;
1613 next if /^Waiting for MySQL server to answer/;
1614 next if /mysqladmin: CREATE DATABASE failed; .* database exists/;
1616 # Postgres version-dependent differences
1617 s/^initdb: warning: (enabling "trust" authentication for local connections)$/\nWARNING: $1/;
1618 # Postgre DB server PID
1619 s/ \[\d+\] (?=(LOG: redirecting log|HINT: Future log output))/ [pppp] /;
1621 # Not all builds include DMARC
1622 next if /^DMARC: no (dmarc_tld_file|sender_host_address)$/ ;
1624 # Platform differences in errno strings
1625 s/ SMTP\(Operation timed out\)<</ SMTP(Connection timed out)<</;
1627 # Platform differences for errno values (eg. Hurd)
1628 s/^errno = \d+$/errno = EEE/;
1629 s/^writing error \d+: /writing error EEE: /;
1631 # Time-only, in debug output
1632 # we have to handle double lines from the DBOPEN, hence placed down here and /mg
1633 s/^\d\d:\d\d:\d\d\s+/01:01:01 /mg;
1635 # pid in debug lines
1636 s/^(\d\d:\d\d:\d\d\s+)(\d+)/$1 . new_value($2, "p%s", \$next_pid) . " "/mgxe;
1637 s/(?<!post-)[Pp]rocess\K(\s\d+ )/new_value($1, "p%s", \$next_pid) . " "/gxe;
1639 # Path in environment varies
1640 s/ PATH=\K.*$/<munged>/;
1642 # When Exim is checking the size of directories for maildir, it uses
1643 # the check_dir_size() function to scan directories. Of course, the order
1644 # of the files that are obtained using readdir() varies from system to
1645 # system. We therefore buffer up debugging lines from check_dir_size()
1646 # and sort them before outputting them.
1648 if (/^check_dir_size:/ || /^skipping TESTSUITE\/test-mail\//)
1656 print MUNGED "MUNGED: the check_dir_size lines have been sorted " .
1657 "to ensure consistency\n";
1658 @saved = sort(@saved);
1659 print MUNGED @saved;
1669 # ======== log ========
1673 # Berkeley DB version differences
1674 next if / Berkeley DB error: /;
1676 # CHUNKING: exact sizes depend on hostnames in headers
1677 s/(=>.* K (?:DKIM=\S+ )?C="250- \d)\d+ (byte chunk, total \d)\d+/$1nn $2nn/;
1679 # OpenSSL version variances
1680 s/(TLS error on connection [^:]*: error:)[0-9A-F]{8}(:system library):(?:fopen|func\(4095\)|):(No such file or directory)$/$1xxxxxxxx$2:fopen:$3/;
1681 next if /TLS error \(SSL_read\): .*error:0A000126:SSL routines::unexpected eof while reading$/ ;
1682 s/EVDATA: \K\(SSL_accept\): error:0A000126:SSL routines::unexpected eof while reading/SSL_accept: TCP connection closed by peer/;
1683 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/;
1684 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./;
1685 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/;
1687 # GnuTLS version variances
1688 if (/TLS error on connection \(recv\): .* (Decode error|peer did not send any certificate)/)
1692 if (/error on first read/)
1694 s/TLS session: \Kerror on first read:/(gnutls_handshake): A TLS fatal alert has been received.:/;
1695 goto RESET_AFTER_EXTRA_LINE_READ;
1700 # translate GnuTLS error into the OpenSSL one
1701 s/ARC: AMS signing: privkey PEM-block import: \KThe requested data were not available.$/error:0906D06C:PEM routines:PEM_read_bio:no start line/;
1702 # and then both into the OpenSSL 3.x one
1703 s/ARC: AMS signing: privkey PEM-block import: error:\K[0-9A-F]{8}:PEM routines:PEM_read_bio:no start line$/1E08010C:DECODER routines::unsupported/;
1706 if ( /(DKIM: d=.*) t=([0-9]*) x=([0-9]*) \[/ )
1708 my ($prefix, $t_diff) = ($1, $3 - $2);
1709 s/DKIM: d=.* t=[0-9]* x=[0-9]* /${prefix} t=T x=T+${t_diff} /;
1712 { s/DKIM: d=.* \Kt=[0-9]* \[/t=T [/; }
1713 # GnuTLS reports a different keysize vs. OpenSSL, for ed25519 keys
1714 s/signer: [^ ]* bits:\K 256/ 253/;
1715 s/public key too short:\K 256 bits/ 253 bits/;
1717 # with GnuTLS we cannot log single bad ALPN. So ignore the with-OpenSSL log line.
1718 # next if /TLS ALPN (http) rejected$/;
1721 s/(?:\[[^\]]*\]:|port )\K$parm_port_d/PORT_D/;
1722 s/(?:\[[^\]]*\]:|port )\K$parm_port_d2/PORT_D2/;
1723 s/(?:\[[^\]]*\]:|port )\K$parm_port_d3/PORT_D3/;
1724 s/(?:\[[^\]]*\]:|port )\K$parm_port_d4/PORT_D4/;
1725 s/(?:\[[^\]]*\]:|port )\K$parm_port_s/PORT_S/;
1726 s/(?:\[[^\]]*\]:|port )\K$parm_port_n/PORT_N/;
1727 s/I=\[[^\]]*\]:\K\d+/ppppp/;
1729 # Platform differences for errno values (eg. Hurd). Leave 0 and negative numbers alone.
1730 s/R=\w+ T=\w+ defer\K \([1-9]\d*\): / (EEE): /;
1732 # Platform differences in errno strings
1733 s/Arg list too long/Argument list too long/;
1735 # OpenSSL vs. GnuTLS
1736 s/session: \K\((SSL_connect|gnutls_handshake)\): timed out/(tls lib connect fn): timed out/;
1737 s/TLS error on connection from .*\K\((SSL_accept|gnutls_handshake)\): timed out/(tls lib accept fn): timed out/;
1738 s/TLS error on connection from .*\K(SSL_accept: TCP connection closed by peer|\(gnutls_handshake\): The TLS connection was non-properly terminated.)/(tls lib accept fn): TCP connection closed by peer/;
1739 s/TLS session: \K\(gnutls_handshake\): rxd alert: No supported application protocol could be negotiated/(SSL_connect): error: <<detail omitted>>/;
1740 s/\(gnutls_handshake\): No common application protocol could be negotiated./(SSL_accept): error: <<detail omitted>>/;
1742 # Not all buildfarm animals have ipv6
1743 next if /<dns:fail> <DNS_(?:NOMATCH|AGAIN):.*:AAAA>$/ ;
1746 # ======== mail ========
1750 # DKIM timestamps, and signatures depending thereon
1751 if ( /^(\s+)t=([0-9]*); x=([0-9]*); b=[A-Za-z0-9+\/]+$/ )
1753 my ($indent, $t_diff) = ($1, $3 - $2);
1754 s/.*/${indent}t=T; x=T+${t_diff}; b=bbbb;/;
1758 elsif ( /^(\s+)t=([0-9]*); b=[A-Za-z0-9+\/]+$/ )
1761 s/.*/${indent}t=T; b=bbbb;/;
1766 # Not all builds include EXPERIMENTAL_DSN_INFO (2 of 2)
1767 if (/^X-Exim-Diagnostic:/)
1770 last if (/^$/ || !/^\s/);
1772 goto RESET_AFTER_EXTRA_LINE_READ;
1776 # ======== All files other than stderr ========
1788 ##################################################
1789 # Subroutine to interact with caller #
1790 ##################################################
1792 # Arguments: [0] the prompt string
1793 # [1] if there is a U in the prompt and $force_update is true
1794 # [2] if there is a C in the prompt and $force_continue is true
1795 # Returns: returns the answer
1798 my ($prompt, $have_u, $have_c) = @_;
1803 print "... update forced\n";
1808 print "... continue forced\n";
1817 ##################################################
1818 # Subroutine to log in force_continue mode #
1819 ##################################################
1821 # In force_continue mode, we just want a terse output to a statically
1822 # named logfile. If multiple files in same batch (stdout, stderr, etc)
1823 # all have mismatches, it will log multiple times.
1825 # Arguments: [0] the logfile to append to
1826 # [1] the testno that failed
1832 my ($logfile, $testno, $detail) = @_;
1834 open(my $fh, '>>', $logfile) or return;
1836 print $fh "Test $testno "
1837 . (defined $detail ? "$detail " : '')
1841 # Computer-readable summary results logfile
1844 my ($logfile, $testno, $resultchar) = @_;
1846 open(my $fh, '>>', $logfile) or return;
1847 print $fh "$testno $resultchar\n";
1852 ##################################################
1853 # Subroutine to compare one output file #
1854 ##################################################
1856 # When an Exim server is part of the test, its output is in separate files from
1857 # an Exim client. The server data is concatenated with the client data as part
1858 # of the munging operation.
1860 # Arguments: [0] the name of the main raw output file
1861 # [1] the name of the server raw output file or undef
1862 # [2] where to put the munged copy
1863 # [3] the name of the saved file
1864 # [4] TRUE if this is a log file whose deliveries must be sorted
1865 # [5] optionally, a custom munge command
1867 # Returns: 0 comparison succeeded
1868 # 1 comparison failed; differences to be ignored
1869 # 2 comparison failed; files may have been updated (=> re-compare)
1871 # Does not return if the user replies "Q" to a prompt.
1874 my($rf,$rsf,$mf,$sf,$sortfile,$extra) = @_;
1876 # If there is no saved file, the raw files must either not exist, or be
1877 # empty. The test ! -s is TRUE if the file does not exist or is empty.
1879 # we check if there is a flavour specific file, but we remember
1880 # the original file name as "generic"
1882 $sf_flavour = "$sf_generic.$flavour";
1883 $sf_current = -e $sf_flavour ? $sf_flavour : $sf_generic;
1885 if (! -e $sf_current)
1887 return 0 if (! -s $rf && (! defined $rsf || ! -s $rsf));
1890 print "** $rf is not empty\n" if (-s $rf);
1891 print "** $rsf is not empty\n" if (defined $rsf && -s $rsf);
1895 $_ = interact('Continue, Show, or Quit? [Q] ', undef, $force_continue);
1896 tests_exit(1) if /^q?$/;
1897 if (/^c$/ && $force_continue) {
1898 log_failure($log_failed_filename, $testno, $rf);
1899 log_test($log_summary_filename, $testno, 'F') if ($force_continue);
1901 return 1 if /^c$/i && $rf !~ /paniclog/ && (!defined $rsf || $rsf !~ /paniclog/);
1905 foreach $f ($rf, $rsf)
1907 if (defined $f && -s $f)
1910 print "------------ $f -----------\n"
1911 if (defined $rf && -s $rf && defined $rsf && -s $rsf);
1919 $_ = interact('Continue, Update & retry, Quit? [Q] ', $force_update, $force_continue);
1920 tests_exit(1) if /^q?$/;
1921 if (/^c$/ && $force_continue) {
1922 log_failure($log_failed_filename, $testno, $rf);
1923 log_test($log_summary_filename, $testno, 'F')
1932 # Control reaches here if either (a) there is a saved file ($sf), or (b) there
1933 # was a request to create a saved file. First, create the munged file from any
1934 # data that does exist.
1936 open(MUNGED, '>', $mf) || tests_exit(-1, "Failed to open $mf: $!");
1937 my($truncated) = munge($rf, $extra) if -e $rf;
1939 # Append the raw server log, if it is non-empty
1940 if (defined $rsf && -e $rsf)
1942 print MUNGED "\n******** SERVER ********\n";
1943 $truncated |= munge($rsf, $extra);
1947 # If a saved file exists, do the comparison. There are two awkward cases:
1949 # If "*** truncated ***" was found in the new file, it means that a log line
1950 # was overlong, and truncated. The problem is that it may be truncated at
1951 # different points on different systems, because of different user name
1952 # lengths. We reload the file and the saved file, and remove lines from the new
1953 # file that precede "*** truncated ***" until we reach one that matches the
1954 # line that precedes it in the saved file.
1956 # If $sortfile is set, we are dealing with a mainlog file where the deliveries
1957 # for an individual message might vary in their order from system to system, as
1958 # a result of parallel deliveries. We load the munged file and sort sequences
1959 # of delivery lines.
1963 # Deal with truncated text items
1967 my(@munged, @saved, $i, $j, $k);
1969 open(MUNGED, $mf) || tests_exit(-1, "Failed to open $mf: $!");
1972 open(SAVED, $sf_current) || tests_exit(-1, "Failed to open $sf_current: $!");
1977 for ($i = 0; $i < @munged; $i++)
1979 if ($munged[$i] =~ /\*\*\* truncated \*\*\*/)
1981 for (; $j < @saved; $j++)
1982 { last if $saved[$j] =~ /\*\*\* truncated \*\*\*/; }
1983 last if $j >= @saved; # not found in saved
1985 for ($k = $i - 1; $k >= 0; $k--)
1986 { last if $munged[$k] eq $saved[$j - 1]; }
1988 last if $k <= 0; # failed to find previous match
1989 splice @munged, $k + 1, $i - $k - 1;
1994 open(my $fh, '>', $mf) or tests_exit(-1, "Failed to open $mf: $!");
1998 # Deal with log sorting
2004 open(my $fh, '<', $mf) or tests_exit(-1, "Failed to open $mf: $!");
2008 for (my $i = 0; $i < @munged; $i++)
2010 if ($munged[$i] =~ /^[-\d]{10}\s[:\d]{8}(\.\d{3})?\s[-A-Za-z\d]{23}\s[-=*]>/)
2013 for ($j = $i + 1; $j < @munged; $j++)
2015 last if $munged[$j] !~
2016 /^[-\d]{10}\s[:\d]{8}(\.\d{3})?\s[-A-Za-z\d]{23}\s[-=*]>/;
2018 @temp = splice(@munged, $i, $j - $i);
2019 @temp = sort(@temp);
2020 splice(@munged, $i, 0, @temp);
2024 open(my $fh, '>', $mf) or tests_exit(-1, "Failed to open $mf: $!");
2025 print $fh "**NOTE: The delivery lines in this file have been sorted.\n";
2031 return 0 if (system("$cf '$mf' '$sf_current' >test-cf") == 0);
2033 # Handle comparison failure
2035 print "** Comparison of $mf with $sf_current failed";
2036 system @more => 'test-cf';
2041 $_ = interact('Continue, Retry, Update current'
2042 . ($sf_current ne $sf_flavour ? "/Save for flavour '$flavour'" : '')
2043 . ' & retry, Quit? [Q] ', $force_update, $force_continue);
2044 tests_exit(1) if /^q?$/;
2045 if (/^c$/ && $force_continue) {
2046 log_failure($log_failed_filename, $testno, $sf_current);
2047 log_test($log_summary_filename, $testno, 'F')
2051 last if (/^[us]$/i);
2055 # Update or delete the saved file, and give the appropriate return code.
2059 my $sf = /^u/i ? $sf_current : $sf_flavour;
2060 copy($mf, $sf) or tests_exit(-1, "Failed to copy $mf $sf");
2064 # if we deal with a flavour file, we can't delete it, because next time the generic
2065 # file would be used again
2066 if ($sf_current eq $sf_flavour) {
2067 open(my $fh, '>', $sf_current);
2070 tests_exit(-1, "Failed to unlink $sf_current") if !unlink($sf_current);
2079 ##################################################
2081 # keyed by name of munge; value is a ref to a hash
2082 # which is keyed by file, value a string to look for.
2084 # paniclog, rejectlog, mainlog, stdout, stderr, msglog, mail
2085 # Search strings starting with 's' do substitutions;
2086 # with '/' do line-skips,
2087 # with 'R' run given code.
2088 # Triggered by a scriptfile line "munge <name>"
2089 ##################################################
2092 { 'stderr' => '/^Reverse DNS security status: unverified\n/' },
2094 'gnutls_unexpected' =>
2095 { 'mainlog' => '/\(recv\): A TLS packet with unexpected length was received./' },
2097 'gnutls_handshake' =>
2098 { 'mainlog' => 's/\(gnutls_handshake\): Error in the push function/\(gnutls_handshake\): A TLS packet with unexpected length was received/' },
2100 'gnutls_bad_clientcert' =>
2101 { 'mainlog' => 's/\(certificate verification failed\): certificate invalid/\(gnutls_handshake\): The peer did not send any certificate./',
2102 'stdout' => 's/Succeeded in starting TLS/A TLS fatal alert has been received.\nFailed to start TLS'
2105 'optional_events' =>
2106 { 'stdout' => '/event_action =/' },
2109 { 'stderr' => '/127.0.0.1 in hosts_requ(ire|est)_ocsp/' },
2111 'optional_cert_hostnames' =>
2112 { 'stderr' => '/in tls_verify_cert_hostnames\? no/' },
2115 { 'stdout' => 's/[[](127\.0\.0\.1|::1)]/[IP_LOOPBACK_ADDR]/' },
2118 { 'stdout' => 's/(Content-length:) \d\d\d/$1 ddd/' },
2121 { 'stderr' => 's/(1[5-9]|23\d)\d\d msec/ssss msec/' },
2124 { 'mainlog' => 's! X=TLS\S+ ! X=TLS_proto_and_cipher !;
2125 s! DN="C=! DN="/C=!;
2126 s! DN="[^,"]*\K,!/!;
2127 s! DN="[^,"]*\K,!/!;
2128 s! DN="[^,"]*\K,!/!;
2130 'rejectlog' => 's/ X=TLS\S+ / X=TLS_proto_and_cipher /',
2133 'optional_dsn_info' =>
2134 { 'mail' => 'Rif (/^(X-(Remote-MTA-(smtp-greeting|helo-response)|Exim-Diagnostic|(body|message)-linecount):|Remote-MTA: X-ip;)/) {
2138 goto RESET_AFTER_EXTRA_LINE_READ;
2143 'optional_config' =>
2145 dkim_(canon|domain|private_key|selector|sign_headers|strict|hash|identity|timestamps)
2146 |gnutls_require_(kx|mac|protocols)
2148 |hosts_(requ(est|ire)|try)_(dane|ocsp)
2149 |dane_require_tls_ciphers
2150 |hosts_(avoid|nopass|noproxy|require|verify_avoid)_tls
2151 |pipelining_connect_advertise_hosts
2159 { 'mainlog' => 's%/(usr/(local/)?)?bin/%SYSBINDIR/%' },
2161 'sync_check_data' =>
2162 { 'mainlog' => 's/^(.* SMTP protocol synchronization error .* next input=.{8}).*$/$1<suppressed>/',
2163 'rejectlog' => 's/^(.* SMTP protocol synchronization error .* next input=.{8}).*$/$1<suppressed>/'},
2165 'timeout_errno' => # actual errno differs Solaris vs. Linux
2166 { 'mainlog' => 's/((?:host|message) deferral .* errno) <\d+> /$1 <EEE> /' },
2168 'peer_terminated_conn' => # actual error differs FreedBS/Solaris vs. Linux
2169 { 'stderr' => 's/^( SMTP\()Connection reset by peer(\)<<)$/$1closed$2/' },
2171 'perl_variants' => # result of hash-in-scalar-context changed from bucket-fill to keycount
2172 { 'stdout' => 's%^> X/X$%> X%' },
2178 return $a if ($a > $b);
2182 ##################################################
2183 # Subroutine to check the output of a test #
2184 ##################################################
2186 # This function is called when the series of subtests is complete. It makes
2187 # use of check_file(), whose arguments are:
2189 # [0] the name of the main raw output file
2190 # [1] the name of the server raw output file or undef
2191 # [2] where to put the munged copy
2192 # [3] the name of the saved file
2193 # [4] TRUE if this is a log file whose deliveries must be sorted
2194 # [5] an optional custom munge command
2196 # Arguments: Optionally, name of a single custom munge to run.
2197 # Returns: 0 if the output compared equal
2198 # 1 if comparison failed; differences to be ignored
2199 # 2 if re-run needed (files may have been updated)
2202 my($mungename) = $_[0];
2204 my($munge) = $munges->{$mungename} if defined $mungename;
2206 $yield = max($yield, check_file("spool/log/paniclog",
2207 "spool/log/serverpaniclog",
2208 "test-paniclog-munged",
2209 "paniclog/$testno", 0,
2210 $munge->{paniclog}));
2212 $yield = max($yield, check_file("spool/log/rejectlog",
2213 "spool/log/serverrejectlog",
2214 "test-rejectlog-munged",
2215 "rejectlog/$testno", 0,
2216 $munge->{rejectlog}));
2218 $yield = max($yield, check_file("spool/log/mainlog",
2219 "spool/log/servermainlog",
2220 "test-mainlog-munged",
2221 "log/$testno", $sortlog,
2222 $munge->{mainlog}));
2226 $yield = max($yield, check_file("test-stdout",
2227 "test-stdout-server",
2228 "test-stdout-munged",
2229 "stdout/$testno", 0,
2235 $yield = max($yield, check_file("test-stderr",
2236 "test-stderr-server",
2237 "test-stderr-munged",
2238 "stderr/$testno", 0,
2242 # Compare any delivered messages, unless this test is skipped.
2244 if (! $message_skip)
2248 # Get a list of expected mailbox files for this script. We don't bother with
2249 # directories, just the files within them.
2251 foreach $oldmail (@oldmails)
2253 next unless $oldmail =~ /^mail\/$testno\./;
2254 print ">> EXPECT $oldmail\n" if $debug;
2255 $expected_mails{$oldmail} = 1;
2258 # If there are any files in test-mail, compare them. Note that "." and
2259 # ".." are automatically omitted by list_files_below().
2261 @mails = list_files_below("test-mail");
2263 foreach $mail (@mails)
2265 next if $mail =~ /^test-mail\/oncelog(.(dir|pag|db))?$/;
2267 $saved_mail = substr($mail, 10); # Remove "test-mail/"
2268 $saved_mail =~ s/^$parm_caller(\/|$)/CALLER/; # Convert caller name
2270 if ($saved_mail =~ /(\d+\.[^.]+\.)/)
2273 $saved_mail =~ s/(\d+\.[^.]+\.)/$msgno./gx;
2276 print ">> COMPARE $mail mail/$testno.$saved_mail\n" if $debug;
2277 $yield = max($yield, check_file($mail, undef, "test-mail-munged",
2278 "mail/$testno.$saved_mail", 0,
2280 delete $expected_mails{"mail/$testno.$saved_mail"};
2283 # Complain if not all expected mails have been found
2285 if (scalar(keys %expected_mails) != 0)
2287 foreach $key (keys %expected_mails)
2288 { print "** no test file found for $key\n"; }
2292 $_ = interact('Continue, Update & retry, or Quit? [Q] ', $force_update, $force_continue);
2293 tests_exit(1) if /^q?$/;
2294 if (/^c$/ && $force_continue) {
2295 log_failure($log_failed_filename, $testno, "missing email");
2296 log_test($log_summary_filename, $testno, 'F')
2300 # For update, we not only have to unlink the file, but we must also
2301 # remove it from the @oldmails vector, as otherwise it will still be
2302 # checked for when we re-run the test.
2306 foreach $key (keys %expected_mails)
2309 tests_exit(-1, "Failed to unlink $key") if !unlink("$key");
2310 for ($i = 0; $i < @oldmails; $i++)
2312 if ($oldmails[$i] eq $key)
2314 splice @oldmails, $i, 1;
2325 # Compare any remaining message logs, unless this test is skipped.
2329 # Get a list of expected msglog files for this test
2331 foreach $oldmsglog (@oldmsglogs)
2333 next unless $oldmsglog =~ /^$testno\./;
2334 $expected_msglogs{$oldmsglog} = 1;
2337 # If there are any files in spool/msglog, compare them. However, we have
2338 # to munge the file names because they are message ids, which are
2341 if (opendir(DIR, "spool/msglog"))
2343 @msglogs = sort readdir(DIR);
2346 foreach $msglog (@msglogs)
2348 next if ($msglog eq "." || $msglog eq ".." || $msglog eq "CVS");
2350 ($munged_msglog = $msglog) =~
2351 s/((?:[^\W_]{6}-){2}[^\W_]{2})
2352 /new_value($1, "10Hm%s-0005vi-00", \$next_msgid_old)/egx;
2355 s/([^\W_]{6}-[^\W_]{11}-[^\W_]{4})
2356 /new_value($1, "10Hm%s-000000005vi-0000", \$next_msgid)/egx;
2358 $yield = max($yield, check_file("spool/msglog/$msglog", undef,
2359 "test-msglog-munged", "msglog/$testno.$munged_msglog", 0,
2361 delete $expected_msglogs{"$testno.$munged_msglog"};
2365 # Complain if not all expected msglogs have been found
2367 if (scalar(keys %expected_msglogs) != 0)
2369 foreach $key (keys %expected_msglogs)
2371 print "** no test msglog found for msglog/$key\n";
2372 ($msgid) = $key =~ /^\d+\.(.*)$/;
2373 foreach $cachekey (keys %cache)
2375 if ($cache{$cachekey} eq $msgid)
2377 print "** original msgid $cachekey\n";
2385 $_ = interact('Continue, Update, or Quit? [Q] ', $force_update, $force_continue);
2386 tests_exit(1) if /^q?$/;
2387 if (/^c$/ && $force_continue) {
2388 log_failure($log_failed_filename, $testno, "missing msglog");
2389 log_test($log_summary_filename, $testno, 'F')
2394 foreach $key (keys %expected_msglogs)
2396 tests_exit(-1, "Failed to unlink msglog/$key")
2397 if !unlink("msglog/$key");
2410 ##################################################
2411 # Subroutine to run one "system" command #
2412 ##################################################
2414 # We put this in a subroutine so that the command can be reflected when
2417 # Argument: the command to be run
2425 $prcmd =~ s/; /;\n>> /;
2426 print ">> $prcmd\n";
2433 ##################################################
2434 # Subroutine to run one script command #
2435 ##################################################
2437 # The <SCRIPT> file is open for us to read an optional return code line,
2438 # followed by the command line and any following data lines for stdin. The
2439 # command line can be continued by the use of \. Data lines are not continued
2440 # in this way. In all lines, the following substitutions are made:
2442 # DIR => the current directory
2443 # CALLER => the caller of this script
2445 # Arguments: the current test number
2446 # reference to the subtest number, holding previous value
2447 # reference to the expected return code value
2448 # reference to flag for not-expected return value
2449 # reference to where to put the command name (for messages)
2450 # auxiliary information returned from a previous run
2452 # Returns: 0 the command was executed inline, no subprocess was run
2453 # 1 a non-exim command was run and waited for
2454 # 2 an exim command was run and waited for
2455 # 3 a command was run and not waited for (daemon, server, exim_lock)
2456 # 4 EOF was encountered after an initial return code line
2457 # Optionally also a second parameter, a hash-ref, with auxiliary information:
2458 # exim_pid: pid of a run process
2459 # munge: name of a post-script results munger
2462 my($testno) = $_[0];
2463 my($subtestref) = $_[1];
2464 my($commandnameref) = $_[4];
2465 my($aux_info) = $_[5];
2468 our %ENV = map { $_ => $ENV{$_} } grep { /^(?:USER|SHELL|PATH|TERM|EXIM_TEST_.*)$/ } keys %ENV;
2470 if (/^(~)?(\d+)\s*(?:([A-Z]+)=(\S+))?$/) # Handle unusual return code
2472 my($r, $rn) = ($_[2], $_[3]);
2474 $$rn = 1 if (defined $1);
2475 $ENV{$3} = $4 if (defined $3);
2477 return 4 if !defined $_; # Missing command
2484 # Handle concatenated command lines
2487 while (substr($_, -1) eq"\\")
2490 $_ = substr($_, 0, -1);
2491 chomp($temp = <SCRIPT>);
2503 do_substitute($testno);
2504 if ($debug) { printf ">> $_\n"; }
2506 # Pass back the command name (for messages)
2508 ($$commandnameref) = /^(\S+)/;
2510 # Here follows code for handling the various different commands that are
2511 # supported by this script. The first group of commands are all freestanding
2512 # in that they share no common code and are not followed by any data lines.
2518 # The "dbmbuild" command runs exim_dbmbuild. This is used both to test the
2519 # utility and to make hintsdb files for testing hintsdb lookups.
2521 if (/^dbmbuild\s+(\S+)\s+(\S+)/)
2523 run_system("(./eximdir/exim_dbmbuild $parm_cwd/$1 $parm_cwd/$2;" .
2524 "echo exim_dbmbuild exit code = \$?)" .
2530 # The "dump" command runs exim_dumpdb. On different systems, the output for
2531 # some types of dump may appear in a different order because it's just hauled
2532 # out of the hintsdb file. We can solve this by sorting. Ignore the leading
2533 # date/time, as it will be flattened later during munging.
2535 if (/^dump\s+(\S+)/)
2538 print ">> ./eximdir/exim_dumpdb $parm_cwd/spool $which\n" if $debug;
2539 open(my $in, "-|", './eximdir/exim_dumpdb', "$parm_cwd/spool", $which) or die "Can't run exim_dumpdb: $!";
2540 open(my $out, ">>test-stdout");
2541 print $out "+++++++++++++++++++++++++++\n";
2543 if ($which eq "retry")
2545 # the sort key is the first part of the retry db dump line, but for
2546 # sorting we (temporarly) replace the own hosts ipv4 with a munged
2547 # version, which matches the munging that is done later
2548 # Why? We must ensure sure, that 127.0.0.1 always sorts first
2549 # map-sort-map: Schwartz's transformation
2551 my @temp = map { $_->[1] }
2552 sort { $a->[0] cmp $b->[0] }
2553 #map { [ (split)[0] =~ s/\Q$parm_ipv4/ip4.ip4.ip4.ip4/gr, $_ ] } # this is too modern for 5.10.1
2555 (my $k = (split)[0]) =~ s/\Q$parm_ipv4\E/ip4.ip4.ip4.ip4/g;
2558 do { local $/ = "\n "; <$in> };
2559 foreach $item (@temp)
2561 $item =~ s/^\s*(.*)\n(.*)\n?\s*$/$1\n$2/m;
2562 print $out " $item\n";
2568 if ($which eq "callout")
2571 my($aa) = substr $a, 21;
2572 my($bb) = substr $b, 21;
2576 elsif ($which eq "seen")
2579 (my $aa = $a) =~ s/^([\d.]+)/$1/;
2580 (my $bb = $b) =~ s/^([\d.]+)/$1/;
2581 $aa =~ s/\Q$parm_ipv4\E/ip4.ip4.ip4.ip4/;
2582 $bb =~ s/\Q$parm_ipv4\E/ip4.ip4.ip4.ip4/;
2588 close($in); # close it explicitly, otherwise $? does not get set
2593 # verbose comments start with ###
2595 for my $file (qw(test-stdout test-stderr test-stderr-server test-stdout-server)) {
2596 open my $fh, '>>', $file or die "Can't open >>$file: $!\n";
2602 # The "echo" command is a way of writing comments to the screen.
2603 if (/^echo\s+(.*)$/)
2610 # The "exim_lock" command runs exim_lock in the same manner as "server",
2611 # but it doesn't use any input.
2613 if (/^exim_lock\s+(.*)$/)
2615 $cmd = "./eximdir/exim_lock $1 >>test-stdout";
2616 $server_pid = open SERVERCMD, "|$cmd" ||
2617 tests_exit(-1, "Failed to run $cmd\n");
2619 # This gives the process time to get started; otherwise the next
2620 # process may not find it there when it expects it.
2622 select(undef, undef, undef, 0.1);
2627 # The "exinext" command runs exinext
2629 if (/^exinext\s+(.*)/)
2631 run_system("(./eximdir/exinext " .
2632 "-DEXIM_PATH=$parm_cwd/eximdir/exim " .
2633 "-C $parm_cwd/test-config $1;" .
2634 "echo exinext exit code = \$?)" .
2640 # The "exigrep" command runs exigrep on the current mainlog
2642 if (/^exigrep\s+(.*)/)
2644 run_system("(./eximdir/exigrep " .
2645 "$1 $parm_cwd/spool/log/mainlog;" .
2646 "echo exigrep exit code = \$?)" .
2652 # The "exiqgrep" command runs exiqgrep on the current spool
2654 if (/^exiqgrep(\s+.*)?/)
2656 run_system("(./eximdir/exiqgrep -E ./eximdir/exim -C $parm_cwd/test-config" . ($1 || '') . ";" .
2657 "echo exiqgrep exit code = \$?)" .
2663 # The "eximstats" command runs eximstats on the current mainlog
2665 if (/^eximstats\s+(.*)/)
2667 run_system("(./eximdir/eximstats " .
2668 "$1 $parm_cwd/spool/log/mainlog;" .
2669 "echo eximstats exit code = \$?)" .
2675 # The "exim_id_update" command runs exim_id_update on the current spool
2677 if (/^exim_id_update(\s+.*)?$/)
2679 run_system("(sudo ./eximdir/exim_id_update" . ($1 || '') . " $parm_cwd/spool/input;" .
2680 "echo exim_id_update exit code = \$?)" .
2681 ">>test-stdout 2>>test-stderr");
2686 # The "gnutls" command makes a copy of saved GnuTLS parameter data in the
2687 # spool directory, to save Exim from re-creating it each time.
2691 my $gen_fn = "spool/gnutls-params-$gnutls_dh_bits_normal";
2692 run_system "sudo cp -p aux-fixed/gnutls-params $gen_fn;" .
2693 "sudo chown $parm_eximuser:$parm_eximgroup $gen_fn;" .
2694 "sudo chmod 0400 $gen_fn";
2699 # The "killdaemon" command should ultimately follow the starting of any Exim
2700 # daemon with the -bd option.
2704 my $return_extra = {};
2705 if (exists $aux_info->{exim_pid})
2707 $pid = $aux_info->{exim_pid};
2708 $return_extra->{exim_pid} = undef;
2709 print ">> killdaemon: recovered pid $pid\n" if $debug;
2712 run_system("sudo /bin/kill -TERM $pid");
2716 $pid = `cat $parm_cwd/spool/exim-daemon.*`;
2719 run_system("sudo /bin/kill -TERM $pid");
2720 close DAEMONCMD; # Waits for process
2723 run_system("sudo /bin/rm -f spool/exim-daemon.*");
2724 return (1, $return_extra);
2728 # The "millisleep" command is like "sleep" except that its argument is in
2729 # milliseconds, thus allowing for a subsecond sleep, which is, in fact, all it
2732 elsif (/^millisleep\s+(.*)$/)
2734 select(undef, undef, undef, $1/1000);
2739 # The "munge" command selects one of a hardwired set of test-result modifications
2740 # to be made before result compares are run against the golden set. This lets
2741 # us account for test-system dependent things which only affect a few, but known,
2743 # Currently only the last munge takes effect.
2745 if (/^munge\s+(.*)$/)
2747 return (0, { munge => $1 });
2751 # The "sleep" command does just that. For sleeps longer than 1 second we
2752 # tell the user what's going on.
2754 if (/^sleep\s+(.*)$/)
2762 printf(" Test %d sleep $1 ", $$subtestref);
2768 printf("\r Test %d $cr", $$subtestref);
2774 # Various Unix management commands are recognized
2776 if (/^(ln|ls|du|mkdir|mkfifo|touch|cp|cat)\s/ ||
2777 /^sudo\s(mkdir|rmdir|rm|mv|cp|chown|chmod)\s/)
2779 run_system("$_ >>test-stdout 2>>test-stderr");
2785 run_system("$_ 2>&1 >test-stderr");
2794 # The next group of commands are also freestanding, but they are all followed
2798 # The "server" command starts up a script-driven server that runs in parallel
2799 # with the following exim command. Therefore, we want to run a subprocess and
2800 # not yet wait for it to complete. The waiting happens after the next exim
2801 # command, triggered by $server_pid being non-zero. The server sends its output
2802 # to a different file. The variable $server_opts, if not empty, contains
2803 # options to disable IPv4 or IPv6 if necessary.
2804 # This works because "server" swallows its stdin before waiting for a connection.
2806 if (/^server\s+(.*)$/)
2808 $pidfile = "$parm_cwd/aux-var/server-daemon.pid";
2809 $cmd = "./bin/server $server_opts -oP $pidfile $1 >>test-stdout-server";
2810 print ">> $cmd\n" if ($debug);
2811 $server_pid = open SERVERCMD, "|$cmd" || tests_exit(-1, "Failed to run $cmd");
2812 SERVERCMD->autoflush(1);
2813 print ">> Server pid is $server_pid\n" if $debug;
2817 last if /^\*{4}\s*$/;
2820 print SERVERCMD "++++\n"; # Send end to server; can't send EOF yet
2821 # because close() waits for the process.
2823 # Interlock the server startup; otherwise the next
2824 # process may not find it there when it expects it.
2825 while (! stat("$pidfile") ) { select(undef, undef, undef, 0.3); }
2830 # The "write" command is a way of creating files of specific sizes for
2831 # buffering tests, or containing specific data lines from within the script
2832 # (rather than hold lots of little files). The "catwrite" command does the
2833 # same, but it also copies the lines to test-stdout.
2835 if (/^(cat)?write\s+(\S+)(?:\s+(.*))?\s*$/)
2837 my($cat) = defined $1;
2839 @sizes = split /\s+/, $3 if defined $3;
2840 open FILE, ">$2" || tests_exit(-1, "Failed to open \"$2\": $!");
2844 open CAT, ">>test-stdout" ||
2845 tests_exit(-1, "Failed to open test-stdout: $!");
2846 print CAT "==========\n";
2849 if (scalar @sizes > 0)
2856 last if /^\+{4}\s*$/;
2863 while (scalar @sizes > 0)
2865 ($count,$len,$leadin) = (shift @sizes) =~ /(\d+)x(\d+)(?:=(.*))?/;
2866 $leadin = '' if !defined $leadin;
2868 $len -= length($leadin) + 1;
2869 while ($count-- > 0)
2871 print FILE $leadin, "a" x $len, "\n";
2872 print CAT $leadin, "a" x $len, "\n" if $cat;
2877 # Post data, or only data if no sized data
2882 last if /^\*{4}\s*$/;
2890 print CAT "==========\n";
2901 # From this point on, script commands are implemented by setting up a shell
2902 # command in the variable $cmd. Shared code to run this command and handle its
2903 # input and output follows.
2905 # The "client", "client-gnutls", and "client-ssl" commands run a script-driven
2906 # program that plays the part of an email client. We also have the availability
2907 # of running Perl for doing one-off special things. Note that all these
2908 # commands expect stdin data to be supplied.
2910 if (/^client/ || /^(sudo\s+)?perl\b/)
2912 if (defined($tls)) {
2913 s/^client-anytls/client-ssl/ if ($tls eq 'openssl');
2914 s/^client-anytls/client-gnutls/ if ($tls eq 'gnutls');
2916 s"client"./bin/client";
2917 $cmd = "$_ >>test-stdout 2>>test-stderr";
2920 # For the "exim" command, replace the text "exim" with the path for the test
2921 # binary, plus -D options to pass over various parameters, and a -C option for
2922 # the testing configuration file. When running in the test harness, Exim does
2923 # not drop privilege when -C and -D options are present. To run the exim
2924 # command as root, we use sudo.
2926 elsif (/^((?i:[A-Z\d_]+=\S+\s+)+)?(\d+)?\s*(sudo(?:\s+-u\s+(\w+))?\s+)?exim(_\S+)?\s+(.*)$/)
2929 my($envset) = (defined $1)? $1 : '';
2930 my($sudo) = (defined $3)? "sudo " . (defined $4 ? "-u $4 ":'') : '';
2931 my($special)= (defined $5)? $5 : '';
2932 $wait_time = (defined $2)? $2 : 0;
2934 # Return 2 rather than 1 afterwards
2938 # Update the test number
2940 $$subtestref = $$subtestref + 1;
2941 printf(" Test %d $cr", $$subtestref);
2943 # Copy the configuration file, making the usual substitutions.
2945 open (IN, "$parm_cwd/confs/$testno") ||
2946 tests_exit(-1, "Couldn't open $parm_cwd/confs/$testno: $!\n");
2947 open (OUT, ">test-config") ||
2948 tests_exit(-1, "Couldn't open test-config: $!\n");
2951 do_substitute($testno);
2957 # The string $msg1 in args substitutes the message id of the first
2958 # message on the queue, and so on. */
2960 if ($args =~ /\$msg/)
2963 if ($args =~ /-qG\w+/) { $queuespec = $&; }
2967 if (defined $queuespec)
2969 @listcmd = ("$parm_cwd/$exim_server", '-bp',
2971 "-DEXIM_PATH=$parm_cwd$exim_server",
2972 -C => "$parm_cwd/test-config");
2976 @listcmd = ("$parm_cwd/$exim_server", '-bp',
2977 "-DEXIM_PATH=$parm_cwd/$exim_server",
2978 -C => "$parm_cwd/test-config");
2980 print ">> Getting queue list from:\n>> @listcmd\n" if $debug;
2981 # We need the message ids sorted in ascending order.
2982 # Message id is: <timestamp>-<pid>-<fractional-time>. On some systems (*BSD) the
2983 # PIDs are randomized, so sorting just the whole PID doesn't work.
2984 # We do the Schartz' transformation here (sort on
2985 # <timestamp><fractional-time>). Thanks to Kirill Miazine
2987 map { $_->[1] } # extract the values
2988 sort { $a->[0] cmp $b->[0] } # sort by key
2989 map { [join('.' => (split /-/, $_)[0,2]) => $_] } # key (timestamp.fractional-time) => value(message_id)
2990 map { /^\s*\d+[smhdw]\s+\S+\s+(\S+)/ } `@listcmd` or tests_exit(-1, "No output from `exim -bp` (@listcmd)\n");
2992 # Done backwards just in case there are more than 9
2994 for (my $i = @msglist; $i > 0; $i--) { $args =~ s/\$msg$i/$msglist[$i-1]/g; }
2995 if ( $args =~ /\$msg\d/ )
2997 tests_exit(-1, "Not enough messages in spool, for test $testno line $lineno\n")
2998 unless $force_continue;
3002 # If -d is specified in $optargs, remove it from $args; i.e. let
3003 # the command line for runtest override. Then run Exim.
3005 $args =~ s/(?:^|\s)-d\S*// if $optargs =~ /(?:^|\s)-d/;
3007 my $opt_valgrind = $valgrind ? "valgrind --leak-check=yes --suppressions=$parm_cwd/aux-fixed/valgrind.supp " : '';
3009 $cmd = "$envset$sudo$opt_valgrind";
3011 if ($special ne '') {
3012 $cmd .= "$parm_cwd/eximdir/exim$special$optargs " .
3013 "-DEXIM_PATH=$parm_cwd/eximdir/exim$special ";
3015 elsif ($args =~ /(^|\s)-DSERVER=server\s/) {
3016 $cmd .= "$parm_cwd/$exim_server$optargs " .
3017 "-DEXIM_PATH=$parm_cwd/$exim_server ";
3020 $cmd .= "$parm_cwd/$exim_client$optargs " .
3021 "-DEXIM_PATH=$parm_cwd/$exim_client ";
3024 $cmd .= "-C $parm_cwd/test-config $args " .
3025 ">>test-stdout 2>>test-stderr";
3027 # If the command is starting an Exim daemon, we run it in the same
3028 # way as the "server" command above, that is, we don't want to wait
3029 # for the process to finish. That happens when "killdaemon" is obeyed later
3030 # in the script. We also send the stderr output to test-stderr-server. The
3031 # daemon has its log files put in a different place too (by configuring with
3032 # log_file_path). This requires the directory to be set up in advance.
3034 # There are also times when we want to run a non-daemon version of Exim
3035 # (e.g. a queue runner) with the server configuration. In this case,
3036 # we also define -DNOTDAEMON.
3038 if ($cmd =~ /\s-DSERVER=server\s/ && $cmd !~ /\s-DNOTDAEMON\s/)
3040 if ($debug) { printf ">> daemon: $cmd\n"; }
3041 run_system("sudo mkdir spool/log 2>/dev/null");
3042 run_system("sudo chown $parm_eximuser:$parm_eximgroup spool/log");
3044 # Before running the command, convert the -bd option into -bdf so that an
3045 # Exim daemon doesn't double fork. This means that when we wait close
3046 # DAEMONCMD, it waits for the correct process. Also, ensure that the pid
3047 # file is written to the spool directory, in case the Exim binary was
3048 # built with PID_FILE_PATH pointing somewhere else.
3050 if ($cmd =~ /\s-oP\s/)
3052 ($pidfile = $cmd) =~ s/^.*-oP ([^ ]+).*$/$1/;
3053 $cmd =~ s!\s-bd\s! -bdf !;
3057 $pidfile = "$parm_cwd/spool/exim-daemon.pid";
3058 $cmd =~ s!\s-bd\s! -bdf -oP $pidfile !;
3060 print ">> |${cmd}-server\n" if ($debug);
3061 open DAEMONCMD, "|${cmd}-server" || tests_exit(-1, "Failed to run $cmd");
3062 DAEMONCMD->autoflush(1);
3063 while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; } # Ignore any input
3065 # Interlock with daemon startup
3066 for (my $count = 0; ! stat("$pidfile") && $count < 30; $count++ )
3067 { select(undef, undef, undef, 0.3); }
3068 return 3; # Don't wait
3070 elsif ($cmd =~ /\s-DSERVER=wait:(\d+)\s/)
3073 # The port and the $dynamic_socket was already allocated while parsing the
3074 # script file, where -DSERVER=wait:PORT_DYNAMIC was encountered.
3076 my $listen_port = $1;
3077 if ($debug) { printf ">> wait-mode daemon: $cmd\n"; }
3078 run_system("sudo mkdir spool/log 2>/dev/null");
3079 run_system("sudo chown $parm_eximuser:$parm_eximgroup spool/log");
3082 if (not defined $pid) { die "** fork failed: $!\n" }
3085 open(STDIN, '<&', $dynamic_socket) or die "** dup sock to stdin failed: $!\n";
3086 close($dynamic_socket);
3087 print "[$$]>> ${cmd}-server\n" if ($debug);
3088 exec "exec ${cmd}-server";
3089 die "Can't exec ${cmd}-server: $!\n";
3091 while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; } # Ignore any input
3092 select(undef, undef, undef, 0.3); # Let the daemon get going
3093 return (3, { exim_pid => $pid }); # Don't wait
3097 # The "background" command is run but not waited-for, like exim -DSERVER=server.
3098 # One script line is read and fork-exec'd. The PID is stored for a later
3101 elsif (/^background$/)
3104 # $pidfile = "$parm_cwd/aux-var/server-daemon.pid";
3106 $_ = <SCRIPT>; $lineno++;
3108 do_substitute($testno);
3110 if ($debug) { printf ">> daemon: $line >>test-stdout 2>>test-stderr\n"; }
3113 if (not defined $pid) { die "** fork failed: $!\n" }
3115 print "[$$]>> ${line}\n" if ($debug);
3117 open(STDIN, "<", "test-stdout");
3119 open(STDOUT, ">>", "test-stdout");
3121 open(STDERR, ">>", "test-stderr-server");
3122 exec "exec ${line}";
3126 # open(my $fh, ">", $pidfile) ||
3127 # tests_exit(-1, "Failed to open $pidfile: $!");
3128 # printf($fh, "%d\n", $pid);
3131 while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; } # Ignore any input
3132 select(undef, undef, undef, 0.3); # Let the daemon get going
3133 return (3, { exim_pid => $pid }); # Don't wait
3140 else { tests_exit(-1, "Command unrecognized in line $lineno: $_"); }
3143 # Run the command, with stdin connected to a pipe, and write the stdin data
3144 # to it, with appropriate substitutions. If a starts with '>>> ', process it
3145 # via Perl's string eval().
3146 # If the command contains
3147 # -DSERVER=server add "-server" to the command, where it will adjoin the name
3148 # for the stderr file. See comment above about the use of -DSERVER.
3150 $stderrsuffix = ($cmd =~ /\s-DSERVER=server\s/)? "-server" : '';
3151 print ">> |${cmd}${stderrsuffix}\n" if ($debug);
3152 open CMD, "|${cmd}${stderrsuffix}" || tests_exit(1, "Failed to run $cmd");
3155 LINE: while (<SCRIPT>)
3158 last if /^\*{4}\s*$/;
3159 do_substitute($testno);
3160 if (my ($cmd, $line) = /^(:\S+?:)(.*)/) {
3163 $cmd eq ':eval:' and do {
3167 $cmd eq ':noeol:' and do {
3171 $cmd eq ':sleep:' and do {
3180 # For timeout tests, wait before closing the pipe; we expect a
3181 # SIGPIPE error in this case.
3185 printf(" Test %d sleep $wait_time ", $$subtestref);
3186 while ($wait_time-- > 0)
3191 printf("\r Test %d $cr", $$subtestref);
3194 $sigpipehappened = 0;
3195 close CMD; # Waits for command to finish
3196 return $yield; # Ran command and waited
3202 ###############################################################################
3203 ###############################################################################
3205 ##################################################
3206 # Check for SpamAssassin and ClamAV #
3207 ##################################################
3209 # These are crude tests. If they aren't good enough, we'll have to improve
3210 # them, for example by actually passing a message through spamc or clamscan.
3212 sub check_running_spamassassin
3214 my $sock = new FileHandle;
3216 if (system("spamc -h 2>/dev/null >/dev/null") == 0)
3218 print "The spamc command works:\n";
3220 # This test for an active SpamAssassin is courtesy of John Jetmore.
3221 # The tests are hard coded to localhost:783, so no point in making
3222 # this test flexible like the clamav test until the test scripts are
3223 # changed. spamd doesn't have the nice PING/PONG protocol that
3224 # clamd does, but it does respond to errors in an informative manner,
3227 my($sint,$sport) = ('127.0.0.1',783);
3230 my $sin = sockaddr_in($sport, inet_aton($sint))
3231 or die "** Failed packing $sint:$sport\n";
3232 socket($sock, PF_INET, SOCK_STREAM, getprotobyname('tcp'))
3233 or die "** Unable to open socket $sint:$sport\n";
3236 sub { die "** Timeout while connecting to socket $sint:$sport\n"; };
3238 connect($sock, $sin)
3239 or die "** Unable to connect to socket $sint:$sport\n";
3242 select((select($sock), $| = 1)[0]);
3243 print $sock "bad command\r\n";
3246 sub { die "** Timeout while reading from socket $sint:$sport\n"; };
3252 or die "** Did not get SPAMD from socket $sint:$sport. "
3259 print " Assume SpamAssassin (spamd) is not running\n";
3263 $parm_running{SpamAssassin} = ' ';
3264 print " SpamAssassin (spamd) seems to be running\n";
3269 print "The spamc command failed: assume SpamAssassin (spamd) is not running\n";
3273 sub check_running_clamav
3277 # For ClamAV, we need to find the clamd socket for use in the Exim
3278 # configuration. Search for the clamd configuration file.
3280 if (system("clamscan -h 2>/dev/null >/dev/null") == 0)
3282 my($f, $clamconf, $test_prefix);
3284 print "The clamscan command works";
3286 $test_prefix = $ENV{EXIM_TEST_PREFIX};
3287 $test_prefix = '' if !defined $test_prefix;
3289 foreach $f ("$test_prefix/etc/clamd.conf",
3290 "$test_prefix/usr/local/etc/clamd.conf",
3291 "$test_prefix/etc/clamav/clamd.conf", '')
3300 # Read the ClamAV configuration file and find the socket interface.
3302 if ($clamconf ne '')
3305 open(IN, "$clamconf") || die "\n** Unable to open $clamconf: $!\n";
3308 if (/^LocalSocket\s+(.*)/)
3310 $parm_clamsocket = $1;
3311 $socket_domain = AF_UNIX;
3314 if (/^TCPSocket\s+(\d+)/)
3316 if (defined $parm_clamsocket)
3318 $parm_clamsocket .= " $1";
3319 $socket_domain = AF_INET;
3324 $parm_clamsocket = " $1";
3327 elsif (/^TCPAddr\s+(\S+)/)
3329 if (defined $parm_clamsocket)
3331 $parm_clamsocket = $1 . $parm_clamsocket;
3332 $socket_domain = AF_INET;
3337 $parm_clamsocket = $1;
3343 if (defined $socket_domain)
3345 print ":\n The clamd socket is $parm_clamsocket\n";
3346 # This test for an active ClamAV is courtesy of Daniel Tiefnig.
3350 if ($socket_domain == AF_UNIX)
3352 $socket = sockaddr_un($parm_clamsocket) or die "** Failed packing '$parm_clamsocket'\n";
3354 elsif ($socket_domain == AF_INET)
3356 my ($ca_host, $ca_port) = split(/\s+/,$parm_clamsocket);
3357 my $ca_hostent = gethostbyname($ca_host) or die "** Failed to get raw address for host '$ca_host'\n";
3358 $socket = sockaddr_in($ca_port, $ca_hostent) or die "** Failed packing '$parm_clamsocket'\n";
3362 die "** Unknown socket domain '$socket_domain' (should not happen)\n";
3364 socket($sock, $socket_domain, SOCK_STREAM, 0) or die "** Unable to open socket '$parm_clamsocket'\n";
3365 local $SIG{ALRM} = sub { die "** Timeout while connecting to socket '$parm_clamsocket'\n"; };
3367 connect($sock, $socket) or die "** Unable to connect to socket '$parm_clamsocket'\n";
3370 my $ofh = select $sock; $| = 1; select $ofh;
3371 print $sock "PING\n";
3373 $SIG{ALRM} = sub { die "** Timeout while reading from socket '$parm_clamsocket'\n"; };
3378 $res =~ /PONG/ or die "** Did not get PONG from socket '$parm_clamsocket'. It said: $res\n";
3385 print " Assume ClamAV is not running\n";
3389 $parm_running{ClamAV} = ' ';
3390 print " ClamAV seems to be running\n";
3395 print ", but the socket for clamd could not be determined\n";
3396 print "Assume ClamAV is not running\n";
3402 print ", but I can't find a configuration for clamd\n";
3403 print "Assume ClamAV is not running\n";
3409 sub check_running_redis
3411 if (defined $parm_lookups{redis})
3413 if (system("redis-server -v 2>/dev/null >/dev/null") == 0)
3415 print "The redis-server command works\n";
3416 $parm_running{redis} = ' ';
3420 print "The redis-server command failed: assume Redis not installed\n";
3425 sub check_running_dovecot
3427 system('dovecot --version >/dev/null 2>&1');
3430 print "Dovecot appears to be available\n";
3431 $parm_running{dovecot} = ' ';
3435 print "Dovecot not found\n";
3441 ###############################################################################
3442 ###############################################################################
3444 # Here begins the Main Program ...
3446 ###############################################################################
3447 ###############################################################################
3451 print "Exim tester $testversion\n";
3453 # extend the PATH with .../sbin
3454 # we map all (.../bin) to (.../sbin:.../bin)
3456 my %seen = map { $_, 1 } split /:/, $ENV{PATH};
3457 join ':' => map { m{(.*)/bin$}
3458 ? ( $seen{"$1/sbin"} ? () : ("$1/sbin"), $_)
3460 split /:/, $ENV{PATH};
3463 ##################################################
3464 # Some tests check created file modes #
3465 ##################################################
3470 ##################################################
3471 # Check for the "less" command #
3472 ##################################################
3474 @more = 'more' if system('which less >/dev/null 2>&1') != 0;
3478 ##################################################
3479 # See if an Exim binary has been given #
3480 ##################################################
3482 # If the first character of the first argument is '/', the argument is taken
3483 # as the path to the binary. If the first argument does not start with a
3484 # '/' but exists in the file system, it's assumed to be the Exim binary.
3487 ##################################################
3488 # Sort out options and which tests are to be run #
3489 ##################################################
3491 # There are a few possible options for the test script itself; after these, any
3492 # options are passed on to Exim calls within the tests. Typically, this is used
3493 # to turn on Exim debugging while setting up a test.
3495 Getopt::Long::Configure qw(no_getopt_compat);
3497 'debug' => sub { $debug = 1; $cr = "\n" },
3498 'diff' => sub { $cf = 'diff -u' },
3499 'continue' => sub { $force_continue = 1; @more = 'cat' },
3500 'update' => \$force_update,
3501 'ipv4!' => \$have_ipv4,
3502 'ipv6!' => \$have_ipv6,
3503 'keep' => \$save_output,
3505 'tls=s' => \my $tls,
3506 'valgrind' => \$valgrind,
3507 'range=s{2}' => \my @range_wanted,
3508 'test=i@' => \my @tests_wanted,
3509 'fail-any!' => \my $fail_any,
3510 'flavor|flavour=s' => \$flavour,
3511 'help' => sub { pod2usage(-exit => 0) },
3516 -noperldoc => system('perldoc -V 2>/dev/null 1>&2')
3521 ($parm_exim, @ARGV) = Exim::Runtest::exim_binary(@ARGV);
3522 print "Exim binary is `$parm_exim'\n" if defined $parm_exim;
3526 my @wanted = sort numerically uniq
3527 @tests_wanted ? @tests_wanted : (),
3528 @range_wanted ? $range_wanted[0] .. $range_wanted[1] : (),
3529 @ARGV ? @ARGV == 1 ? $ARGV[0] :
3530 $ARGV[1] eq '+' ? $ARGV[0]..($ARGV[0] >= 9000 ? TEST_SPECIAL_TOP : TEST_TOP) :
3531 0+$ARGV[0]..0+$ARGV[1] # add 0 to cope with test numbers starting with zero
3533 @wanted = 1..TEST_TOP if not @wanted;
3534 map { $wanted{sprintf("%04d",$_)}= $_; } @wanted;
3536 ##################################################
3537 # Check for sudo access to root #
3538 ##################################################
3540 print "You need to have sudo access to root to run these tests. Checking ...\n";
3541 if (system('sudo true >/dev/null') != 0)
3543 die "** Test for sudo failed: testing abandoned.\n";
3547 print "Test for sudo OK\n";
3553 ##################################################
3554 # Make the command's directory current #
3555 ##################################################
3557 # After doing so, we find its absolute path name.
3560 $cwd = '.' if ($cwd !~ s|/[^/]+$||);
3561 chdir($cwd) || die "** Failed to chdir to \"$cwd\": $!\n";
3562 $parm_cwd = Cwd::getcwd();
3565 ##################################################
3566 # Search for an Exim binary to test #
3567 ##################################################
3569 # If an Exim binary hasn't been provided, try to find one. We can handle the
3570 # case where exim-testsuite is installed alongside Exim source directories. For
3571 # PH's private convenience, if there's a directory just called "exim4", that
3572 # takes precedence; otherwise exim-snapshot takes precedence over any numbered
3575 # If $parm_exim is still empty, ask the caller
3579 print "** Did not find an Exim binary to test\n";
3580 for ($i = 0; $i < 5; $i++)
3583 print "** Enter pathname for Exim binary: ";
3584 chomp($trybin = <STDIN>);
3587 $parm_exim = $trybin;
3592 print "** $trybin does not exist\n";
3595 die "** Too many tries\n" if $parm_exim eq '';
3600 ##################################################
3601 # Find what is in the binary #
3602 ##################################################
3604 # deal with TRUSTED_CONFIG_LIST restrictions
3605 unlink("$parm_cwd/test-config") if -e "$parm_cwd/test-config";
3606 open (IN, "$parm_cwd/confs/0000") ||
3607 tests_exit(-1, "Couldn't open $parm_cwd/confs/0000: $!\n");
3608 open (OUT, ">test-config") ||
3609 tests_exit(-1, "Couldn't open test-config: $!\n");
3610 while (<IN>) { print OUT; }
3614 print("Probing with config file: $parm_cwd/test-config\n");
3616 my $eximinfo = "$parm_exim -d -C $parm_cwd/test-config -DDIR=$parm_cwd -bP exim_user exim_group";
3617 chomp(my @eximinfo = `$eximinfo 2>&1`);
3618 die "$0: Can't run $eximinfo\n" if $? == -1;
3620 warn 'Got ' . ($?>>8) . " from $eximinfo\n" if $?;
3623 if (my ($version) = /^Exim version (\S+)/) {
3624 my $git = `git describe --dirty=-XX --match 'exim-4*'`;
3625 if (defined $git and $? == 0) {
3627 $git =~ s/^exim-//i;
3628 $git =~ s/.*-\Kg([[:xdigit:]]+(?:-XX)?)/$1/;
3631 *** Version mismatch
3632 *** Exim binary: $version
3636 if not $version eq $git;
3639 $parm_eximuser = $1 if /^exim_user = (.*)$/;
3640 $parm_eximgroup = $1 if /^exim_group = (.*)$/;
3641 $parm_trusted_config_list = $1 if /^TRUSTED_CONFIG_LIST:.*?"(.*?)"$/;
3642 ($parm_configure_owner, $parm_configure_group) = ($1, $2)
3643 if /^Configure owner:\s*(\d+):(\d+)/;
3644 print if /wrong owner/;
3647 if (not defined $parm_eximuser) {
3648 die <<XXX, map { "|$_\n" } @eximinfo;
3649 Unable to extract exim_user from binary.
3650 Check if Exim refused to run; if so, consider:
3651 TRUSTED_CONFIG_LIST ALT_CONFIG_PREFIX WHITELIST_D_MACROS
3652 If debug permission denied, are you in the exim group?
3653 Failing to get information from binary.
3654 Output from $eximinfo:
3659 if ($parm_eximuser =~ /^\d+$/) { $parm_exim_uid = $parm_eximuser; }
3660 else { $parm_exim_uid = getpwnam($parm_eximuser); }
3662 if (defined $parm_eximgroup)
3664 if ($parm_eximgroup =~ /^\d+$/) { $parm_exim_gid = $parm_eximgroup; }
3665 else { $parm_exim_gid = getgrnam($parm_eximgroup); }
3668 # check the permissions on the TRUSTED_CONFIG_LIST
3669 if (defined $parm_trusted_config_list)
3671 die "TRUSTED_CONFIG_LIST: $parm_trusted_config_list: $!\n"
3672 if not -f $parm_trusted_config_list;
3674 die "TRUSTED_CONFIG_LIST $parm_trusted_config_list must not be world writable!\n"
3675 if 02 & (stat _)[2];
3677 die sprintf "TRUSTED_CONFIG_LIST: $parm_trusted_config_list %d is group writable, but not owned by group '%s' or '%s'.\n",
3679 scalar(getgrgid 0), scalar(getgrgid $>)
3680 if (020 & (stat _)[2]) and not ((stat _)[5] == $> or (stat _)[5] == 0);
3682 die sprintf "TRUSTED_CONFIG_LIST: $parm_trusted_config_list is not owned by user '%s' or '%s'.\n",
3683 scalar(getpwuid 0), scalar(getpwuid $>)
3684 if (not (-o _ or (stat _)[4] == 0));
3686 open(TCL, $parm_trusted_config_list) or die "Can't open $parm_trusted_config_list: $!\n";
3687 my $test_config = getcwd() . '/test-config';
3688 die "Can't find '$test_config' in TRUSTED_CONFIG_LIST $parm_trusted_config_list."
3689 if not grep { /^\Q$test_config\E$/ } <TCL>;
3693 die "Unable to check the TRUSTED_CONFIG_LIST, seems to be empty?\n";
3696 die "CONFIGURE_OWNER ($parm_configure_owner) does not match the user invoking $0 ($>)\n"
3697 if $parm_configure_owner != $>;
3699 die "CONFIGURE_GROUP ($parm_configure_group) does not match the group invoking $0 ($))\n"
3700 if 0020 & (stat "$parm_cwd/test-config")[2]
3701 and $parm_configure_group != $);
3703 die "aux-fixed file is group-writeable; best to strip them all, recursively\n"
3704 if 0020 & (stat "aux-fixed/0037.f-1")[2];
3707 open(EXIMINFO, "$parm_exim -d-all+transport -bV -C $parm_cwd/test-config -DDIR=$parm_cwd |") ||
3708 die "** Cannot run $parm_exim: $!\n";
3710 print "-" x 78, "\n";
3716 if (/^(Exim|Library) version/) { print; }
3717 if (/Runtime: /) {print; }
3719 elsif (/^Size of off_t: (\d+)/)
3722 $have_largefiles = 1 if $1 > 4;
3723 die "** Size of off_t > 32 which seems improbable, not running tests\n"
3727 elsif (/^Support for: (.*)/)
3728 { # Compile-time features - exim -bV
3730 @temp = split /(\s+)/, $1;
3732 %parm_support = @temp;
3735 elsif (/^Lookups \((?:built-in|dynamic)\): ?(.*)/)
3738 @temp = split /(\s+)/, $1;
3740 my %temp_lookups = @temp;
3741 @parm_lookups{keys %temp_lookups} = values %temp_lookups;
3744 elsif (/^Authenticators: (.*)/)
3747 @temp = split /(\s+)/, $1;
3749 %parm_authenticators = @temp;
3752 elsif (/^Routers \((?:built-in|dynamic)\): ?(.*)/)
3755 @temp = split /(\s+)/, $1;
3757 my %temp_routers= @temp;
3758 @parm_routers{keys %temp_routers} = values %temp_routers;
3761 # Some transports have options, e.g. appendfile/maildir. For those, ensure
3762 # that the basic transport name is set, and then the name with each of the
3765 elsif (/^Transports: (.*)/)
3768 @temp = split /(\s+)/, $1;
3771 %parm_transports = @temp;
3772 foreach $k (keys %parm_transports)
3776 @temp = split /\//, $k;
3777 $parm_transports{$temp[0]} = " ";
3778 for ($i = 1; $i < @temp; $i++)
3779 { $parm_transports{"$temp[0]/$temp[$i]"} = " "; }
3784 elsif (/^Malware: (.*)/)
3787 @temp = split /(\s+)/, $1;
3789 %parm_malware = @temp;
3794 print "-" x 78, "\n";
3796 unlink("$parm_cwd/test-config");
3800 if (defined $parm_support{Content_Scanning})
3802 check_running_spamassassin();
3803 check_running_clamav();
3805 check_running_redis();
3806 check_running_dovecot();
3808 ##################################################
3809 # Test for the basic requirements #
3810 ##################################################
3812 # This test suite assumes that Exim has been built with at least the "usual"
3813 # set of routers, transports, and lookups. Ensure that this is so.
3817 $missing .= " Lookup: lsearch\n" if (!defined $parm_lookups{lsearch});
3819 $missing .= " Router: accept\n" if (!defined $parm_routers{accept});
3820 $missing .= " Router: dnslookup\n" if (!defined $parm_routers{dnslookup});
3821 $missing .= " Router: manualroute\n" if (!defined $parm_routers{manualroute});
3822 $missing .= " Router: redirect\n" if (!defined $parm_routers{redirect});
3824 $missing .= " Transport: appendfile\n" if (!defined $parm_transports{appendfile});
3825 $missing .= " Transport: autoreply\n" if (!defined $parm_transports{autoreply});
3826 $missing .= " Transport: pipe\n" if (!defined $parm_transports{pipe});
3827 $missing .= " Transport: smtp\n" if (!defined $parm_transports{smtp});
3832 print "** Many features can be included or excluded from Exim binaries.\n";
3833 print "** This test suite requires that Exim is built to contain a certain\n";
3834 print "** set of basic facilities. It seems that some of these are missing\n";
3835 print "** from the binary that is under test, so the test cannot proceed.\n";
3836 print "** The missing facilities are:\n";
3838 die "** Test script abandoned\n";
3842 ##################################################
3843 # Check for the auxiliary programs #
3844 ##################################################
3846 # These are always required:
3848 for $prog ("cf", "checkaccess", "client", "client-ssl", "client-gnutls",
3849 "fakens", "iefbr14", "server")
3851 next if ($prog eq "client-ssl" && !defined $parm_support{OpenSSL});
3852 next if ($prog eq "client-gnutls" && !defined $parm_support{GnuTLS});
3853 if (!-e "bin/$prog")
3856 print "** bin/$prog does not exist. Have you run ./configure and make?\n";
3857 die "** Test script abandoned\n";
3861 # If the "loaded" binary is missing, we cut out tests for ${dlfunc. It isn't
3862 # compiled on systems where we don't know how to. However, if Exim does not
3863 # have that functionality compiled, we needn't bother.
3865 $dlfunc_deleted = 0;
3866 if (defined $parm_support{Expand_dlfunc} && !-e 'bin/loaded')
3868 delete $parm_support{Expand_dlfunc};
3869 $dlfunc_deleted = 1;
3873 ##################################################
3874 # Find environmental details #
3875 ##################################################
3877 # Find the caller of this program.
3879 ($parm_caller,$pwpw,$parm_caller_uid,$parm_caller_gid,$pwquota,$pwcomm,
3880 $parm_caller_gecos, $parm_caller_home) = getpwuid($>);
3882 $pwpw = $pwpw; # Kill Perl warnings
3883 $pwquota = $pwquota;
3886 $parm_caller_group = getgrgid($parm_caller_gid);
3888 print "Program caller is $parm_caller ($parm_caller_uid), whose group is $parm_caller_group ($parm_caller_gid)\n";
3889 print "Home directory is $parm_caller_home\n";
3891 unless (defined $parm_eximgroup)
3893 print "Unable to derive \$parm_eximgroup.\n";
3894 die "** ABANDONING.\n";
3897 if ($parm_caller_home eq $parm_cwd)
3899 print "will confuse working dir with homedir; change homedir\n";
3900 die "** ABANDONING.\n";
3903 print "You need to be in the Exim group to run these tests. Checking ...";
3905 if (`groups` =~ /\b\Q$parm_eximgroup\E\b/)
3911 print "\nOh dear, you are not in the Exim group.\n";
3912 die "** Testing abandoned.\n";
3915 # Find this host's IP addresses - there may be many, of course, but we keep
3916 # one of each type (IPv4 and IPv6).
3917 #XXX it would be good to avoid non-UP interfaces
3919 open(IFCONFIG, '-|', (grep { -x "$_/ip" } split /:/, $ENV{PATH}) ? 'ip address' : 'ifconfig -a')
3920 or die "** Cannot run 'ip address' or 'ifconfig -a'\n";
3921 while (not ($parm_ipv4 and $parm_ipv6) and defined($_ = <IFCONFIG>))
3923 if (/^(?:[0-9]+: )?([a-z0-9]+): /) { $ifname = $1; }
3925 if (not $parm_ipv4 and /^\s*inet(?:\saddr(?:ess))?:?\s*(\d+\.\d+\.\d+\.\d+)(?:\/\d+)?\s/i)
3927 # It would be nice to be able to vary the /16 used for manyhome; we could take
3928 # an option to runtest used here - but we'd also have to pass it on to fakens.
3929 # Possibly an environment variable?
3930 next if $1 eq '0.0.0.0' or $1 =~ /^(?:127|10\.250)\./;
3934 if ( (not $parm_ipv6 or $parm_ipv6 =~ /%/)
3935 and /^\s*inet6(?:\saddr(?:ess))?:?\s*([abcdef\d:]+)(?:%[^ \/]+)?(?:\/\d+)?/i)
3937 next if $1 eq '::' or $1 eq '::1' or $1 =~ /^ff00/i or $1 =~ /^fe80::1/i;
3939 if ($1 =~ /^fe80/i) { $parm_ipv6 .= '%' . $ifname; }
3944 # Use private IP addresses if there are no public ones.
3946 # If either type of IP address is missing, we need to set the value to
3947 # something other than empty, because that wrecks the substitutions. The value
3948 # is reflected, so use a meaningful string. Set appropriate options for the
3949 # "server" command. In practice, however, many tests assume 127.0.0.1 is
3950 # available, so things will go wrong if there is no IPv4 address. The lack
3951 # of IPV4 or IPv6 can be simulated by command options, which force $have_ipv4
3952 # and $have_ipv6 false.
3957 $parm_ipv4 = "<no IPv4 address found>";
3958 $server_opts .= " -noipv4";
3960 elsif ($have_ipv4 == 0)
3962 $parm_ipv4 = "<IPv4 testing disabled>";
3963 $server_opts .= " -noipv4";
3967 $parm_running{IPv4} = " ";
3973 $parm_ipv6 = "<no IPv6 address found>";
3974 $server_opts .= " -noipv6";
3975 delete($parm_support{IPv6});
3977 elsif ($have_ipv6 == 0)
3979 $parm_ipv6 = "<IPv6 testing disabled>";
3980 $server_opts .= " -noipv6";
3981 delete($parm_support{IPv6});
3983 elsif (!defined $parm_support{IPv6})
3986 $parm_ipv6 = "<no IPv6 support in Exim binary>";
3987 $server_opts .= " -noipv6";
3991 $parm_running{IPv6} = " ";
3994 print "IPv4 address is $parm_ipv4\n";
3995 print "IPv6 address is $parm_ipv6\n";
3996 $parm_ipv6 =~ /^[^%\/]*/;
3997 # drop any %scope from the ipv6, for some uses
3998 ($parm_ipv6_stripped = $parm_ipv6) =~ s/%.*//g;
4000 # For munging test output, we need the reversed IP addresses.
4002 $parm_ipv4r = ($parm_ipv4 !~ /^\d/)? '' :
4003 join(".", reverse(split /\./, $parm_ipv4));
4005 $parm_ipv6r = $parm_ipv6; # Appropriate if not in use
4006 if ($parm_ipv6 =~ /^[\da-f]/)
4008 my(@comps) = split /:/, $parm_ipv6_stripped;
4010 foreach $comp (@comps)
4012 push @nibbles, sprintf("%lx", hex($comp) >> 8);
4013 push @nibbles, sprintf("%lx", hex($comp) & 0xff);
4015 $parm_ipv6r = join(".", reverse(@nibbles));
4018 # Find the host name, fully qualified.
4020 chomp($temp = `hostname`);
4021 die "'hostname' didn't return anything\n" unless defined $temp and length $temp;
4024 $parm_hostname = $temp;
4028 $parm_hostname = (gethostbyname($temp))[0];
4029 $parm_hostname = "no.host.name.found" unless defined $parm_hostname and length $parm_hostname;
4031 print "Hostname is $parm_hostname\n";
4033 if ($parm_hostname !~ /\./)
4035 print "\n*** Host name is not fully qualified: this may cause problems ***\n\n";
4038 if ($parm_hostname =~ /[[:upper:]]/)
4040 print "\n*** Host name has upper case characters: this may cause problems ***\n\n";
4043 if ($parm_hostname =~ /\.example\.com$/)
4045 die "\n*** Host name ends in .example.com; this conflicts with the testsuite use of that domain.\n"
4046 . " Please change the host's name (or comment out this check, and fail several testcases)\n";
4051 ##################################################
4052 # Create a testing version of Exim #
4053 ##################################################
4055 # We want to be able to run Exim with a variety of configurations. Normally,
4056 # the use of -C to change configuration causes Exim to give up its root
4057 # privilege (unless the caller is exim or root). For these tests, we do not
4058 # want this to happen. Also, we want Exim to know that it is running in its
4061 # We achieve this by copying the binary and patching it as we go. The new
4062 # binary knows it is a testing copy, and it allows -C and -D without loss of
4063 # privilege. Clearly, this file is dangerous to have lying around on systems
4064 # where there are general users with login accounts. To protect against this,
4065 # we put the new binary in a special directory that is accessible only to the
4066 # caller of this script, who is known to have sudo root privilege from the test
4067 # that was done above. Furthermore, we ensure that the binary is deleted at the
4068 # end of the test. First ensure the directory exists.
4071 { unlink "eximdir/exim"; } # Just in case
4074 mkdir("eximdir", 0710) || die "** Unable to mkdir $parm_cwd/eximdir: $!\n";
4075 system("sudo chgrp $parm_eximgroup eximdir");
4078 # The construction of the patched binary must be done as root, so we use
4079 # a separate script. As well as indicating that this is a test-harness binary,
4080 # the version number is patched to "x.yz" so that its length is always the
4081 # same. Otherwise, when it appears in Received: headers, it affects the length
4082 # of the message, which breaks certain comparisons.
4084 die "** Unable to make patched exim: $!\n"
4085 if (system("sudo ./patchexim $parm_exim") != 0);
4087 # If TLS-library-specific binaries have been made, grab them too
4090 $f = $parm_exim . '_' . $suff;
4092 $exim_openssl = "eximdir/exim_$suff";
4093 die "** Unable to make patched exim: $!\n"
4094 if (system("sudo ./patchexim -o $exim_openssl $f") != 0);
4097 $f = $parm_exim . '_' . $suff;
4099 $exim_gnutls = "eximdir/exim_$suff";
4100 die "** Unable to make patched exim: $!\n"
4101 if (system("sudo ./patchexim -o $exim_gnutls $f") != 0);
4106 die "** Need both $exim_openssl and $exim_gnutls for cross-library teting\n"
4107 if ( !defined($exim_openssl) || !defined($exim_gnutls) );
4108 if ($tls eq 'openssl')
4110 $exim_client = $exim_openssl;
4111 $exim_server = $exim_gnutls;
4113 elsif ($tls eq 'gnutls')
4115 $exim_client = $exim_gnutls;
4116 $exim_server = $exim_openssl;
4119 { die "** need eother openssl or gnutls speified as the client for cross-library testing, saw $tls\n"; }
4122 { $exim_client = $exim_server = 'eximdir/exim'; }
4123 print ">> \$exim_client <$exim_client>\n";;
4124 print ">> \$exim_server <$exim_server>\n";;
4126 # From this point on, exits from the program must go via the subroutine
4127 # tests_exit(), so that suitable cleaning up can be done when required.
4128 # Arrange to catch interrupting signals, to assist with this.
4130 $SIG{INT} = \&inthandler;
4131 $SIG{PIPE} = \&pipehandler;
4133 # For some tests, we need another copy of the binary that is setuid exim rather
4136 system("sudo cp eximdir/exim eximdir/exim_exim;" .
4137 "sudo chown $parm_eximuser eximdir/exim_exim;" .
4138 "sudo chgrp $parm_eximgroup eximdir/exim_exim;" .
4139 "sudo chmod 06755 eximdir/exim_exim");
4141 # Copy any libraries that were built for dynamic load
4142 # Currently this is only for lookup methods
4144 ($parm_exim_dir) = $parm_exim =~ m?^(.*)/exim?;
4146 while (my $file = glob("$parm_exim_dir/dynmodules/*.so")) {
4147 my $base = basename($file);
4148 cp("$file", "eximdir/");
4149 system("sudo chmod 755 eximdir/$base");
4152 ##################################################
4153 # Make copies of utilities we might need #
4154 ##################################################
4156 # Certain of the tests make use of some of Exim's utilities. We do not need
4157 # to be root to copy these.
4159 $dbm_build_deleted = 0;
4160 if (defined $parm_lookups{dbm} && not cp("$parm_exim_dir/exim_dbmbuild", "eximdir/exim_dbmbuild"))
4162 delete $parm_lookups{dbm};
4163 $dbm_build_deleted = 1;
4166 foreach my $tool (qw(exim_dumpdb exim_lock exinext exigrep eximstats exiqgrep exim_msgdate exim_id_update)) {
4167 cp("$parm_exim_dir/$tool" => "eximdir/$tool")
4168 or tests_exit(-1, "Failed to make a copy of $tool: $!");
4171 # Collect some version information
4172 print '-' x 78, "\n";
4173 print "Perl version for runtest: $]\n";
4174 foreach (map { "./eximdir/$_" } qw(exigrep exinext eximstats exiqgrep exim_msgdate)) {
4175 # fold (or unfold?) multiline output into a one-liner
4176 print join(', ', map { chomp; $_ } `$_ --version`), "\n";
4178 print '-' x 78, "\n";
4181 ##################################################
4182 # Check that the Exim user can access stuff #
4183 ##################################################
4185 # We delay this test till here so that we can check access to the actual test
4186 # binary. This will be needed when Exim re-exec's itself to do deliveries.
4188 print "Exim user is $parm_eximuser ($parm_exim_uid)\n";
4189 print "Exim group is $parm_eximgroup ($parm_exim_gid)\n";
4191 if ($parm_caller_uid eq $parm_exim_uid) {
4192 tests_exit(-1, "Exim user ($parm_eximuser,$parm_exim_uid) cannot be "
4193 ."the same as caller ($parm_caller,$parm_caller_uid)");
4195 if ($parm_caller_gid eq $parm_exim_gid) {
4196 tests_exit(-1, "Exim group ($parm_eximgroup,$parm_exim_gid) cannot be "
4197 ."the same as caller's ($parm_caller) group as it confuses "
4198 ."results analysis");
4201 print "The Exim user needs access to the test suite directory. Checking ...";
4203 if (($rc = system("sudo bin/checkaccess $parm_cwd/eximdir/exim $parm_eximuser $parm_eximgroup")) != 0)
4205 my($why) = "unknown failure $rc";
4207 $why = "Couldn't find user \"$parm_eximuser\"" if $rc == 1;
4208 $why = "Couldn't find group \"$parm_eximgroup\"" if $rc == 2;
4209 $why = "Couldn't read auxiliary group list" if $rc == 3;
4210 $why = "Couldn't get rid of auxiliary groups" if $rc == 4;
4211 $why = "Couldn't set gid" if $rc == 5;
4212 $why = "Couldn't set uid" if $rc == 6;
4213 $why = "Couldn't open \"$parm_cwd/eximdir/exim\"" if $rc == 7;
4214 print "\n** $why\n";
4215 tests_exit(-1, "$parm_eximuser cannot access the test suite directory");
4222 tests_exit(-1, "Failed to unlink $log_summary_filename: $!")
4223 if not unlink($log_summary_filename) and -e $log_summary_filename;
4225 ##################################################
4226 # Create a list of available tests #
4227 ##################################################
4229 # The scripts directory contains a number of subdirectories whose names are
4230 # of the form 0000-xxxx, 1100-xxxx, 2000-xxxx, etc. Each set of tests apart
4231 # from the first requires certain optional features to be included in the Exim
4232 # binary. These requirements are contained in a file called "REQUIRES" within
4233 # the directory. We scan all these tests, discarding those that cannot be run
4234 # because the current binary does not support the right facilities, and also
4235 # those that are outside the numerical range selected.
4237 printf "\nWill run %d tests between %d and %d for flavour %s\n",
4238 scalar(@wanted), $wanted[0], $wanted[-1], $flavour;
4240 print "Omitting \${dlfunc expansion tests (loadable module not present)\n"
4242 print "Omitting dbm tests (unable to copy exim_dbmbuild)\n"
4243 if $dbm_build_deleted;
4246 my @test_dirs = grep { not /^CVS$/ } map { basename $_ } glob 'scripts/*'
4247 or die tests_exit(-1, "Failed to find test scripts in 'scripts/*`: $!");
4249 # Scan for relevant tests
4250 # HS12: Needs to be reworked.
4251 DIR: for (my $i = 0; $i < @test_dirs; $i++)
4253 my($testdir) = $test_dirs[$i];
4256 print ">>Checking $testdir\n" if $debug;
4258 # Skip this directory if the first test is equal or greater than the first
4259 # test in the next directory.
4261 next DIR if ($i < @test_dirs - 1) &&
4262 ($wanted[0] >= substr($test_dirs[$i+1], 0, 4));
4264 # No need to carry on if the end test is less than the first test in this
4267 last DIR if $wanted[-1] < substr($testdir, 0, 4);
4269 # Check requirements, if any.
4271 if (open(my $requires, "scripts/$testdir/REQUIRES"))
4277 if (/^support (.*)$/)
4279 if (!defined $parm_support{$1}) { $wantthis = 0; last; }
4281 elsif (/^running (.*)$/)
4283 if (!defined $parm_running{$1}) { $wantthis = 0; last; }
4285 elsif (/^lookup (.*)$/)
4287 if (!defined $parm_lookups{$1}) { $wantthis = 0; last; }
4289 elsif (/^authenticators? (.*)$/)
4291 if (!defined $parm_authenticators{$1}) { $wantthis = 0; last; }
4293 elsif (/^router (.*)$/)
4295 if (!defined $parm_routers{$1}) { $wantthis = 0; last; }
4297 elsif (/^transport (.*)$/)
4299 if (!defined $parm_transports{$1}) { $wantthis = 0; last; }
4301 elsif (/^malware (.*)$/)
4303 if (!defined $parm_malware{$1}) { $wantthis = 0; last; }
4305 elsif (/^(not )?feature (.*)$/)
4306 { #a macro name, or lack thereof - -bP macros
4307 # move to a subroutine?
4308 my $eximinfo = "$parm_exim -C $parm_cwd/test-config -DDIR=$parm_cwd -bP macro $2";
4310 open (IN, "$parm_cwd/confs/0000") ||
4311 tests_exit(-1, "Couldn't open $parm_cwd/confs/0000: $!\n");
4312 open (OUT, ">test-config") ||
4313 tests_exit(-1, "Couldn't open test-config: $!\n");
4316 do_substitute($testno);
4322 system($eximinfo . " >/dev/null 2>&1");
4323 if (!defined $1 && $? != 0 || defined $1 && $? == 0) {
4325 unlink("$parm_cwd/test-config");
4326 $_ = $1 || "" . "feature $2";
4329 unlink("$parm_cwd/test-config");
4331 elsif (/^ipv6-non-linklocal/)
4333 if ($parm_ipv6 =~ /%/) { $wantthis = 0; last; }
4337 tests_exit(-1, "Unknown line in \"scripts/$testdir/REQUIRES\": \"$_\"");
4343 tests_exit(-1, "Failed to open \"scripts/$testdir/REQUIRES\": $!")
4347 # Loop if we do not want the tests in this subdirectory.
4352 print "Omitting tests in $testdir (missing $_)\n";
4355 # We want the tests from this subdirectory, provided they are in the
4356 # range that was selected.
4359 map { push @testlist, $_ if exists $wanted{$_} } grep { /^\d+(?:\.\d+)?$/ } map { basename $_ } glob "scripts/$testdir/*";
4361 tests_exit(-1, "Failed to read test scripts from `scripts/$testdir/*': $!")
4364 foreach $test (@testlist)
4368 log_test($log_summary_filename, $test, '.');
4372 push @test_list, "$testdir/$test";
4377 print ">>Test List:\n", join "\n", @test_list, '' if $debug;
4380 ##################################################
4381 # Munge variable auxiliary data #
4382 ##################################################
4384 # Some of the auxiliary data files have to refer to the current testing
4385 # directory and other parameter data. The generic versions of these files are
4386 # stored in the aux-var-src directory. At this point, we copy each of them
4387 # to the aux-var directory, making appropriate substitutions. There aren't very
4388 # many of them, so it's easiest just to do this every time. Ensure the mode
4389 # is standardized, as this path is used as a test for the ${stat: expansion.
4391 # A similar job has to be done for the files in the dnszones-src directory, to
4392 # make the fake DNS zones for testing. Most of the zone files are copied to
4393 # files of the same name, but db.ipv4.V4NET and db.ipv6.V6NET use the testing
4394 # networks that are defined by parameter.
4396 foreach $basedir ("aux-var", "dnszones")
4398 system("sudo rm -rf $parm_cwd/$basedir");
4399 mkdir("$parm_cwd/$basedir", 0777);
4400 chmod(0755, "$parm_cwd/$basedir");
4402 opendir(AUX, "$parm_cwd/$basedir-src") ||
4403 tests_exit(-1, "Failed to opendir $parm_cwd/$basedir-src: $!");
4404 my(@filelist) = readdir(AUX);
4407 foreach $file (@filelist)
4409 my($outfile) = $file;
4410 next if $file =~ /^\./;
4412 if ($file eq "db.ip4.V4NET")
4414 $outfile = "db.ip4.$parm_ipv4_test_net";
4416 elsif ($file eq "db.ip6.V6NET")
4418 my(@nibbles) = reverse(split /\s*/, $parm_ipv6_test_net);
4420 $outfile = "db.ip6.@nibbles";
4424 print ">>Copying $basedir-src/$file to $basedir/$outfile\n" if $debug;
4425 open(IN, "$parm_cwd/$basedir-src/$file") ||
4426 tests_exit(-1, "Failed to open $parm_cwd/$basedir-src/$file: $!");
4427 open(OUT, ">$parm_cwd/$basedir/$outfile") ||
4428 tests_exit(-1, "Failed to open $parm_cwd/$basedir/$outfile: $!");
4439 # Set a user's shell, distinguishable from /bin/sh
4441 symlink('/bin/sh' => 'aux-var/sh');
4442 $ENV{SHELL} = $parm_shell = "$parm_cwd/aux-var/sh";
4444 ##################################################
4445 # Create fake DNS zones for this host #
4446 ##################################################
4448 # There are fixed zone files for 127.0.0.1 and ::1, but we also want to be
4449 # sure that there are forward and reverse registrations for this host, using
4450 # its real IP addresses. Dynamically created zone files achieve this.
4452 if ($have_ipv4 || $have_ipv6)
4454 my($shortname,$domain) = $parm_hostname =~ /^([^.]+)(.*)/;
4455 open(OUT, ">$parm_cwd/dnszones/db$domain") ||
4456 tests_exit(-1, "Failed to open $parm_cwd/dnszones/db$domain: $!");
4457 print OUT "; This is a dynamically constructed fake zone file.\n" .
4458 "; The following line causes fakens to return PASS_ON\n" .
4459 "; for queries that it cannot answer\n\n" .
4460 "PASS ON NOT FOUND\n\n";
4461 print OUT "$shortname A $parm_ipv4\n" if $have_ipv4;
4462 print OUT "$shortname AAAA $parm_ipv6_stripped\n" if $have_ipv6;
4463 print OUT "\n; End\n";
4467 if ($have_ipv4 && $parm_ipv4 ne "127.0.0.1")
4469 my(@components) = $parm_ipv4 =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)/;
4471 if ($components[0]=='10')
4473 open(OUT, ">>$parm_cwd/dnszones/db.ip4.$components[0]") ||
4474 tests_exit(-1, "Failed to open $parm_cwd/dnszones/db.ip4.$components[0]: $!");
4475 print OUT "$components[3].$components[2].$components[1] PTR $parm_hostname.\n\n";
4480 open(OUT, ">$parm_cwd/dnszones/db.ip4.$components[0]") ||
4482 "Failed to open $parm_cwd/dnszones/db.ip4.$components[0]: $!");
4483 print OUT "; This is a dynamically constructed fake zone file.\n" .
4484 "; The zone is $components[0].in-addr.arpa.\n\n" .
4485 "$components[3].$components[2].$components[1] PTR $parm_hostname.\n\n" .
4491 if ($have_ipv6 && $parm_ipv6_stripped ne "::1")
4493 my($exp_v6) = $parm_ipv6_stripped;
4494 $exp_v6 =~ s/[^:]//g;
4495 if ( $parm_ipv6_stripped =~ /^([^:].+)::$/ ) {
4496 $exp_v6 = $1 . ':0' x (9-length($exp_v6));
4497 } elsif ( $parm_ipv6_stripped =~ /^(.+)::(.+)$/ ) {
4498 $exp_v6 = $1 . ':0' x (8-length($exp_v6)) . ':' . $2;
4499 } elsif ( $parm_ipv6_stripped =~ /^::(.+[^:])$/ ) {
4500 $exp_v6 = '0:' x (9-length($exp_v6)) . $1;
4502 $exp_v6 = $parm_ipv6_stripped;
4504 my(@components) = split /:/, $exp_v6;
4505 my(@nibbles) = reverse (split /\s*/, shift @components);
4509 open(OUT, ">$parm_cwd/dnszones/db.ip6.@nibbles") ||
4511 "Failed to open $parm_cwd/dnszones/db.ip6.@nibbles: $!");
4512 print OUT "; This is a dynamically constructed fake zone file.\n" .
4513 "; The zone is @nibbles.ip6.arpa.\n\n";
4515 @components = reverse @components;
4516 foreach $c (@components)
4518 $c = "0$c" until $c =~ /^..../;
4519 @nibbles = reverse(split /\s*/, $c);
4520 print OUT "$sep@nibbles";
4524 print OUT " PTR $parm_hostname.\n\n; End\n";
4531 ##################################################
4532 # Create lists of mailboxes and message logs #
4533 ##################################################
4535 # We use these lists to check that a test has created the expected files. It
4536 # should be faster than looking for the file each time. For mailboxes, we have
4537 # to scan a complete subtree, in order to handle maildirs. For msglogs, there
4538 # is just a flat list of files.
4540 @oldmails = list_files_below("mail");
4541 opendir(DIR, "msglog") || tests_exit(-1, "Failed to opendir msglog: $!");
4542 @oldmsglogs = readdir(DIR);
4547 ##################################################
4548 # Run the required tests #
4549 ##################################################
4551 # Each test script contains a number of tests, separated by a line that
4552 # contains ****. We open input from the terminal so that we can read responses
4555 if (not $force_continue) {
4556 # runtest needs to interact if we're not in continue
4557 # mode. It does so by communicate to /dev/tty
4558 open(T, '<', '/dev/tty') or tests_exit(-1, "Failed to open /dev/tty: $!");
4559 print "\nPress RETURN to run the tests: ";
4565 foreach $test (@test_list)
4567 state $lasttestdir = '';
4570 local $commandno = 0;
4571 local $subtestno = 0;
4574 (local $testno = $test) =~ s|.*/||;
4576 # Leaving traces in the process table and in the environment
4577 # gives us a chance to identify hanging processes (exim daemons)
4578 local $0 = "[runtest $testno]";
4579 local $ENV{EXIM_TEST_NUMBER} = $testno;
4583 my $thistestdir = substr($test, 0, -5);
4585 $dynamic_socket->close() if $dynamic_socket;
4587 if ($lasttestdir ne $thistestdir)
4590 if (-s "scripts/$thistestdir/REQUIRES")
4593 print "\n>>> The following tests require: ";
4594 open(my $requires, '<', "scripts/$thistestdir/REQUIRES") ||
4595 tests_exit(-1, "Failed to open scripts/$thistestdir/REQUIRES: $!");
4598 $gnutls = 1 if /^support GnuTLS/;
4603 $lasttestdir = $thistestdir;
4606 # Remove any debris in the spool directory and the test-mail directory
4607 # and also the files for collecting stdout and stderr. Then put back
4608 # the test-mail directory for appendfile deliveries.
4610 system "sudo /bin/rm -rf spool test-*";
4613 # A privileged Exim will normally make its own spool directory, but some of
4614 # the tests run in unprivileged modes that don't always work if the spool
4615 # directory isn't already there. What is more, we want anybody to be able
4616 # to read it in order to find the daemon's pid.
4619 system "sudo chown $parm_eximuser:$parm_eximgroup spool; " .
4620 "sudo chmod 0755 spool";
4622 # Empty the cache that keeps track of things like message id mappings, and
4623 # set up the initial sequence strings.
4626 $next_msgid_old = "aX";
4638 $TEST_STATE->{munge} = '';
4640 # Remove the associative arrays used to hold checked mail files and msglogs
4642 undef %expected_mails;
4643 undef %expected_msglogs;
4645 # Open the test's script
4646 open(SCRIPT, "scripts/$test") ||
4647 tests_exit(-1, "Failed to open \"scripts/$test\": $!");
4648 # Run through the script once to set variables which should be global
4651 if (/^no_message_check/) { $message_skip = 1; next; }
4652 if (/^no_msglog_check/) { $msglog_skip = 1; next; }
4653 if (/^no_munge/) { $munge_skip = 1; next; }
4654 if (/^no_stderr_check/) { $stderr_skip = 1; next; }
4655 if (/^no_stdout_check/) { $stdout_skip = 1; next; }
4656 if (/^rmfiltertest/) { $rmfiltertest = 1; next; }
4657 if (/^sortlog/) { $sortlog = 1; next; }
4658 if (/\bPORT_DYNAMIC\b/) { $dynamic_socket = Exim::Runtest::dynamic_socket(); next; }
4660 # Reset to beginning of file for per test interpreting/processing
4663 # The first line in the script must be a comment that is used to identify
4664 # the set of tests as a whole.
4668 tests_exit(-1, "Missing identifying comment at start of $test") if (!/^#/);
4669 printf("%s %s", (substr $test, 5), (substr $_, 2));
4671 # Loop for each of the subtests within the script. The variable $server_pid
4672 # is used to remember the pid of a "server" process, for which we do not
4673 # wait until we have waited for a subsequent command.
4675 local($server_pid) = 0;
4676 for ($commandno = 1; !eof SCRIPT; $commandno++)
4678 # Skip further leading comments and blank lines, handle the flag setting
4679 # commands, and deal with tests for IP support.
4684 # Could remove these variable settings because they are already
4685 # set above, but doesn't hurt to leave them here.
4686 if (/^no_message_check/) { $message_skip = 1; next; }
4687 if (/^no_msglog_check/) { $msglog_skip = 1; next; }
4688 if (/^no_munge/) { $munge_skip = 1; next; }
4689 if (/^no_stderr_check/) { $stderr_skip = 1; next; }
4690 if (/^no_stdout_check/) { $stdout_skip = 1; next; }
4691 if (/^rmfiltertest/) { $rmfiltertest = 1; next; }
4692 if (/^sortlog/) { $sortlog = 1; next; }
4694 if (/^need_largefiles/)
4696 next if $have_largefiles;
4697 print ">>> Large file support is needed for test $testno, but is not available: skipping\n";
4698 $docheck = 0; # don't check output
4699 undef $_; # pretend EOF
4706 print ">>> IPv4 is needed for test $testno, but is not available: skipping\n";
4707 $docheck = 0; # don't check output
4708 undef $_; # pretend EOF
4719 print ">>> IPv6 is needed for test $testno, but is not available: skipping\n";
4720 $docheck = 0; # don't check output
4721 undef $_; # pretend EOF
4725 if (/^need_move_frozen_messages/)
4727 next if defined $parm_support{move_frozen_messages};
4728 print ">>> move frozen message support is needed for test $testno, " .
4729 "but is not\n>>> available: skipping\n";
4730 $docheck = 0; # don't check output
4731 undef $_; # pretend EOF
4735 last unless /^(?:#(?!##\s)|\s*$)/;
4737 last if !defined $_; # Hit EOF
4739 my($subtest_startline) = $lineno;
4741 # Now run the command. The function returns 0 for an inline command,
4742 # 1 if a non-exim command was run and waited for, 2 if an exim
4743 # command was run and waited for, and 3 if a command
4744 # was run and not waited for (usually a daemon or server startup).
4746 my($commandname) = '';
4747 my($expectrc, $expect_not) = (0, 0);
4748 my($rc, $run_extra) = run_command($testno, \$subtestno, \$expectrc, \$expect_not, \$commandname, $TEST_STATE);
4752 print ">> rc=$rc cmdrc=$cmdrc\n";
4753 if (defined $run_extra) {
4754 foreach my $k (keys %$run_extra) {
4755 my $v = defined $run_extra->{$k} ? qq!"$run_extra->{$k}"! : '<undef>';
4756 print ">> $k -> $v\n";
4760 $run_extra = {} unless defined $run_extra;
4761 foreach my $k (keys %$run_extra) {
4762 if (exists $TEST_STATE->{$k}) {
4763 my $nv = defined $run_extra->{$k} ? qq!"$run_extra->{$k}"! : 'removed';
4764 print ">> override of $k; was $TEST_STATE->{$k}, now $nv\n" if $debug;
4766 if (defined $run_extra->{$k}) {
4767 $TEST_STATE->{$k} = $run_extra->{$k};
4768 } elsif (exists $TEST_STATE->{$k}) {
4769 delete $TEST_STATE->{$k};
4773 # Hit EOF after an initial return code number
4775 tests_exit(-1, "Unexpected EOF in script") if ($rc == 4);
4777 # Carry on with the next command if we did not wait for this one. $rc == 0
4778 # if no subprocess was run; $rc == 3 if we started a process but did not
4781 next if ($rc == 0 || $rc == 3);
4783 # We ran and waited for a command. Check for the expected result unless
4786 if (!$sigpipehappened && ($expect_not ? ($cmdrc == $expectrc) : ($cmdrc != $expectrc)))
4788 printf("** Command $commandno (\"$commandname\", starting at line $subtest_startline)\n");
4789 if (($cmdrc & 0xff) == 0)
4792 { printf("** Return code %d (expected anything but that)", $cmdrc/256); }
4794 { printf("** Return code %d (expected %d)", $cmdrc/256, $expectrc/256); }
4796 elsif (($cmdrc & 0xff00) == 0)
4797 { printf("** Killed by signal %d", $cmdrc & 255); }
4799 { printf("** Status %x", $cmdrc); }
4803 print "\nshow stdErr, show stdOut, Retry, Continue (without file comparison), or Quit? [Q] ";
4804 $_ = $force_continue ? "c" : <T>;
4805 tests_exit(1) if /^q?$/i;
4806 if (/^c$/ && $force_continue)
4808 log_failure($log_failed_filename, $testno, "exit code unexpected");
4809 log_test($log_summary_filename, $testno, 'F');
4812 if ($force_continue)
4814 print "\nstdout tail:\n";
4815 print "==================>\n";
4816 system("tail -20 test-stdout");
4817 print "===================\n";
4819 print "stderr tail:\n";
4820 print "==================>\n";
4821 system("tail -30 test-stderr");
4822 print "===================\n";
4824 print "stdout-server tail:\n";
4825 print "==================>\n";
4826 system("tail -20 test-stdout-server");
4827 print "===================\n";
4829 print "stderr-server tail:\n";
4830 print "==================>\n";
4831 system("tail -30 test-stderr-server");
4832 print "===================\n";
4834 print "... continue forced\n";
4840 system @more => 'test-stderr';
4844 system @more => 'test-stdout';
4848 $retry = 1 if /^r$/i;
4852 # If the command was exim, and a listening server is running, we can now
4853 # close its input, which causes us to wait for it to finish, which is why
4854 # we didn't close it earlier.
4856 if ($rc == 2 && $server_pid != 0)
4862 if (($? & 0xff) == 0)
4863 { printf("Server return code %d for test %d starting line %d", $?/256,
4864 $testno, $subtest_startline); }
4865 elsif (($? & 0xff00) == 0)
4866 { printf("Server killed by signal %d", $? & 255); }
4868 { printf("Server status %x", $?); }
4872 print "\nShow server stdout, Retry, Continue, or Quit? [Q] ";
4873 $_ = $force_continue ? "c" : <T>;
4874 tests_exit(1) if /^q?$/i;
4875 if (/^c$/ && $force_continue)
4877 log_failure($log_failed_filename, $testno, "exit code unexpected");
4878 log_test($log_summary_filename, $testno, 'F');
4881 print "... continue forced\n" if $force_continue;
4886 open(S, "test-stdout-server") ||
4887 tests_exit(-1, "Failed to open test-stdout-server: $!");
4892 $retry = 1 if /^r$/i;
4899 # The script has finished. Check the all the output that was generated. The
4900 # function returns 0 for a perfect pass, 1 if imperfect but ok, 2 if we should
4901 # rerun the test (the files # have been updated).
4902 # It does not return if the user responds Q to a prompt.
4907 print (("#" x 79) . "\n");
4914 my $rc = check_output($TEST_STATE->{munge});
4917 log_test($log_summary_filename, $testno, 'P');
4925 print (" Script completed\n");
4929 print (("#" x 79) . "\n");
4936 ##################################################
4937 # Exit from the test script #
4938 ##################################################
4940 tests_exit(-1, "No runnable tests selected") if not @test_list;
4941 tests_exit($fail_any ? $failures : 0);
4947 runtest - run the exim testsuite
4951 runtest [exim-path] [options] [test0 [test1]]
4955 B<runtest> runs the Exim testsuite.
4959 For legacy reasons the options are not case sensitive.
4965 Do not stop for user interaction or on errors. (default: off)
4969 This option enables the output of debug information when running the
4970 various test commands. (default: off)
4974 Use C<diff -u> for comparing the expected output with the produced
4975 output. (default: use a built-in routine)
4977 =item B<--flavor>|B<--flavour> I<flavour>
4979 Override the expected results for results for a specific (OS) flavour.
4984 Skip IPv4 related setup and tests (default: use ipv4)
4988 Skip IPv6 related setup and tests (default: use ipv6)
4992 Keep the various output files produced during a test run. (default: don't keep)
4994 =item B<--range> I<n0> I<n1>
4996 Run tests between (including) I<n0> and I<n1>. A "+" may be used to specify the "last
5001 Insert some delays to compensate for a slow host system. (default: off)
5003 =item B<--test> I<n>
5005 Run the specified test. This option may used multiple times.
5009 Automatically update the recorded (expected) data on mismatch. (default: off)
5013 Start Exim wrapped by I<valgrind>. (default: don't use valgrind)
5021 # End of runtest script