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