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