OpenSSL: add remote host info to log line for in-connection TLS error. Bug 3010
[exim.git] / test / runtest
1 #! /usr/bin/env perl
2 # We use env, because in some environments of our build farm
3 # the Perl 5.010 interpreter is only reachable via $PATH
4
5 ###############################################################################
6 # This is the controlling script for the "new" test suite for Exim. It should #
7 # be possible to export this suite for running on a wide variety of hosts, in #
8 # contrast to the old suite, which was very dependent on the environment of   #
9 # Philip Hazel's desktop computer. This implementation inspects the version   #
10 # of Exim that it finds, and tests only those features that are included. The #
11 # surrounding environment is also tested to discover what is available. See   #
12 # the README file for details of how it all works.                            #
13 #                                                                             #
14 # Implementation started: 03 August 2005 by Philip Hazel                      #
15 # Placed in the Exim CVS: 06 February 2006                                    #
16 ###############################################################################
17
18 #use strict;
19 use v5.10.1;
20 use warnings;
21 use if $^V >= v5.19.11, experimental => 'smartmatch';
22
23 use Errno;
24 use FileHandle;
25 use Socket;
26 use Time::Local;
27 use Cwd;
28 use File::Basename;
29 use Pod::Usage;
30 use Getopt::Long;
31 use FindBin qw'$RealBin';
32 use File::Copy;
33
34 use lib "$RealBin/lib";
35 use Exim::Runtest;
36 use Exim::Utils qw(uniq numerically cp);
37
38 use if $ENV{DEBUG} && scalar($ENV{DEBUG} =~ /\bruntest\b/) => 'Smart::Comments' => '####';
39 use if $ENV{DEBUG} && scalar($ENV{DEBUG} =~ /\bruntest\b/) => 'Data::Dumper';
40
41 use constant TEST_TOP => 8999;
42 use constant TEST_SPECIAL_TOP => 9999;
43
44
45 # Start by initializing some global variables
46
47 chomp(my $testversion = `git describe --always --dirty 2>&1` || '<unknown>');
48
49 # This gets embedded in the D-H params filename, and the value comes
50 # from asking GnuTLS for "normal", but there appears to be no way to
51 # use certtool/... to ask what that value currently is.  *sigh*
52 # We also clamp it because of NSS interop, see addition of tls_dh_max_bits.
53 # This value is correct as of GnuTLS 2.12.18 as clamped by tls_dh_max_bits.
54 # normal = 2432   tls_dh_max_bits = 2236
55 my $gnutls_dh_bits_normal = 2236;
56
57 my $cf = 'bin/cf -exact';
58 my $cr = "\r";
59 my $debug = 0;
60 my $flavour = do {
61   my $f = Exim::Runtest::flavour() // '';
62   (grep { $f eq $_ } Exim::Runtest::flavours()) ? $f : 'FOO';
63 };
64 my $force_continue = 0;
65 my $force_update = 0;
66 my $log_failed_filename = 'failed-summary.log';
67 my $log_summary_filename = 'run-summary.log';
68 my @more = qw'less -XF';
69 my $optargs = '';
70 my $save_output = 0;
71 my $server_opts = '';
72 my $slow = 0;
73 my $valgrind = 0;
74
75 my $have_ipv4 = 1;
76 my $have_ipv6 = 1;
77 my $have_largefiles = 0;
78
79 my @test_list = ();
80
81
82 # Networks to use for DNS tests. We need to choose some networks that will
83 # never be used so that there is no chance that the host on which we are
84 # running is actually in one of the test networks. Private networks such as
85 # the IPv4 10.0.0.0/8 network are no good because hosts may well use them.
86 # Rather than use some unassigned numbers (that might become assigned later),
87 # I have chosen some multicast networks, in the belief that such addresses
88 # won't ever be assigned to hosts. This is the only place where these numbers
89 # are defined, so it is trivially possible to change them should that ever
90 # become necessary.
91
92 my $parm_ipv4_test_net = 224;
93 my $parm_ipv6_test_net = 'ff00';
94
95 # Port numbers are currently hard-wired
96
97 my $parm_port_n = 1223;         # Nothing listening on this port
98 my $parm_port_s = 1224;         # Used for the "server" command
99 my $parm_port_d = 1225;         # Used for the Exim daemon
100 my $parm_port_d2 = 1226;        # Additional for daemon
101 my $parm_port_d3 = 1227;        # Additional for daemon
102 my $parm_port_d4 = 1228;        # Additional for daemon
103 my $dynamic_socket;          # allocated later for PORT_DYNAMIC
104
105 # Find a suiteable group name for test (currently only 0001
106 # uses a group name. A numeric group id would do
107 my $parm_mailgroup = Exim::Runtest::mailgroup('mail');
108
109 # Manually set locale
110 $ENV{LC_ALL} = 'C';
111
112 # In some environments USER does not exist, but we need it for some test(s)
113 $ENV{USER} = getpwuid($>) if not exists $ENV{USER};
114
115 my ($parm_configure_owner, $parm_configure_group);
116 my ($parm_ipv4, $parm_ipv6, $parm_ipv6_stripped);
117 my $parm_hostname;
118
119 ###############################################################################
120 ###############################################################################
121
122 # Define a number of subroutines
123
124 ###############################################################################
125 ###############################################################################
126
127
128 ##################################################
129 #              Handle signals                    #
130 ##################################################
131
132 sub pipehandler { $sigpipehappened = 1; }
133
134 sub inthandler { print "\n"; tests_exit(-1, "Caught SIGINT"); }
135
136
137 ##################################################
138 #       Do global macro substitutions            #
139 ##################################################
140
141 # This function is applied to configurations, command lines and data lines in
142 # scripts, and to lines in the files of the aux-var-src and the dnszones-src
143 # directory. It takes one argument: the current test number, or zero when
144 # setting up files before running any tests.
145
146 sub do_substitute{
147 s?\bCALLER\b?$parm_caller?g;
148 s?\bCALLERGROUP\b?$parm_caller_group?g;
149 s?\bCALLER_UID\b?$parm_caller_uid?g;
150 s?\bCALLER_GID\b?$parm_caller_gid?g;
151 s?\bCLAMSOCKET\b?$parm_clamsocket?g;
152 s?\bDIR/?$parm_cwd/?g;
153 s?\bEXIMGROUP\b?$parm_eximgroup?g;
154 s?\bEXIMUSER\b?$parm_eximuser?g;
155 s?\bHOSTIPV4\b?$parm_ipv4?g;
156 s?\bHOSTIPV6\b?$parm_ipv6?g;
157 s?\bHOSTNAME\b?$parm_hostname?g;
158 s?\bPORT_D\b?$parm_port_d?g;
159 s?\bPORT_D2\b?$parm_port_d2?g;
160 s?\bPORT_D3\b?$parm_port_d3?g;
161 s?\bPORT_D4\b?$parm_port_d4?g;
162 s?\bPORT_N\b?$parm_port_n?g;
163 s?\bPORT_S\b?$parm_port_s?g;
164 s?\bTESTNUM\b?$_[0]?g;
165 s?(\b|_)V4NET([\._])?$1$parm_ipv4_test_net$2?g;
166 s?\bV6NET:?$parm_ipv6_test_net:?g;
167 s?\bPORT_DYNAMIC\b?$dynamic_socket->sockport()?eg;
168 s?\bMAILGROUP\b?$parm_mailgroup?g;
169 }
170
171
172 ##################################################
173 #     Any state to be preserved across tests     #
174 ##################################################
175
176 my $TEST_STATE = {};
177
178
179 ##################################################
180 #        Subroutine to tidy up and exit          #
181 ##################################################
182
183 # In all cases, we check for any Exim daemons that have been left running, and
184 # kill them. Then remove all the spool data, test output, and the modified Exim
185 # binary if we are ending normally.
186
187 # Arguments:
188 #    $_[0] = 0 for a normal exit; full cleanup done
189 #    $_[0] > 0 for an error exit; no files cleaned up
190 #    $_[0] < 0 for a "die" exit; $_[1] contains a message
191
192 sub tests_exit{
193 my($rc) = $_[0];
194 my($spool);
195
196 # Search for daemon pid files and kill the daemons. We kill with SIGINT rather
197 # than SIGTERM to stop it outputting "Terminated" to the terminal when not in
198 # the background.
199
200 if (exists $TEST_STATE->{exim_pid})
201   {
202   $pid = $TEST_STATE->{exim_pid};
203   print "Tidyup: killing wait-mode daemon pid=$pid\n";
204   system("sudo kill -INT $pid");
205   }
206
207 if (opendir(DIR, "spool"))
208   {
209   my(@spools) = sort readdir(DIR);
210   closedir(DIR);
211   foreach $spool (@spools)
212     {
213     next if $spool !~ /^exim-daemon./;
214     open(PID, "spool/$spool") || die "** Failed to open \"spool/$spool\": $!\n";
215     chomp($pid = <PID>);
216     close(PID);
217     print "Tidyup: killing daemon pid=$pid\n";
218     system("sudo rm -f spool/$spool; sudo kill -INT $pid");
219     }
220   }
221 else
222   { die "** Failed to opendir(\"spool\"): $!\n" unless $!{ENOENT}; }
223
224 # Close the terminal input and remove the test files if all went well, unless
225 # the option to save them is set. Always remove the patched Exim binary. Then
226 # exit normally, or die.
227
228 close(T);
229 system("sudo /bin/rm -rf ./spool test-* ./dnszones/*")
230   if ($rc == 0 && !$save_output);
231
232 system("sudo /bin/rm -rf ./eximdir/*")
233   if (!$save_output);
234
235 print "\nYou were in test $test at the end there.\n\n" if defined $test;
236 exit $rc if ($rc >= 0);
237 die "** runtest error: $_[1]\n";
238 }
239
240
241
242 ##################################################
243 #   Subroutines used by the munging subroutine   #
244 ##################################################
245
246 # This function is used for things like message ids, where we want to generate
247 # more than one value, but keep a consistent mapping throughout.
248 #
249 # Arguments:
250 #   $oldid        the value from the file
251 #   $base         a base string into which we insert a sequence
252 #   $sequence     the address of the current sequence counter
253
254 sub new_value {
255 my($oldid, $base, $sequence) = @_;
256 my($newid) = $cache{$oldid};
257 print ">> replace  $oldid -> $newid\n" if ($debug && defined $newid);
258 if (! defined $newid)
259   {
260   $newid = sprintf($base, $$sequence++);
261   print ">> new      $oldid -> $newid\n" if $debug;
262   $cache{$oldid} = $newid;
263   }
264 return $newid;
265 }
266
267
268 # This is used while munging the output from exim_dumpdb.
269 # May go wrong across DST changes.
270
271 sub date_seconds {
272 my($day,$month,$year,$hour,$min,$sec) =
273   $_[0] =~ /^(\d\d)-(\w\w\w)-(\d{4})\s(\d\d):(\d\d):(\d\d)/;
274 my($mon);
275 if   ($month =~ /Jan/) {$mon = 0;}
276 elsif($month =~ /Feb/) {$mon = 1;}
277 elsif($month =~ /Mar/) {$mon = 2;}
278 elsif($month =~ /Apr/) {$mon = 3;}
279 elsif($month =~ /May/) {$mon = 4;}
280 elsif($month =~ /Jun/) {$mon = 5;}
281 elsif($month =~ /Jul/) {$mon = 6;}
282 elsif($month =~ /Aug/) {$mon = 7;}
283 elsif($month =~ /Sep/) {$mon = 8;}
284 elsif($month =~ /Oct/) {$mon = 9;}
285 elsif($month =~ /Nov/) {$mon = 10;}
286 elsif($month =~ /Dec/) {$mon = 11;}
287 return timelocal($sec,$min,$hour,$day,$mon,$year);
288 }
289
290
291 # This is a subroutine to sort maildir files into time-order. The second field
292 # is the microsecond field, and may vary in length, so must be compared
293 # numerically.
294
295 sub maildirsort {
296 return $a cmp $b if ($a !~ /^\d+\.H\d/ || $b !~ /^\d+\.H\d/);
297 my($x1,$y1) = $a =~ /^(\d+)\.H(\d+)/;
298 my($x2,$y2) = $b =~ /^(\d+)\.H(\d+)/;
299 return ($x1 != $x2)? ($x1 <=> $x2) : ($y1 <=> $y2);
300 }
301
302
303
304 ##################################################
305 #   Subroutine list files below a directory      #
306 ##################################################
307
308 # This is used to build up a list of expected mail files below a certain path
309 # in the directory tree. It has to be recursive in order to deal with multiple
310 # maildir mailboxes.
311
312 sub list_files_below {
313 my($dir) = $_[0];
314 my(@yield) = ();
315 my(@sublist, $file);
316
317 opendir(DIR, $dir) || tests_exit(-1, "Failed to open $dir: $!");
318 @sublist = sort maildirsort readdir(DIR);
319 closedir(DIR);
320
321 foreach $file (@sublist)
322   {
323   next if $file eq "." || $file eq ".." || $file eq "CVS";
324   if (-d "$dir/$file")
325     { @yield = (@yield, list_files_below("$dir/$file")); }
326   else
327     { push @yield, "$dir/$file"; }
328   }
329
330 return @yield;
331 }
332
333
334
335 ##################################################
336 #         Munge a file before comparing          #
337 ##################################################
338
339 # The pre-processing turns all dates, times, Exim versions, message ids, and so
340 # on into standard values, so that the compare works. Perl's substitution with
341 # an expression provides a neat way to do some of these changes.
342
343 # We keep a global associative array for repeatedly turning the same values
344 # into the same standard values throughout the data from a single test.
345 # Message ids get this treatment (can't be made reliable for times), and
346 # times in dumped retry databases are also handled in a special way, as are
347 # incoming port numbers and PIDs.
348
349 # On entry to the subroutine, the file to write to is already opened with the
350 # name MUNGED. The input file name is the only argument to the subroutine.
351 # Certain actions are taken only when the name contains "stderr", "stdout",
352 # or "log". The yield of the function is 1 if a line matching "*** truncated
353 # ***" is encountered; otherwise it is 0.
354
355 sub munge {
356 my($file) = $_[0];
357 my($extra) = $_[1];
358 my($yield) = 0;
359 my(@saved) = ();
360
361 local $_;
362
363 open(IN, "$file") || tests_exit(-1, "Failed to open $file: $!");
364
365 my($is_log) = $file =~ /log/;
366 my($is_stdout) = $file =~ /stdout/;
367 my($is_stderr) = $file =~ /stderr/;
368 my($is_mail) = $file =~ /mail/;
369
370 # Date pattern
371
372 $date = "\\d{2}-\\w{3}-\\d{4}\\s\\d{2}:\\d{2}:\\d{2}";
373
374 # Debug time & pid
375
376 $time_pid = "(?:\\d{2}:\\d{2}:\\d{2}\\s+\\d+\\s)";
377
378 # Pattern for matching pids at start of stderr lines; initially something
379 # that won't match.
380
381 $spid = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
382
383 # Scan the file and make the changes. Near the bottom there are some changes
384 # that are specific to certain file types, though there are also some of those
385 # inline too.
386
387 LINE: while(<IN>)
388   {
389 RESET_AFTER_EXTRA_LINE_READ:
390   if ($munge_skip)
391     {
392     # Munging is a no-op, except for exim_msgdate specials.
393     # Useful when testing exim_msgdate so that
394     # we compare unmunged dates and message-ids.
395     s%^localhost \d+ from message-id != given number \d+ at \K/.+(?=/test/eximdir/exim_msgdate line 387.$)%DIR%;
396
397     print MUNGED;
398     next;
399     }
400
401   # Custom munges
402   if ($extra)
403     {
404     next if $extra =~ m%^/%  &&  eval $extra;
405     eval $extra if $extra =~ m/^s/;
406     eval substr($extra, 1) if $extra =~ m/^R/;
407     }
408
409   # Check for "*** truncated ***"
410   $yield = 1 if /\*\*\* truncated \*\*\*/;
411
412   # Replace the name of this host
413   s/\Q$parm_hostname\E/the.local.host.name/g;
414
415   # But convert "name=the.local.host address=127.0.0.1" to use "localhost"
416   s/name=the\.local\.host address=127\.0\.0\.1/name=localhost address=127.0.0.1/g;
417
418   # The name of the shell may vary
419   s/\s\Q$parm_shell\E\b/ ENV_SHELL/;
420
421   # Replace the path to the testsuite directory
422   s?\Q$parm_cwd\E?TESTSUITE?g;
423
424   # Replace the Exim version number (may appear in various places)
425   # patchexim should have fixed this for us
426   #s/Exim \K\d+[._]\d+[\w_-]*/x.yz/i;
427
428   # Replace Exim message ids by a unique series.
429   # Both old and new formats, with separate replace series, for now.
430   s/(\d[^\W_]{5}-[^\W_]{6}-[^\W_]{2})
431     /new_value($1, "10Hm%s-0005vi-00", \$next_msgid_old)/egx;
432   s/(\d[^\W_]{5}-[^\W_]{11}-[^\W_]{4})
433     /new_value($1, "10Hm%s-000000005vi-0000", \$next_msgid)/egx;
434
435   # The names of lock files appear in some error and debug messages
436   s/\.lock(\.[-\w]+)+(\.[\da-f]+){2}/.lock.test.ex.dddddddd.pppppppp/;
437
438   # Unless we are in an IPv6 test, replace IPv4 and/or IPv6 in "listening on
439   # port" message, because it is not always the same.
440   s/port (\d+) \([^)]+\)/port $1/g
441     if !$is_ipv6test && m/listening for SMTP(S?) on port/;
442
443   # Challenges in SPA authentication
444   s/TlRMTVNTUAACAAAAAAAAAAAoAAABgg[\w+\/]+/TlRMTVNTUAACAAAAAAAAAAAoAAABggAAAEbBRwqFwwIAAAAAAAAAAAAt1sgAAAAA/;
445
446   # PRVS values
447   s?prvs=([^/]+)/[\da-f]{10}@?prvs=$1/xxxxxxxxxx@?g;    # Old form
448   s?prvs=[\da-f]{10}=([^@]+)@?prvs=xxxxxxxxxx=$1@?g;    # New form
449
450   # There are differences in error messages between OpenSSL versions
451   s/SSL_CTX_set_cipher_list/SSL_connect/;
452   s/error=\Kauthority and subject key identifier mismatch/self signed certificate/;
453   s/error=\Kself-signed certificate/self signed certificate/;
454
455   # One error test in expansions mentions base 62 or 36
456   s/is not a base (36|62) number/is not a base 36\/62 number/;
457
458   # This message sometimes has a different number of seconds
459   s/forced fail after \d seconds/forced fail after d seconds/;
460
461   # This message may contain a different DBM library name
462   s/Failed to open \S+( \([^\)]+\))? file/Failed to open DBM file/;
463
464   # The message for a non-listening FIFO varies
465   s/:[^:]+: while opening named pipe/: Error: while opening named pipe/;
466
467   # Debugging output of lists of hosts may have different sort keys
468   s/sort=\S+/sort=xx/ if /^\S+ (?:\d+\.){3}\d+ mx=\S+ sort=\S+/;
469
470   # Random local part in callout cache testing
471   s/myhost.test.ex-\d+-testing/myhost.test.ex-dddddddd-testing/;
472   s/the.local.host.name-\d+-testing/the.local.host.name-dddddddd-testing/;
473
474   # File descriptor numbers may vary
475   s/^writing data block fd=\d+/writing data block fd=dddd/;
476   s/(running as transport filter:) fd_write=\d+ fd_read=\d+/$1 fd_write=dddd fd_read=dddd/;
477
478
479   # ======== Dumpdb output ========
480   # This must be before the general date/date munging.
481   # Time data lines, which look like this:
482   # 25-Aug-2000 12:11:37  25-Aug-2000 12:11:37  26-Aug-2000 12:11:37
483   if (/^($date)\s+($date)\s+($date)(\s+\*)?\s*$/)
484     {
485     my($date1,$date2,$date3,$expired) = ($1,$2,$3,$4);
486     $expired = '' if !defined $expired;
487
488     # Round the time-difference up to nearest even value
489     my($increment) = ((date_seconds($date3) - date_seconds($date2) + 1) >> 1) << 1;
490
491     # We used to use globally unique replacement values, but timing
492     # differences make this impossible. Just show the increment on the
493     # last one.
494
495     printf MUNGED ("first failed = time last try = time2 next try = time2 + %s%s\n",
496       $increment, $expired);
497     next;
498     }
499
500   # more_errno values in exim_dumpdb output which are times
501   s/T:(\S+)\s-22\s(\S+)\s/T:$1 -22 xxxx /;
502
503   # port numbers in dumpdb output
504   s/T:([a-z.]+(:[0-9.]+)?):$parm_port_n /T:$1:PORT_N /;
505
506   # port numbers in stderr
507   s/^set_process_info: .*\]:\K$parm_port_d /PORT_D /;
508   s/^set_process_info: .*\]:\K$parm_port_s /PORT_S /;
509
510
511   # ======== Dates and times ========
512
513   # Dates and times are all turned into the same value - trying to turn
514   # them into different ones cannot be done repeatedly because they are
515   # real time stamps generated while running the test. The actual date and
516   # time used was fixed when I first started running automatic Exim tests.
517
518   # Date/time in header lines and SMTP responses
519   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}
520     /Tue, 2 Mar 1999 09:44:33 +0000/gx;
521   # and in a French locale
522   s/\S{4},\s\d\d?\s[^,]+\s\d{4}\s\d\d\:\d\d:\d\d\s[-+]\d{4}
523     /dim., 10 f\xE9vr 2019 20:05:49 +0000/gx;
524
525   # Date/time in logs and in one instance of a filter test
526   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;
527   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;
528   s/^Logwrite\s"\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d/Logwrite "1999-03-02 09:44:33/gx;
529   # Date/time in syslog test
530   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;
531   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;
532   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;
533   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;
534
535   s/((D|[RQD]T)=)\d+s/$1qqs/g;
536   s/((D|[RQD]T)=)\d\.\d{3}s/$1q.qqqs/g;
537
538   # Date/time in message separators
539   s/(?:[A-Z][a-z]{2}\s){2}\d\d\s\d\d:\d\d:\d\d\s\d\d\d\d
540     /Tue Mar 02 09:44:33 1999/gx;
541
542   # Date of message arrival in spool file as shown by -Mvh
543   s/^\d{9,10}\s0$/ddddddddd 0/;
544
545   # Date/time in mbx mailbox files
546   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;
547
548   # Dates/times in debugging output for writing retry records
549   if (/^  first failed=(\d+) last try=(\d+) next try=(\d+) (.*)$/)
550     {
551     my($next) = $3 - $2;
552     $_ = "  first failed=dddd last try=dddd next try=+$next $4\n";
553     }
554   s/^(\s*)now=\d+ first_failed=\d+ next_try=\d+ expired=(\w)/$1now=tttt first_failed=tttt next_try=tttt expired=$2/;
555   s/^(\s*)received_time=\d+ diff=\d+ timeout=(\d+)/$1received_time=tttt diff=tttt timeout=$2/;
556
557   # Time to retry may vary
558   s/time to retry = \S+/time to retry = tttt/;
559   s/retry record exists: age=\S+/retry record exists: age=ttt/;
560   s/failing_interval=\S+ message_age=\S+/failing_interval=ttt message_age=ttt/;
561
562   # Date/time in exim -bV output
563   s/\d\d-[A-Z][a-z]{2}-\d{4}\s\d\d:\d\d:\d\d/07-Mar-2000 12:21:52/g;
564
565   # Eximstats heading
566   s/Exim\sstatistics\sfrom\s\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d\sto\s
567     \d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d/Exim statistics from <time> to <time>/x;
568
569   # Treat ECONNRESET the same as ECONNREFUSED.  At least some systems give
570   # us the former on a new connection.
571   s/(could not connect to .*: Connection) reset by peer$/$1 refused/;
572
573   # ======== TLS certificate algorithms ========
574   #
575   # In Received: headers, convert RFC 8314 style ciphersuite to
576   # the older (comment) style, keeping only the Auth element
577   # (discarding kex, cipher, mac).  For TLS 1.3 there is no kex
578   # element (and no _WITH); insert a spurious "RSA".
579   # Also in $tls_X_cipher_std reporting.
580
581   s/^\s+by \S+ with .+ \K \(TLS1(?:\.[0-3])?\) tls TLS_.*?([^_]+)_WITH.+$/(TLS1.x:ke-$1-AES256-SHAnnn:xxx)/;
582   s/^\s+by \S+ with .+ \K \(TLS1(?:\.[0-3])?\) tls TLS_.+$/(TLS1.x:ke-RSA-AES256-SHAnnn:xxx)/;
583
584   s/ cipher_ TLS_.*?([^_]+)_WITH.+$/ cipher_ TLS1.x:ke_$1_WITH_ci_mac/;
585   s/ cipher_ TLS_.*$/ cipher_ TLS1.x:ke_RSA_WITH_ci_mac/;
586
587   # Test machines might have various different TLS library versions supporting
588   # different protocols; can't rely upon TLS 1.2's AES256-GCM-SHA384, so we
589   # treat the standard algorithms the same.
590   #
591   # TLSversion : KeyExchange? - Authentication/Signature - C_iph_er - MAC : bits
592   #
593   # So far, have seen:
594   #   TLSv1:AES128-GCM-SHA256:128
595   #   TLSv1:AES256-SHA:256
596   #   TLSv1.1:AES256-SHA:256
597   #   TLSv1.2:AES256-GCM-SHA384:256
598   #   TLSv1.2:DHE-RSA-AES256-SHA:256
599   #   TLSv1.3:TLS_AES_256_GCM_SHA384:256
600   #   TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128
601   # We also need to handle the ciphersuite without the TLS part present, for
602   # client-ssl's output.  We also see some older forced ciphersuites, but
603   # negotiating TLS 1.2 instead of 1.0.
604   # Mail headers (...), log-lines X=..., client-ssl output ...
605   # (and \b doesn't match between ' ' and '(' )
606   #
607   # Retain the authentication algorith field as we want to test that.
608
609   s/( (?: (?:\b|\s) [\(=] ) | \s )TLS1(\.[123])?:/$1TLS1.x:/xg;
610   s/(?<!ke-)((EC)?DHE-)?(RSA|ECDSA)-AES(128|256)-(GCM-SHA(256|384)|SHA)(?!:)/ke-$3-AES256-SHAnnn/g;
611   s/(?<!ke-)((EC)?DHE-)?(RSA|ECDSA)-AES(128|256)-(GCM-SHA(256|384)|SHA):(128|256)/ke-$3-AES256-SHAnnn:xxx/g;
612
613   # OpenSSL TLSv1.3 - unsure what to do about the authentication-variant testcases now,
614   # as it seems the protocol no longer supports a user choice.  Replace the "TLS" field with "RSA".
615   # Also insert a key-exchange field for back-compat, even though 1.3 doesn't do that.
616   #
617   # TLSversion : "TLS" - C_iph_er - MAC : ???
618   #
619   s/TLS_AES(_256)?_GCM_SHA384(?!:)/ke-RSA-AES256-SHAnnn/g;
620   s/:TLS_AES(_256)?_GCM_SHA384:256/:ke-RSA-AES256-SHAnnn:xxx/g;
621
622   # LibreSSL
623   # TLSv1:AES256-GCM-SHA384:256
624   # TLSv1:ECDHE-RSA-CHACHA20-POLY1305:256
625   # TLS1.3:AEAD-AES256-GCM-SHA384:256
626   #
627   # ECDHE-RSA-CHACHA20-POLY1305
628   # AES256-GCM-SHA384
629
630   s/(?<!-)(AES256-GCM-SHA384)/RSA-$1/;
631   s/AEAD-(AES256-GCM-SHA384)/RSA-$1/g;
632   s/(?<!ke-)((EC)?DHE-)?(RSA|ECDSA)-(AES256|CHACHA20)-(GCM-SHA384|POLY1305)(?!:)/ke-$3-AES256-SHAnnn/g;
633   s/(?<!ke-)((EC)?DHE-)?(RSA|ECDSA)-(AES256|CHACHA20)-(GCM-SHA384|POLY1305):256/ke-$3-AES256-SHAnnn:xxx/g;
634
635   # GnuTLS have seen:
636   #   TLS1.3:ECDHE_RSA_AES_256_GCM_SHA384:256
637   #   TLS1.3:ECDHE_SECP256R1__RSA_PSS_RSAE_SHA256__AES_256_GCM__AEAD:256
638   #   TLS1.3:ECDHE_X25519__RSA_PSS_RSAE_SHA256__AES_256_GCM:256
639   #   TLS1.3:ECDHE_PSK_SECP256R1__AES_256_GCM__AEAD:256
640   #
641   #   TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256
642   #   TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128
643   #   TLS1.2:RSA_AES_256_CBC_SHA1:256 (canonical)
644   #   TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128
645   #   TLS1.2:ECDHE_SECP256R1__RSA_SHA256__AES_256_GCM:256
646   #   TLS1.2:ECDHE_SECP256R1__RSA_SHA256__AES_128_CBC__SHA256:128
647   #   TLS1.2:ECDHE_SECP256R1__ECDSA_SHA512__AES_256_GCM:256
648   #   TLS1.2:ECDHE_SECP256R1__AES_256_GCM:256           (3.6.7 resumption)
649   #   TLS1.2:ECDHE_RSA_SECP256R1__AES_256_GCM:256       (! 3.5.18 !)
650   #   TLS1.2:RSA__CAMELLIA_256_GCM:256                  (leave the cipher name)
651   #   TLS1.2-PKIX:RSA__AES_128_GCM__AEAD:128            (the -PKIX seems to be a 3.1.20 thing)
652   #   TLS1.2-PKIX:ECDHE_RSA_SECP521R1__AES_256_GCM__AEAD:256
653   #
654   #   X=TLS1.2:DHE_RSA_AES_256_CBC_SHA256:256
655   #   X=TLS1.2:RSA_AES_256_CBC_SHA1:256
656   #   X=TLS1.1:RSA_AES_256_CBC_SHA1:256
657   #   X=TLS1.0:RSA_AES_256_CBC_SHA1:256
658   #   X=TLS1.0:DHE_RSA_AES_256_CBC_SHA1:256
659   #   X=TLS1.0-PKIX:RSA__AES_256_CBC__SHA1:256
660   # and as stand-alone cipher:
661   #   ECDHE-RSA-AES256-SHA
662   #   DHE-RSA-AES256-SHA256
663   #   DHE-RSA-AES256-SHA
664   # picking latter as canonical simply because regex easier that way.
665   s/\bDHE_RSA_AES_128_CBC_SHA1:128/RSA-AES256-SHA1:256/g;
666   s/TLS1.[x0123](-PKIX)?:                                               # TLS version
667     ((EC)?DHE(_((?<psk>PSK)_)?((?<auth>RSA|ECDSA)_)?
668                                 (SECP(256|521)R1|X25519))?__?)?         # key-exchange
669     ((?<auth>RSA|ECDSA)((_PSS_RSAE)?_SHA(512|256))?__?)?                # authentication
670     (?<with>WITH_)?                                                     # stdname-with
671     AES_(256|128)_(CBC|GCM)                                             # cipher
672     (__?AEAD)?                                                          # pseudo-MAC
673     (__?SHA(1|256|384))?                                                # PRF
674     :(256|128)                                                          # cipher strength
675     /"TLS1.x:ke-"
676         . (defined($+{psk}) ? $+{psk} : "")
677         . (defined($+{auth}) ? $+{auth} : "")
678         . (defined($+{with}) ? $+{with} : "")
679         . "-AES256-SHAnnn:xxx"/gex;
680   s/TLS1.2:RSA__CAMELLIA_256_GCM(_SHA384)?:256/TLS1.2:RSA_CAMELLIA_256_GCM-SHAnnn:256/g;
681   s/\b(ECDHE-(RSA|ECDSA)-AES256-SHA|DHE-RSA-AES256-SHA256)\b/ke-$2-AES256-SHAnnn/g;
682
683   # Separate reporting of TLS version
684   s/ver:    TLS1(\.[0-3])?$/ver:    TLS1.x/;
685   s/ \(TLS1(\.[0-3])?\) / (TLS1.x) /;
686
687   # GnuTLS library error message changes
688   s/(No certificate was found|Certificate is required)/The peer did not send any certificate/g;
689 #(dodgy test?)  s/\(certificate verification failed\): invalid/\(gnutls_handshake\): The peer did not send any certificate./g;
690   s/\(gnutls_priority_set\): No or insufficient priorities were set/\(gnutls_handshake\): Could not negotiate a supported cipher suite/g;
691   s/\(gnutls_handshake\): \KNo supported cipher suites have been found.$/Could not negotiate a supported cipher suite./;
692
693   # (this new one is a generic channel-read error, but the testsuite
694   # only hits it in one place)
695   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;
696
697   # (replace old with new, hoping that old only happens in one situation)
698   s/TLS error on connection to \d{1,3}(.\d{1,3}){3} \[\d{1,3}(.\d{1,3}){3}\] \(gnutls_handshake\): A TLS packet with unexpected length was received./a TLS session is required for ip4.ip4.ip4.ip4 [ip4.ip4.ip4.ip4], but an attempt to start TLS failed/g;
699   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;
700
701   # signature algorithm names
702   s/RSA-SHA1/RSA-SHA/;
703
704
705   # ======== Caller's login, uid, gid, home, gecos ========
706
707   s/\Q$parm_caller_home\E/CALLER_HOME/g;   # NOTE: these must be done
708   s/\b\Q$parm_caller\E\b/CALLER/g;         #       in this order!
709   s/\b\Q$parm_caller_group\E\b/CALLER/g;   # In case group name different
710
711   s/\beuid=$parm_caller_uid\b/euid=CALLER_UID/g;
712   s/\begid=$parm_caller_gid\b/egid=CALLER_GID/g;
713
714   s/\buid=$parm_caller_uid\b/uid=CALLER_UID/g;
715   s/\bgid=$parm_caller_gid\b/gid=CALLER_GID/g;
716
717   s/\bname="?$parm_caller_gecos"?/name=CALLER_GECOS/g;
718
719   # When looking at spool files with -Mvh, we will find not only the caller
720   # login, but also the uid and gid. It seems that $) in some Perls gives all
721   # the auxiliary gids as well, so don't bother checking for that.
722
723   s/^CALLER $> \d+$/CALLER UID GID/;
724
725   # There is one case where the caller's login is forced to something else,
726   # in order to test the processing of logins that contain spaces. Weird what
727   # some people do, isn't it?
728
729   s/^spaced user $> \d+$/CALLER UID GID/;
730
731
732   # ======== Exim's login ========
733   # For messages received by the daemon, this is in the -H file, which some
734   # tests inspect. For bounce messages, this will appear on the U= lines in
735   # logs and also after Received: and in addresses. In one pipe test it appears
736   # after "Running as:". It also appears in addresses, and in the names of lock
737   # files.
738
739   s/U=$parm_eximuser/U=EXIMUSER/;
740   s/user=$parm_eximuser/user=EXIMUSER/;
741   s/login=$parm_eximuser/login=EXIMUSER/;
742   s/Received: from $parm_eximuser /Received: from EXIMUSER /;
743   s/Running as: $parm_eximuser/Running as: EXIMUSER/;
744   s/\b$parm_eximuser@/EXIMUSER@/;
745   s/\b$parm_eximuser\.lock\./EXIMUSER.lock./;
746
747   s/\beuid=$parm_exim_uid\b/euid=EXIM_UID/g;
748   s/\begid=$parm_exim_gid\b/egid=EXIM_GID/g;
749
750   s/\buid=$parm_exim_uid\b/uid=EXIM_UID/g;
751   s/\bgid=$parm_exim_gid\b/gid=EXIM_GID/g;
752
753   s/^$parm_eximuser $parm_exim_uid $parm_exim_gid/EXIMUSER EXIM_UID EXIM_GID/;
754
755
756   # ======== General uids, gids, and pids ========
757   # Note: this must come after munges for caller's and exim's uid/gid
758
759   # These are for systems where long int is 64
760   s/\buid=4294967295/uid=-1/;
761   s/\beuid=4294967295/euid=-1/;
762   s/\bgid=4294967295/gid=-1/;
763   s/\begid=4294967295/egid=-1/;
764
765   s/\bgid=\d+/gid=gggg/;
766   s/\begid=\d+/egid=gggg/;
767   s/\b(?:pid=|pid\s|PID:\s|Process\s|child\s)\K(\d+)/new_value($1, "p%s", \$next_pid)/gxe;
768   s/\buid=\d+/uid=uuuu/;
769   s/\beuid=\d+/euid=uuuu/;
770   s/set_process_info:\s+\d+/set_process_info: pppp/;
771   s/process \d+ running as transport filter/process pppp running as transport filter/;
772   s/process \d+ writing to transport filter/process pppp writing to transport filter/;
773   s/reading pipe for subprocess \d+/reading pipe for subprocess pppp/;
774   s/remote delivery process \d+ ended/remote delivery process pppp ended/;
775
776   # Pid in temp file in appendfile transport
777   s"test-mail/(subdir/)?temp\K\.\d+\.".pppp.";
778
779   # Optional pid in log lines
780   s/^(\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d)(\.\d{3}|)(\s[+-]\d{4}|)(\s\[\d+\])/
781     "$1$2$3 [" . new_value($4, "%s", \$next_pid) . "]"/gxe;
782
783   # Optional pid in syslog test lines
784   s/^(SYSLOG:\s\'([-0-9]{10}\s[:.0-9]{8,12}\s([-+]\d{4}\s)?|))(\[\d+\] )/
785     "$1\[" . new_value($4, "%s", \$next_pid) . "]"/gxe;
786
787   # Detect a daemon stderr line with a pid and save the pid for subsequent
788   # removal from following lines.
789   $spid = $1 if /^(\s*\d+) (?:listening|LOG: MAIN|(?:daemon_smtp_port|local_interfaces) overridden by)/;
790   s/^$spid //;
791
792   # Queue runner waiting messages
793   s/waiting for children of \d+/waiting for children of pppp/;
794   s/waiting for (\S+) \(\d+\)/waiting for $1 (pppp)/;
795
796   # Most builds are without HAVE_LOCAL_SCAN
797   next if /^calling local_scan\(\); timeout=300$/;
798   next if /^local_scan\(\) returned 0 NULL$/;
799
800   # ======== Port numbers ========
801   # Incoming port numbers may vary, but not in daemon startup line.
802
803   s/^Port: (\d+)/"Port: " . new_value($1, "%s", \$next_port)/e;
804   s/\(port=(\d+)/"(port=" . new_value($1, "%s", \$next_port)/e;
805
806   # This handles "connection from" and the like, when the port is given
807   if (!/listening for SMTP on/ && !/Connecting to/ && !/=>/ && !/->/
808       && !/\*>/&& !/==/  && !/\*\*/ && !/Connection refused/ && !/in response to/)
809     {
810     s/\[([a-z\d:]+|\d+(?:\.\d+){3})\]:(\d+)/"[".$1."]:".new_value($2,"%s",\$next_port)/ie;
811     }
812
813   # Port in host address in spool file output from -Mvh
814   s/^(--?host_address) (.*[:.])\d+$/$1 ${2}9999/;
815
816   if ($dynamic_socket and $dynamic_socket->opened and my $port = $dynamic_socket->sockport) {
817     s/^Connecting to 127\.0\.0\.1 port \K$port/<dynamic port>/;
818   }
819
820
821   # ======== Local IP addresses ========
822   # The amount of space between "host" and the address in verification output
823   # depends on the length of the host name. We therefore reduce it to one space
824   # for all of them.
825   # Also, the length of space at the end of the host line is dependent
826   # on the length of the longest line, so strip it also on otherwise
827   # un-rewritten lines like localhost
828   #
829   # host 127.0.0.1     [127.0.0.1]
830   # host 10.0.0.1      [10.0.0.1]-
831   #
832   # host 127.0.0.1     [127.0.0.1]--
833   # host 169.16.16.16  [169.16.16.10]
834
835   s/^\s+host\s(\S+)\s+(\S+)/  host $1 $2/;
836   s/^\s+(host\s\S+\s\S+)\s+(port=.*)/  host $1 $2/;
837   s/^\s+(host\s\S+\s\S+)\s+(?=MX=)/  $1 /;
838   s/host\s\Q$parm_ipv4\E\s\[\Q$parm_ipv4\E\]/host ipv4.ipv4.ipv4.ipv4 [ipv4.ipv4.ipv4.ipv4]/;
839   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]/;
840   s/\b\Q$parm_ipv4\E\b/ip4.ip4.ip4.ip4/g;
841   s/(^|\W)\K\Q$parm_ipv6\E/ip6:ip6:ip6:ip6:ip6:ip6:ip6:ip6/g;
842   s/(^|\W)\K\Q$parm_ipv6_stripped\E/ip6:ip6:ip6:ip6:ip6:ip6:ip6:ip6/g;
843   s/\b\Q$parm_ipv4r\E\b/ip4-reverse/g;
844   s/(^|\W)\K\Q$parm_ipv6r\E/ip6-reverse/g;
845   s/^\s+host\s\S+\s+\[\S+\]\K +$//;     # strip, not collapse the trailing whitespace
846
847
848   # ======== Test network IP addresses ========
849   s/(\b|_)\Q$parm_ipv4_test_net\E(?=\.\d+\.\d+\.\d+\b|_|\.rbl|\.in-addr|\.test\.again\.dns)/$1V4NET/g;
850   s/\b\Q$parm_ipv6_test_net\E(?=:[\da-f]+:[\da-f]+:[\da-f]+)/V6NET/gi;
851
852
853   # ======== IP error numbers and messages ========
854   # These vary between operating systems
855   s/Can(no|')t assign requested address/Netwk addr not available/;
856   s/Operation timed out/Connection timed out/;
857   s/Address family not supported by protocol family/Network Error/;
858   s/Network( is)? unreachable/Network unreachable/;
859   s/Invalid argument/Network Error/;
860
861   s/\(\d+\): Network/(dd): Network/;
862   s/\(\d+\): Connection refused/(dd): Connection refused/;
863   s/\(\d+\): Connection timed out/(dd): Connection timed out/;
864   s/\d+ 65 Connection refused/dd 65 Connection refused/;
865   s/\d+ 321 Connection timed out/dd 321 Connection timed out/;
866
867
868   # ======== Other error numbers ========
869   s/errno=\d+/errno=dd/g;
870
871   # ======== System Error Messages ======
872   # depending on the underlaying file system the error message seems to differ
873   s/(?: is not a regular file)|(?: has too many links \(\d+\))/ not a regular file or too many links/;
874
875   # ======== Output from ls ========
876   # Different operating systems use different spacing on long output
877   #s/ +/ /g if /^[-rwd]{10} /;
878   # (Bug 1226) SUSv3 allows a trailing printable char for modified access method control.
879   # Handle only the Gnu and MacOS space, dot, plus and at-sign.  A full [[:graph:]]
880   # unfortunately matches a non-ls linefull of dashes.
881   # Allow the case where we've already picked out the file protection bits.
882   if (s/^([-d](?:[-r][-w][-SsTtx]){3})[.+@]?( +|$)/$1$2/) {
883     s/ +/ /g;
884   }
885
886
887   # ======== Message sizes =========
888   # Message sizes vary, owing to different logins and host names that get
889   # automatically inserted. I can't think of any way of even approximately
890   # comparing these.
891
892   s/([\s,])S=\d+\b/$1S=sss/;
893   s/:S\d+\b/:Ssss/;
894   s/^(\s*\d+[mhd]\s+)\d+(\s+(?:[a-z0-9-]{23}|[a-z0-9-]{18}) <)/TTT   sss$2/i if $is_stdout;
895   s/\sSIZE=\d+\b/ SIZE=ssss/;
896   s/\ssize=\d+\b/ size=sss/ if $is_stderr;
897   s/old size = \d+\b/old size = sssss/;
898   s/message size = \d+\b/message size = sss/;
899   s/this message = \d+\b/this message = sss/;
900   s/Size of headers = \d+/Size of headers = sss/;
901   s/sum=(?!0)\d+/sum=dddd/;
902   s/(?<=sum=dddd )count=\d+\b/count=dd/;
903   s/(?<=sum=0 )count=\d+\b/count=dd/;
904   s/,S is \d+\b/,S is ddddd/;
905   s/\+0100,\d+;/+0100,ddd;/;
906   s/\(\d+ bytes written\)/(ddd bytes written)/;
907   s/added '\d+ 1'/added 'ddd 1'/;
908   s/Received\s+\d+/Received               nnn/;
909   s/Delivered\s+\d+/Delivered              nnn/;
910
911
912   # ======== Values in spool space failure message ========
913   s/space=\d+ inodes=[+-]?\d+/space=xxxxx inodes=xxxxx/;
914
915
916   # ======== Filter sizes ========
917   # The sizes of filter files may vary because of the substitution of local
918   # filenames, logins, etc.
919
920   s/^\d+(?= (\(tainted\) )?bytes read from )/ssss/;
921
922
923   # ======== OpenSSL error messages ========
924   # Different releases of the OpenSSL libraries seem to give different error
925   # numbers, or handle specific bad conditions in different ways, leading to
926   # different wording in the error messages, so we cannot compare them.
927
928 #XXX This loses any trailing "delivering unencypted to" which is unfortunate
929 #    but I can't work out how to deal with that.
930   s/(TLS session: \(SSL_\w+\): error:)(.*)(?!: delivering)/$1 <<detail omitted>>/;
931   s/TLS error on connection from .*\K\(SSL_accept\): error:.*:unexpected eof while reading$/(tls lib accept fn): TCP connection closed by peer/;
932   s/(TLS error on connection from .* \(SSL_\w+\): error:)(.*)/$1 <<detail omitted>>/;
933   next if /SSL verify error: depth=0 error=certificate not trusted/;
934
935   # OpenSSL 3.0.0
936   s/TLS error \(D-H param setting .* error:\K.*dh key too small/xxxxxxxx:SSL routines::dh key too small/;
937
938   # OpenSSL 1.1.1
939   s/error:\K0B080074:x509 certificate routines:X509_check_private_key(?=:key values mismatch$)/05800074:x509 certificate routines:/;
940   s/error:\K02001002:system library:fopen(?=:No such file or directory$)/80000002:system library:/;
941   s/error:\K0909006C:PEM routines:get_name(?=:no start line$)/0480006C:PEM routines:/;
942
943   # ======== Maildir things ========
944   # timestamp output in maildir processing
945   s/(timestamp=|\(timestamp_only\): )\d+/$1ddddddd/g;
946
947   # maildir delivery files appearing in log lines (in cases of error)
948   s/writing to(?: file)? tmp\/\d+\.[^.]+\.(\S+)/writing to tmp\/MAILDIR.$1/;
949
950   s/renamed tmp\/\d+\.[^.]+\.(\S+) as new\/\d+\.[^.]+\.(\S+)/renamed tmp\/MAILDIR.$1 as new\/MAILDIR.$1/;
951
952   # Maildir file names in general
953   s/\b\d+\.M\d+P\d+\b/dddddddddd.HddddddPddddd/;
954
955   # Maildirsize data
956   while (/^\d+S,\d+C\s*$/)
957     {
958     print MUNGED;
959     while (<IN>)
960       {
961       last if !/^\d+ \d+\s*$/;
962       print MUNGED "ddd d\n";
963       }
964     last if !defined $_;
965     }
966   last if !defined $_;
967
968
969   # SRS timestamps and signatures vary by hostname and from run to run
970
971   s/(?i)SRS0=....=.[^=]?=([^=]+)=([^@]+)\@([^ ]+)/SRS0=ZZZZ=YY=$1=$2\@$3/g;
972
973
974   # ======== Output from the "fd" program about open descriptors ========
975   # The statuses seem to be different on different operating systems, but
976   # at least we'll still be checking the number of open fd's.
977
978   s/max fd = \d+/max fd = dddd/;
979   s/status=[0-9a-f]+ (?:RDONLY|WRONLY|RDWR)/STATUS/g;
980
981
982   # ======== Contents of spool files ========
983   # A couple of tests dump the contents of the -H file. The length fields
984   # will be wrong because of different user names, etc.
985   s/^\d\d\d(?=[PFS*])/ddd/;
986
987
988   # ==========================================================
989   # MIME boundaries in RFC3461 DSN messages
990   s/\d{8,10}-eximdsn-\d+/NNNNNNNNNN-eximdsn-MMMMMMMMMM/;
991
992   # Cyrus SASL library version differences (rejectlog)
993   s/Cyrus SASL permanent failure: \Kuser not found$/generic failure/;
994
995   # ==========================================================
996   # Some munging is specific to the specific file types
997
998   # ======== stdout ========
999
1000   if ($is_stdout)
1001     {
1002     # Skip translate_ip_address and use_classresources in -bP output because
1003     # they aren't always there.
1004
1005     next if /translate_ip_address =/;
1006     next if /use_classresources/;
1007
1008     # In certain filter tests, remove initial filter lines because they just
1009     # clog up by repetition.
1010
1011     if ($rmfiltertest)
1012       {
1013       next if /^(Sender\staken\sfrom|
1014                  Return-path\scopied\sfrom|
1015                  Sender\s+=|
1016                  Recipient\s+=)/x;
1017       if (/^Testing \S+ filter/)
1018         {
1019         $_ = <IN>;    # remove blank line
1020         next;
1021         }
1022       }
1023
1024     # remote IPv6 addrs vary
1025     s/^(Connection request from) \[.*:.*:.*\]$/$1 \[ipv6\]/;
1026
1027     # openssl version variances
1028   # Error lines on stdout from SSL contain process id values and file names.
1029   # They also contain a source file name and line number, which may vary from
1030   # release to release.
1031
1032     next if /^SSL info:/;
1033     next if /SSL verify error: depth=0 error=certificate not trusted/;
1034     s/SSL3_READ_BYTES/ssl3_read_bytes/i;
1035     s/CONNECT_CR_FINISHED/ssl3_read_bytes/i;
1036     s/^[[:xdigit:]]+:error:[[:xdigit:]]+(?:E[[:xdigit:]]+)?(:SSL routines:ssl3_read_bytes:[^:]+:).*(:SSL alert number \d\d)$/pppp:error:dddddddd$1\[...\]$2/;
1037     s/^error:\K[^:]*:(SSL routines:ssl3_read_bytes:(tls|ssl)v\d+ alert)/dddddddd:$1/;
1038     s/^error:\K[[:xdigit:]]+:SSL routines::(tlsv13 alert certificate required)$/dddddddd:SSL routines:ssl3_read_bytes:$1/;
1039     s/^error:\K[[:xdigit:]]+:SSL routines::((tlsv1|sslv3) alert (unknown ca|certificate revoked))$/dddddddd:SSL routines:ssl3_read_bytes:$1/;
1040
1041     # gnutls version variances
1042     next if /^Error in the pull function./;
1043
1044     # optional IDN2 variant conversions.  Accept either IDN1 or IDN2
1045     s/conversion  strasse.de/conversion  xn--strae-oqa.de/;
1046     s/conversion: german.xn--strae-oqa.de/conversion: german.straße.de/;
1047
1048     # subsecond timstamp info in reported header-files
1049     s/^-received_time_usec \.\K\d{6}$/uuuuuu/;
1050     s/^-received_time_complete \K\d+\.\d{6}$/tttt.uuuuuu/;
1051
1052     # Postgres server takes varible time to shut down; lives in various places
1053     s/^waiting for server to shut down\.+ done$/waiting for server to shut down.... done/;
1054     s/^\/.*postgres /POSTGRES /;
1055
1056     # DMARC is not always supported by the build
1057     next if /^dmarc_tld_file =/;
1058
1059     # ARC is not always supported by the build
1060     next if /^arc_sign =/;
1061
1062     # LIMITS is not always supported by the build
1063     next if /^limits_advertise_hosts =/;
1064
1065     # TLS resumption is not always supported by the build
1066     next if /^tls_resumption_hosts =/;
1067     next if /^-tls_resumption/;
1068     next if /^host_name_extract = /;
1069
1070     # gsasl library version may not support some methods
1071     s/250-AUTH ANONYMOUS PLAIN SCRAM-SHA-1\K SCRAM-SHA-256//;
1072
1073     # mailq times change with when the run is done, vs. static-source spoolfiles
1074     s/\s*\d*[hd](?=   317 [0-9A-Za-z\-]{23} <nobody\@test.ex>)/DDd/;
1075     }
1076
1077   # ======== stderr ========
1078
1079   elsif ($is_stderr)
1080     {
1081     # The very first line of debugging output will vary
1082     s/^Exim version .*/Exim version x.yz ..../;
1083
1084     # Skip some lines that Exim puts out at the start of debugging output
1085     # because they will be different in different binaries.
1086
1087     next if /^$time_pid?
1088                 (?: Berkeley\ DB:\s
1089                   | Probably\ (?:Berkeley\ DB|ndbm|GDBM)
1090                   | Using\ tdb
1091                   | Authenticators:
1092                   | Lookups(?:\(built-in\))?:
1093                   | Support\ for:
1094                   | Routers:
1095                   | Transports:
1096                   | Malware:
1097                   | log\ selectors\ =
1098                   | cwd=
1099                   | Fixed\ never_users
1100                   | Configure\ owner
1101                   | Size\ of\ off_t:
1102                 )
1103               /x;
1104
1105     # Lines with a leading pid.  Only handle >= 4-digit PIDs to avoid converting SMTP respose codes
1106     s/^\s*(\d{4,})\s(?!(?:previous message|in\s|bytes remain in|SMTP accept process running))/new_value($1, "p%s", \$next_pid) . ' '/e;
1107
1108     # Debugging lines for Exim terminations and process-generation
1109     next if /(?:postfork: | fork(?:ing|ed) for )/;
1110
1111     # IP address lookups use gethostbyname() when IPv6 is not supported,
1112     # and gethostbyname2() or getipnodebyname() when it is.
1113
1114     s/\b(gethostbyname2?|\bgetipnodebyname)(\(af=inet\))?/get[host|ipnode]byname[2]/;
1115
1116     # Extra lookups done when ipv6 is supported
1117     next if /^host_fake_gethostbyname\(af=inet6\) returned 1 \(HOST_NOT_FOUND\)$/;
1118
1119     # we don't care what TZ enviroment the testhost was running
1120     next if /^Reset TZ to/;
1121
1122     # port numbers
1123     s/(?:\[[^\]]*\]:|V4NET\.0\.0\.0:|localhost::?|127\.0\.0\.1[.:]:?|port[= ])\K$parm_port_d/PORT_D/;
1124     s/(?:\[[^\]]*\]:|V4NET\.0\.0\.0:|localhost::?|127\.0\.0\.1[.:]:?|port[= ])\K$parm_port_d2/PORT_D2/;
1125     s/(?:\[[^\]]*\]:|V4NET\.0\.0\.0:|localhost::?|127\.0\.0\.1[.:]:?|port[= ])\K$parm_port_d3/PORT_D3/;
1126     s/(?:\[[^\]]*\]:|V4NET\.0\.0\.0:|localhost::?|127\.0\.0\.1[.:]:?|port[= ])\K$parm_port_d4/PORT_D4/;
1127     s/(?:\[[^\]]*\]:|V4NET\.0\.0\.0:|localhost::?|127\.0\.0\.1[.:]:?|port[= ])\K$parm_port_s/PORT_S/;
1128     s/(?:\[[^\]]*\]:|V4NET\.0\.0\.0:|localhost::?|127\.0\.0\.1[.:]:?|port[= ])\K$parm_port_n/PORT_N/;
1129
1130     # ========= Exim lookups ==================
1131     # Lookups have a char which depends on the number of lookup types compiled in,
1132     # in stderr output.  Replace with a "0".  Recognising this while avoiding
1133     # other output is fragile; perhaps the debug output should be revised instead.
1134     s%^\s+(:?closing )?\K[0-?]TESTSUITE/aux-fixed/%0TESTSUITE/aux-fixed/%g;
1135
1136     # drop gnutls version strings
1137     next if /GnuTLS compile-time version: \d+[\.\d]+$/;
1138     next if /GnuTLS runtime version: \d+[\.\d]+$/;
1139     # and unwanted debug
1140     next if /^GnuTLS<2>: FIPS140-2 (context is not set|operation mode switched from initial to not-approved)$/;
1141     next if /^GnuTLS<3>: ASSERT: sign.c\[_gnutls_sign_is_secure2\]:\d+$/;
1142     next if /^GnuTLS<3>: ASSERT: \.\.\/\.\.\/lib\/pkcs11.c\[find_multi_objs_cb\]:/;
1143     next if /^GnuTLS<3>: ASSERT: \.\.\/\.\.\/lib\/pkcs11.c\[gnutls_pkcs11_obj_list_import_url3\]:/;
1144
1145     # drop openssl version strings
1146     next if /OpenSSL compile-time version: OpenSSL \d+[\.\da-z]+/;
1147     next if /OpenSSL runtime version: OpenSSL \d+[\.\da-z]+/;
1148
1149     # this is timing-dependent
1150     next if /^OpenSSL: creating STEK$/;
1151     next if /^selfsign cert rotate$/;
1152
1153     # TLS preload
1154     # only OpenSSL speaks of these
1155     next if /^TLS: (preloading (DH params \S+|ECDH curve \S+|CA bundle) for server|generating selfsigned server cert)/;
1156     next if /^ Diffie-Hellman initialized from default/;
1157     next if /^ ECDH OpenSSL (< )?[\d.+]+: temp key parameter settings:/;
1158     next if /^ ECDH: .*'prime256v1'/;
1159     next if /^tls_verify_certificates: system$/;
1160     next if /^tls_set_watch: .*\/cert.pem/;
1161     next if /^Generating 2048 bit RSA key/;
1162
1163     # TLS preload
1164     # only GnuTLS speaks of these
1165     next if /^GnuTLS global init required$/;
1166     next if /^TLS: basic cred init, server/;
1167     next if /^TLS: preloading cipher list for server: NULL$/;
1168     s/^GnuTLS using default session cipher\/priority "NORMAL"$/TLS: not preloading cipher list for server/;
1169     next if /^GnuTLS<2>: added \d+ protocols, \d+ ciphersuites, \d+ sig algos and \d+ groups into priority list$/;
1170     next if /^GnuTLS<2>: (Disabling X.509 extensions|signing structure using RSA-SHA256)/;
1171     next if /^GnuTLS.*(wrap_nettle_mpi_print|gnutls_subject_alt_names_get|get_alt_name)/;
1172     next if /^GnuTLS<[23]>: (p11|ASSERT: pkcs11.c|Initializing needed PKCS #11 modules)/;
1173     next if /^GnuTLS<2>: Intel (AES|GCM) accelerator was detected/;
1174     next if /^Added \d{3} certificate authorities/;
1175     next if /^TLS: not preloading CRL for server/;
1176     next if /^GnuTLS<3>: ASSERT: extensions.c\[_gnutls_get_extension/;
1177     next if /^GnuTLS<3>: ASSERT: \.\.\/\.\.\/\.\.\/lib\/x509\//;
1178     next if /^GnuTLS<2>: Initializing PKCS #11 modules/;
1179
1180
1181     # only kevent platforms (FreeBSD, OpenBSD) say this
1182     next if /^watch dir/;
1183     next if /^watch file .*\/usr\/local/;
1184     next if /^watch file .*\/etc\/ssl/;
1185     next if /^closing watch fd:/;
1186
1187     # TLS preload
1188     # there happen in different orders for OpenSSL/GnuTLS/noTLS
1189     next if /^TLS: generating selfsigned server cert/;
1190     next if /^TLS: not preloading (CA bundle|cipher list) for server$/;
1191     next if /^TLS: not preloading server certs$/;
1192
1193     # some plaatforms are missing the standard CA bundle file
1194     next if /^tls_set_watch\(\) fail on '\/usr\/lib\/ssl\/cert.pem': No such file or directory$/;
1195
1196     # drop lookups
1197     next if /^$time_pid?(?: Lookups\ \(built-in\):
1198                                         | Loading\ lookup\ modules\ from
1199                                         | Loaded\ \d+\ lookup\ modules
1200                                         | Total\ \d+\ lookups)/x;
1201
1202     # drop compiler information
1203     next if /^$time_pid?Compiler:/;
1204
1205     # and the ugly bit
1206     # different libraries will have different numbers (possibly 0) of follow-up
1207     # lines, indenting with more data
1208     if (/^$time_pid?Library version:/) {
1209       while (1) {
1210         $_ = <IN>;
1211         next if /^$time_pid?\s/;
1212         goto RESET_AFTER_EXTRA_LINE_READ;
1213       }
1214     }
1215
1216     # drop other build-time controls emitted for debugging
1217     next if /^$time_pid?WHITELIST_D_MACROS:/;
1218     next if /^$time_pid?TRUSTED_CONFIG_LIST:/;
1219
1220     # As of Exim 4.74, we log when a setgid fails; because we invoke Exim
1221     # with -be, privileges will have been dropped, so this will always
1222     # be the case
1223     next if /^changing group to \d+ failed: (Operation not permitted|Not owner)/;
1224
1225     # We might not keep this check; rather than change all the tests, just
1226     # ignore it as long as it succeeds; then we only need to change the
1227     # TLS tests where tls_require_ciphers has been set.
1228     if (m{^changed uid/gid: calling tls_validate_require_cipher}) {
1229       my $discard = <IN>;
1230       next;
1231     }
1232     next if /^tls_validate_require_cipher child \d+ ended: status=0x0/;
1233
1234     # We invoke Exim with -D, so we hit this new message as of Exim 4.73:
1235     next if /^macros_trusted overridden to true by whitelisting/;
1236
1237     # We have to omit the localhost ::1 address so that all is well in
1238     # the IPv4-only case.
1239
1240     print MUNGED "MUNGED: ::1 will be omitted in what follows\n"
1241       if (/looked up these IP addresses/);
1242     next if /name=localhost address=::1/;
1243
1244     # drop pdkim debugging header
1245     next if /^DKIM( <<<<<<<<<<<<<<<<<<<<<<<<<<<<<+|: no signatures)$/;
1246
1247     # Some platforms have TIOCOUTome do not
1248     next if /\d+ bytes remain in socket output buffer$/;
1249     # Various other IPv6 lines must be omitted too
1250
1251     next if /using host_fake_gethostbyname for \S+ \(IPv6\)/;
1252     next if /get\[host\|ipnode\]byname\[2\]\(af=inet6\)/;
1253     next if /DNS lookup of \S+ \(AAAA\) using fakens/;
1254     next if / in dns_ipv4_lookup?/;
1255     next if / writing neg-cache entry for .*AAAA/;
1256     next if /^faking res_search\(AAAA\) response length as 65535/;
1257
1258     if (/DNS lookup of \S+ \(AAAA\) gave NO_DATA/)
1259       {
1260       $_= <IN>;     # Gets "returning DNS_NODATA"
1261       next;
1262       }
1263
1264     # Non-TLS builds have a different default Recieved: header expansion
1265     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)/;
1266     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)/;
1267     if (/condition: def:tls_in_ver$/)
1268       {
1269       $_= <IN>; $_= <IN>; $_= <IN>; $_= <IN>;
1270       $_= <IN>; $_= <IN>; $_= <IN>; $_= <IN>;
1271       $_= <IN>; $_= <IN>; $_= <IN>; $_= <IN>;
1272       $_= <IN>; $_= <IN>; $_= <IN>; $_= <IN>;
1273       $_= <IN>; $_= <IN>; $_= <IN>; $_= <IN>; $_= <IN>; next;
1274       }
1275
1276
1277     # Skip tls_advertise_hosts and hosts_require_tls checks when the options
1278     # are unset, because tls ain't always there.
1279
1280     next if /^((>>>)?\s*host)? in tls_advertise_hosts\?$/;
1281     next if /in\s(?:tls_advertise_hosts\?|hosts_require_tls\?)
1282                 \sno\s\((option\sunset|end\sof\slist)\)/x;
1283
1284     # Skip auxiliary group lists because they will vary.
1285
1286     next if /auxiliary group list:/;
1287
1288     # Skip "extracted from gecos field" because the gecos field varies
1289
1290     next if /extracted from gecos field/;
1291
1292     # Skip "waiting for data on socket" and "read response data: size=" lines
1293     # because some systems pack more stuff into packets than others.
1294
1295     next if /waiting for data on socket/;
1296     next if /read response data: size=/;
1297
1298     # If Exim is compiled with readline support but it can't find the library
1299     # to load, there will be an extra debug line. Omit it.
1300
1301     next if /failed to load readline:/;
1302
1303     # Some DBM libraries seem to make DBM files on opening with O_RDWR without
1304     # O_CREAT; other's don't. In the latter case there is some debugging output
1305     # which is not present in the former. Skip the relevant lines (there are
1306     # three of them).
1307
1308     if (/returned from EXIM_DBOPEN: \(nil\)/)
1309       {
1310       $_ .= <IN>;
1311       s?\Q$parm_cwd\E?TESTSUITE?g;
1312       if (/TESTSUITE\/spool\/db\/\S+ appears not to exist: trying to create/)
1313         { $_ = <IN>; next; }
1314       }
1315
1316     # Some tests turn on +expand debugging to check on expansions.
1317     # Unfortunately, the Received: expansion varies, depending on whether TLS
1318     # is compiled or not. So we must remove the relevant debugging if it is.
1319
1320     if (/^condition: def:tls_cipher/)
1321       {
1322       while (<IN>) { last if /^condition: def:sender_address/; }
1323       }
1324     elsif (/^expanding: Received: /)
1325       {
1326       while (<IN>) { last if !/^\s/; }
1327       }
1328
1329     # remote port numbers vary
1330     s/(Connection request from 127.0.0.1 port) \d{1,5}/$1 sssss/;
1331
1332     # Platform-dependent error strings
1333     s/Operation timed out/Connection timed out/;
1334
1335     # Platform differences on disconnect
1336     s/unexpected disconnection while reading SMTP command from \[127.0.0.1\] \K\(error: Connection reset by peer\) //;
1337
1338     # Platform-dependent resolver option bits
1339     s/^ (?:writing|update) neg-cache entry for [^,]+-\K[0-9a-f]+, ttl/xxxx, ttl/;
1340
1341     # timing variance, run-to-run
1342     s/^time on queue = \K1s/0s/;
1343
1344     # content-scan: file order can vary in directory
1345     s%unspool_mbox\(\): unlinking 'TESTSUITE/spool/scan/[^/]*/\K[^\']*%FFFFFFFFF%;
1346
1347     # Skip hosts_require_dane checks when the options
1348     # are unset, because dane ain't always there.
1349     next if /in\shosts_require_dane\?\sno\s\(option\sunset\)/x;
1350
1351     # daemon notifier socket
1352     s% \@(?=[^ @]+/spool/exim_daemon_notify$)% %;
1353     next if /unlinking notifier socket/;
1354
1355     # daemon notifier socket
1356     # Timing variance over runs.  Collapse repeated memssages.
1357     if (/notify triggered queue run/)
1358       {
1359       my $line = $_;
1360       while (/notify triggered queue run/) { $_ = <IN>; }
1361       $_ = $line . $_;
1362       }
1363
1364     # Different builds will have different lookup types included
1365     s/^\s*search_type \K\d+ \((\w+)\) quoting -1 \(none\)$/NN ($1) quoting -1 (none)/;
1366     # and different numbers of lookup types result in different type-code letters,
1367     # so convert them all to "0"
1368     s%(?<!lsearch)[^ ](?=TESTSUITE/aux-fixed/(?:0414.list[12]|0464.domains)$)%0%;
1369
1370     # DISABLE_OCSP
1371     next if /in hosts_requ(est|ire)_ocsp\? (no|yes)/;
1372
1373     # SUPPORT_PROXY
1374     next if /host in hosts_proxy\?/;
1375
1376     # PIPE_CONNECT
1377     if ( /^(>>>)?\s*host in pipelining_connect_advertise_hosts\?$/ )
1378       {
1379       $_ = <IN>;
1380       while ( /^(>>>)?\s*list element:/ ) { $_ = <IN>; }
1381       goto RESET_AFTER_EXTRA_LINE_READ;
1382       }
1383     next if / in (?:pipelining_connect_advertise_hosts|hosts_pipe_connect)?\? no /;
1384
1385     # Experimental_International
1386     next if / in smtputf8_advertise_hosts\? no \(option unset\)/;
1387
1388     # Experimental_REQUIRETLS
1389     next if / in tls_advertise_requiretls?\? no \(end of list\)/;
1390
1391     # Experimental_LIMITS
1392     if ( /^((>>>)?\s*host)? in limits_advertise_hosts\?$/ )
1393       {
1394       $_ = <IN>;
1395       while ( /^(>>>)?\s*list element: !\*$/ ) { $_ = <IN>; }
1396       goto RESET_AFTER_EXTRA_LINE_READ;
1397       }
1398     next if / in limits_advertise_hosts?\? no \(matched "!\*"\)/;
1399
1400     # Experimental_XCLIENT
1401     next if / in hosts_xclient?\? no \(option unset\)/;
1402
1403     # TCP Fast Open
1404     next if /^(ppppp )?setsockopt FASTOPEN: Network Error/;
1405
1406     # DISABLE_TLS_RESUME
1407     # TLS resumption is not always supported by the build
1408     next if /in tls_resumption_hosts\?/;
1409     next if /RE '.outlook.com/;
1410
1411     # Environment cleaning
1412     next if /\w+ in keep_environment\? (yes|no)/;
1413
1414     # Sizes vary with test hostname
1415     s/^cmd buf flush \d+ bytes/cmd buf flush ddd bytes/;
1416
1417     # Spool filesystem free space changes on different systems.
1418     s/^((?:spool|log) directory space =) -?\d+K (inodes =)\s*-?\d+/$1 nnnnnK $2 nnnnn/;
1419
1420     # Non-TLS builds have different expansions for received_header_text
1421     if (s/(with \$received_protocol)\}\} \$\{if def:tls_cipher \{\(\$tls_cipher\)\n$/$1/)
1422       {
1423       $_ .= <IN>;
1424       s/[\sâ•Ž]+\}\}(?=\(Exim )/\}\} /;
1425       }
1426     if (/^ â”œâ”€â”€condition: def:tls_cipher$/)
1427       {
1428       <IN>; <IN>; <IN>; <IN>; <IN>; <IN>;
1429       <IN>; <IN>; <IN>; <IN>; <IN>; next;
1430       }
1431
1432     # Not all platforms build with DKIM enabled
1433     next if /^DKIM >> Body data for hash, canonicalized/;
1434
1435     # Not all platforms build with SPF enabled
1436     next if /^(spf_conn_init|SPF_dns_exim_new|spf_compile\.c)/;
1437
1438     # Not all platforms have sendfile support
1439     next if /^cannot use sendfile for body: no support$/;
1440
1441     #  Parts of DKIM-specific debug output depend on the time/date
1442     next if /^date:\w+,\{SP\}/;
1443     next if /^DKIM \[[^[]+\] (Header hash|b) computed:/;
1444
1445     # Not all platforms support TCP Fast Open, and the compile omits the check
1446     if (s/\S+ in hosts_try_fastopen\? (no \(option unset\)|no \(end of list\)|yes \(matched "\*"\))\n$//)
1447       {
1448       chomp;
1449       $_ .= <IN>;
1450       s/ \.\.\. >>> / ... /;
1451       if (s/ non-TFO mode connection attempt to 224.0.0.0, 0 data\b$//) { chomp; $_ .= <IN>; }
1452       s/Address family not supported by protocol family/Network Error/;
1453       s/Network is unreachable/Network Error/;
1454       }
1455     next if /^(ppppp |\d+ )?setsockopt FASTOPEN: Protocol not available$/;
1456     s/^(Connecting to .* \.\.\. sending) \d+ (nonTFO early-data)$/$1 dd $2/;
1457
1458     if (/^([0-9: ]*                                             # possible timestamp
1459         Connecting\ to\ [^ ]+\ [^ ]+(\ from\ [^ ]+)?)\ \.\.\.
1460         \ .*TFO\ mode\x20
1461         (sendto,\ no\ data:\ EINPROGRESS                        # Linux
1462         |connection\ attempt\ to\ [^,]+,\ 0\ data)              # MacOS & no-support
1463         $/x)
1464       {
1465       $_ = $1 . " ... " . <IN>;
1466       s/^(.* \.\.\.) [0-9: ]*connected$/$1  connected/;
1467
1468       if (/^Connecting to .* \.\.\.  connected$/)
1469         {
1470         $_ .= <IN>;
1471         if (/^(Connecting to .* \.\.\.  )connected\n\s+SMTP(\(close\)>>|\(Connection refused\)<<)$/)
1472           {
1473           $_ = $1 . "failed: Connection refused\n" . <IN>;
1474           s/^(Connecting .*)\n\s+SMTP\(close\)>>$/$1/;
1475           }
1476         elsif (/^(Connecting to .* \.\.\.  connected\n)read response data: size=/)
1477           { $_ = $1; }
1478
1479         # Date/time in SMTP banner
1480         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}
1481           /Tue, 2 Mar 1999 09:44:33 +0000/gx;
1482         }
1483       }
1484
1485     # Specific pointer values reported for DB operations change from run to run
1486     s/^(\s*returned from EXIM_DBOPEN: )(0x)?[0-9a-f]+/${1}0xAAAAAAAA/;
1487     s/^(\s*EXIM_DBCLOSE.)(0x)?[0-9a-f]+/${1}0xAAAAAAAA/;
1488
1489     # Platform-dependent output during MySQL startup
1490     next if /PerconaFT file system space/;
1491     next if /^Waiting for MySQL server to answer/;
1492     next if /mysqladmin: CREATE DATABASE failed; .* database exists/;
1493
1494     # Postgres version-dependent differences
1495     s/^initdb: warning: (enabling "trust" authentication for local connections)$/\nWARNING: $1/;
1496     # Postgre DB server PID
1497     s/ \[\d+\] (?=(LOG:  redirecting log|HINT:  Future log output))/ [pppp] /;
1498
1499     # Not all builds include DMARC
1500     next if /^DMARC: no (dmarc_tld_file|sender_host_address)$/ ;
1501
1502     # Platform differences in errno strings
1503     s/  SMTP\(Operation timed out\)<</  SMTP(Connection timed out)<</;
1504
1505     # Platform differences for errno values (eg. Hurd)
1506     s/^errno = \d+$/errno = EEE/;
1507     s/^writing error \d+: /writing error EEE: /;
1508
1509     # Time-only, in debug output
1510     # we have to handle double lines from the DBOPEN, hence placed down here and /mg
1511     s/^\d\d:\d\d:\d\d\s+/01:01:01 /mg;
1512
1513     # pid in debug lines
1514     s/^(\d\d:\d\d:\d\d\s+)(\d+)/$1 . new_value($2, "p%s", \$next_pid) . " "/mgxe;
1515     s/(?<!post-)[Pp]rocess\K(\s\d+ )/new_value($1, "p%s", \$next_pid) . " "/gxe;
1516
1517     # Path in environment varies
1518     s/ PATH=\K.*$/<munged>/;
1519
1520     # When Exim is checking the size of directories for maildir, it uses
1521     # the check_dir_size() function to scan directories. Of course, the order
1522     # of the files that are obtained using readdir() varies from system to
1523     # system. We therefore buffer up debugging lines from check_dir_size()
1524     # and sort them before outputting them.
1525
1526     if (/^check_dir_size:/ || /^skipping TESTSUITE\/test-mail\//)
1527       {
1528       push @saved, $_;
1529       }
1530     else
1531       {
1532       if (@saved > 0)
1533         {
1534         print MUNGED "MUNGED: the check_dir_size lines have been sorted " .
1535           "to ensure consistency\n";
1536         @saved = sort(@saved);
1537         print MUNGED @saved;
1538         @saved = ();
1539         }
1540
1541       print MUNGED;
1542       }
1543
1544     next;
1545     }
1546
1547   # ======== log ========
1548
1549   elsif ($is_log)
1550     {
1551     # Berkeley DB version differences
1552     next if / Berkeley DB error: /;
1553
1554     # CHUNKING: exact sizes depend on hostnames in headers
1555     s/(=>.* K C="250- \d)\d+ (byte chunk, total \d)\d+/$1nn $2nn/;
1556
1557     # OpenSSL version variances
1558     s/(TLS error on connection [^:]*: error:)[0-9A-F]{8}(:system library):(?:fopen|func\(4095\)|):(No such file or directory)$/$1xxxxxxxx$2:fopen:$3/;
1559     next if /TLS error \(SSL_read\): .*error:0A000126:SSL routines::unexpected eof while reading$/ ;
1560     s/EVDATA: \K\(SSL_accept\): error:0A000126:SSL routines::unexpected eof while reading/SSL_accept: TCP connection closed by peer/;
1561     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/;
1562     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./;
1563     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/;
1564
1565     # GnuTLS version variances
1566     if (/TLS error on connection \(recv\): .* (Decode error|peer did not send any certificate)/)
1567       {
1568       my $prev = $_;
1569       $_ = <IN>;
1570       if (/error on first read/)
1571         {
1572         s/TLS session: \Kerror on first read:/(gnutls_handshake): A TLS fatal alert has been received.:/;
1573         goto RESET_AFTER_EXTRA_LINE_READ;
1574         }
1575       else
1576         { $_ = $prev; }
1577       }
1578     # translate GnuTLS error into the OpenSSL one
1579     s/ARC: AMS signing: privkey PEM-block import: \KThe requested data were not available.$/error:0906D06C:PEM routines:PEM_read_bio:no start line/;
1580     # and then both into the OpenSSL 3.x one
1581     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/;
1582
1583     # DKIM timestamps
1584     if ( /(DKIM: d=.*) t=([0-9]*) x=([0-9]*) / )
1585       {
1586       my ($prefix, $t_diff) = ($1, $3 - $2);
1587       s/DKIM: d=.* t=[0-9]* x=[0-9]* /${prefix} t=T x=T+${t_diff} /;
1588       }
1589     # GnuTLS reports a different keysize vs. OpenSSL, for ed25519 keys
1590     s/signer: [^ ]* bits:\K 256/ 253/;
1591     s/public key too short:\K 256 bits/ 253 bits/;
1592
1593     # with GnuTLS we cannot log single bad ALPN.  So ignore the with-OpenSSL log line.
1594     # next if /TLS ALPN (http) rejected$/;
1595
1596     # port numbers
1597     s/(?:\[[^\]]*\]:|port )\K$parm_port_d/PORT_D/;
1598     s/(?:\[[^\]]*\]:|port )\K$parm_port_d2/PORT_D2/;
1599     s/(?:\[[^\]]*\]:|port )\K$parm_port_d3/PORT_D3/;
1600     s/(?:\[[^\]]*\]:|port )\K$parm_port_d4/PORT_D4/;
1601     s/(?:\[[^\]]*\]:|port )\K$parm_port_s/PORT_S/;
1602     s/(?:\[[^\]]*\]:|port )\K$parm_port_n/PORT_N/;
1603     s/I=\[[^\]]*\]:\K\d+/ppppp/;
1604
1605     # Platform differences for errno values (eg. Hurd).  Leave 0 and negative numbers alone.
1606     s/R=\w+ T=\w+ defer\K \([1-9]\d*\): / (EEE): /;
1607
1608     # Platform differences in errno strings
1609     s/Arg list too long/Argument list too long/;
1610
1611     # OpenSSL vs. GnuTLS
1612     s/session: \K\((SSL_connect|gnutls_handshake)\): timed out/(tls lib connect fn): timed out/;
1613     s/TLS error on connection from .*\K\((SSL_accept|gnutls_handshake)\): timed out/(tls lib accept fn): timed out/;
1614     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/;
1615     s/TLS session: \K\(gnutls_handshake\): rxd alert: No supported application protocol could be negotiated/(SSL_connect): error: <<detail omitted>>/;
1616     s/\(gnutls_handshake\): No common application protocol could be negotiated./(SSL_accept): error: <<detail omitted>>/;
1617     }
1618
1619   # ======== mail ========
1620
1621   elsif ($is_mail)
1622     {
1623     # DKIM timestamps, and signatures depending thereon
1624     if ( /^(\s+)t=([0-9]*); x=([0-9]*); b=[A-Za-z0-9+\/]+$/ )
1625       {
1626       my ($indent, $t_diff) = ($1, $3 - $2);
1627       s/.*/${indent}t=T; x=T+${t_diff}; b=bbbb;/;
1628       <IN>;
1629       <IN>;
1630       }
1631     }
1632
1633   # ======== All files other than stderr ========
1634
1635   print MUNGED;
1636   }
1637
1638 close(IN);
1639 return $yield;
1640 }
1641
1642
1643
1644
1645 ##################################################
1646 #        Subroutine to interact with caller      #
1647 ##################################################
1648
1649 # Arguments: [0] the prompt string
1650 #            [1] if there is a U in the prompt and $force_update is true
1651 #            [2] if there is a C in the prompt and $force_continue is true
1652 # Returns:   returns the answer
1653
1654 sub interact {
1655   my ($prompt, $have_u, $have_c) = @_;
1656
1657   print $prompt;
1658
1659   if ($have_u) {
1660     print "... update forced\n";
1661     return 'u';
1662   }
1663
1664   if ($have_c) {
1665     print "... continue forced\n";
1666     return 'c';
1667   }
1668
1669   return lc <T>;
1670 }
1671
1672
1673
1674 ##################################################
1675 #    Subroutine to log in force_continue mode    #
1676 ##################################################
1677
1678 # In force_continue mode, we just want a terse output to a statically
1679 # named logfile.  If multiple files in same batch (stdout, stderr, etc)
1680 # all have mismatches, it will log multiple times.
1681 #
1682 # Arguments: [0] the logfile to append to
1683 #            [1] the testno that failed
1684 # Returns:   nothing
1685
1686
1687
1688 sub log_failure {
1689   my ($logfile, $testno, $detail) = @_;
1690
1691   open(my $fh, '>>', $logfile) or return;
1692
1693   print $fh "Test $testno "
1694         . (defined $detail ? "$detail " : '')
1695         . "failed\n";
1696 }
1697
1698 # Computer-readable summary results logfile
1699
1700 sub log_test {
1701   my ($logfile, $testno, $resultchar) = @_;
1702
1703   open(my $fh, '>>', $logfile) or return;
1704   print $fh "$testno $resultchar\n";
1705 }
1706
1707
1708
1709 ##################################################
1710 #    Subroutine to compare one output file       #
1711 ##################################################
1712
1713 # When an Exim server is part of the test, its output is in separate files from
1714 # an Exim client. The server data is concatenated with the client data as part
1715 # of the munging operation.
1716 #
1717 # Arguments:  [0] the name of the main raw output file
1718 #             [1] the name of the server raw output file or undef
1719 #             [2] where to put the munged copy
1720 #             [3] the name of the saved file
1721 #             [4] TRUE if this is a log file whose deliveries must be sorted
1722 #             [5] optionally, a custom munge command
1723 #
1724 # Returns:    0 comparison succeeded
1725 #             1 comparison failed; differences to be ignored
1726 #             2 comparison failed; files may have been updated (=> re-compare)
1727 #
1728 # Does not return if the user replies "Q" to a prompt.
1729
1730 sub check_file{
1731 my($rf,$rsf,$mf,$sf,$sortfile,$extra) = @_;
1732
1733 # If there is no saved file, the raw files must either not exist, or be
1734 # empty. The test ! -s is TRUE if the file does not exist or is empty.
1735
1736 # we check if there is a flavour specific file, but we remember
1737 # the original file name as "generic"
1738 $sf_generic = $sf;
1739 $sf_flavour = "$sf_generic.$flavour";
1740 $sf_current = -e $sf_flavour ? $sf_flavour : $sf_generic;
1741
1742 if (! -e $sf_current)
1743   {
1744   return 0 if (! -s $rf && (! defined $rsf || ! -s $rsf));
1745
1746   print "\n";
1747   print "** $rf is not empty\n" if (-s $rf);
1748   print "** $rsf is not empty\n" if (defined $rsf && -s $rsf);
1749
1750   for (;;)
1751     {
1752     $_ = interact('Continue, Show, or Quit? [Q] ', undef, $force_continue);
1753     tests_exit(1) if /^q?$/;
1754     if (/^c$/ && $force_continue) {
1755       log_failure($log_failed_filename, $testno, $rf);
1756       log_test($log_summary_filename, $testno, 'F') if ($force_continue);
1757     }
1758     return 1 if /^c$/i && $rf !~ /paniclog/ && (!defined $rsf || $rsf !~ /paniclog/);
1759     last if (/^[sc]$/);
1760     }
1761
1762   foreach $f ($rf, $rsf)
1763     {
1764     if (defined $f && -s $f)
1765       {
1766       print "\n";
1767       print "------------ $f -----------\n"
1768         if (defined $rf && -s $rf && defined $rsf && -s $rsf);
1769       system @more => $f;
1770       }
1771     }
1772
1773   print "\n";
1774   for (;;)
1775     {
1776     $_ = interact('Continue, Update & retry, Quit? [Q] ', $force_update, $force_continue);
1777     tests_exit(1) if /^q?$/;
1778     if (/^c$/ && $force_continue) {
1779       log_failure($log_failed_filename, $testno, $rf);
1780       log_test($log_summary_filename, $testno, 'F')
1781     }
1782     return 1 if /^c$/i;
1783     last if (/^u$/i);
1784     }
1785   }
1786
1787 #### $_
1788
1789 # Control reaches here if either (a) there is a saved file ($sf), or (b) there
1790 # was a request to create a saved file. First, create the munged file from any
1791 # data that does exist.
1792
1793 open(MUNGED, '>', $mf) || tests_exit(-1, "Failed to open $mf: $!");
1794 my($truncated) = munge($rf, $extra) if -e $rf;
1795
1796 # Append the raw server log, if it is non-empty
1797 if (defined $rsf && -e $rsf)
1798   {
1799   print MUNGED "\n******** SERVER ********\n";
1800   $truncated |= munge($rsf, $extra);
1801   }
1802 close(MUNGED);
1803
1804 # If a saved file exists, do the comparison. There are two awkward cases:
1805 #
1806 # If "*** truncated ***" was found in the new file, it means that a log line
1807 # was overlong, and truncated. The problem is that it may be truncated at
1808 # different points on different systems, because of different user name
1809 # lengths. We reload the file and the saved file, and remove lines from the new
1810 # file that precede "*** truncated ***" until we reach one that matches the
1811 # line that precedes it in the saved file.
1812 #
1813 # If $sortfile is set, we are dealing with a mainlog file where the deliveries
1814 # for an individual message might vary in their order from system to system, as
1815 # a result of parallel deliveries. We load the munged file and sort sequences
1816 # of delivery lines.
1817
1818 if (-e $sf_current)
1819   {
1820   # Deal with truncated text items
1821
1822   if ($truncated)
1823     {
1824     my(@munged, @saved, $i, $j, $k);
1825
1826     open(MUNGED, $mf) || tests_exit(-1, "Failed to open $mf: $!");
1827     @munged = <MUNGED>;
1828     close(MUNGED);
1829     open(SAVED, $sf_current) || tests_exit(-1, "Failed to open $sf_current: $!");
1830     @saved = <SAVED>;
1831     close(SAVED);
1832
1833     $j = 0;
1834     for ($i = 0; $i < @munged; $i++)
1835       {
1836       if ($munged[$i] =~ /\*\*\* truncated \*\*\*/)
1837         {
1838         for (; $j < @saved; $j++)
1839           { last if $saved[$j] =~ /\*\*\* truncated \*\*\*/; }
1840         last if $j >= @saved;     # not found in saved
1841
1842         for ($k = $i - 1; $k >= 0; $k--)
1843           { last if $munged[$k] eq $saved[$j - 1]; }
1844
1845         last if $k <= 0;          # failed to find previous match
1846         splice @munged, $k + 1, $i - $k - 1;
1847         $i = $k + 1;
1848         }
1849       }
1850
1851     open(my $fh, '>', $mf) or tests_exit(-1, "Failed to open $mf: $!");
1852     print $fh @munged;
1853     }
1854
1855   # Deal with log sorting
1856
1857   if ($sortfile)
1858     {
1859
1860     my @munged = do {
1861       open(my $fh, '<', $mf) or tests_exit(-1, "Failed to open $mf: $!");
1862       <$fh>;
1863     };
1864
1865     for (my $i = 0; $i < @munged; $i++)
1866       {
1867       if ($munged[$i] =~ /^[-\d]{10}\s[:\d]{8}\s[-A-Za-z\d]{16}\s[-=*]>/)
1868         {
1869         my $j;
1870         for ($j = $i + 1; $j < @munged; $j++)
1871           {
1872           last if $munged[$j] !~
1873             /^[-\d]{10}\s[:\d]{8}\s[-A-Za-z\d]{16}\s[-=*]>/;
1874           }
1875         @temp = splice(@munged, $i, $j - $i);
1876         @temp = sort(@temp);
1877         splice(@munged, $i, 0, @temp);
1878         }
1879       }
1880
1881     open(my $fh, '>', $mf) or tests_exit(-1, "Failed to open $mf: $!");
1882     print $fh "**NOTE: The delivery lines in this file have been sorted.\n";
1883     print $fh @munged;
1884     }
1885
1886   # Do the comparison
1887
1888   return 0 if (system("$cf '$mf' '$sf_current' >test-cf") == 0);
1889
1890   # Handle comparison failure
1891
1892   print "** Comparison of $mf with $sf_current failed";
1893   system @more => 'test-cf';
1894
1895   print "\n";
1896   for (;;)
1897     {
1898     $_ = interact('Continue, Retry, Update current'
1899         . ($sf_current ne $sf_flavour  ? "/Save for flavour '$flavour'" : '')
1900         . ' & retry, Quit? [Q] ', $force_update, $force_continue);
1901     tests_exit(1) if /^q?$/;
1902     if (/^c$/ && $force_continue) {
1903       log_failure($log_failed_filename, $testno, $sf_current);
1904       log_test($log_summary_filename, $testno, 'F')
1905     }
1906     return 1 if /^c$/i;
1907     return 2 if /^r$/i;
1908     last if (/^[us]$/i);
1909     }
1910   }
1911
1912 # Update or delete the saved file, and give the appropriate return code.
1913
1914 if (-s $mf)
1915   {
1916     my $sf = /^u/i ? $sf_current : $sf_flavour;
1917     copy($mf, $sf) or tests_exit(-1, "Failed to copy $mf $sf");
1918   }
1919 else
1920   {
1921     # if we deal with a flavour file, we can't delete it, because next time the generic
1922     # file would be used again
1923     if ($sf_current eq $sf_flavour) {
1924       open(my $fh, '>', $sf_current);
1925     }
1926     else {
1927       tests_exit(-1, "Failed to unlink $sf_current") if !unlink($sf_current);
1928     }
1929   }
1930
1931 return 2;
1932 }
1933
1934
1935
1936 ##################################################
1937 # Custom munges
1938 # keyed by name of munge; value is a ref to a hash
1939 # which is keyed by file, value a string to look for.
1940 # Usable files are:
1941 #  paniclog, rejectlog, mainlog, stdout, stderr, msglog, mail
1942 # Search strings starting with 's' do substitutions;
1943 # with '/' do line-skips,
1944 # with 'R' run given code.
1945 # Triggered by a scriptfile line "munge <name>"
1946 ##################################################
1947 $munges =
1948   { 'dnssec' =>
1949     { 'stderr' => '/^Reverse DNS security status: unverified\n/' },
1950
1951     'gnutls_unexpected' =>
1952     { 'mainlog' => '/\(recv\): A TLS packet with unexpected length was received./' },
1953
1954     'gnutls_handshake' =>
1955     { 'mainlog' => 's/\(gnutls_handshake\): Error in the push function/\(gnutls_handshake\): A TLS packet with unexpected length was received/' },
1956
1957     'gnutls_bad_clientcert' =>
1958     { 'mainlog' => 's/\(certificate verification failed\): certificate invalid/\(gnutls_handshake\): The peer did not send any certificate./',
1959       'stdout'  => 's/Succeeded in starting TLS/A TLS fatal alert has been received.\nFailed to start TLS'
1960     },
1961
1962     'optional_events' =>
1963     { 'stdout' => '/event_action =/' },
1964
1965     'optional_ocsp' =>
1966     { 'stderr' => '/127.0.0.1 in hosts_requ(ire|est)_ocsp/' },
1967
1968     'optional_cert_hostnames' =>
1969     { 'stderr' => '/in tls_verify_cert_hostnames\? no/' },
1970
1971     'loopback' =>
1972     { 'stdout' => 's/[[](127\.0\.0\.1|::1)]/[IP_LOOPBACK_ADDR]/' },
1973
1974     'scanfile_size' =>
1975     { 'stdout' => 's/(Content-length:) \d\d\d/$1 ddd/' },
1976
1977     'delay_1500' =>
1978     { 'stderr' => 's/(1[5-9]|23\d)\d\d msec/ssss msec/' },
1979
1980     'tls_anycipher' =>
1981     { 'mainlog'   => 's! X=TLS\S+ ! X=TLS_proto_and_cipher !;
1982                       s! DN="C=! DN="/C=!;
1983                       s! DN="[^,"]*\K,!/!;
1984                       s! DN="[^,"]*\K,!/!;
1985                       s! DN="[^,"]*\K,!/!;
1986                      ',
1987       'rejectlog' => 's/ X=TLS\S+ / X=TLS_proto_and_cipher /',
1988     },
1989
1990     'optional_dsn_info' =>
1991     { 'mail' => 'Rif (/^(X-(Remote-MTA-(smtp-greeting|helo-response)|Exim-Diagnostic|(body|message)-linecount):|Remote-MTA: X-ip;)/) {
1992                     while (1) {
1993                       $_ = <IN>;
1994                       next if /^ /;
1995                       goto RESET_AFTER_EXTRA_LINE_READ;
1996                     }
1997                   }'
1998     },
1999
2000     'optional_config' =>
2001     { 'stdout' => '/^(
2002                   dkim_(canon|domain|private_key|selector|sign_headers|strict|hash|identity|timestamps)
2003                   |gnutls_require_(kx|mac|protocols)
2004                   |hosts_pipe_connect
2005                   |hosts_(requ(est|ire)|try)_(dane|ocsp)
2006                   |dane_require_tls_ciphers
2007                   |hosts_(avoid|nopass|noproxy|require|verify_avoid)_tls
2008                   |pipelining_connect_advertise_hosts
2009                   |socks_proxy
2010                   |tls_[^ ]*
2011                   |utf8_downconvert
2012                   )($|[ ]=)/x'
2013     },
2014
2015     'sys_bindir' =>
2016     { 'mainlog' => 's%/(usr/(local/)?)?bin/%SYSBINDIR/%' },
2017
2018     'sync_check_data' =>
2019     { 'mainlog'   => 's/^(.* SMTP protocol synchronization error .* next input=.{8}).*$/$1<suppressed>/',
2020       'rejectlog' => 's/^(.* SMTP protocol synchronization error .* next input=.{8}).*$/$1<suppressed>/'},
2021
2022     'timeout_errno' =>          # actual errno differs Solaris vs. Linux
2023     { 'mainlog' => 's/((?:host|message) deferral .* errno) <\d+> /$1 <EEE> /' },
2024
2025     'peer_terminated_conn' =>   # actual error differs FreedBSD vs. Linux
2026     { 'stderr' => 's/^(  SMTP\()Connection reset by peer(\)<<)$/$1closed$2/' },
2027
2028     'perl_variants' =>          # result of hash-in-scalar-context changed from bucket-fill to keycount
2029     { 'stdout' => 's%^> X/X$%> X%' },
2030   };
2031
2032
2033 sub max {
2034   my ($a, $b) = @_;
2035   return $a if ($a > $b);
2036   return $b;
2037 }
2038
2039 ##################################################
2040 #    Subroutine to check the output of a test    #
2041 ##################################################
2042
2043 # This function is called when the series of subtests is complete. It makes
2044 # use of check_file(), whose arguments are:
2045 #
2046 #  [0] the name of the main raw output file
2047 #  [1] the name of the server raw output file or undef
2048 #  [2] where to put the munged copy
2049 #  [3] the name of the saved file
2050 #  [4] TRUE if this is a log file whose deliveries must be sorted
2051 #  [5] an optional custom munge command
2052 #
2053 # Arguments: Optionally, name of a single custom munge to run.
2054 # Returns:   0 if the output compared equal
2055 #            1 if comparison failed; differences to be ignored
2056 #            2 if re-run needed (files may have been updated)
2057
2058 sub check_output{
2059 my($mungename) = $_[0];
2060 my($yield) = 0;
2061 my($munge) = $munges->{$mungename} if defined $mungename;
2062
2063 $yield = max($yield,  check_file("spool/log/paniclog",
2064                        "spool/log/serverpaniclog",
2065                        "test-paniclog-munged",
2066                        "paniclog/$testno", 0,
2067                        $munge->{paniclog}));
2068
2069 $yield = max($yield,  check_file("spool/log/rejectlog",
2070                        "spool/log/serverrejectlog",
2071                        "test-rejectlog-munged",
2072                        "rejectlog/$testno", 0,
2073                        $munge->{rejectlog}));
2074
2075 $yield = max($yield,  check_file("spool/log/mainlog",
2076                        "spool/log/servermainlog",
2077                        "test-mainlog-munged",
2078                        "log/$testno", $sortlog,
2079                        $munge->{mainlog}));
2080
2081 if (!$stdout_skip)
2082   {
2083   $yield = max($yield,  check_file("test-stdout",
2084                        "test-stdout-server",
2085                        "test-stdout-munged",
2086                        "stdout/$testno", 0,
2087                        $munge->{stdout}));
2088   }
2089
2090 if (!$stderr_skip)
2091   {
2092   $yield = max($yield,  check_file("test-stderr",
2093                        "test-stderr-server",
2094                        "test-stderr-munged",
2095                        "stderr/$testno", 0,
2096                        $munge->{stderr}));
2097   }
2098
2099 # Compare any delivered messages, unless this test is skipped.
2100
2101 if (! $message_skip)
2102   {
2103   my($msgno) = 0;
2104
2105   # Get a list of expected mailbox files for this script. We don't bother with
2106   # directories, just the files within them.
2107
2108   foreach $oldmail (@oldmails)
2109     {
2110     next unless $oldmail =~ /^mail\/$testno\./;
2111     print ">> EXPECT $oldmail\n" if $debug;
2112     $expected_mails{$oldmail} = 1;
2113     }
2114
2115   # If there are any files in test-mail, compare them. Note that "." and
2116   # ".." are automatically omitted by list_files_below().
2117
2118   @mails = list_files_below("test-mail");
2119
2120   foreach $mail (@mails)
2121     {
2122     next if $mail =~ /^test-mail\/oncelog(.(dir|pag|db))?$/;
2123
2124     $saved_mail = substr($mail, 10);               # Remove "test-mail/"
2125     $saved_mail =~ s/^$parm_caller(\/|$)/CALLER/;  # Convert caller name
2126
2127     if ($saved_mail =~ /(\d+\.[^.]+\.)/)
2128       {
2129       $msgno++;
2130       $saved_mail =~ s/(\d+\.[^.]+\.)/$msgno./gx;
2131       }
2132
2133     print ">> COMPARE $mail mail/$testno.$saved_mail\n" if $debug;
2134     $yield = max($yield,  check_file($mail, undef, "test-mail-munged",
2135       "mail/$testno.$saved_mail", 0,
2136       $munge->{mail}));
2137     delete $expected_mails{"mail/$testno.$saved_mail"};
2138     }
2139
2140   # Complain if not all expected mails have been found
2141
2142   if (scalar(keys %expected_mails) != 0)
2143     {
2144     foreach $key (keys %expected_mails)
2145       { print "** no test file found for $key\n"; }
2146
2147     for (;;)
2148       {
2149       $_ = interact('Continue, Update & retry, or Quit? [Q] ', $force_update, $force_continue);
2150       tests_exit(1) if /^q?$/;
2151       if (/^c$/ && $force_continue) {
2152         log_failure($log_failed_filename, $testno, "missing email");
2153         log_test($log_summary_filename, $testno, 'F')
2154       }
2155       last if /^c$/;
2156
2157       # For update, we not only have to unlink the file, but we must also
2158       # remove it from the @oldmails vector, as otherwise it will still be
2159       # checked for when we re-run the test.
2160
2161       if (/^u$/)
2162         {
2163         foreach $key (keys %expected_mails)
2164           {
2165           my($i);
2166           tests_exit(-1, "Failed to unlink $key") if !unlink("$key");
2167           for ($i = 0; $i < @oldmails; $i++)
2168             {
2169             if ($oldmails[$i] eq $key)
2170               {
2171               splice @oldmails, $i, 1;
2172               last;
2173               }
2174             }
2175           }
2176         last;
2177         }
2178       }
2179     }
2180   }
2181
2182 # Compare any remaining message logs, unless this test is skipped.
2183
2184 if (! $msglog_skip)
2185   {
2186   # Get a list of expected msglog files for this test
2187
2188   foreach $oldmsglog (@oldmsglogs)
2189     {
2190     next unless $oldmsglog =~ /^$testno\./;
2191     $expected_msglogs{$oldmsglog} = 1;
2192     }
2193
2194   # If there are any files in spool/msglog, compare them. However, we have
2195   # to munge the file names because they are message ids, which are
2196   # time dependent.
2197
2198   if (opendir(DIR, "spool/msglog"))
2199     {
2200     @msglogs = sort readdir(DIR);
2201     closedir(DIR);
2202
2203     foreach $msglog (@msglogs)
2204       {
2205       next if ($msglog eq "." || $msglog eq ".." || $msglog eq "CVS");
2206
2207       ($munged_msglog = $msglog) =~
2208         s/((?:[^\W_]{6}-){2}[^\W_]{2})
2209           /new_value($1, "10Hm%s-0005vi-00", \$next_msgid_old)/egx;
2210
2211       $munged_msglog =~
2212         s/([^\W_]{6}-[^\W_]{11}-[^\W_]{4})
2213           /new_value($1, "10Hm%s-000000005vi-0000", \$next_msgid)/egx;
2214
2215       $yield = max($yield,  check_file("spool/msglog/$msglog", undef,
2216         "test-msglog-munged", "msglog/$testno.$munged_msglog", 0,
2217         $munge->{msglog}));
2218       delete $expected_msglogs{"$testno.$munged_msglog"};
2219       }
2220     }
2221
2222   # Complain if not all expected msglogs have been found
2223
2224   if (scalar(keys %expected_msglogs) != 0)
2225     {
2226     foreach $key (keys %expected_msglogs)
2227       {
2228       print "** no test msglog found for msglog/$key\n";
2229       ($msgid) = $key =~ /^\d+\.(.*)$/;
2230       foreach $cachekey (keys %cache)
2231         {
2232         if ($cache{$cachekey} eq $msgid)
2233           {
2234           print "** original msgid $cachekey\n";
2235           last;
2236           }
2237         }
2238       }
2239
2240     for (;;)
2241       {
2242       $_ = interact('Continue, Update, or Quit? [Q] ', $force_update, $force_continue);
2243       tests_exit(1) if /^q?$/;
2244       if (/^c$/ && $force_continue) {
2245         log_failure($log_failed_filename, $testno, "missing msglog");
2246         log_test($log_summary_filename, $testno, 'F')
2247       }
2248       last if /^c$/;
2249       if (/^u$/)
2250         {
2251         foreach $key (keys %expected_msglogs)
2252           {
2253           tests_exit(-1, "Failed to unlink msglog/$key")
2254             if !unlink("msglog/$key");
2255           }
2256         last;
2257         }
2258       }
2259     }
2260   }
2261
2262 return $yield;
2263 }
2264
2265
2266
2267 ##################################################
2268 #     Subroutine to run one "system" command     #
2269 ##################################################
2270
2271 # We put this in a subroutine so that the command can be reflected when
2272 # debugging.
2273 #
2274 # Argument: the command to be run
2275 # Returns:  nothing
2276
2277 sub run_system {
2278 my($cmd) = $_[0];
2279 if ($debug)
2280   {
2281   my($prcmd) = $cmd;
2282   $prcmd =~ s/; /;\n>> /;
2283   print ">> $prcmd\n";
2284   }
2285 system($cmd);
2286 }
2287
2288
2289
2290 ##################################################
2291 #      Subroutine to run one script command      #
2292 ##################################################
2293
2294 # The <SCRIPT> file is open for us to read an optional return code line,
2295 # followed by the command line and any following data lines for stdin. The
2296 # command line can be continued by the use of \. Data lines are not continued
2297 # in this way. In all lines, the following substitutions are made:
2298 #
2299 # DIR    => the current directory
2300 # CALLER => the caller of this script
2301 #
2302 # Arguments: the current test number
2303 #            reference to the subtest number, holding previous value
2304 #            reference to the expected return code value
2305 #            reference to where to put the command name (for messages)
2306 #            auxiliary information returned from a previous run
2307 #
2308 # Returns:   0 the command was executed inline, no subprocess was run
2309 #            1 a non-exim command was run and waited for
2310 #            2 an exim command was run and waited for
2311 #            3 a command was run and not waited for (daemon, server, exim_lock)
2312 #            4 EOF was encountered after an initial return code line
2313 # Optionally also a second parameter, a hash-ref, with auxiliary information:
2314 #            exim_pid: pid of a run process
2315 #            munge: name of a post-script results munger
2316
2317 sub run_command{
2318 my($testno) = $_[0];
2319 my($subtestref) = $_[1];
2320 my($commandnameref) = $_[3];
2321 my($aux_info) = $_[4];
2322 my($yield) = 1;
2323
2324 our %ENV = map { $_ => $ENV{$_} } grep { /^(?:USER|SHELL|PATH|TERM|EXIM_TEST_.*)$/ } keys %ENV;
2325
2326 if (/^(\d+)\s*(?:([A-Z]+)=(\S+))?$/)                # Handle unusual return code
2327   {
2328   my($r) = $_[2];
2329   $$r = $1 << 8;
2330   $ENV{$2} = $3 if (defined $2);
2331   $_ = <SCRIPT>;
2332   return 4 if !defined $_;       # Missing command
2333   $lineno++;
2334   }
2335
2336 chomp;
2337 $wait_time = 0;
2338
2339 # Handle concatenated command lines
2340
2341 s/\s+$//;
2342 while (substr($_, -1) eq"\\")
2343   {
2344   my($temp);
2345   $_ = substr($_, 0, -1);
2346   chomp($temp = <SCRIPT>);
2347   if (defined $temp)
2348     {
2349     $lineno++;
2350     $temp =~ s/\s+$//;
2351     $temp =~ s/^\s+//;
2352     $_ .= $temp;
2353     }
2354   }
2355
2356 # Do substitutions
2357
2358 do_substitute($testno);
2359 if ($debug) { printf ">> $_\n"; }
2360
2361 # Pass back the command name (for messages)
2362
2363 ($$commandnameref) = /^(\S+)/;
2364
2365 # Here follows code for handling the various different commands that are
2366 # supported by this script. The first group of commands are all freestanding
2367 # in that they share no common code and are not followed by any data lines.
2368
2369
2370 ###################
2371 ###################
2372
2373 # The "dbmbuild" command runs exim_dbmbuild. This is used both to test the
2374 # utility and to make DBM files for testing DBM lookups.
2375
2376 if (/^dbmbuild\s+(\S+)\s+(\S+)/)
2377   {
2378   run_system("(./eximdir/exim_dbmbuild $parm_cwd/$1 $parm_cwd/$2;" .
2379          "echo exim_dbmbuild exit code = \$?)" .
2380          ">>test-stdout");
2381   return 1;
2382   }
2383
2384
2385 # The "dump" command runs exim_dumpdb. On different systems, the output for
2386 # some types of dump may appear in a different order because it's just hauled
2387 # out of the DBM file. We can solve this by sorting. Ignore the leading
2388 # date/time, as it will be flattened later during munging.
2389
2390 if (/^dump\s+(\S+)/)
2391   {
2392   my $which  = $1;
2393   print ">> ./eximdir/exim_dumpdb $parm_cwd/spool $which\n" if $debug;
2394   open(my $in, "-|", './eximdir/exim_dumpdb', "$parm_cwd/spool", $which) or die "Can't run exim_dumpdb: $!";
2395   open(my $out, ">>test-stdout");
2396   print $out "+++++++++++++++++++++++++++\n";
2397
2398   if ($which eq "retry")
2399     {
2400     # the sort key is the first part of the retry db dump line, but for
2401     # sorting we (temporarly) replace the own hosts ipv4 with a munged
2402     # version, which matches the munging that is done later
2403     # Why? We must ensure sure, that 127.0.0.1 always sorts first
2404     # map-sort-map: Schwartz's transformation
2405     # test 0099
2406     my @temp = map  { $_->[1] }
2407                sort { $a->[0] cmp $b->[0] }
2408                #map  { [ (split)[0] =~ s/\Q$parm_ipv4/ip4.ip4.ip4.ip4/gr, $_ ] }  # this is too modern for 5.10.1
2409                map  {
2410                 (my $k = (split)[0]) =~ s/\Q$parm_ipv4\E/ip4.ip4.ip4.ip4/g;
2411                 [ $k, $_ ]
2412                }
2413                do { local $/ = "\n  "; <$in> };
2414     foreach $item (@temp)
2415       {
2416       $item =~ s/^\s*(.*)\n(.*)\n?\s*$/$1\n$2/m;
2417       print $out "  $item\n";
2418       }
2419     }
2420   else
2421     {
2422     my @temp = <$in>;
2423     if ($which eq "callout")
2424       {
2425       @temp = sort {
2426                    my($aa) = substr $a, 21;
2427                    my($bb) = substr $b, 21;
2428                    return $aa cmp $bb;
2429                    } @temp;
2430       }
2431     elsif ($which eq "seen")
2432       {
2433       @temp = sort {
2434                    (my $aa = $a) =~ s/^([\d.]+)/$1/;
2435                    (my $bb = $b) =~ s/^([\d.]+)/$1/;
2436                    $aa =~ s/\Q$parm_ipv4\E/ip4.ip4.ip4.ip4/;
2437                    $bb =~ s/\Q$parm_ipv4\E/ip4.ip4.ip4.ip4/;
2438                    return $aa cmp $bb;
2439                    } @temp;
2440       }
2441     print $out @temp;
2442     }
2443   close($in); # close it explicitly, otherwise $? does not get set
2444   return 1;
2445   }
2446
2447
2448 # verbose comments start with ###
2449 if (/^###\s/) {
2450   for my $file (qw(test-stdout test-stderr test-stderr-server test-stdout-server)) {
2451     open my $fh, '>>', $file or die "Can't open >>$file: $!\n";
2452     say {$fh} $_;
2453   }
2454   return 0;
2455 }
2456
2457 # The "echo" command is a way of writing comments to the screen.
2458 if (/^echo\s+(.*)$/)
2459   {
2460   print "$1\n";
2461   return 0;
2462   }
2463
2464
2465 # The "exim_lock" command runs exim_lock in the same manner as "server",
2466 # but it doesn't use any input.
2467
2468 if (/^exim_lock\s+(.*)$/)
2469   {
2470   $cmd = "./eximdir/exim_lock $1 >>test-stdout";
2471   $server_pid = open SERVERCMD, "|$cmd" ||
2472     tests_exit(-1, "Failed to run $cmd\n");
2473
2474   # This gives the process time to get started; otherwise the next
2475   # process may not find it there when it expects it.
2476
2477   select(undef, undef, undef, 0.1);
2478   return 3;
2479   }
2480
2481
2482 # The "exinext" command runs exinext
2483
2484 if (/^exinext\s+(.*)/)
2485   {
2486   run_system("(./eximdir/exinext " .
2487     "-DEXIM_PATH=$parm_cwd/eximdir/exim " .
2488     "-C $parm_cwd/test-config $1;" .
2489     "echo exinext exit code = \$?)" .
2490     ">>test-stdout");
2491   return 1;
2492   }
2493
2494
2495 # The "exigrep" command runs exigrep on the current mainlog
2496
2497 if (/^exigrep\s+(.*)/)
2498   {
2499   run_system("(./eximdir/exigrep " .
2500     "$1 $parm_cwd/spool/log/mainlog;" .
2501     "echo exigrep exit code = \$?)" .
2502     ">>test-stdout");
2503   return 1;
2504   }
2505
2506
2507 # The "exiqgrep" command runs exiqgrep on the current spool
2508
2509 if (/^exiqgrep(\s+.*)?/)
2510   {
2511   run_system("(./eximdir/exiqgrep -E ./eximdir/exim -C $parm_cwd/test-config" . ($1 || '') . ";" .
2512     "echo exiqgrep exit code = \$?)" .
2513     ">>test-stdout");
2514   return 1;
2515   }
2516
2517
2518 # The "eximstats" command runs eximstats on the current mainlog
2519
2520 if (/^eximstats\s+(.*)/)
2521   {
2522   run_system("(./eximdir/eximstats " .
2523     "$1 $parm_cwd/spool/log/mainlog;" .
2524     "echo eximstats exit code = \$?)" .
2525     ">>test-stdout");
2526   return 1;
2527   }
2528
2529
2530 # The "exim_id_update" command runs exim_id_update on the current spool
2531
2532 if (/^exim_id_update(\s+.*)?$/)
2533   {
2534   run_system("(sudo ./eximdir/exim_id_update" . ($1 || '') . " $parm_cwd/spool/input;" .
2535     "echo exim_id_update exit code = \$?)" .
2536     ">>test-stdout 2>>test-stderr");
2537   return 1;
2538   }
2539
2540
2541 # The "gnutls" command makes a copy of saved GnuTLS parameter data in the
2542 # spool directory, to save Exim from re-creating it each time.
2543
2544 if (/^gnutls/)
2545   {
2546   my $gen_fn = "spool/gnutls-params-$gnutls_dh_bits_normal";
2547   run_system "sudo cp -p aux-fixed/gnutls-params $gen_fn;" .
2548          "sudo chown $parm_eximuser:$parm_eximgroup $gen_fn;" .
2549          "sudo chmod 0400 $gen_fn";
2550   return 1;
2551   }
2552
2553
2554 # The "killdaemon" command should ultimately follow the starting of any Exim
2555 # daemon with the -bd option.
2556
2557 if (/^killdaemon/)
2558   {
2559   my $return_extra = {};
2560   if (exists $aux_info->{exim_pid})
2561     {
2562     $pid = $aux_info->{exim_pid};
2563     $return_extra->{exim_pid} = undef;
2564     print ">> killdaemon: recovered pid $pid\n" if $debug;
2565     if ($pid)
2566       {
2567       run_system("sudo /bin/kill -TERM $pid");
2568       wait;
2569       }
2570     } else {
2571     $pid = `cat $parm_cwd/spool/exim-daemon.*`;
2572     if ($pid)
2573       {
2574       run_system("sudo /bin/kill -TERM $pid");
2575       close DAEMONCMD;                                   # Waits for process
2576       }
2577     }
2578     run_system("sudo /bin/rm -f spool/exim-daemon.*");
2579   return (1, $return_extra);
2580   }
2581
2582
2583 # The "millisleep" command is like "sleep" except that its argument is in
2584 # milliseconds, thus allowing for a subsecond sleep, which is, in fact, all it
2585 # is used for.
2586
2587 elsif (/^millisleep\s+(.*)$/)
2588   {
2589   select(undef, undef, undef, $1/1000);
2590   return 0;
2591   }
2592
2593
2594 # The "munge" command selects one of a hardwired set of test-result modifications
2595 # to be made before result compares are run against the golden set.  This lets
2596 # us account for test-system dependent things which only affect a few, but known,
2597 # test-cases.
2598 # Currently only the last munge takes effect.
2599
2600 if (/^munge\s+(.*)$/)
2601   {
2602   return (0, { munge => $1 });
2603   }
2604
2605
2606 # The "sleep" command does just that. For sleeps longer than 1 second we
2607 # tell the user what's going on.
2608
2609 if (/^sleep\s+(.*)$/)
2610   {
2611   if ($1 == 1)
2612     {
2613     sleep(1);
2614     }
2615   else
2616     {
2617     printf("  Test %d sleep $1 ", $$subtestref);
2618     for (1..$1)
2619       {
2620       print ".";
2621       sleep(1);
2622       }
2623     printf("\r  Test %d                            $cr", $$subtestref);
2624     }
2625   return 0;
2626   }
2627
2628
2629 # Various Unix management commands are recognized
2630
2631 if (/^(ln|ls|du|mkdir|mkfifo|touch|cp|cat)\s/ ||
2632     /^sudo\s(mkdir|rmdir|rm|mv|cp|chown|chmod)\s/)
2633   {
2634   run_system("$_ >>test-stdout 2>>test-stderr");
2635   return 1;
2636   }
2637
2638
2639
2640 ###################
2641 ###################
2642
2643 # The next group of commands are also freestanding, but they are all followed
2644 # by data lines.
2645
2646
2647 # The "server" command starts up a script-driven server that runs in parallel
2648 # with the following exim command. Therefore, we want to run a subprocess and
2649 # not yet wait for it to complete. The waiting happens after the next exim
2650 # command, triggered by $server_pid being non-zero. The server sends its output
2651 # to a different file. The variable $server_opts, if not empty, contains
2652 # options to disable IPv4 or IPv6 if necessary.
2653 # This works because "server" swallows its stdin before waiting for a connection.
2654
2655 if (/^server\s+(.*)$/)
2656   {
2657   $pidfile = "$parm_cwd/aux-var/server-daemon.pid";
2658   $cmd = "./bin/server $server_opts -oP $pidfile $1 >>test-stdout-server";
2659   print ">> $cmd\n" if ($debug);
2660   $server_pid = open SERVERCMD, "|$cmd" || tests_exit(-1, "Failed to run $cmd");
2661   SERVERCMD->autoflush(1);
2662   print ">> Server pid is $server_pid\n" if $debug;
2663   while (<SCRIPT>)
2664     {
2665     $lineno++;
2666     last if /^\*{4}\s*$/;
2667     print SERVERCMD;
2668     }
2669   print SERVERCMD "++++\n"; # Send end to server; can't send EOF yet
2670                             # because close() waits for the process.
2671
2672   # Interlock the server startup; otherwise the next
2673   # process may not find it there when it expects it.
2674   while (! stat("$pidfile") ) { select(undef, undef, undef, 0.3); }
2675   return 3;
2676   }
2677
2678
2679 # The "write" command is a way of creating files of specific sizes for
2680 # buffering tests, or containing specific data lines from within the script
2681 # (rather than hold lots of little files). The "catwrite" command does the
2682 # same, but it also copies the lines to test-stdout.
2683
2684 if (/^(cat)?write\s+(\S+)(?:\s+(.*))?\s*$/)
2685   {
2686   my($cat) = defined $1;
2687   @sizes = ();
2688   @sizes = split /\s+/, $3 if defined $3;
2689   open FILE, ">$2" || tests_exit(-1, "Failed to open \"$2\": $!");
2690
2691   if ($cat)
2692     {
2693     open CAT, ">>test-stdout" ||
2694       tests_exit(-1, "Failed to open test-stdout: $!");
2695     print CAT "==========\n";
2696     }
2697
2698   if (scalar @sizes > 0)
2699     {
2700     # Pre-data
2701
2702     while (<SCRIPT>)
2703       {
2704       $lineno++;
2705       last if /^\+{4}\s*$/;
2706       print FILE;
2707       print CAT if $cat;
2708       }
2709
2710     # Sized data
2711
2712     while (scalar @sizes > 0)
2713       {
2714       ($count,$len,$leadin) = (shift @sizes) =~ /(\d+)x(\d+)(?:=(.*))?/;
2715       $leadin = '' if !defined $leadin;
2716       $leadin =~ s/_/ /g;
2717       $len -= length($leadin) + 1;
2718       while ($count-- > 0)
2719         {
2720         print FILE $leadin, "a" x $len, "\n";
2721         print CAT $leadin, "a" x $len, "\n" if $cat;
2722         }
2723       }
2724     }
2725
2726   # Post data, or only data if no sized data
2727
2728   while (<SCRIPT>)
2729     {
2730     $lineno++;
2731     last if /^\*{4}\s*$/;
2732     print FILE;
2733     print CAT if $cat;
2734     }
2735   close FILE;
2736
2737   if ($cat)
2738     {
2739     print CAT "==========\n";
2740     close CAT;
2741     }
2742
2743   return 0;
2744   }
2745
2746
2747 ###################
2748 ###################
2749
2750 # From this point on, script commands are implemented by setting up a shell
2751 # command in the variable $cmd. Shared code to run this command and handle its
2752 # input and output follows.
2753
2754 # The "client", "client-gnutls", and "client-ssl" commands run a script-driven
2755 # program that plays the part of an email client. We also have the availability
2756 # of running Perl for doing one-off special things. Note that all these
2757 # commands expect stdin data to be supplied.
2758
2759 if (/^client/ || /^(sudo\s+)?perl\b/)
2760   {
2761   s"client"./bin/client";
2762   $cmd = "$_ >>test-stdout 2>>test-stderr";
2763   }
2764
2765 # For the "exim" command, replace the text "exim" with the path for the test
2766 # binary, plus -D options to pass over various parameters, and a -C option for
2767 # the testing configuration file. When running in the test harness, Exim does
2768 # not drop privilege when -C and -D options are present. To run the exim
2769 # command as root, we use sudo.
2770
2771 elsif (/^((?i:[A-Z\d_]+=\S+\s+)+)?(\d+)?\s*(sudo(?:\s+-u\s+(\w+))?\s+)?exim(_\S+)?\s+(.*)$/)
2772   {
2773   $args = $6;
2774   my($envset) = (defined $1)? $1      : '';
2775   my($sudo)   = (defined $3)? "sudo " . (defined $4 ? "-u $4 ":'')  : '';
2776   my($special)= (defined $5)? $5      : '';
2777   $wait_time  = (defined $2)? $2      : 0;
2778
2779   # Return 2 rather than 1 afterwards
2780
2781   $yield = 2;
2782
2783   # Update the test number
2784
2785   $$subtestref = $$subtestref + 1;
2786   printf("  Test %d       $cr", $$subtestref);
2787
2788   # Copy the configuration file, making the usual substitutions.
2789
2790   open (IN, "$parm_cwd/confs/$testno") ||
2791     tests_exit(-1, "Couldn't open $parm_cwd/confs/$testno: $!\n");
2792   open (OUT, ">test-config") ||
2793     tests_exit(-1, "Couldn't open test-config: $!\n");
2794   while (<IN>)
2795     {
2796     do_substitute($testno);
2797     print OUT;
2798     }
2799   close(IN);
2800   close(OUT);
2801
2802   # The string $msg1 in args substitutes the message id of the first
2803   # message on the queue, and so on. */
2804
2805   if ($args =~ /\$msg/)
2806     {
2807     my($queuespec);
2808     if ($args =~ /-qG\w+/) { $queuespec = $&; }
2809
2810     my @listcmd;
2811
2812     if (defined $queuespec)
2813       {
2814       @listcmd  = ("$parm_cwd/eximdir/exim", '-bp',
2815                    $queuespec,
2816                    "-DEXIM_PATH=$parm_cwd/eximdir/exim",
2817                    -C => "$parm_cwd/test-config");
2818       }
2819     else
2820       {
2821       @listcmd  = ("$parm_cwd/eximdir/exim", '-bp',
2822                    "-DEXIM_PATH=$parm_cwd/eximdir/exim",
2823                    -C => "$parm_cwd/test-config");
2824       }
2825     print ">> Getting queue list from:\n>>    @listcmd\n" if $debug;
2826     # We need the message ids sorted in ascending order.
2827     # Message id is: <timestamp>-<pid>-<fractional-time>. On some systems (*BSD) the
2828     # PIDs are randomized, so sorting just the whole PID doesn't work.
2829     # We do the Schartz' transformation here (sort on
2830     # <timestamp><fractional-time>). Thanks to Kirill Miazine
2831     my @msglist =
2832       map { $_->[1] }                                   # extract the values
2833       sort { $a->[0] cmp $b->[0] }                      # sort by key
2834       map { [join('.' => (split /-/, $_)[0,2]) => $_] } # key (timestamp.fractional-time) => value(message_id)
2835       map { /^\s*\d+[smhdw]\s+\S+\s+(\S+)/ } `@listcmd` or tests_exit(-1, "No output from `exim -bp` (@listcmd)\n");
2836
2837     # Done backwards just in case there are more than 9
2838
2839     for (my $i = @msglist; $i > 0; $i--) { $args =~ s/\$msg$i/$msglist[$i-1]/g; }
2840     if ( $args =~ /\$msg\d/ )
2841       {
2842       tests_exit(-1, "Not enough messages in spool, for test $testno line $lineno\n")
2843         unless $force_continue;
2844       }
2845     }
2846
2847   # If -d is specified in $optargs, remove it from $args; i.e. let
2848   # the command line for runtest override. Then run Exim.
2849
2850   $args =~ s/(?:^|\s)-d\S*// if $optargs =~ /(?:^|\s)-d/;
2851
2852   my $opt_valgrind = $valgrind ? "valgrind --leak-check=yes --suppressions=$parm_cwd/aux-fixed/valgrind.supp " : '';
2853
2854   $cmd = "$envset$sudo$opt_valgrind" .
2855          "$parm_cwd/eximdir/exim$special$optargs " .
2856          "-DEXIM_PATH=$parm_cwd/eximdir/exim$special " .
2857          "-C $parm_cwd/test-config $args " .
2858          ">>test-stdout 2>>test-stderr";
2859   # If the command is starting an Exim daemon, we run it in the same
2860   # way as the "server" command above, that is, we don't want to wait
2861   # for the process to finish. That happens when "killdaemon" is obeyed later
2862   # in the script. We also send the stderr output to test-stderr-server. The
2863   # daemon has its log files put in a different place too (by configuring with
2864   # log_file_path). This requires the  directory to be set up in advance.
2865   #
2866   # There are also times when we want to run a non-daemon version of Exim
2867   # (e.g. a queue runner) with the server configuration. In this case,
2868   # we also define -DNOTDAEMON.
2869
2870   if ($cmd =~ /\s-DSERVER=server\s/ && $cmd !~ /\s-DNOTDAEMON\s/)
2871     {
2872     if ($debug) { printf ">> daemon: $cmd\n"; }
2873     run_system("sudo mkdir spool/log 2>/dev/null");
2874     run_system("sudo chown $parm_eximuser:$parm_eximgroup spool/log");
2875
2876     # Before running the command, convert the -bd option into -bdf so that an
2877     # Exim daemon doesn't double fork. This means that when we wait close
2878     # DAEMONCMD, it waits for the correct process. Also, ensure that the pid
2879     # file is written to the spool directory, in case the Exim binary was
2880     # built with PID_FILE_PATH pointing somewhere else.
2881
2882     if ($cmd =~ /\s-oP\s/)
2883       {
2884       ($pidfile = $cmd) =~ s/^.*-oP ([^ ]+).*$/$1/;
2885       $cmd =~ s!\s-bd\s! -bdf !;
2886       }
2887     else
2888       {
2889       $pidfile = "$parm_cwd/spool/exim-daemon.pid";
2890       $cmd =~ s!\s-bd\s! -bdf -oP $pidfile !;
2891       }
2892     print ">> |${cmd}-server\n" if ($debug);
2893     open DAEMONCMD, "|${cmd}-server" || tests_exit(-1, "Failed to run $cmd");
2894     DAEMONCMD->autoflush(1);
2895     while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; }   # Ignore any input
2896
2897     # Interlock with daemon startup
2898     for (my $count = 0; ! stat("$pidfile") && $count < 30; $count++ )
2899       { select(undef, undef, undef, 0.3); }
2900     return 3;                                     # Don't wait
2901     }
2902   elsif ($cmd =~ /\s-DSERVER=wait:(\d+)\s/)
2903     {
2904
2905     # The port and the $dynamic_socket was already allocated while parsing the
2906     # script file, where -DSERVER=wait:PORT_DYNAMIC was encountered.
2907
2908     my $listen_port = $1;
2909     if ($debug) { printf ">> wait-mode daemon: $cmd\n"; }
2910     run_system("sudo mkdir spool/log 2>/dev/null");
2911     run_system("sudo chown $parm_eximuser:$parm_eximgroup spool/log");
2912
2913     my $pid = fork();
2914     if (not defined $pid) { die "** fork failed: $!\n" }
2915     if (not $pid) {
2916       close(STDIN);
2917       open(STDIN, '<&', $dynamic_socket) or die "** dup sock to stdin failed: $!\n";
2918       close($dynamic_socket);
2919       print "[$$]>> ${cmd}-server\n" if ($debug);
2920       exec "exec ${cmd}-server";
2921       die "Can't exec ${cmd}-server: $!\n";
2922     }
2923     while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; }   # Ignore any input
2924     select(undef, undef, undef, 0.3);             # Let the daemon get going
2925     return (3, { exim_pid => $pid });             # Don't wait
2926     }
2927   }
2928
2929 # The "background" command is run but not waited-for, like exim -DSERVER=server.
2930 # One script line is read and fork-exec'd.  The PID is stored for a later
2931 # killdaemon.
2932
2933 elsif (/^background$/)
2934   {
2935   my $line;
2936 #  $pidfile = "$parm_cwd/aux-var/server-daemon.pid";
2937
2938   $_ = <SCRIPT>; $lineno++;
2939   chomp;
2940   do_substitute($testno);
2941   $line = $_;
2942   if ($debug) { printf ">> daemon: $line >>test-stdout 2>>test-stderr\n"; }
2943
2944   my $pid = fork();
2945   if (not defined $pid) { die "** fork failed: $!\n" }
2946   if (not $pid) {
2947     print "[$$]>> ${line}\n" if ($debug);
2948     close(STDIN);
2949     open(STDIN, "<", "test-stdout");
2950     close(STDOUT);
2951     open(STDOUT, ">>", "test-stdout");
2952     close(STDERR);
2953     open(STDERR, ">>", "test-stderr-server");
2954     exec "exec ${line}";
2955     exit(1);
2956   }
2957
2958 #  open(my $fh, ">", $pidfile) ||
2959 #      tests_exit(-1, "Failed to open $pidfile: $!");
2960 #  printf($fh, "%d\n", $pid);
2961 #  close($fh);
2962
2963   while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; }   # Ignore any input
2964   select(undef, undef, undef, 0.3);             # Let the daemon get going
2965   return (3, { exim_pid => $pid });             # Don't wait
2966   }
2967
2968
2969
2970 # Unknown command
2971
2972 else { tests_exit(-1, "Command unrecognized in line $lineno: $_"); }
2973
2974
2975 # Run the command, with stdin connected to a pipe, and write the stdin data
2976 # to it, with appropriate substitutions. If a starts with '>>> ', process it
2977 # via Perl's string eval().
2978 # If the command contains
2979 # -DSERVER=server add "-server" to the command, where it will adjoin the name
2980 # for the stderr file. See comment above about the use of -DSERVER.
2981
2982 $stderrsuffix = ($cmd =~ /\s-DSERVER=server\s/)? "-server" : '';
2983 print ">> |${cmd}${stderrsuffix}\n" if ($debug);
2984 open CMD, "|${cmd}${stderrsuffix}" || tests_exit(1, "Failed to run $cmd");
2985
2986 CMD->autoflush(1);
2987 LINE: while (<SCRIPT>)
2988   {
2989   $lineno++;
2990   last if /^\*{4}\s*$/;
2991   do_substitute($testno);
2992   if (my ($cmd, $line) = /^(:\S+?:)(.*)/) {
2993     $_ = $line;
2994       {
2995       $cmd eq ':eval:' and do {
2996         $_ = eval "\"$_\"";
2997         last;
2998       };
2999       $cmd eq ':noeol:' and do {
3000         s/[\r\n]*$//;
3001         last;
3002       };
3003       $cmd eq ':sleep:' and do {
3004         sleep $_;
3005         next LINE;
3006       };
3007     }
3008   }
3009   print CMD;
3010   }
3011
3012 # For timeout tests, wait before closing the pipe; we expect a
3013 # SIGPIPE error in this case.
3014
3015 if ($wait_time > 0)
3016   {
3017   printf("  Test %d sleep $wait_time ", $$subtestref);
3018   while ($wait_time-- > 0)
3019     {
3020     print ".";
3021     sleep(1);
3022     }
3023   printf("\r  Test %d                                       $cr", $$subtestref);
3024   }
3025
3026 $sigpipehappened = 0;
3027 close CMD;                # Waits for command to finish
3028 return $yield;            # Ran command and waited
3029 }
3030
3031
3032
3033
3034 ###############################################################################
3035 ###############################################################################
3036
3037 ##################################################
3038 #    Check for SpamAssassin and ClamAV           #
3039 ##################################################
3040
3041 # These are crude tests. If they aren't good enough, we'll have to improve
3042 # them, for example by actually passing a message through spamc or clamscan.
3043
3044 sub check_running_spamassassin
3045 {
3046 my $sock = new FileHandle;
3047
3048 if (system("spamc -h 2>/dev/null >/dev/null") == 0)
3049   {
3050   print "The spamc command works:\n";
3051
3052   # This test for an active SpamAssassin is courtesy of John Jetmore.
3053   # The tests are hard coded to localhost:783, so no point in making
3054   # this test flexible like the clamav test until the test scripts are
3055   # changed.  spamd doesn't have the nice PING/PONG protocol that
3056   # clamd does, but it does respond to errors in an informative manner,
3057   # so use that.
3058
3059   my($sint,$sport) = ('127.0.0.1',783);
3060   eval
3061     {
3062     my $sin = sockaddr_in($sport, inet_aton($sint))
3063         or die "** Failed packing $sint:$sport\n";
3064     socket($sock, PF_INET, SOCK_STREAM, getprotobyname('tcp'))
3065         or die "** Unable to open socket $sint:$sport\n";
3066
3067     local $SIG{ALRM} =
3068         sub { die "** Timeout while connecting to socket $sint:$sport\n"; };
3069     alarm(5);
3070     connect($sock, $sin)
3071         or die "** Unable to connect to socket $sint:$sport\n";
3072     alarm(0);
3073
3074     select((select($sock), $| = 1)[0]);
3075     print $sock "bad command\r\n";
3076
3077     $SIG{ALRM} =
3078         sub { die "** Timeout while reading from socket $sint:$sport\n"; };
3079     alarm(10);
3080     my $res = <$sock>;
3081     alarm(0);
3082
3083     $res =~ m|^SPAMD/|
3084         or die "** Did not get SPAMD from socket $sint:$sport. "
3085               ."It said: $res\n";
3086     };
3087   alarm(0);
3088   if($@)
3089     {
3090     print "  $@";
3091     print "  Assume SpamAssassin (spamd) is not running\n";
3092     }
3093   else
3094     {
3095     $parm_running{SpamAssassin} = ' ';
3096     print "  SpamAssassin (spamd) seems to be running\n";
3097     }
3098   }
3099 else
3100   {
3101   print "The spamc command failed: assume SpamAssassin (spamd) is not running\n";
3102   }
3103 }
3104
3105 sub check_running_clamav
3106 {
3107 my $sock;
3108
3109 # For ClamAV, we need to find the clamd socket for use in the Exim
3110 # configuration. Search for the clamd configuration file.
3111
3112 if (system("clamscan -h 2>/dev/null >/dev/null") == 0)
3113   {
3114   my($f, $clamconf, $test_prefix);
3115
3116   print "The clamscan command works";
3117
3118   $test_prefix = $ENV{EXIM_TEST_PREFIX};
3119   $test_prefix = '' if !defined $test_prefix;
3120
3121   foreach $f ("$test_prefix/etc/clamd.conf",
3122               "$test_prefix/usr/local/etc/clamd.conf",
3123               "$test_prefix/etc/clamav/clamd.conf", '')
3124     {
3125     if (-e $f)
3126       {
3127       $clamconf = $f;
3128       last;
3129       }
3130     }
3131
3132   # Read the ClamAV configuration file and find the socket interface.
3133
3134   if ($clamconf ne '')
3135     {
3136     my $socket_domain;
3137     open(IN, "$clamconf") || die "\n** Unable to open $clamconf: $!\n";
3138     while (<IN>)
3139       {
3140       if (/^LocalSocket\s+(.*)/)
3141         {
3142         $parm_clamsocket = $1;
3143         $socket_domain = AF_UNIX;
3144         last;
3145         }
3146       if (/^TCPSocket\s+(\d+)/)
3147         {
3148         if (defined $parm_clamsocket)
3149           {
3150           $parm_clamsocket .= " $1";
3151           $socket_domain = AF_INET;
3152           last;
3153           }
3154         else
3155           {
3156           $parm_clamsocket = " $1";
3157           }
3158         }
3159       elsif (/^TCPAddr\s+(\S+)/)
3160         {
3161         if (defined $parm_clamsocket)
3162           {
3163           $parm_clamsocket = $1 . $parm_clamsocket;
3164           $socket_domain = AF_INET;
3165           last;
3166           }
3167         else
3168           {
3169           $parm_clamsocket = $1;
3170           }
3171         }
3172       }
3173     close(IN);
3174
3175     if (defined $socket_domain)
3176       {
3177       print ":\n  The clamd socket is $parm_clamsocket\n";
3178       # This test for an active ClamAV is courtesy of Daniel Tiefnig.
3179       eval
3180         {
3181         my $socket;
3182         if ($socket_domain == AF_UNIX)
3183           {
3184           $socket = sockaddr_un($parm_clamsocket) or die "** Failed packing '$parm_clamsocket'\n";
3185           }
3186         elsif ($socket_domain == AF_INET)
3187           {
3188           my ($ca_host, $ca_port) = split(/\s+/,$parm_clamsocket);
3189           my $ca_hostent = gethostbyname($ca_host) or die "** Failed to get raw address for host '$ca_host'\n";
3190           $socket = sockaddr_in($ca_port, $ca_hostent) or die "** Failed packing '$parm_clamsocket'\n";
3191           }
3192         else
3193           {
3194           die "** Unknown socket domain '$socket_domain' (should not happen)\n";
3195           }
3196         socket($sock, $socket_domain, SOCK_STREAM, 0) or die "** Unable to open socket '$parm_clamsocket'\n";
3197         local $SIG{ALRM} = sub { die "** Timeout while connecting to socket '$parm_clamsocket'\n"; };
3198         alarm(5);
3199         connect($sock, $socket) or die "** Unable to connect to socket '$parm_clamsocket'\n";
3200         alarm(0);
3201
3202         my $ofh = select $sock; $| = 1; select $ofh;
3203         print $sock "PING\n";
3204
3205         $SIG{ALRM} = sub { die "** Timeout while reading from socket '$parm_clamsocket'\n"; };
3206         alarm(10);
3207         my $res = <$sock>;
3208         alarm(0);
3209
3210         $res =~ /PONG/ or die "** Did not get PONG from socket '$parm_clamsocket'. It said: $res\n";
3211         };
3212       alarm(0);
3213
3214       if($@)
3215         {
3216         print "  $@";
3217         print "  Assume ClamAV is not running\n";
3218         }
3219       else
3220         {
3221         $parm_running{ClamAV} = ' ';
3222         print "  ClamAV seems to be running\n";
3223         }
3224       }
3225     else
3226       {
3227       print ", but the socket for clamd could not be determined\n";
3228       print "Assume ClamAV is not running\n";
3229       }
3230     }
3231
3232   else
3233     {
3234     print ", but I can't find a configuration for clamd\n";
3235     print "Assume ClamAV is not running\n";
3236     }
3237   }
3238 }
3239
3240
3241 sub check_running_redis
3242 {
3243 if (defined $parm_lookups{redis})
3244   {
3245   if (system("redis-server -v 2>/dev/null >/dev/null") == 0)
3246     {
3247     print "The redis-server command works\n";
3248     $parm_running{redis} = ' ';
3249     }
3250   else
3251     {
3252     print "The redis-server command failed: assume Redis not installed\n";
3253     }
3254   }
3255 }
3256
3257 sub check_running_dovecot
3258 {
3259 system('dovecot --version >/dev/null');
3260 if ($? == 0)
3261   {
3262   print "Dovecot appears to be available\n";
3263   $parm_running{dovecot} = ' ';
3264   }
3265 else
3266   {
3267   print "Dovecot not found\n";
3268   }
3269 }
3270
3271
3272
3273 ###############################################################################
3274 ###############################################################################
3275
3276 # Here begins the Main Program ...
3277
3278 ###############################################################################
3279 ###############################################################################
3280
3281
3282 autoflush STDOUT 1;
3283 print "Exim tester $testversion\n";
3284
3285 # extend the PATH with .../sbin
3286 # we map all (.../bin) to (.../sbin:.../bin)
3287 $ENV{PATH} = do {
3288   my %seen = map { $_, 1 } split /:/, $ENV{PATH};
3289   join ':' => map { m{(.*)/bin$}
3290                 ? ( $seen{"$1/sbin"} ? () : ("$1/sbin"), $_)
3291                 : ($_) }
3292       split /:/, $ENV{PATH};
3293 };
3294
3295 ##################################################
3296 #      Some tests check created file modes       #
3297 ##################################################
3298
3299 umask 022;
3300
3301
3302 ##################################################
3303 #       Check for the "less" command             #
3304 ##################################################
3305
3306 @more = 'more' if system('which less >/dev/null 2>&1') != 0;
3307
3308
3309
3310 ##################################################
3311 #      See if an Exim binary has been given      #
3312 ##################################################
3313
3314 # If the first character of the first argument is '/', the argument is taken
3315 # as the path to the binary. If the first argument does not start with a
3316 # '/' but exists in the file system, it's assumed to be the Exim binary.
3317
3318
3319 ##################################################
3320 # Sort out options and which tests are to be run #
3321 ##################################################
3322
3323 # There are a few possible options for the test script itself; after these, any
3324 # options are passed on to Exim calls within the tests. Typically, this is used
3325 # to turn on Exim debugging while setting up a test.
3326
3327 Getopt::Long::Configure qw(no_getopt_compat);
3328 GetOptions(
3329     'debug'    => sub { $debug          = 1; $cr   = "\n" },
3330     'diff'     => sub { $cf             = 'diff -u' },
3331     'continue' => sub { $force_continue = 1; @more = 'cat' },
3332     'update'   => \$force_update,
3333     'ipv4!'    => \$have_ipv4,
3334     'ipv6!'    => \$have_ipv6,
3335     'keep'     => \$save_output,
3336     'slow'     => \$slow,
3337     'valgrind' => \$valgrind,
3338     'range=s{2}'       => \my @range_wanted,
3339     'test=i@'          => \my @tests_wanted,
3340     'fail-any!'        => \my $fail_any,
3341     'flavor|flavour=s' => \$flavour,
3342     'help'             => sub { pod2usage(-exit => 0) },
3343     'man'              => sub {
3344         pod2usage(
3345             -exit      => 0,
3346             -verbose   => 2,
3347             -noperldoc => system('perldoc -V 2>/dev/null 1>&2')
3348         );
3349     },
3350 ) or pod2usage;
3351
3352 ($parm_exim, @ARGV) = Exim::Runtest::exim_binary(@ARGV);
3353 print "Exim binary is `$parm_exim'\n" if defined $parm_exim;
3354
3355
3356 my @wanted = sort numerically uniq
3357   @tests_wanted ? @tests_wanted : (),
3358   @range_wanted ? $range_wanted[0] .. $range_wanted[1] : (),
3359   @ARGV ? @ARGV == 1 ? $ARGV[0] :
3360           $ARGV[1] eq '+' ? $ARGV[0]..($ARGV[0] >= 9000 ? TEST_SPECIAL_TOP : TEST_TOP) :
3361           0+$ARGV[0]..0+$ARGV[1]    # add 0 to cope with test numbers starting with zero
3362         : ();
3363 @wanted = 1..TEST_TOP if not @wanted;
3364
3365 ##################################################
3366 #        Check for sudo access to root           #
3367 ##################################################
3368
3369 print "You need to have sudo access to root to run these tests. Checking ...\n";
3370 if (system('sudo true >/dev/null') != 0)
3371   {
3372   die "** Test for sudo failed: testing abandoned.\n";
3373   }
3374 else
3375   {
3376   print "Test for sudo OK\n";
3377   }
3378
3379
3380
3381
3382 ##################################################
3383 #      Make the command's directory current      #
3384 ##################################################
3385
3386 # After doing so, we find its absolute path name.
3387
3388 $cwd = $0;
3389 $cwd = '.' if ($cwd !~ s|/[^/]+$||);
3390 chdir($cwd) || die "** Failed to chdir to \"$cwd\": $!\n";
3391 $parm_cwd = Cwd::getcwd();
3392
3393
3394 ##################################################
3395 #     Search for an Exim binary to test          #
3396 ##################################################
3397
3398 # If an Exim binary hasn't been provided, try to find one. We can handle the
3399 # case where exim-testsuite is installed alongside Exim source directories. For
3400 # PH's private convenience, if there's a directory just called "exim4", that
3401 # takes precedence; otherwise exim-snapshot takes precedence over any numbered
3402 # releases.
3403
3404 # If $parm_exim is still empty, ask the caller
3405
3406 if (not $parm_exim)
3407   {
3408   print "** Did not find an Exim binary to test\n";
3409   for ($i = 0; $i < 5; $i++)
3410     {
3411     my($trybin);
3412     print "** Enter pathname for Exim binary: ";
3413     chomp($trybin = <STDIN>);
3414     if (-e $trybin)
3415       {
3416       $parm_exim = $trybin;
3417       last;
3418       }
3419     else
3420       {
3421       print "** $trybin does not exist\n";
3422       }
3423     }
3424   die "** Too many tries\n" if $parm_exim eq '';
3425   }
3426
3427
3428
3429 ##################################################
3430 #          Find what is in the binary            #
3431 ##################################################
3432
3433 # deal with TRUSTED_CONFIG_LIST restrictions
3434 unlink("$parm_cwd/test-config") if -e "$parm_cwd/test-config";
3435 open (IN, "$parm_cwd/confs/0000") ||
3436   tests_exit(-1, "Couldn't open $parm_cwd/confs/0000: $!\n");
3437 open (OUT, ">test-config") ||
3438   tests_exit(-1, "Couldn't open test-config: $!\n");
3439 while (<IN>) { print OUT; }
3440 close(IN);
3441 close(OUT);
3442
3443 print("Probing with config file: $parm_cwd/test-config\n");
3444
3445 my $eximinfo = "$parm_exim -d -C $parm_cwd/test-config -DDIR=$parm_cwd -bP exim_user exim_group";
3446 chomp(my @eximinfo = `$eximinfo 2>&1`);
3447 die "$0: Can't run $eximinfo\n" if $? == -1;
3448
3449 warn 'Got ' . ($?>>8) . " from $eximinfo\n" if $?;
3450 foreach (@eximinfo)
3451   {
3452   if (my ($version) = /^Exim version (\S+)/) {
3453     my $git = `git describe --dirty=-XX --match 'exim-4*'`;
3454     if (defined $git and $? == 0) {
3455       chomp $git;
3456       $git =~ s/^exim-//i;
3457       $git =~ s/.*-\Kg([[:xdigit:]]+(?:-XX)?)/$1/;
3458       print <<___
3459
3460 *** Version mismatch
3461 *** Exim binary: $version
3462 *** Git        : $git
3463
3464 ___
3465         if not $version eq $git;
3466     }
3467   }
3468   $parm_eximuser = $1 if /^exim_user = (.*)$/;
3469   $parm_eximgroup = $1 if /^exim_group = (.*)$/;
3470   $parm_trusted_config_list = $1 if /^TRUSTED_CONFIG_LIST:.*?"(.*?)"$/;
3471   ($parm_configure_owner, $parm_configure_group) = ($1, $2)
3472         if /^Configure owner:\s*(\d+):(\d+)/;
3473   print if /wrong owner/;
3474   }
3475
3476 if (not defined $parm_eximuser) {
3477   die <<XXX, map { "|$_\n" } @eximinfo;
3478 Unable to extract exim_user from binary.
3479 Check if Exim refused to run; if so, consider:
3480   TRUSTED_CONFIG_LIST ALT_CONFIG_PREFIX WHITELIST_D_MACROS
3481 If debug permission denied, are you in the exim group?
3482 Failing to get information from binary.
3483 Output from $eximinfo:
3484 XXX
3485
3486 }
3487
3488 if ($parm_eximuser =~ /^\d+$/) { $parm_exim_uid = $parm_eximuser; }
3489 else { $parm_exim_uid = getpwnam($parm_eximuser); }
3490
3491 if (defined $parm_eximgroup)
3492   {
3493   if ($parm_eximgroup =~ /^\d+$/) { $parm_exim_gid = $parm_eximgroup; }
3494     else { $parm_exim_gid = getgrnam($parm_eximgroup); }
3495   }
3496
3497 # check the permissions on the TRUSTED_CONFIG_LIST
3498 if (defined $parm_trusted_config_list)
3499   {
3500   die "TRUSTED_CONFIG_LIST: $parm_trusted_config_list: $!\n"
3501     if not -f $parm_trusted_config_list;
3502
3503   die "TRUSTED_CONFIG_LIST $parm_trusted_config_list must not be world writable!\n"
3504     if 02 & (stat _)[2];
3505
3506   die sprintf "TRUSTED_CONFIG_LIST: $parm_trusted_config_list %d is group writable, but not owned by group '%s' or '%s'.\n",
3507   (stat _)[1],
3508     scalar(getgrgid 0), scalar(getgrgid $>)
3509     if (020 & (stat _)[2]) and not ((stat _)[5] == $> or (stat _)[5] == 0);
3510
3511   die sprintf "TRUSTED_CONFIG_LIST: $parm_trusted_config_list is not owned by user '%s' or '%s'.\n",
3512   scalar(getpwuid 0), scalar(getpwuid $>)
3513      if (not (-o _ or (stat _)[4] == 0));
3514
3515   open(TCL, $parm_trusted_config_list) or die "Can't open $parm_trusted_config_list: $!\n";
3516   my $test_config = getcwd() . '/test-config';
3517   die "Can't find '$test_config' in TRUSTED_CONFIG_LIST $parm_trusted_config_list."
3518     if not grep { /^\Q$test_config\E$/ } <TCL>;
3519   }
3520 else
3521   {
3522   die "Unable to check the TRUSTED_CONFIG_LIST, seems to be empty?\n";
3523   }
3524
3525 die "CONFIGURE_OWNER ($parm_configure_owner) does not match the user invoking $0 ($>)\n"
3526         if $parm_configure_owner != $>;
3527
3528 die "CONFIGURE_GROUP ($parm_configure_group) does not match the group invoking $0 ($))\n"
3529         if 0020 & (stat "$parm_cwd/test-config")[2]
3530         and $parm_configure_group != $);
3531
3532 die "aux-fixed file is group-writeable; best to strip them all, recursively\n"
3533         if 0020 & (stat "aux-fixed/0037.f-1")[2];
3534
3535
3536 open(EXIMINFO, "$parm_exim -d-all+transport -bV -C $parm_cwd/test-config -DDIR=$parm_cwd |") ||
3537   die "** Cannot run $parm_exim: $!\n";
3538
3539 print "-" x 78, "\n";
3540
3541 while (<EXIMINFO>)
3542   {
3543   my(@temp);
3544
3545   if (/^(Exim|Library) version/) { print; }
3546   if (/Runtime: /) {print; }
3547
3548   elsif (/^Size of off_t: (\d+)/)
3549     {
3550     print;
3551     $have_largefiles = 1 if $1 > 4;
3552     die "** Size of off_t > 32 which seems improbable, not running tests\n"
3553         if ($1 > 32);
3554     }
3555
3556   elsif (/^Support for: (.*)/)
3557     {
3558     print;
3559     @temp = split /(\s+)/, $1;
3560     push(@temp, ' ');
3561     %parm_support = @temp;
3562     }
3563
3564   elsif (/^Lookups \(built-in\): (.*)/)
3565     {
3566     print;
3567     @temp = split /(\s+)/, $1;
3568     push(@temp, ' ');
3569     %parm_lookups = @temp;
3570     }
3571
3572   elsif (/^Authenticators: (.*)/)
3573     {
3574     print;
3575     @temp = split /(\s+)/, $1;
3576     push(@temp, ' ');
3577     %parm_authenticators = @temp;
3578     }
3579
3580   elsif (/^Routers: (.*)/)
3581     {
3582     print;
3583     @temp = split /(\s+)/, $1;
3584     push(@temp, ' ');
3585     %parm_routers = @temp;
3586     }
3587
3588   # Some transports have options, e.g. appendfile/maildir. For those, ensure
3589   # that the basic transport name is set, and then the name with each of the
3590   # options.
3591
3592   elsif (/^Transports: (.*)/)
3593     {
3594     print;
3595     @temp = split /(\s+)/, $1;
3596     my($i,$k);
3597     push(@temp, ' ');
3598     %parm_transports = @temp;
3599     foreach $k (keys %parm_transports)
3600       {
3601       if ($k =~ "/")
3602         {
3603         @temp = split /\//, $k;
3604         $parm_transports{$temp[0]} = " ";
3605         for ($i = 1; $i < @temp; $i++)
3606           { $parm_transports{"$temp[0]/$temp[$i]"} = " "; }
3607         }
3608       }
3609     }
3610
3611   elsif (/^Malware: (.*)/)
3612     {
3613     print;
3614     @temp = split /(\s+)/, $1;
3615     push(@temp, ' ');
3616     %parm_malware = @temp;
3617     }
3618
3619   }
3620 close(EXIMINFO);
3621 print "-" x 78, "\n";
3622
3623 unlink("$parm_cwd/test-config");
3624
3625
3626
3627 if (defined $parm_support{Content_Scanning})
3628   {
3629   check_running_spamassassin();
3630   check_running_clamav();
3631   }
3632 check_running_redis();
3633 check_running_dovecot();
3634
3635 ##################################################
3636 #         Test for the basic requirements        #
3637 ##################################################
3638
3639 # This test suite assumes that Exim has been built with at least the "usual"
3640 # set of routers, transports, and lookups. Ensure that this is so.
3641
3642 $missing = '';
3643
3644 $missing .= "     Lookup: lsearch\n" if (!defined $parm_lookups{lsearch});
3645
3646 $missing .= "     Router: accept\n" if (!defined $parm_routers{accept});
3647 $missing .= "     Router: dnslookup\n" if (!defined $parm_routers{dnslookup});
3648 $missing .= "     Router: manualroute\n" if (!defined $parm_routers{manualroute});
3649 $missing .= "     Router: redirect\n" if (!defined $parm_routers{redirect});
3650
3651 $missing .= "     Transport: appendfile\n" if (!defined $parm_transports{appendfile});
3652 $missing .= "     Transport: autoreply\n" if (!defined $parm_transports{autoreply});
3653 $missing .= "     Transport: pipe\n" if (!defined $parm_transports{pipe});
3654 $missing .= "     Transport: smtp\n" if (!defined $parm_transports{smtp});
3655
3656 if ($missing ne '')
3657   {
3658   print "\n";
3659   print "** Many features can be included or excluded from Exim binaries.\n";
3660   print "** This test suite requires that Exim is built to contain a certain\n";
3661   print "** set of basic facilities. It seems that some of these are missing\n";
3662   print "** from the binary that is under test, so the test cannot proceed.\n";
3663   print "** The missing facilities are:\n";
3664   print "$missing";
3665   die "** Test script abandoned\n";
3666   }
3667
3668
3669 ##################################################
3670 #      Check for the auxiliary programs          #
3671 ##################################################
3672
3673 # These are always required:
3674
3675 for $prog ("cf", "checkaccess", "client", "client-ssl", "client-gnutls",
3676            "fakens", "iefbr14", "server")
3677   {
3678   next if ($prog eq "client-ssl" && !defined $parm_support{OpenSSL});
3679   next if ($prog eq "client-gnutls" && !defined $parm_support{GnuTLS});
3680   if (!-e "bin/$prog")
3681     {
3682     print "\n";
3683     print "** bin/$prog does not exist. Have you run ./configure and make?\n";
3684     die "** Test script abandoned\n";
3685     }
3686   }
3687
3688 # If the "loaded" binary is missing, we cut out tests for ${dlfunc. It isn't
3689 # compiled on systems where we don't know how to. However, if Exim does not
3690 # have that functionality compiled, we needn't bother.
3691
3692 $dlfunc_deleted = 0;
3693 if (defined $parm_support{Expand_dlfunc} && !-e 'bin/loaded')
3694   {
3695   delete $parm_support{Expand_dlfunc};
3696   $dlfunc_deleted = 1;
3697   }
3698
3699
3700 ##################################################
3701 #          Find environmental details            #
3702 ##################################################
3703
3704 # Find the caller of this program.
3705
3706 ($parm_caller,$pwpw,$parm_caller_uid,$parm_caller_gid,$pwquota,$pwcomm,
3707  $parm_caller_gecos, $parm_caller_home) = getpwuid($>);
3708
3709 $pwpw = $pwpw;       # Kill Perl warnings
3710 $pwquota = $pwquota;
3711 $pwcomm = $pwcomm;
3712
3713 $parm_caller_group = getgrgid($parm_caller_gid);
3714
3715 print "Program caller is $parm_caller ($parm_caller_uid), whose group is $parm_caller_group ($parm_caller_gid)\n";
3716 print "Home directory is $parm_caller_home\n";
3717
3718 unless (defined $parm_eximgroup)
3719   {
3720   print "Unable to derive \$parm_eximgroup.\n";
3721   die "** ABANDONING.\n";
3722   }
3723
3724 if ($parm_caller_home eq $parm_cwd)
3725   {
3726   print "will confuse working dir with homedir; change homedir\n";
3727   die "** ABANDONING.\n";
3728   }
3729
3730 print "You need to be in the Exim group to run these tests. Checking ...";
3731
3732 if (`groups` =~ /\b\Q$parm_eximgroup\E\b/)
3733   {
3734   print " OK\n";
3735   }
3736 else
3737   {
3738   print "\nOh dear, you are not in the Exim group.\n";
3739   die "** Testing abandoned.\n";
3740   }
3741
3742 # Find this host's IP addresses - there may be many, of course, but we keep
3743 # one of each type (IPv4 and IPv6).
3744 #XXX it would be good to avoid non-UP interfaces
3745
3746 open(IFCONFIG, '-|', (grep { -x "$_/ip" } split /:/, $ENV{PATH}) ? 'ip address' : 'ifconfig -a')
3747   or die "** Cannot run 'ip address' or 'ifconfig -a'\n";
3748 while (not ($parm_ipv4 and $parm_ipv6) and defined($_ = <IFCONFIG>))
3749   {
3750   if (/^(?:[0-9]+: )?([a-z0-9]+): /) { $ifname = $1; }
3751
3752   if (not $parm_ipv4 and /^\s*inet(?:\saddr(?:ess))?:?\s*(\d+\.\d+\.\d+\.\d+)(?:\/\d+)?\s/i)
3753     {
3754     # It would be nice to be able to vary the /16 used for manyhome; we could take
3755     # an option to runtest used here - but we'd also have to pass it on to fakens.
3756     # Possibly an environment variable?
3757     next if $1 eq '0.0.0.0' or $1 =~ /^(?:127|10\.250)\./;
3758     $parm_ipv4 = $1;
3759     }
3760
3761   if (   (not $parm_ipv6 or $parm_ipv6 =~ /%/)
3762      and /^\s*inet6(?:\saddr(?:ess))?:?\s*([abcdef\d:]+)(?:%[^ \/]+)?(?:\/\d+)?/i)
3763     {
3764     next if $1 eq '::' or $1 eq '::1' or $1 =~ /^ff00/i or $1 =~ /^fe80::1/i;
3765     $parm_ipv6 = $1;
3766     if ($1 =~ /^fe80/i) { $parm_ipv6 .= '%' . $ifname; }
3767     }
3768   }
3769 close(IFCONFIG);
3770
3771 # Use private IP addresses if there are no public ones.
3772
3773 # If either type of IP address is missing, we need to set the value to
3774 # something other than empty, because that wrecks the substitutions. The value
3775 # is reflected, so use a meaningful string. Set appropriate options for the
3776 # "server" command. In practice, however, many tests assume 127.0.0.1 is
3777 # available, so things will go wrong if there is no IPv4 address. The lack
3778 # of IPV4 or IPv6 can be simulated by command options, which force $have_ipv4
3779 # and $have_ipv6 false.
3780
3781 if (not $parm_ipv4)
3782   {
3783   $have_ipv4 = 0;
3784   $parm_ipv4 = "<no IPv4 address found>";
3785   $server_opts .= " -noipv4";
3786   }
3787 elsif ($have_ipv4 == 0)
3788   {
3789   $parm_ipv4 = "<IPv4 testing disabled>";
3790   $server_opts .= " -noipv4";
3791   }
3792 else
3793   {
3794   $parm_running{IPv4} = " ";
3795   }
3796
3797 if (not $parm_ipv6)
3798   {
3799   $have_ipv6 = 0;
3800   $parm_ipv6 = "<no IPv6 address found>";
3801   $server_opts .= " -noipv6";
3802   delete($parm_support{IPv6});
3803   }
3804 elsif ($have_ipv6 == 0)
3805   {
3806   $parm_ipv6 = "<IPv6 testing disabled>";
3807   $server_opts .= " -noipv6";
3808   delete($parm_support{IPv6});
3809   }
3810 elsif (!defined $parm_support{IPv6})
3811   {
3812   $have_ipv6 = 0;
3813   $parm_ipv6 = "<no IPv6 support in Exim binary>";
3814   $server_opts .= " -noipv6";
3815   }
3816 else
3817   {
3818   $parm_running{IPv6} = " ";
3819   }
3820
3821 print "IPv4 address is $parm_ipv4\n";
3822 print "IPv6 address is $parm_ipv6\n";
3823 $parm_ipv6 =~ /^[^%\/]*/;
3824 # drop any %scope from the ipv6, for some uses
3825 ($parm_ipv6_stripped = $parm_ipv6) =~ s/%.*//g;
3826
3827 # For munging test output, we need the reversed IP addresses.
3828
3829 $parm_ipv4r = ($parm_ipv4 !~ /^\d/)? '' :
3830   join(".", reverse(split /\./, $parm_ipv4));
3831
3832 $parm_ipv6r = $parm_ipv6;             # Appropriate if not in use
3833 if ($parm_ipv6 =~ /^[\da-f]/)
3834   {
3835   my(@comps) = split /:/, $parm_ipv6_stripped;
3836   my(@nibbles);
3837   foreach $comp (@comps)
3838     {
3839     push @nibbles, sprintf("%lx", hex($comp) >> 8);
3840     push @nibbles, sprintf("%lx", hex($comp) & 0xff);
3841     }
3842   $parm_ipv6r = join(".", reverse(@nibbles));
3843   }
3844
3845 # Find the host name, fully qualified.
3846
3847 chomp($temp = `hostname`);
3848 die "'hostname' didn't return anything\n" unless defined $temp and length $temp;
3849 if ($temp =~ /\./)
3850   {
3851   $parm_hostname = $temp;
3852   }
3853 else
3854   {
3855   $parm_hostname = (gethostbyname($temp))[0];
3856   $parm_hostname = "no.host.name.found" unless defined $parm_hostname and length $parm_hostname;
3857   }
3858 print "Hostname is $parm_hostname\n";
3859
3860 if ($parm_hostname !~ /\./)
3861   {
3862   print "\n*** Host name is not fully qualified: this may cause problems ***\n\n";
3863   }
3864
3865 if ($parm_hostname =~ /[[:upper:]]/)
3866   {
3867   print "\n*** Host name has upper case characters: this may cause problems ***\n\n";
3868   }
3869
3870 if ($parm_hostname =~ /\.example\.com$/)
3871   {
3872   die "\n*** Host name ends in .example.com; this conflicts with the testsuite use of that domain.\n"
3873         . "    Please change the host's name (or comment out this check, and fail several testcases)\n";
3874   }
3875
3876
3877
3878 ##################################################
3879 #     Create a testing version of Exim           #
3880 ##################################################
3881
3882 # We want to be able to run Exim with a variety of configurations. Normally,
3883 # the use of -C to change configuration causes Exim to give up its root
3884 # privilege (unless the caller is exim or root). For these tests, we do not
3885 # want this to happen. Also, we want Exim to know that it is running in its
3886 # test harness.
3887
3888 # We achieve this by copying the binary and patching it as we go. The new
3889 # binary knows it is a testing copy, and it allows -C and -D without loss of
3890 # privilege. Clearly, this file is dangerous to have lying around on systems
3891 # where there are general users with login accounts. To protect against this,
3892 # we put the new binary in a special directory that is accessible only to the
3893 # caller of this script, who is known to have sudo root privilege from the test
3894 # that was done above. Furthermore, we ensure that the binary is deleted at the
3895 # end of the test. First ensure the directory exists.
3896
3897 if (-d "eximdir")
3898   { unlink "eximdir/exim"; }     # Just in case
3899 else
3900   {
3901   mkdir("eximdir", 0710) || die "** Unable to mkdir $parm_cwd/eximdir: $!\n";
3902   system("sudo chgrp $parm_eximgroup eximdir");
3903   }
3904
3905 # The construction of the patched binary must be done as root, so we use
3906 # a separate script. As well as indicating that this is a test-harness binary,
3907 # the version number is patched to "x.yz" so that its length is always the
3908 # same. Otherwise, when it appears in Received: headers, it affects the length
3909 # of the message, which breaks certain comparisons.
3910
3911 die "** Unable to make patched exim: $!\n"
3912   if (system("sudo ./patchexim $parm_exim") != 0);
3913
3914 # From this point on, exits from the program must go via the subroutine
3915 # tests_exit(), so that suitable cleaning up can be done when required.
3916 # Arrange to catch interrupting signals, to assist with this.
3917
3918 $SIG{INT} = \&inthandler;
3919 $SIG{PIPE} = \&pipehandler;
3920
3921 # For some tests, we need another copy of the binary that is setuid exim rather
3922 # than root.
3923
3924 system("sudo cp eximdir/exim eximdir/exim_exim;" .
3925        "sudo chown $parm_eximuser eximdir/exim_exim;" .
3926        "sudo chgrp $parm_eximgroup eximdir/exim_exim;" .
3927        "sudo chmod 06755 eximdir/exim_exim");
3928
3929 ##################################################
3930 #     Make copies of utilities we might need     #
3931 ##################################################
3932
3933 # Certain of the tests make use of some of Exim's utilities. We do not need
3934 # to be root to copy these.
3935
3936 ($parm_exim_dir) = $parm_exim =~ m?^(.*)/exim?;
3937
3938 $dbm_build_deleted = 0;
3939 if (defined $parm_lookups{dbm} && not cp("$parm_exim_dir/exim_dbmbuild", "eximdir/exim_dbmbuild"))
3940   {
3941   delete $parm_lookups{dbm};
3942   $dbm_build_deleted = 1;
3943   }
3944
3945 foreach my $tool (qw(exim_dumpdb exim_lock exinext exigrep eximstats exiqgrep exim_msgdate exim_id_update)) {
3946   cp("$parm_exim_dir/$tool" => "eximdir/$tool")
3947     or tests_exit(-1, "Failed to make a copy of $tool: $!");
3948 }
3949
3950 # Collect some version information
3951 print '-' x 78, "\n";
3952 print "Perl version for runtest: $]\n";
3953 foreach (map { "./eximdir/$_" } qw(exigrep exinext eximstats exiqgrep exim_msgdate)) {
3954   # fold (or unfold?) multiline output into a one-liner
3955   print join(', ', map { chomp; $_ } `$_ --version`), "\n";
3956 }
3957 print '-' x 78, "\n";
3958
3959
3960 ##################################################
3961 #    Check that the Exim user can access stuff   #
3962 ##################################################
3963
3964 # We delay this test till here so that we can check access to the actual test
3965 # binary. This will be needed when Exim re-exec's itself to do deliveries.
3966
3967 print "Exim user is $parm_eximuser ($parm_exim_uid)\n";
3968 print "Exim group is $parm_eximgroup ($parm_exim_gid)\n";
3969
3970 if ($parm_caller_uid eq $parm_exim_uid) {
3971   tests_exit(-1, "Exim user ($parm_eximuser,$parm_exim_uid) cannot be "
3972                 ."the same as caller ($parm_caller,$parm_caller_uid)");
3973 }
3974 if ($parm_caller_gid eq $parm_exim_gid) {
3975   tests_exit(-1, "Exim group ($parm_eximgroup,$parm_exim_gid) cannot be "
3976                 ."the same as caller's ($parm_caller) group as it confuses "
3977                 ."results analysis");
3978 }
3979
3980 print "The Exim user needs access to the test suite directory. Checking ...";
3981
3982 if (($rc = system("sudo bin/checkaccess $parm_cwd/eximdir/exim $parm_eximuser $parm_eximgroup")) != 0)
3983   {
3984   my($why) = "unknown failure $rc";
3985   $rc >>= 8;
3986   $why = "Couldn't find user \"$parm_eximuser\"" if $rc == 1;
3987   $why = "Couldn't find group \"$parm_eximgroup\"" if $rc == 2;
3988   $why = "Couldn't read auxiliary group list" if $rc == 3;
3989   $why = "Couldn't get rid of auxiliary groups" if $rc == 4;
3990   $why = "Couldn't set gid" if $rc == 5;
3991   $why = "Couldn't set uid" if $rc == 6;
3992   $why = "Couldn't open \"$parm_cwd/eximdir/exim\"" if $rc == 7;
3993   print "\n** $why\n";
3994   tests_exit(-1, "$parm_eximuser cannot access the test suite directory");
3995   }
3996 else
3997   {
3998   print " OK\n";
3999   }
4000
4001 tests_exit(-1, "Failed to unlink $log_summary_filename: $!")
4002   if not unlink($log_summary_filename) and -e $log_summary_filename;
4003
4004 ##################################################
4005 #        Create a list of available tests        #
4006 ##################################################
4007
4008 # The scripts directory contains a number of subdirectories whose names are
4009 # of the form 0000-xxxx, 1100-xxxx, 2000-xxxx, etc. Each set of tests apart
4010 # from the first requires certain optional features to be included in the Exim
4011 # binary. These requirements are contained in a file called "REQUIRES" within
4012 # the directory. We scan all these tests, discarding those that cannot be run
4013 # because the current binary does not support the right facilities, and also
4014 # those that are outside the numerical range selected.
4015
4016 printf "\nWill run %d tests between %d and %d for flavour %s\n",
4017   scalar(@wanted), $wanted[0], $wanted[-1], $flavour;
4018
4019 print "Omitting \${dlfunc expansion tests (loadable module not present)\n"
4020   if $dlfunc_deleted;
4021 print "Omitting dbm tests (unable to copy exim_dbmbuild)\n"
4022   if $dbm_build_deleted;
4023
4024
4025 my @test_dirs = grep { not /^CVS$/ } map { basename $_ } glob 'scripts/*'
4026   or die tests_exit(-1, "Failed to find test scripts in 'scripts/*`: $!");
4027
4028 # Scan for relevant tests
4029 # HS12: Needs to be reworked.
4030 DIR: for (my $i = 0; $i < @test_dirs; $i++)
4031   {
4032   my($testdir) = $test_dirs[$i];
4033   my($wantthis) = 1;
4034
4035   print ">>Checking $testdir\n" if $debug;
4036
4037   # Skip this directory if the first test is equal or greater than the first
4038   # test in the next directory.
4039
4040   next DIR if ($i < @test_dirs - 1) &&
4041           ($wanted[0] >= substr($test_dirs[$i+1], 0, 4));
4042
4043   # No need to carry on if the end test is less than the first test in this
4044   # subdirectory.
4045
4046   last DIR if $wanted[-1] < substr($testdir, 0, 4);
4047
4048   # Check requirements, if any.
4049
4050   if (open(my $requires, "scripts/$testdir/REQUIRES"))
4051     {
4052     while (<$requires>)
4053       {
4054       next if /^\s*$/;
4055       s/\s+$//;
4056       if (/^support (.*)$/)
4057         {
4058         if (!defined $parm_support{$1}) { $wantthis = 0; last; }
4059         }
4060       elsif (/^running (.*)$/)
4061         {
4062         if (!defined $parm_running{$1}) { $wantthis = 0; last; }
4063         }
4064       elsif (/^lookup (.*)$/)
4065         {
4066         if (!defined $parm_lookups{$1}) { $wantthis = 0; last; }
4067         }
4068       elsif (/^authenticators? (.*)$/)
4069         {
4070         if (!defined $parm_authenticators{$1}) { $wantthis = 0; last; }
4071         }
4072       elsif (/^router (.*)$/)
4073         {
4074         if (!defined $parm_routers{$1}) { $wantthis = 0; last; }
4075         }
4076       elsif (/^transport (.*)$/)
4077         {
4078         if (!defined $parm_transports{$1}) { $wantthis = 0; last; }
4079         }
4080       elsif (/^malware (.*)$/)
4081         {
4082         if (!defined $parm_malware{$1}) { $wantthis = 0; last; }
4083         }
4084       elsif (/^(not )?feature (.*)$/)
4085         {
4086         # move to a subroutine?
4087         my $eximinfo = "$parm_exim -C $parm_cwd/test-config -DDIR=$parm_cwd -bP macro $2";
4088
4089         open (IN, "$parm_cwd/confs/0000") ||
4090           tests_exit(-1, "Couldn't open $parm_cwd/confs/0000: $!\n");
4091         open (OUT, ">test-config") ||
4092           tests_exit(-1, "Couldn't open test-config: $!\n");
4093         while (<IN>)
4094           {
4095           do_substitute($testno);
4096           print OUT;
4097           }
4098         close(IN);
4099         close(OUT);
4100
4101         system($eximinfo . " >/dev/null 2>&1");
4102         if (!defined $1 && $? != 0 || defined $1 && $? == 0) {
4103           $wantthis = 0;
4104           unlink("$parm_cwd/test-config");
4105           $_ = $1 || "" . "feature $2";
4106           last;
4107         }
4108         unlink("$parm_cwd/test-config");
4109         }
4110       elsif (/^ipv6-non-linklocal/)
4111         {
4112         if ($parm_ipv6 =~ /%/) { $wantthis = 0; last; }
4113         }
4114       else
4115         {
4116         tests_exit(-1, "Unknown line in \"scripts/$testdir/REQUIRES\": \"$_\"");
4117         }
4118       }
4119     }
4120   else
4121     {
4122     tests_exit(-1, "Failed to open \"scripts/$testdir/REQUIRES\": $!")
4123       unless $!{ENOENT};
4124     }
4125
4126   # Loop if we do not want the tests in this subdirectory.
4127
4128   if (!$wantthis)
4129     {
4130     chomp;
4131     print "Omitting tests in $testdir (missing $_)\n";
4132     }
4133
4134   # We want the tests from this subdirectory, provided they are in the
4135   # range that was selected.
4136
4137   @testlist = grep { $_ ~~ @wanted } grep { /^\d+(?:\.\d+)?$/ } map { basename $_ } glob "scripts/$testdir/*";
4138   tests_exit(-1, "Failed to read test scripts from `scripts/$testdir/*': $!")
4139     if not @testlist;
4140
4141   foreach $test (@testlist)
4142     {
4143     if (!$wantthis)
4144       {
4145       log_test($log_summary_filename, $test, '.');
4146       }
4147     else
4148       {
4149       push @test_list, "$testdir/$test";
4150       }
4151     }
4152   }
4153
4154 print ">>Test List:\n", join "\n", @test_list, '' if $debug;
4155
4156
4157 ##################################################
4158 #         Munge variable auxiliary data          #
4159 ##################################################
4160
4161 # Some of the auxiliary data files have to refer to the current testing
4162 # directory and other parameter data. The generic versions of these files are
4163 # stored in the aux-var-src directory. At this point, we copy each of them
4164 # to the aux-var directory, making appropriate substitutions. There aren't very
4165 # many of them, so it's easiest just to do this every time. Ensure the mode
4166 # is standardized, as this path is used as a test for the ${stat: expansion.
4167
4168 # A similar job has to be done for the files in the dnszones-src directory, to
4169 # make the fake DNS zones for testing. Most of the zone files are copied to
4170 # files of the same name, but db.ipv4.V4NET and db.ipv6.V6NET use the testing
4171 # networks that are defined by parameter.
4172
4173 foreach $basedir ("aux-var", "dnszones")
4174   {
4175   system("sudo rm -rf $parm_cwd/$basedir");
4176   mkdir("$parm_cwd/$basedir", 0777);
4177   chmod(0755, "$parm_cwd/$basedir");
4178
4179   opendir(AUX, "$parm_cwd/$basedir-src") ||
4180     tests_exit(-1, "Failed to opendir $parm_cwd/$basedir-src: $!");
4181   my(@filelist) = readdir(AUX);
4182   close(AUX);
4183
4184   foreach $file (@filelist)
4185     {
4186     my($outfile) = $file;
4187     next if $file =~ /^\./;
4188
4189     if ($file eq "db.ip4.V4NET")
4190       {
4191       $outfile = "db.ip4.$parm_ipv4_test_net";
4192       }
4193     elsif ($file eq "db.ip6.V6NET")
4194       {
4195       my(@nibbles) = reverse(split /\s*/, $parm_ipv6_test_net);
4196       $" = '.';
4197       $outfile = "db.ip6.@nibbles";
4198       $" = ' ';
4199       }
4200
4201     print ">>Copying $basedir-src/$file to $basedir/$outfile\n" if $debug;
4202     open(IN, "$parm_cwd/$basedir-src/$file") ||
4203       tests_exit(-1, "Failed to open $parm_cwd/$basedir-src/$file: $!");
4204     open(OUT, ">$parm_cwd/$basedir/$outfile") ||
4205       tests_exit(-1, "Failed to open $parm_cwd/$basedir/$outfile: $!");
4206     while (<IN>)
4207       {
4208       do_substitute(0);
4209       print OUT;
4210       }
4211     close(IN);
4212     close(OUT);
4213     }
4214   }
4215
4216 # Set a user's shell, distinguishable from /bin/sh
4217
4218 symlink('/bin/sh' => 'aux-var/sh');
4219 $ENV{SHELL} = $parm_shell = "$parm_cwd/aux-var/sh";
4220
4221 ##################################################
4222 #     Create fake DNS zones for this host        #
4223 ##################################################
4224
4225 # There are fixed zone files for 127.0.0.1 and ::1, but we also want to be
4226 # sure that there are forward and reverse registrations for this host, using
4227 # its real IP addresses. Dynamically created zone files achieve this.
4228
4229 if ($have_ipv4 || $have_ipv6)
4230   {
4231   my($shortname,$domain) = $parm_hostname =~ /^([^.]+)(.*)/;
4232   open(OUT, ">$parm_cwd/dnszones/db$domain") ||
4233     tests_exit(-1, "Failed to open $parm_cwd/dnszones/db$domain: $!");
4234   print OUT "; This is a dynamically constructed fake zone file.\n" .
4235     "; The following line causes fakens to return PASS_ON\n" .
4236     "; for queries that it cannot answer\n\n" .
4237     "PASS ON NOT FOUND\n\n";
4238   print OUT "$shortname  A     $parm_ipv4\n" if $have_ipv4;
4239   print OUT "$shortname  AAAA  $parm_ipv6_stripped\n" if $have_ipv6;
4240   print OUT "\n; End\n";
4241   close(OUT);
4242   }
4243
4244 if ($have_ipv4 && $parm_ipv4 ne "127.0.0.1")
4245   {
4246   my(@components) = $parm_ipv4 =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)/;
4247
4248   if ($components[0]=='10')
4249     {
4250     open(OUT, ">>$parm_cwd/dnszones/db.ip4.$components[0]") ||
4251       tests_exit(-1, "Failed  to open $parm_cwd/dnszones/db.ip4.$components[0]: $!");
4252     print OUT "$components[3].$components[2].$components[1]  PTR  $parm_hostname.\n\n";
4253     close(OUT);
4254     }
4255   else
4256     {
4257     open(OUT, ">$parm_cwd/dnszones/db.ip4.$components[0]") ||
4258       tests_exit(-1,
4259         "Failed  to open $parm_cwd/dnszones/db.ip4.$components[0]: $!");
4260     print OUT "; This is a dynamically constructed fake zone file.\n" .
4261       "; The zone is $components[0].in-addr.arpa.\n\n" .
4262       "$components[3].$components[2].$components[1]  PTR  $parm_hostname.\n\n" .
4263       "; End\n";
4264     close(OUT);
4265     }
4266   }
4267
4268 if ($have_ipv6 && $parm_ipv6_stripped ne "::1")
4269   {
4270   my($exp_v6) = $parm_ipv6_stripped;
4271   $exp_v6 =~ s/[^:]//g;
4272   if ( $parm_ipv6_stripped =~ /^([^:].+)::$/ ) {
4273     $exp_v6 = $1 . ':0' x (9-length($exp_v6));
4274   } elsif ( $parm_ipv6_stripped =~ /^(.+)::(.+)$/ ) {
4275     $exp_v6 = $1 . ':0' x (8-length($exp_v6)) . ':' . $2;
4276   } elsif ( $parm_ipv6_stripped =~ /^::(.+[^:])$/ ) {
4277     $exp_v6 = '0:' x (9-length($exp_v6)) . $1;
4278   } else {
4279     $exp_v6 = $parm_ipv6_stripped;
4280   }
4281   my(@components) = split /:/, $exp_v6;
4282   my(@nibbles) = reverse (split /\s*/, shift @components);
4283   my($sep) =  '';
4284
4285   $" = ".";
4286   open(OUT, ">$parm_cwd/dnszones/db.ip6.@nibbles") ||
4287     tests_exit(-1,
4288       "Failed  to open $parm_cwd/dnszones/db.ip6.@nibbles: $!");
4289   print OUT "; This is a dynamically constructed fake zone file.\n" .
4290     "; The zone is @nibbles.ip6.arpa.\n\n";
4291
4292   @components = reverse @components;
4293   foreach $c (@components)
4294     {
4295     $c = "0$c" until $c =~ /^..../;
4296     @nibbles = reverse(split /\s*/, $c);
4297     print OUT "$sep@nibbles";
4298     $sep = ".";
4299     }
4300
4301   print OUT "  PTR  $parm_hostname.\n\n; End\n";
4302   close(OUT);
4303   $" = " ";
4304   }
4305
4306
4307
4308 ##################################################
4309 #    Create lists of mailboxes and message logs  #
4310 ##################################################
4311
4312 # We use these lists to check that a test has created the expected files. It
4313 # should be faster than looking for the file each time. For mailboxes, we have
4314 # to scan a complete subtree, in order to handle maildirs. For msglogs, there
4315 # is just a flat list of files.
4316
4317 @oldmails = list_files_below("mail");
4318 opendir(DIR, "msglog") || tests_exit(-1, "Failed to opendir msglog: $!");
4319 @oldmsglogs = readdir(DIR);
4320 closedir(DIR);
4321
4322
4323
4324 ##################################################
4325 #         Run the required tests                 #
4326 ##################################################
4327
4328 # Each test script contains a number of tests, separated by a line that
4329 # contains ****. We open input from the terminal so that we can read responses
4330 # to prompts.
4331
4332 if (not $force_continue) {
4333   # runtest needs to interact if we're not in continue
4334   # mode. It does so by communicate to /dev/tty
4335   open(T, '<', '/dev/tty') or tests_exit(-1, "Failed to open /dev/tty: $!");
4336   print "\nPress RETURN to run the tests: ";
4337   <T>;
4338 }
4339
4340
4341 my $failures = 0;
4342 foreach $test (@test_list)
4343   {
4344   state $lasttestdir = '';
4345
4346   local $lineno     = 0;
4347   local $commandno  = 0;
4348   local $subtestno  = 0;
4349   local $sortlog    = 0;
4350
4351   (local $testno = $test) =~ s|.*/||;
4352
4353   # Leaving traces in the process table and in the environment
4354   # gives us a chance to identify hanging processes (exim daemons)
4355   local $0 = "[runtest $testno]";
4356   local $ENV{EXIM_TEST_NUMBER} = $testno;
4357
4358   my $gnutls   = 0;
4359   my $docheck  = 1;
4360   my $thistestdir  = substr($test, 0, -5);
4361
4362   $dynamic_socket->close() if $dynamic_socket;
4363
4364   if ($lasttestdir ne $thistestdir)
4365     {
4366     $gnutls = 0;
4367     if (-s "scripts/$thistestdir/REQUIRES")
4368       {
4369       my $indent = '';
4370       print "\n>>> The following tests require: ";
4371       open(my $requires, '<', "scripts/$thistestdir/REQUIRES") ||
4372         tests_exit(-1, "Failed to open scripts/$thistestdir/REQUIRES: $!");
4373       while (<$requires>)
4374         {
4375         $gnutls = 1 if /^support GnuTLS/;
4376         print $indent, $_;
4377         $indent = ">>>                              ";
4378         }
4379       }
4380       $lasttestdir = $thistestdir;
4381     }
4382
4383   # Remove any debris in the spool directory and the test-mail directory
4384   # and also the files for collecting stdout and stderr. Then put back
4385   # the test-mail directory for appendfile deliveries.
4386
4387   system "sudo /bin/rm -rf spool test-*";
4388   mkdir "test-mail";
4389
4390   # A privileged Exim will normally make its own spool directory, but some of
4391   # the tests run in unprivileged modes that don't always work if the spool
4392   # directory isn't already there. What is more, we want anybody to be able
4393   # to read it in order to find the daemon's pid.
4394
4395   mkdir "spool";
4396   system "sudo chown $parm_eximuser:$parm_eximgroup spool; " .
4397          "sudo chmod 0755 spool";
4398
4399   # Empty the cache that keeps track of things like message id mappings, and
4400   # set up the initial sequence strings.
4401
4402   undef %cache;
4403   $next_msgid_old = "aX";
4404   $next_msgid = "aX";
4405   $next_pid = 1234;
4406   $next_port = 1111;
4407   $message_skip = 0;
4408   $msglog_skip = 0;
4409   $munge_skip = 0;
4410   $stderr_skip = 0;
4411   $stdout_skip = 0;
4412   $rmfiltertest = 0;
4413   $is_ipv6test = 0;
4414   $TEST_STATE->{munge} = '';
4415
4416   # Remove the associative arrays used to hold checked mail files and msglogs
4417
4418   undef %expected_mails;
4419   undef %expected_msglogs;
4420
4421   # Open the test's script
4422   open(SCRIPT, "scripts/$test") ||
4423     tests_exit(-1, "Failed to open \"scripts/$test\": $!");
4424   # Run through the script once to set variables which should be global
4425   while (<SCRIPT>)
4426     {
4427     if (/^no_message_check/) { $message_skip = 1; next; }
4428     if (/^no_msglog_check/)  { $msglog_skip = 1; next; }
4429     if (/^no_munge/)         { $munge_skip = 1; next; }
4430     if (/^no_stderr_check/)  { $stderr_skip = 1; next; }
4431     if (/^no_stdout_check/)  { $stdout_skip = 1; next; }
4432     if (/^rmfiltertest/)     { $rmfiltertest = 1; next; }
4433     if (/^sortlog/)          { $sortlog = 1; next; }
4434     if (/\bPORT_DYNAMIC\b/)  { $dynamic_socket = Exim::Runtest::dynamic_socket(); next; }
4435     }
4436   # Reset to beginning of file for per test interpreting/processing
4437   seek(SCRIPT, 0, 0);
4438
4439   # The first line in the script must be a comment that is used to identify
4440   # the set of tests as a whole.
4441
4442   $_ = <SCRIPT>;
4443   $lineno++;
4444   tests_exit(-1, "Missing identifying comment at start of $test") if (!/^#/);
4445   printf("%s %s", (substr $test, 5), (substr $_, 2));
4446
4447   # Loop for each of the subtests within the script. The variable $server_pid
4448   # is used to remember the pid of a "server" process, for which we do not
4449   # wait until we have waited for a subsequent command.
4450
4451   local($server_pid) = 0;
4452   for ($commandno = 1; !eof SCRIPT; $commandno++)
4453     {
4454     # Skip further leading comments and blank lines, handle the flag setting
4455     # commands, and deal with tests for IP support.
4456
4457     while (<SCRIPT>)
4458       {
4459       $lineno++;
4460       # Could remove these variable settings because they are already
4461       # set above, but doesn't hurt to leave them here.
4462       if (/^no_message_check/) { $message_skip = 1; next; }
4463       if (/^no_msglog_check/)  { $msglog_skip = 1; next; }
4464       if (/^no_munge/)         { $munge_skip = 1; next; }
4465       if (/^no_stderr_check/)  { $stderr_skip = 1; next; }
4466       if (/^no_stdout_check/)  { $stdout_skip = 1; next; }
4467       if (/^rmfiltertest/)     { $rmfiltertest = 1; next; }
4468       if (/^sortlog/)          { $sortlog = 1; next; }
4469
4470       if (/^need_largefiles/)
4471         {
4472         next if $have_largefiles;
4473         print ">>> Large file support is needed for test $testno, but is not available: skipping\n";
4474         $docheck = 0;      # don't check output
4475         undef $_;          # pretend EOF
4476         last;
4477         }
4478
4479       if (/^need_ipv4/)
4480         {
4481         next if $have_ipv4;
4482         print ">>> IPv4 is needed for test $testno, but is not available: skipping\n";
4483         $docheck = 0;      # don't check output
4484         undef $_;          # pretend EOF
4485         last;
4486         }
4487
4488       if (/^need_ipv6/)
4489         {
4490         if ($have_ipv6)
4491           {
4492           $is_ipv6test = 1;
4493           next;
4494           }
4495         print ">>> IPv6 is needed for test $testno, but is not available: skipping\n";
4496         $docheck = 0;      # don't check output
4497         undef $_;          # pretend EOF
4498         last;
4499         }
4500
4501       if (/^need_move_frozen_messages/)
4502         {
4503         next if defined $parm_support{move_frozen_messages};
4504         print ">>> move frozen message support is needed for test $testno, " .
4505           "but is not\n>>> available: skipping\n";
4506         $docheck = 0;      # don't check output
4507         undef $_;          # pretend EOF
4508         last;
4509         }
4510
4511       last unless /^(?:#(?!##\s)|\s*$)/;
4512       }
4513     last if !defined $_;  # Hit EOF
4514
4515     my($subtest_startline) = $lineno;
4516
4517     # Now run the command. The function returns 0 for an inline command,
4518     # 1 if a non-exim command was run and waited for, 2 if an exim
4519     # command was run and waited for, and 3 if a command
4520     # was run and not waited for (usually a daemon or server startup).
4521
4522     my($commandname) = '';
4523     my($expectrc) = 0;
4524     my($rc, $run_extra) = run_command($testno, \$subtestno, \$expectrc, \$commandname, $TEST_STATE);
4525     my($cmdrc) = $?;
4526
4527     if ($debug) {
4528       print ">> rc=$rc cmdrc=$cmdrc\n";
4529       if (defined $run_extra) {
4530         foreach my $k (keys %$run_extra) {
4531           my $v = defined $run_extra->{$k} ? qq!"$run_extra->{$k}"! : '<undef>';
4532           print ">>   $k -> $v\n";
4533         }
4534       }
4535     }
4536     $run_extra = {} unless defined $run_extra;
4537     foreach my $k (keys %$run_extra) {
4538       if (exists $TEST_STATE->{$k}) {
4539         my $nv = defined $run_extra->{$k} ? qq!"$run_extra->{$k}"! : 'removed';
4540         print ">> override of $k; was $TEST_STATE->{$k}, now $nv\n" if $debug;
4541       }
4542       if (defined $run_extra->{$k}) {
4543         $TEST_STATE->{$k} = $run_extra->{$k};
4544       } elsif (exists $TEST_STATE->{$k}) {
4545         delete $TEST_STATE->{$k};
4546       }
4547     }
4548
4549     # Hit EOF after an initial return code number
4550
4551     tests_exit(-1, "Unexpected EOF in script") if ($rc == 4);
4552
4553     # Carry on with the next command if we did not wait for this one. $rc == 0
4554     # if no subprocess was run; $rc == 3 if we started a process but did not
4555     # wait for it.
4556
4557     next if ($rc == 0 || $rc == 3);
4558
4559     # We ran and waited for a command. Check for the expected result unless
4560     # it died.
4561
4562     if ($cmdrc != $expectrc && !$sigpipehappened)
4563       {
4564       printf("** Command $commandno (\"$commandname\", starting at line $subtest_startline)\n");
4565       if (($cmdrc & 0xff) == 0)
4566         {
4567         printf("** Return code %d (expected %d)", $cmdrc/256, $expectrc/256);
4568         }
4569       elsif (($cmdrc & 0xff00) == 0)
4570         { printf("** Killed by signal %d", $cmdrc & 255); }
4571       else
4572         { printf("** Status %x", $cmdrc); }
4573
4574       for (;;)
4575         {
4576         print "\nshow stdErr, show stdOut, Retry, Continue (without file comparison), or Quit? [Q] ";
4577         $_ = $force_continue ? "c" : <T>;
4578         tests_exit(1) if /^q?$/i;
4579         if (/^c$/ && $force_continue)
4580           {
4581           log_failure($log_failed_filename, $testno, "exit code unexpected");
4582           log_test($log_summary_filename, $testno, 'F');
4583           $failures++;
4584           }
4585         if ($force_continue)
4586           {
4587           print "\nstdout tail:\n";
4588           print "==================>\n";
4589           system("tail -20 test-stdout");
4590           print "===================\n";
4591
4592           print "stderr tail:\n";
4593           print "==================>\n";
4594           system("tail -30 test-stderr");
4595           print "===================\n";
4596
4597           print "stdout-server tail:\n";
4598           print "==================>\n";
4599           system("tail -20 test-stdout-server");
4600           print "===================\n";
4601
4602           print "stderr-server tail:\n";
4603           print "==================>\n";
4604           system("tail -30 test-stderr-server");
4605           print "===================\n";
4606
4607           print "... continue forced\n";
4608           }
4609
4610         last if /^[rc]$/i;
4611         if (/^e$/i)
4612           {
4613           system @more => 'test-stderr';
4614           }
4615         elsif (/^o$/i)
4616           {
4617           system @more => 'test-stdout';
4618           }
4619         }
4620
4621       $retry = 1 if /^r$/i;
4622       $docheck = 0;
4623       }
4624
4625     # If the command was exim, and a listening server is running, we can now
4626     # close its input, which causes us to wait for it to finish, which is why
4627     # we didn't close it earlier.
4628
4629     if ($rc == 2 && $server_pid != 0)
4630       {
4631       close SERVERCMD;
4632       $server_pid = 0;
4633       if ($? != 0)
4634         {
4635         if (($? & 0xff) == 0)
4636           { printf("Server return code %d for test %d starting line %d", $?/256,
4637                 $testno, $subtest_startline); }
4638         elsif (($? & 0xff00) == 0)
4639           { printf("Server killed by signal %d", $? & 255); }
4640         else
4641           { printf("Server status %x", $?); }
4642
4643         for (;;)
4644           {
4645           print "\nShow server stdout, Retry, Continue, or Quit? [Q] ";
4646           $_ = $force_continue ? "c" : <T>;
4647           tests_exit(1) if /^q?$/i;
4648           if (/^c$/ && $force_continue)
4649             {
4650             log_failure($log_failed_filename, $testno, "exit code unexpected");
4651             log_test($log_summary_filename, $testno, 'F');
4652             $failures++;
4653             }
4654           print "... continue forced\n" if $force_continue;
4655           last if /^[rc]$/i;
4656
4657           if (/^s$/i)
4658             {
4659             open(S, "test-stdout-server") ||
4660               tests_exit(-1, "Failed to open test-stdout-server: $!");
4661             print while <S>;
4662             close(S);
4663             }
4664           }
4665         $retry = 1 if /^r$/i;
4666         }
4667       }
4668     }
4669
4670   close SCRIPT;
4671
4672   # The script has finished. Check the all the output that was generated. The
4673   # function returns 0 for a perfect pass, 1 if imperfect but ok, 2 if we should
4674   # rerun the test (the files # have been updated).
4675   # It does not return if the user responds Q to a prompt.
4676
4677   if ($retry)
4678     {
4679     $retry = '0';
4680     print (("#" x 79) . "\n");
4681     redo;
4682     }
4683
4684   if ($docheck)
4685     {
4686     sleep 1 if $slow;
4687     my $rc = check_output($TEST_STATE->{munge});
4688     if ($rc == 0)
4689       {
4690       log_test($log_summary_filename, $testno, 'P');
4691       }
4692     else
4693       {
4694       $failures++;
4695       }
4696     if ($rc < 2)
4697       {
4698       print ("  Script completed\n");
4699       }
4700     else
4701       {
4702       print (("#" x 79) . "\n");
4703       redo;
4704       }
4705     }
4706   }
4707
4708
4709 ##################################################
4710 #         Exit from the test script              #
4711 ##################################################
4712
4713 tests_exit(-1, "No runnable tests selected") if not @test_list;
4714 tests_exit($fail_any ? $failures : 0);
4715
4716 __END__
4717
4718 =head1 NAME
4719
4720  runtest - run the exim testsuite
4721
4722 =head1 SYNOPSIS
4723
4724  runtest [exim-path] [options] [test0 [test1]]
4725
4726 =head1 DESCRIPTION
4727
4728 B<runtest> runs the Exim testsuite.
4729
4730 =head1 OPTIONS
4731
4732 For legacy reasons the options are not case sensitive.
4733
4734 =over
4735
4736 =item B<--continue>
4737
4738 Do not stop for user interaction or on errors. (default: off)
4739
4740 =item B<--debug>
4741
4742 This option enables the output of debug information when running the
4743 various test commands. (default: off)
4744
4745 =item B<--diff>
4746
4747 Use C<diff -u> for comparing the expected output with the produced
4748 output. (default: use a built-in routine)
4749
4750 =item B<--flavor>|B<--flavour> I<flavour>
4751
4752 Override the expected results for results for a specific (OS) flavour.
4753 (default: unused)
4754
4755 =item B<--[no]ipv4>
4756
4757 Skip IPv4 related setup and tests (default: use ipv4)
4758
4759 =item B<--[no]ipv6>
4760
4761 Skip IPv6 related setup and tests (default: use ipv6)
4762
4763 =item B<--keep>
4764
4765 Keep the various output files produced during a test run. (default: don't keep)
4766
4767 =item B<--range> I<n0> I<n1>
4768
4769 Run tests between (including) I<n0> and I<n1>. A "+" may be used to specify the "last
4770 test available".
4771
4772 =item B<--slow>
4773
4774 Insert some delays to compensate for a slow host system. (default: off)
4775
4776 =item B<--test> I<n>
4777
4778 Run the specified test. This option may used multiple times.
4779
4780 =item B<--update>
4781
4782 Automatically update the recorded (expected) data on mismatch. (default: off)
4783
4784 =item B<--valgrind>
4785
4786 Start Exim wrapped by I<valgrind>. (default: don't use valgrind)
4787
4788 =back
4789
4790 =cut
4791
4792
4793 # End of runtest script