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