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