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