Testsuite: fix debug stream munging for non-autocreate DBM variants, and for no TFO...
[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 = '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);
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     my($increment) = date_seconds($date3) - date_seconds($date2);
464
465     # We used to use globally unique replacement values, but timing
466     # differences make this impossible. Just show the increment on the
467     # last one.
468
469     printf MUNGED ("first failed = time last try = time2 next try = time2 + %s%s\n",
470       $increment, $expired);
471     next;
472     }
473
474   # more_errno values in exim_dumpdb output which are times
475   s/T:(\S+)\s-22\s(\S+)\s/T:$1 -22 xxxx /;
476
477
478   # ======== Dates and times ========
479
480   # Dates and times are all turned into the same value - trying to turn
481   # them into different ones cannot be done repeatedly because they are
482   # real time stamps generated while running the test. The actual date and
483   # time used was fixed when I first started running automatic Exim tests.
484
485   # Date/time in header lines and SMTP responses
486   s/[A-Z][a-z]{2},\s\d\d?\s[A-Z][a-z]{2}\s\d\d\d\d\s\d\d\:\d\d:\d\d\s[-+]\d{4}
487     /Tue, 2 Mar 1999 09:44:33 +0000/gx;
488
489   # Date/time in logs and in one instance of a filter test
490   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;
491   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;
492   s/^Logwrite\s"\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d/Logwrite "1999-03-02 09:44:33/gx;
493   # Date/time in syslog test
494   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;
495   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;
496   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;
497   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;
498
499   s/((D|[RQD]T)=)\d+s/$1qqs/g;
500   s/((D|[RQD]T)=)\d\.\d{3}s/$1q.qqqs/g;
501
502   # Date/time in message separators
503   s/(?:[A-Z][a-z]{2}\s){2}\d\d\s\d\d:\d\d:\d\d\s\d\d\d\d
504     /Tue Mar 02 09:44:33 1999/gx;
505
506   # Date of message arrival in spool file as shown by -Mvh
507   s/^\d{9,10}\s0$/ddddddddd 0/;
508
509   # Date/time in mbx mailbox files
510   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;
511
512   # Dates/times in debugging output for writing retry records
513   if (/^  first failed=(\d+) last try=(\d+) next try=(\d+) (.*)$/)
514     {
515     my($next) = $3 - $2;
516     $_ = "  first failed=dddd last try=dddd next try=+$next $4\n";
517     }
518   s/^(\s*)now=\d+ first_failed=\d+ next_try=\d+ expired=(\d)/$1now=tttt first_failed=tttt next_try=tttt expired=$2/;
519   s/^(\s*)received_time=\d+ diff=\d+ timeout=(\d+)/$1received_time=tttt diff=tttt timeout=$2/;
520
521   # Time to retry may vary
522   s/time to retry = \S+/time to retry = tttt/;
523   s/retry record exists: age=\S+/retry record exists: age=ttt/;
524   s/failing_interval=\S+ message_age=\S+/failing_interval=ttt message_age=ttt/;
525
526   # Date/time in exim -bV output
527   s/\d\d-[A-Z][a-z]{2}-\d{4}\s\d\d:\d\d:\d\d/07-Mar-2000 12:21:52/g;
528
529   # Eximstats heading
530   s/Exim\sstatistics\sfrom\s\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d\sto\s
531     \d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d/Exim statistics from <time> to <time>/x;
532
533   # Treat ECONNRESET the same as ECONNREFUSED.  At least some systems give
534   # us the former on a new connection.
535   s/(could not connect to .*: Connection) reset by peer$/$1 refused/;
536
537   # ======== TLS certificate algorithms ========
538   # Test machines might have various different TLS library versions supporting
539   # different protocols; can't rely upon TLS 1.2's AES256-GCM-SHA384, so we
540   # treat the standard algorithms the same.
541   #
542   # TLSversion : KeyExchange? - Authentication/Signature - C_iph_er - MAC : ???
543   #
544   # So far, have seen:
545   #   TLSv1:AES128-GCM-SHA256:128
546   #   TLSv1:AES256-SHA:256
547   #   TLSv1.1:AES256-SHA:256
548   #   TLSv1.2:AES256-GCM-SHA384:256
549   #   TLSv1.2:DHE-RSA-AES256-SHA:256
550   #   TLSv1.3:TLS_AES_256_GCM_SHA384:256
551   #   TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128
552   # We also need to handle the ciphersuite without the TLS part present, for
553   # client-ssl's output.  We also see some older forced ciphersuites, but
554   # negotiating TLS 1.2 instead of 1.0.
555   # Mail headers (...), log-lines X=..., client-ssl output ...
556   # (and \b doesn't match between ' ' and '(' )
557   #
558   # Retain the authentication algorith field as we want to test that.
559
560   s/( (?: (?:\b|\s) [\(=] ) | \s )TLSv1\.[123]:/$1TLSv1:/xg;
561   s/((EC)?DHE-)?(RSA|ECDSA)-AES(128|256)-(GCM-SHA(256|384)|SHA)(?!:)/ke-$3-AES256-SHA/g;
562   s/((EC)?DHE-)?(RSA|ECDSA)-AES(128|256)-(GCM-SHA(256|384)|SHA):(128|256)/ke-$3-AES256-SHA:xxx/g;
563
564   # OpenSSL TLSv1.3 - unsure what to do about the authentication-variant testcases now,
565   # as it seems the protocol no longer supports a user choice.  Replace the "TLS" field with "RSA".
566   # Also insert a key-exchange field for back-compat, even though 1.3 doesn't do that.
567   #
568   # TLSversion : "TLS" - C_iph_er - MAC : ???
569   #
570   s/TLS_AES(_256)?_GCM_SHA384(?!:)/ke-RSA-AES256-SHA/g;
571   s/:TLS_AES(_256)?_GCM_SHA384:256/:ke-RSA-AES256-SHA:xxx/g;
572
573   # LibreSSL
574   # TLSv1:AES256-GCM-SHA384:256
575   # TLSv1:ECDHE-RSA-CHACHA20-POLY1305:256
576   #
577   # ECDHE-RSA-CHACHA20-POLY1305
578   # AES256-GCM-SHA384
579
580   s/(?<!-)(AES256-GCM-SHA384)/RSA-$1/;
581   s/((EC)?DHE-)?(RSA|ECDSA)-(AES256|CHACHA20)-(GCM-SHA384|POLY1305)(?!:)/ke-$3-AES256-SHA/g;
582   s/((EC)?DHE-)?(RSA|ECDSA)-(AES256|CHACHA20)-(GCM-SHA384|POLY1305):256/ke-$3-AES256-SHA:xxx/g;
583
584   # GnuTLS have seen:
585   #   TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256
586   #   TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128
587   #   TLS1.2:RSA_AES_256_CBC_SHA1:256 (canonical)
588   #   TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128
589   #
590   #   X=TLS1.2:DHE_RSA_AES_256_CBC_SHA256:256
591   #   X=TLS1.2:RSA_AES_256_CBC_SHA1:256
592   #   X=TLS1.1:RSA_AES_256_CBC_SHA1:256
593   #   X=TLS1.0:DHE_RSA_AES_256_CBC_SHA1:256
594   # and as stand-alone cipher:
595   #   ECDHE-RSA-AES256-SHA
596   #   DHE-RSA-AES256-SHA256
597   #   DHE-RSA-AES256-SHA
598   # picking latter as canonical simply because regex easier that way.
599   s/\bDHE_RSA_AES_128_CBC_SHA1:128/RSA_AES_256_CBC_SHA1:256/g;
600   s/TLS1.[012]:((EC)?DHE_)?(RSA|ECDSA)_AES_(256|128)_(CBC|GCM)_SHA(1|256|384):(256|128)/TLS1.x:ke_$3_AES_256_CBC_SHAnnn:256/g;
601   s/\b(ECDHE-(RSA|ECDSA)-AES256-SHA|DHE-RSA-AES256-SHA256)\b/ke-$2-AES256-SHAxx/g;
602
603   # GnuTLS library error message changes
604   s/No certificate was found/The peer did not send any certificate/g;
605 #(dodgy test?)  s/\(certificate verification failed\): invalid/\(gnutls_handshake\): The peer did not send any certificate./g;
606   s/\(gnutls_priority_set\): No or insufficient priorities were set/\(gnutls_handshake\): Could not negotiate a supported cipher suite/g;
607   s/\(gnutls_handshake\): \KNo supported cipher suites have been found.$/Could not negotiate a supported cipher suite./;
608
609   # (this new one is a generic channel-read error, but the testsuite
610   # only hits it in one place)
611   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;
612
613   # (replace old with new, hoping that old only happens in one situation)
614   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;
615   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;
616
617   # signature algorithm names
618   s/RSA-SHA1/RSA-SHA/;
619
620
621   # ======== Caller's login, uid, gid, home, gecos ========
622
623   s/\Q$parm_caller_home\E/CALLER_HOME/g;   # NOTE: these must be done
624   s/\b\Q$parm_caller\E\b/CALLER/g;         #       in this order!
625   s/\b\Q$parm_caller_group\E\b/CALLER/g;   # In case group name different
626
627   s/\beuid=$parm_caller_uid\b/euid=CALLER_UID/g;
628   s/\begid=$parm_caller_gid\b/egid=CALLER_GID/g;
629
630   s/\buid=$parm_caller_uid\b/uid=CALLER_UID/g;
631   s/\bgid=$parm_caller_gid\b/gid=CALLER_GID/g;
632
633   s/\bname="?$parm_caller_gecos"?/name=CALLER_GECOS/g;
634
635   # When looking at spool files with -Mvh, we will find not only the caller
636   # login, but also the uid and gid. It seems that $) in some Perls gives all
637   # the auxiliary gids as well, so don't bother checking for that.
638
639   s/^CALLER $> \d+$/CALLER UID GID/;
640
641   # There is one case where the caller's login is forced to something else,
642   # in order to test the processing of logins that contain spaces. Weird what
643   # some people do, isn't it?
644
645   s/^spaced user $> \d+$/CALLER UID GID/;
646
647
648   # ======== Exim's login ========
649   # For messages received by the daemon, this is in the -H file, which some
650   # tests inspect. For bounce messages, this will appear on the U= lines in
651   # logs and also after Received: and in addresses. In one pipe test it appears
652   # after "Running as:". It also appears in addresses, and in the names of lock
653   # files.
654
655   s/U=$parm_eximuser/U=EXIMUSER/;
656   s/user=$parm_eximuser/user=EXIMUSER/;
657   s/login=$parm_eximuser/login=EXIMUSER/;
658   s/Received: from $parm_eximuser /Received: from EXIMUSER /;
659   s/Running as: $parm_eximuser/Running as: EXIMUSER/;
660   s/\b$parm_eximuser@/EXIMUSER@/;
661   s/\b$parm_eximuser\.lock\./EXIMUSER.lock./;
662
663   s/\beuid=$parm_exim_uid\b/euid=EXIM_UID/g;
664   s/\begid=$parm_exim_gid\b/egid=EXIM_GID/g;
665
666   s/\buid=$parm_exim_uid\b/uid=EXIM_UID/g;
667   s/\bgid=$parm_exim_gid\b/gid=EXIM_GID/g;
668
669   s/^$parm_eximuser $parm_exim_uid $parm_exim_gid/EXIMUSER EXIM_UID EXIM_GID/;
670
671
672   # ======== General uids, gids, and pids ========
673   # Note: this must come after munges for caller's and exim's uid/gid
674
675   # These are for systems where long int is 64
676   s/\buid=4294967295/uid=-1/;
677   s/\beuid=4294967295/euid=-1/;
678   s/\bgid=4294967295/gid=-1/;
679   s/\begid=4294967295/egid=-1/;
680
681   s/\bgid=\d+/gid=gggg/;
682   s/\begid=\d+/egid=gggg/;
683   s/\b(pid=|PID: )\d+/$1pppp/;
684   s/\buid=\d+/uid=uuuu/;
685   s/\beuid=\d+/euid=uuuu/;
686   s/set_process_info:\s+\d+/set_process_info: pppp/;
687   s/queue run pid \d+/queue run pid ppppp/;
688   s/process \d+ running as transport filter/process pppp running as transport filter/;
689   s/process \d+ writing to transport filter/process pppp writing to transport filter/;
690   s/reading pipe for subprocess \d+/reading pipe for subprocess pppp/;
691   s/remote delivery process \d+ ended/remote delivery process pppp ended/;
692
693   # Pid in temp file in appendfile transport
694   s"test-mail/temp\.\d+\."test-mail/temp.pppp.";
695
696   # Optional pid in log lines
697   s/^(\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d)(\.\d{3}|)(\s[+-]\d{4}|)(\s\[\d+\])/
698     "$1$2$3 [" . new_value($4, "%s", \$next_pid) . "]"/gxe;
699
700   # Optional pid in syslog test lines
701   s/^(SYSLOG:\s\'([-0-9]{10}\s[:.0-9]{8,12}\s([-+]\d{4}\s)?|))(\[\d+\] )/
702     "$1\[" . new_value($4, "%s", \$next_pid) . "]"/gxe;
703
704   # Detect a daemon stderr line with a pid and save the pid for subsequent
705   # removal from following lines.
706   $spid = $1 if /^(\s*\d+) (?:listening|LOG: MAIN|(?:daemon_smtp_port|local_interfaces) overridden by)/;
707   s/^$spid //;
708
709   # Queue runner waiting messages
710   s/waiting for children of \d+/waiting for children of pppp/;
711   s/waiting for (\S+) \(\d+\)/waiting for $1 (pppp)/;
712
713   # The spool header file name varies with PID
714   s%^(Writing spool header file: .*/hdr).[0-9]{1,5}%$1.pppp%;
715
716   # ======== Port numbers ========
717   # Incoming port numbers may vary, but not in daemon startup line.
718
719   s/^Port: (\d+)/"Port: " . new_value($1, "%s", \$next_port)/e;
720   s/\(port=(\d+)/"(port=" . new_value($1, "%s", \$next_port)/e;
721
722   # This handles "connection from" and the like, when the port is given
723   if (!/listening for SMTP on/ && !/Connecting to/ && !/=>/ && !/->/
724       && !/\*>/ && !/Connection refused/)
725     {
726     s/\[([a-z\d:]+|\d+(?:\.\d+){3})\]:(\d+)/"[".$1."]:".new_value($2,"%s",\$next_port)/ie;
727     }
728
729   # Port in host address in spool file output from -Mvh
730   s/^-host_address (.*)\.\d+/-host_address $1.9999/;
731
732   if ($dynamic_socket and $dynamic_socket->opened and my $port = $dynamic_socket->sockport) {
733     s/^Connecting to 127\.0\.0\.1 port \K$port/<dynamic port>/;
734   }
735
736
737   # ======== Local IP addresses ========
738   # The amount of space between "host" and the address in verification output
739   # depends on the length of the host name. We therefore reduce it to one space
740   # for all of them.
741   # Also, the length of space at the end of the host line is dependent
742   # on the length of the longest line, so strip it also on otherwise
743   # un-rewritten lines like localhost
744
745   s/^\s+host\s(\S+)\s+(\S+)/  host $1 $2/;
746   s/^\s+(host\s\S+\s\S+)\s+(port=.*)/  host $1 $2/;
747   s/^\s+(host\s\S+\s\S+)\s+(?=MX=)/  $1 /;
748   s/host\s\Q$parm_ipv4\E\s\[\Q$parm_ipv4\E\]/host ipv4.ipv4.ipv4.ipv4 [ipv4.ipv4.ipv4.ipv4]/;
749   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]/;
750   s/\b\Q$parm_ipv4\E\b/ip4.ip4.ip4.ip4/g;
751   s/(^|\W)\K\Q$parm_ipv6\E/ip6:ip6:ip6:ip6:ip6:ip6:ip6:ip6/g;
752   s/\b\Q$parm_ipv4r\E\b/ip4-reverse/g;
753   s/(^|\W)\K\Q$parm_ipv6r\E/ip6-reverse/g;
754   s/^(\s+host\s\S+\s+\[\S+\]) +$/$1 /;
755
756
757   # ======== Test network IP addresses ========
758   s/(\b|_)\Q$parm_ipv4_test_net\E(?=\.\d+\.\d+\.\d+\b|_|\.rbl|\.in-addr|\.test\.again\.dns)/$1V4NET/g;
759   s/\b\Q$parm_ipv6_test_net\E(?=:[\da-f]+:[\da-f]+:[\da-f]+)/V6NET/gi;
760
761
762   # ======== IP error numbers and messages ========
763   # These vary between operating systems
764   s/Can't assign requested address/Network Error/;
765   s/Cannot assign requested address/Network Error/;
766   s/Operation timed out/Connection timed out/;
767   s/Address family not supported by protocol family/Network Error/;
768   s/Network is unreachable/Network Error/;
769   s/Invalid argument/Network Error/;
770
771   s/\(\d+\): Network/(dd): Network/;
772   s/\(\d+\): Connection refused/(dd): Connection refused/;
773   s/\(\d+\): Connection timed out/(dd): Connection timed out/;
774   s/\d+ 65 Connection refused/dd 65 Connection refused/;
775   s/\d+ 321 Connection timed out/dd 321 Connection timed out/;
776
777
778   # ======== Other error numbers ========
779   s/errno=\d+/errno=dd/g;
780
781   # ======== System Error Messages ======
782   # depending on the underlaying file system the error message seems to differ
783   s/(?: is not a regular file)|(?: has too many links \(\d+\))/ not a regular file or too many links/;
784
785   # ======== Output from ls ========
786   # Different operating systems use different spacing on long output
787   #s/ +/ /g if /^[-rwd]{10} /;
788   # (Bug 1226) SUSv3 allows a trailing printable char for modified access method control.
789   # Handle only the Gnu and MacOS space, dot, plus and at-sign.  A full [[:graph:]]
790   # unfortunately matches a non-ls linefull of dashes.
791   # Allow the case where we've already picked out the file protection bits.
792   if (s/^([-d](?:[-r][-w][-SsTtx]){3})[.+@]?( +|$)/$1$2/) {
793     s/ +/ /g;
794   }
795
796
797   # ======== Message sizes =========
798   # Message sizes vary, owing to different logins and host names that get
799   # automatically inserted. I can't think of any way of even approximately
800   # comparing these.
801
802   s/([\s,])S=\d+\b/$1S=sss/;
803   s/:S\d+\b/:Ssss/;
804   s/^(\s*\d+m\s+)\d+(\s+[a-z0-9-]{16} <)/$1sss$2/i if $is_stdout;
805   s/\sSIZE=\d+\b/ SIZE=ssss/;
806   s/\ssize=\d+\b/ size=sss/ if $is_stderr;
807   s/old size = \d+\b/old size = sssss/;
808   s/message size = \d+\b/message size = sss/;
809   s/this message = \d+\b/this message = sss/;
810   s/Size of headers = \d+/Size of headers = sss/;
811   s/sum=(?!0)\d+/sum=dddd/;
812   s/(?<=sum=dddd )count=\d+\b/count=dd/;
813   s/(?<=sum=0 )count=\d+\b/count=dd/;
814   s/,S is \d+\b/,S is ddddd/;
815   s/\+0100,\d+;/+0100,ddd;/;
816   s/\(\d+ bytes written\)/(ddd bytes written)/;
817   s/added '\d+ 1'/added 'ddd 1'/;
818   s/Received\s+\d+/Received               nnn/;
819   s/Delivered\s+\d+/Delivered              nnn/;
820
821
822   # ======== Values in spool space failure message ========
823   s/space=\d+ inodes=[+-]?\d+/space=xxxxx inodes=xxxxx/;
824
825
826   # ======== Filter sizes ========
827   # The sizes of filter files may vary because of the substitution of local
828   # filenames, logins, etc.
829
830   s/^\d+(?= bytes read from )/ssss/;
831
832
833   # ======== OpenSSL error messages ========
834   # Different releases of the OpenSSL libraries seem to give different error
835   # numbers, or handle specific bad conditions in different ways, leading to
836   # different wording in the error messages, so we cannot compare them.
837
838 #XXX This loses any trailing "deliving unencypted to" which is unfortunate
839 #    but I can't work out how to deal with that.
840   s/(TLS session: \(SSL_\w+\): error:)(.*)(?!: delivering)/$1 <<detail omitted>>/;
841   s/(TLS error on connection from .* \(SSL_\w+\): error:)(.*)/$1 <<detail omitted>>/;
842   next if /SSL verify error: depth=0 error=certificate not trusted/;
843
844   # ======== Maildir things ========
845   # timestamp output in maildir processing
846   s/(timestamp=|\(timestamp_only\): )\d+/$1ddddddd/g;
847
848   # maildir delivery files appearing in log lines (in cases of error)
849   s/writing to(?: file)? tmp\/\d+\.[^.]+\.(\S+)/writing to tmp\/MAILDIR.$1/;
850
851   s/renamed tmp\/\d+\.[^.]+\.(\S+) as new\/\d+\.[^.]+\.(\S+)/renamed tmp\/MAILDIR.$1 as new\/MAILDIR.$1/;
852
853   # Maildir file names in general
854   s/\b\d+\.H\d+P\d+\b/dddddddddd.HddddddPddddd/;
855
856   # Maildirsize data
857   while (/^\d+S,\d+C\s*$/)
858     {
859     print MUNGED;
860     while (<IN>)
861       {
862       last if !/^\d+ \d+\s*$/;
863       print MUNGED "ddd d\n";
864       }
865     last if !defined $_;
866     }
867   last if !defined $_;
868
869
870   # ======== Output from the "fd" program about open descriptors ========
871   # The statuses seem to be different on different operating systems, but
872   # at least we'll still be checking the number of open fd's.
873
874   s/max fd = \d+/max fd = dddd/;
875   s/status=0 RDONLY/STATUS/g;
876   s/status=1 WRONLY/STATUS/g;
877   s/status=2 RDWR/STATUS/g;
878
879
880   # ======== Contents of spool files ========
881   # A couple of tests dump the contents of the -H file. The length fields
882   # will be wrong because of different user names, etc.
883   s/^\d\d\d(?=[PFS*])/ddd/;
884
885
886   # ========= Exim lookups ==================
887   # Lookups have a char which depends on the number of lookup types compiled in,
888   # in stderr output.  Replace with a "0".  Recognising this while avoiding
889   # other output is fragile; perhaps the debug output should be revised instead.
890   s%(?<!sqlite)(?<!lsearch\*@)(?<!lsearch\*)(?<!lsearch)[0-?]TESTSUITE/aux-fixed/%0TESTSUITE/aux-fixed/%g;
891
892   # ==========================================================
893   # MIME boundaries in RFC3461 DSN messages
894   s/\d{8,10}-eximdsn-\d+/NNNNNNNNNN-eximdsn-MMMMMMMMMM/;
895
896   # ==========================================================
897   # Some munging is specific to the specific file types
898
899   # ======== stdout ========
900
901   if ($is_stdout)
902     {
903     # Skip translate_ip_address and use_classresources in -bP output because
904     # they aren't always there.
905
906     next if /translate_ip_address =/;
907     next if /use_classresources/;
908
909     # In certain filter tests, remove initial filter lines because they just
910     # clog up by repetition.
911
912     if ($rmfiltertest)
913       {
914       next if /^(Sender\staken\sfrom|
915                  Return-path\scopied\sfrom|
916                  Sender\s+=|
917                  Recipient\s+=)/x;
918       if (/^Testing \S+ filter/)
919         {
920         $_ = <IN>;    # remove blank line
921         next;
922         }
923       }
924
925     # remote IPv6 addrs vary
926     s/^(Connection request from) \[.*:.*:.*\]$/$1 \[ipv6\]/;
927
928     # openssl version variances
929   # Error lines on stdout from SSL contain process id values and file names.
930   # They also contain a source file name and line number, which may vary from
931   # release to release.
932
933     next if /^SSL info:/;
934     next if /SSL verify error: depth=0 error=certificate not trusted/;
935     s/SSL3_READ_BYTES/ssl3_read_bytes/i;
936     s/CONNECT_CR_FINISHED/ssl3_read_bytes/i;
937     s/^\d+:error:\d+(?:E\d+)?(:SSL routines:ssl3_read_bytes:[^:]+:).*(:SSL alert number \d\d)$/pppp:error:dddddddd$1\[...\]$2/;
938
939     # gnutls version variances
940     next if /^Error in the pull function./;
941
942     # optional IDN2 variant conversions.  Accept either IDN1 or IDN2
943     s/conversion  strasse.de/conversion  xn--strae-oqa.de/;
944     s/conversion: german.xn--strae-oqa.de/conversion: german.straße.de/;
945
946     # subsecond timstamp info in reported header-files
947     s/^(-received_time_usec \.)\d{6}$/$1uuuuuu/;
948
949     # Postgres server takes varible time to shut down; lives in various places
950     s/^waiting for server to shut down\.+ done$/waiting for server to shut down.... done/;
951     s/^\/.*postgres /POSTGRES /;
952
953     # ARC is not always supported by the build
954     next if /^arc_sign =/;
955     }
956
957   # ======== stderr ========
958
959   elsif ($is_stderr)
960     {
961     # The very first line of debugging output will vary
962
963     s/^Exim version .*/Exim version x.yz ..../;
964
965     # Debugging lines for Exim terminations and process-generation
966
967     s/(?<=^>>>>>>>>>>>>>>>> Exim pid=)\d+(?= terminating)/pppp/;
968     s/^(proxy-proc \w{5}-pid) \d+$/$1 pppp/;
969
970     # IP address lookups use gethostbyname() when IPv6 is not supported,
971     # and gethostbyname2() or getipnodebyname() when it is.
972
973     s/\b(gethostbyname2?|\bgetipnodebyname)(\(af=inet\))?/get[host|ipnode]byname[2]/;
974
975     # we don't care what TZ enviroment the testhost was running
976     next if /^Reset TZ to/;
977
978     # drop gnutls version strings
979     next if /GnuTLS compile-time version: \d+[\.\d]+$/;
980     next if /GnuTLS runtime version: \d+[\.\d]+$/;
981
982     # drop openssl version strings
983     next if /OpenSSL compile-time version: OpenSSL \d+[\.\da-z]+/;
984     next if /OpenSSL runtime version: OpenSSL \d+[\.\da-z]+/;
985
986     # drop lookups
987     next if /^Lookups \(built-in\):/;
988     next if /^Loading lookup modules from/;
989     next if /^Loaded \d+ lookup modules/;
990     next if /^Total \d+ lookups/;
991
992     # drop compiler information
993     next if /^Compiler:/;
994
995     # and the ugly bit
996     # different libraries will have different numbers (possibly 0) of follow-up
997     # lines, indenting with more data
998     if (/^Library version:/) {
999       while (1) {
1000         $_ = <IN>;
1001         next if /^\s/;
1002         goto RESET_AFTER_EXTRA_LINE_READ;
1003       }
1004     }
1005
1006     # drop other build-time controls emitted for debugging
1007     next if /^WHITELIST_D_MACROS:/;
1008     next if /^TRUSTED_CONFIG_LIST:/;
1009
1010     # As of Exim 4.74, we log when a setgid fails; because we invoke Exim
1011     # with -be, privileges will have been dropped, so this will always
1012     # be the case
1013     next if /^changing group to \d+ failed: (Operation not permitted|Not owner)/;
1014
1015     # We might not keep this check; rather than change all the tests, just
1016     # ignore it as long as it succeeds; then we only need to change the
1017     # TLS tests where tls_require_ciphers has been set.
1018     if (m{^changed uid/gid: calling tls_validate_require_cipher}) {
1019       my $discard = <IN>;
1020       next;
1021     }
1022     next if /^tls_validate_require_cipher child \d+ ended: status=0x0/;
1023
1024     # We invoke Exim with -D, so we hit this new message as of Exim 4.73:
1025     next if /^macros_trusted overridden to true by whitelisting/;
1026
1027     # We have to omit the localhost ::1 address so that all is well in
1028     # the IPv4-only case.
1029
1030     print MUNGED "MUNGED: ::1 will be omitted in what follows\n"
1031       if (/looked up these IP addresses/);
1032     next if /name=localhost address=::1/;
1033
1034     # drop pdkim debugging header
1035     next if /^PDKIM( <<<<<<<<<<<<<<<<<<<<<<<<<<<<<+|: no signatures)$/;
1036
1037     # Various other IPv6 lines must be omitted too
1038
1039     next if /using host_fake_gethostbyname for \S+ \(IPv6\)/;
1040     next if /get\[host\|ipnode\]byname\[2\]\(af=inet6\)/;
1041     next if /DNS lookup of \S+ \(AAAA\) using fakens/;
1042     next if / in dns_ipv4_lookup?/;
1043
1044     if (/DNS lookup of \S+ \(AAAA\) gave NO_DATA/)
1045       {
1046       $_= <IN>;     # Gets "returning DNS_NODATA"
1047       next;
1048       }
1049
1050     # Skip tls_advertise_hosts and hosts_require_tls checks when the options
1051     # are unset, because tls ain't always there.
1052
1053     next if /in\s(?:tls_advertise_hosts\?|hosts_require_tls\?)
1054                 \sno\s\((option\sunset|end\sof\slist)\)/x;
1055
1056     # Skip auxiliary group lists because they will vary.
1057
1058     next if /auxiliary group list:/;
1059
1060     # Skip "extracted from gecos field" because the gecos field varies
1061
1062     next if /extracted from gecos field/;
1063
1064     # Skip "waiting for data on socket" and "read response data: size=" lines
1065     # because some systems pack more stuff into packets than others.
1066
1067     next if /waiting for data on socket/;
1068     next if /read response data: size=/;
1069
1070     # If Exim is compiled with readline support but it can't find the library
1071     # to load, there will be an extra debug line. Omit it.
1072
1073     next if /failed to load readline:/;
1074
1075     # Some DBM libraries seem to make DBM files on opening with O_RDWR without
1076     # O_CREAT; other's don't. In the latter case there is some debugging output
1077     # which is not present in the former. Skip the relevant lines (there are
1078     # three of them).
1079
1080     if (/returned from EXIM_DBOPEN: \(nil\)/)
1081       {
1082       $_ .= <IN>;
1083       s?\Q$parm_cwd\E?TESTSUITE?g;
1084       if (/TESTSUITE\/spool\/db\/\S+ appears not to exist: trying to create/)
1085         { $_ = <IN>; next; }
1086       }
1087
1088     # Some tests turn on +expand debugging to check on expansions.
1089     # Unfortunately, the Received: expansion varies, depending on whether TLS
1090     # is compiled or not. So we must remove the relevant debugging if it is.
1091
1092     if (/^condition: def:tls_cipher/)
1093       {
1094       while (<IN>) { last if /^condition: def:sender_address/; }
1095       }
1096     elsif (/^expanding: Received: /)
1097       {
1098       while (<IN>) { last if !/^\s/; }
1099       }
1100
1101     # remote port numbers vary
1102     s/(Connection request from 127.0.0.1 port) \d{1,5}/$1 sssss/;
1103
1104     # Skip hosts_require_dane checks when the options
1105     # are unset, because dane ain't always there.
1106
1107     next if /in\shosts_require_dane\?\sno\s\(option\sunset\)/x;
1108
1109     # SUPPORT_PROXY
1110     next if /host in hosts_proxy\?/;
1111
1112     # Experimental_International
1113     next if / in smtputf8_advertise_hosts\? no \(option unset\)/;
1114
1115     # Experimental_REQUIRETLS
1116     next if / in tls_advertise_requiretls?\? no \(end of list\)/;
1117
1118     # TCP Fast Open
1119     next if /^setsockopt FASTOPEN: Network Error/;
1120
1121     # Environment cleaning
1122     next if /\w+ in keep_environment\? (yes|no)/;
1123
1124     # Sizes vary with test hostname
1125     s/^cmd buf flush \d+ bytes$/cmd buf flush ddd bytes/;
1126
1127     # Spool filesystem free space changes on different systems.
1128     s/^((?:spool|log) directory space =) -?\d+K (inodes =)\s*-?\d+/$1 nnnnnK $2 nnnnn/;
1129
1130     # Non-TLS builds have different expansions for received_header_text
1131     if (s/(with \$received_protocol)\}\} \$\{if def:tls_cipher \{\(\$tls_cipher\)\n$/$1/)
1132       {
1133       $_ .= <IN>;
1134       s/[\s╎]+\}\}(?=\(Exim )/\}\} /;
1135       }
1136     if (/^ ├──condition: def:tls_cipher$/)
1137       {
1138       <IN>; <IN>; <IN>; <IN>; <IN>; <IN>;
1139       <IN>; <IN>; <IN>; <IN>; <IN>; next;
1140       }
1141
1142     # Not all platforms build with DKIM enabled
1143     next if /^PDKIM >> Body data for hash, canonicalized/;
1144
1145     # Not all platforms have sendfile support
1146     next if /^cannot use sendfile for body: no support$/;
1147
1148     #  Parts of DKIM-specific debug output depend on the time/date
1149     next if /^date:\w+,\{SP\}/;
1150     next if /^PDKIM \[[^[]+\] (Header hash|b) computed:/;
1151
1152     # Not all platforms support TCP Fast Open, and the compile omits the check
1153     if (s/\S+ in hosts_try_fastopen\? no \(option unset\)\n$//)
1154       {
1155       $_ .= <IN>;
1156       s/ \.\.\. >>> / ... /;
1157       s/Address family not supported by protocol family/Network Error/;
1158       s/Network is unreachable/Network Error/;
1159       }
1160
1161     next if /^(ppppp )?setsockopt FASTOPEN: Protocol not available$/;
1162
1163     # Specific pointer values reported for DB operations change from run to run
1164     s/^(\s*returned from EXIM_DBOPEN: )(0x)?[0-9a-f]+/${1}0xAAAAAAAA/;
1165     s/^(\s*EXIM_DBCLOSE.)(0x)?[0-9a-f]+/${1}0xAAAAAAAA/;
1166
1167     # Platform-dependent output during MySQL startup
1168     next if /PerconaFT file system space/;
1169     next if /^Waiting for MySQL server to answer/;
1170     next if /mysqladmin: CREATE DATABASE failed; .* database exists/;
1171
1172     # Not all builds include DMARC
1173     next if /^DMARC: no (dmarc_tld_file|sender_host_address)$/ ;
1174
1175     # When Exim is checking the size of directories for maildir, it uses
1176     # the check_dir_size() function to scan directories. Of course, the order
1177     # of the files that are obtained using readdir() varies from system to
1178     # system. We therefore buffer up debugging lines from check_dir_size()
1179     # and sort them before outputting them.
1180
1181     if (/^check_dir_size:/ || /^skipping TESTSUITE\/test-mail\//)
1182       {
1183       push @saved, $_;
1184       }
1185     else
1186       {
1187       if (@saved > 0)
1188         {
1189         print MUNGED "MUNGED: the check_dir_size lines have been sorted " .
1190           "to ensure consistency\n";
1191         @saved = sort(@saved);
1192         print MUNGED @saved;
1193         @saved = ();
1194         }
1195
1196       # Skip some lines that Exim puts out at the start of debugging output
1197       # because they will be different in different binaries.
1198
1199       print MUNGED
1200         unless (/^Berkeley DB: / ||
1201                 /^Probably (?:Berkeley DB|ndbm|GDBM)/ ||
1202                 /^Authenticators:/ ||
1203                 /^Lookups:/ ||
1204                 /^Support for:/ ||
1205                 /^Routers:/ ||
1206                 /^Transports:/ ||
1207                 /^Malware:/ ||
1208                 /^log selectors =/ ||
1209                 /^cwd=/ ||
1210                 /^Fixed never_users:/ ||
1211                 /^Configure owner:/ ||
1212                 /^Size of off_t:/
1213                 );
1214
1215
1216       }
1217
1218     next;
1219     }
1220
1221   # ======== log ========
1222
1223   elsif ($is_log)
1224     {
1225     # Berkeley DB version differences
1226     next if / Berkeley DB error: /;
1227
1228     # CHUNKING: exact sizes depend on hostnames in headers
1229     s/(=>.* K C="250- \d)\d+ (byte chunk, total \d)\d+/$1nn $2nn/;
1230
1231     # openssl version variances
1232     s/(TLS error on connection [^:]*: error:)[0-9A-F]{8}(:system library):(?:fopen|func\(4095\)):(No such file or directory)$/$1xxxxxxxx$2:fopen:$3/;
1233     s/(DANE attempt failed.*error:)[0-9A-F]{8}(:SSL routines:)(ssl3_get_server_certificate|tls_process_server_certificate|CONNECT_CR_CERT)(?=:certificate verify failed$)/$1xxxxxxxx$2ssl3_get_server_certificate/;
1234     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./;
1235
1236     # DKIM timestamps
1237     if ( /(DKIM: d=.*) t=([0-9]*) x=([0-9]*) / )
1238       {
1239       my ($prefix, $t_diff) = ($1, $3 - $2);
1240       s/DKIM: d=.* t=[0-9]* x=[0-9]* /${prefix} t=T x=T+${t_diff} /;
1241       }
1242     }
1243
1244   # ======== mail ========
1245
1246   elsif ($is_mail)
1247     {
1248     # DKIM timestamps, and signatures depending thereon
1249     if ( /^(\s+)t=([0-9]*); x=([0-9]*); b=[A-Za-z0-9+\/]+$/ )
1250       {
1251       my ($indent, $t_diff) = ($1, $3 - $2);
1252       s/.*/${indent}t=T; x=T+${t_diff}; b=bbbb;/;
1253       <IN>;
1254       <IN>;
1255       }
1256     }
1257
1258   # ======== All files other than stderr ========
1259
1260   print MUNGED;
1261   }
1262
1263 close(IN);
1264 return $yield;
1265 }
1266
1267
1268
1269
1270 ##################################################
1271 #        Subroutine to interact with caller      #
1272 ##################################################
1273
1274 # Arguments: [0] the prompt string
1275 #            [1] if there is a U in the prompt and $force_update is true
1276 #            [2] if there is a C in the prompt and $force_continue is true
1277 # Returns:   returns the answer
1278
1279 sub interact {
1280   my ($prompt, $have_u, $have_c) = @_;
1281
1282   print $prompt;
1283
1284   if ($have_u) {
1285     print "... update forced\n";
1286     return 'u';
1287   }
1288
1289   if ($have_c) {
1290     print "... continue forced\n";
1291     return 'c';
1292   }
1293
1294   return lc <T>;
1295 }
1296
1297
1298
1299 ##################################################
1300 #    Subroutine to log in force_continue mode    #
1301 ##################################################
1302
1303 # In force_continue mode, we just want a terse output to a statically
1304 # named logfile.  If multiple files in same batch (stdout, stderr, etc)
1305 # all have mismatches, it will log multiple times.
1306 #
1307 # Arguments: [0] the logfile to append to
1308 #            [1] the testno that failed
1309 # Returns:   nothing
1310
1311
1312
1313 sub log_failure {
1314   my ($logfile, $testno, $detail) = @_;
1315
1316   open(my $fh, '>>', $logfile) or return;
1317
1318   print $fh "Test $testno "
1319         . (defined $detail ? "$detail " : '')
1320         . "failed\n";
1321 }
1322
1323 # Computer-readable summary results logfile
1324
1325 sub log_test {
1326   my ($logfile, $testno, $resultchar) = @_;
1327
1328   open(my $fh, '>>', $logfile) or return;
1329   print $fh "$testno $resultchar\n";
1330 }
1331
1332
1333
1334 ##################################################
1335 #    Subroutine to compare one output file       #
1336 ##################################################
1337
1338 # When an Exim server is part of the test, its output is in separate files from
1339 # an Exim client. The server data is concatenated with the client data as part
1340 # of the munging operation.
1341 #
1342 # Arguments:  [0] the name of the main raw output file
1343 #             [1] the name of the server raw output file or undef
1344 #             [2] where to put the munged copy
1345 #             [3] the name of the saved file
1346 #             [4] TRUE if this is a log file whose deliveries must be sorted
1347 #             [5] optionally, a custom munge command
1348 #
1349 # Returns:    0 comparison succeeded
1350 #             1 comparison failed; differences to be ignored
1351 #             2 comparison failed; files may have been updated (=> re-compare)
1352 #
1353 # Does not return if the user replies "Q" to a prompt.
1354
1355 sub check_file{
1356 my($rf,$rsf,$mf,$sf,$sortfile,$extra) = @_;
1357
1358 # If there is no saved file, the raw files must either not exist, or be
1359 # empty. The test ! -s is TRUE if the file does not exist or is empty.
1360
1361 # we check if there is a flavour specific file, but we remember
1362 # the original file name as "generic"
1363 $sf_generic = $sf;
1364 $sf_flavour = "$sf_generic.$flavour";
1365 $sf_current = -e $sf_flavour ? $sf_flavour : $sf_generic;
1366
1367 if (! -e $sf_current)
1368   {
1369   return 0 if (! -s $rf && (! defined $rsf || ! -s $rsf));
1370
1371   print "\n";
1372   print "** $rf is not empty\n" if (-s $rf);
1373   print "** $rsf is not empty\n" if (defined $rsf && -s $rsf);
1374
1375   for (;;)
1376     {
1377     $_ = interact('Continue, Show, or Quit? [Q] ', undef, $force_continue);
1378     tests_exit(1) if /^q?$/;
1379     if (/^c$/ && $force_continue) {
1380       log_failure($log_failed_filename, $testno, $rf);
1381       log_test($log_summary_filename, $testno, 'F') if ($force_continue);
1382     }
1383     return 1 if /^c$/i && $rf !~ /paniclog/ && $rsf !~ /paniclog/;
1384     last if (/^[sc]$/);
1385     }
1386
1387   foreach $f ($rf, $rsf)
1388     {
1389     if (defined $f && -s $f)
1390       {
1391       print "\n";
1392       print "------------ $f -----------\n"
1393         if (defined $rf && -s $rf && defined $rsf && -s $rsf);
1394       system("$more '$f'");
1395       }
1396     }
1397
1398   print "\n";
1399   for (;;)
1400     {
1401     $_ = interact('Continue, Update & retry, Quit? [Q] ', $force_update, $force_continue);
1402     tests_exit(1) if /^q?$/;
1403     if (/^c$/ && $force_continue) {
1404       log_failure($log_failed_filename, $testno, $rf);
1405       log_test($log_summary_filename, $testno, 'F')
1406     }
1407     return 1 if /^c$/i;
1408     last if (/^u$/i);
1409     }
1410   }
1411
1412 #### $_
1413
1414 # Control reaches here if either (a) there is a saved file ($sf), or (b) there
1415 # was a request to create a saved file. First, create the munged file from any
1416 # data that does exist.
1417
1418 open(MUNGED, '>', $mf) || tests_exit(-1, "Failed to open $mf: $!");
1419 my($truncated) = munge($rf, $extra) if -e $rf;
1420
1421 # Append the raw server log, if it is non-empty
1422 if (defined $rsf && -e $rsf)
1423   {
1424   print MUNGED "\n******** SERVER ********\n";
1425   $truncated |= munge($rsf, $extra);
1426   }
1427 close(MUNGED);
1428
1429 # If a saved file exists, do the comparison. There are two awkward cases:
1430 #
1431 # If "*** truncated ***" was found in the new file, it means that a log line
1432 # was overlong, and truncated. The problem is that it may be truncated at
1433 # different points on different systems, because of different user name
1434 # lengths. We reload the file and the saved file, and remove lines from the new
1435 # file that precede "*** truncated ***" until we reach one that matches the
1436 # line that precedes it in the saved file.
1437 #
1438 # If $sortfile is set, we are dealing with a mainlog file where the deliveries
1439 # for an individual message might vary in their order from system to system, as
1440 # a result of parallel deliveries. We load the munged file and sort sequences
1441 # of delivery lines.
1442
1443 if (-e $sf_current)
1444   {
1445   # Deal with truncated text items
1446
1447   if ($truncated)
1448     {
1449     my(@munged, @saved, $i, $j, $k);
1450
1451     open(MUNGED, $mf) || tests_exit(-1, "Failed to open $mf: $!");
1452     @munged = <MUNGED>;
1453     close(MUNGED);
1454     open(SAVED, $sf_current) || tests_exit(-1, "Failed to open $sf_current: $!");
1455     @saved = <SAVED>;
1456     close(SAVED);
1457
1458     $j = 0;
1459     for ($i = 0; $i < @munged; $i++)
1460       {
1461       if ($munged[$i] =~ /\*\*\* truncated \*\*\*/)
1462         {
1463         for (; $j < @saved; $j++)
1464           { last if $saved[$j] =~ /\*\*\* truncated \*\*\*/; }
1465         last if $j >= @saved;     # not found in saved
1466
1467         for ($k = $i - 1; $k >= 0; $k--)
1468           { last if $munged[$k] eq $saved[$j - 1]; }
1469
1470         last if $k <= 0;          # failed to find previous match
1471         splice @munged, $k + 1, $i - $k - 1;
1472         $i = $k + 1;
1473         }
1474       }
1475
1476     open(MUNGED, '>', $mf) || tests_exit(-1, "Failed to open $mf: $!");
1477     for ($i = 0; $i < @munged; $i++)
1478       { print MUNGED $munged[$i]; }
1479     close(MUNGED);
1480     }
1481
1482   # Deal with log sorting
1483
1484   if ($sortfile)
1485     {
1486     my(@munged, $i, $j);
1487
1488     open(MUNGED, $mf) || tests_exit(-1, "Failed to open $mf: $!");
1489     @munged = <MUNGED>;
1490     close(MUNGED);
1491
1492     for ($i = 0; $i < @munged; $i++)
1493       {
1494       if ($munged[$i] =~ /^[-\d]{10}\s[:\d]{8}\s[-A-Za-z\d]{16}\s[-=*]>/)
1495         {
1496         for ($j = $i + 1; $j < @munged; $j++)
1497           {
1498           last if $munged[$j] !~
1499             /^[-\d]{10}\s[:\d]{8}\s[-A-Za-z\d]{16}\s[-=*]>/;
1500           }
1501         @temp = splice(@munged, $i, $j - $i);
1502         @temp = sort(@temp);
1503         splice(@munged, $i, 0, @temp);
1504         }
1505       }
1506
1507     open(MUNGED, ">$mf") || tests_exit(-1, "Failed to open $mf: $!");
1508     print MUNGED "**NOTE: The delivery lines in this file have been sorted.\n";
1509     for ($i = 0; $i < @munged; $i++)
1510       { print MUNGED $munged[$i]; }
1511     close(MUNGED);
1512     }
1513
1514   # Do the comparison
1515
1516   return 0 if (system("$cf '$mf' '$sf_current' >test-cf") == 0);
1517
1518   # Handle comparison failure
1519
1520   print "** Comparison of $mf with $sf_current failed";
1521   system("$more test-cf");
1522
1523   print "\n";
1524   for (;;)
1525     {
1526     $_ = interact('Continue, Retry, Update current'
1527         . ($sf_current ne $sf_flavour  ? "/Save for flavour '$flavour'" : '')
1528         . ' & retry, Quit? [Q] ', $force_update, $force_continue);
1529     tests_exit(1) if /^q?$/;
1530     if (/^c$/ && $force_continue) {
1531       log_failure($log_failed_filename, $testno, $sf_current);
1532       log_test($log_summary_filename, $testno, 'F')
1533     }
1534     return 1 if /^c$/i;
1535     return 2 if /^r$/i;
1536     last if (/^[us]$/i);
1537     }
1538   }
1539
1540 # Update or delete the saved file, and give the appropriate return code.
1541
1542 if (-s $mf)
1543   {
1544     my $sf = /^u/i ? $sf_current : $sf_flavour;
1545     tests_exit(-1, "Failed to cp $mf $sf") if system("cp '$mf' '$sf'") != 0;
1546   }
1547 else
1548   {
1549     # if we deal with a flavour file, we can't delete it, because next time the generic
1550     # file would be used again
1551     if ($sf_current eq $sf_flavour) {
1552       open(FOO, ">$sf_current");
1553       close(FOO);
1554     }
1555     else {
1556       tests_exit(-1, "Failed to unlink $sf_current") if !unlink($sf_current);
1557     }
1558   }
1559
1560 return 2;
1561 }
1562
1563
1564
1565 ##################################################
1566 # Custom munges
1567 # keyed by name of munge; value is a ref to a hash
1568 # which is keyed by file, value a string to look for.
1569 # Usable files are:
1570 #  paniclog, rejectlog, mainlog, stdout, stderr, msglog, mail
1571 # Search strings starting with 's' do substitutions;
1572 # with '/' do line-skips.
1573 # Triggered by a scriptfile line "munge <name>"
1574 ##################################################
1575 $munges =
1576   { 'dnssec' =>
1577     { 'stderr' => '/^Reverse DNS security status: unverified\n/' },
1578
1579     'gnutls_unexpected' =>
1580     { 'mainlog' => '/\(recv\): A TLS packet with unexpected length was received./' },
1581
1582     'gnutls_handshake' =>
1583     { 'mainlog' => 's/\(gnutls_handshake\): Error in the push function/\(gnutls_handshake\): A TLS packet with unexpected length was received/' },
1584
1585     'gnutls_bad_clientcert' =>
1586     { 'mainlog' => 's/\(certificate verification failed\): certificate invalid/\(gnutls_handshake\): The peer did not send any certificate./',
1587       'stdout'  => 's/Succeeded in starting TLS/A TLS fatal alert has been received.\nFailed to start TLS'
1588     },
1589
1590     'optional_events' =>
1591     { 'stdout' => '/event_action =/' },
1592
1593     'optional_ocsp' =>
1594     { 'stderr' => '/127.0.0.1 in hosts_requ(ire|est)_ocsp/' },
1595
1596     'optional_cert_hostnames' =>
1597     { 'stderr' => '/in tls_verify_cert_hostnames\? no/' },
1598
1599     'loopback' =>
1600     { 'stdout' => 's/[[](127\.0\.0\.1|::1)]/[IP_LOOPBACK_ADDR]/' },
1601
1602     'scanfile_size' =>
1603     { 'stdout' => 's/(Content-length:) \d\d\d/$1 ddd/' },
1604
1605     'delay_1500' =>
1606     { 'stderr' => 's/(1[5-9]|23\d)\d\d msec/ssss msec/' },
1607
1608     'tls_anycipher' =>
1609     { 'mainlog'   => 's! X=TLS\S+ ! X=TLS_proto_and_cipher !;
1610                       s! DN="C=! DN="/C=!;
1611                       s! DN="[^,"]*\K,!/!;
1612                       s! DN="[^,"]*\K,!/!;
1613                       s! DN="[^,"]*\K,!/!;
1614                      ',
1615       'rejectlog' => 's/ X=TLS\S+ / X=TLS_proto_and_cipher /',
1616       'mail'      => 's/ \(TLS[^)]*\)/ (TLS_proto_and_cipher)/',
1617     },
1618
1619     'debug_pid' =>
1620     { 'stderr' => 's/(^\s{0,4}|(?<=Process )|(?<=child ))\d{1,5}/ppppp/g' },
1621
1622     'optional_dsn_info' =>
1623     { 'mail' => '/^(X-(Remote-MTA-(smtp-greeting|helo-response)|Exim-Diagnostic|(body|message)-linecount):|Remote-MTA: X-ip;)/'
1624     },
1625
1626     'optional_config' =>
1627     { 'stdout' => '/^(
1628                   dkim_(canon|domain|private_key|selector|sign_headers|strict|hash|identity|timestamps)
1629                   |gnutls_require_(kx|mac|protocols)
1630                   |hosts_(requ(est|ire)|try)_(dane|ocsp)
1631                   |dane_require_tls_ciphers
1632                   |hosts_(avoid|nopass|noproxy|require|verify_avoid)_tls
1633                   |socks_proxy
1634                   |tls_[^ ]*
1635                   |utf8_downconvert
1636                   )($|[ ]=)/x'
1637     },
1638
1639     'sys_bindir' =>
1640     { 'mainlog' => 's%/(usr/(local/)?)?bin/%SYSBINDIR/%' },
1641
1642     'sync_check_data' =>
1643     { 'mainlog'   => 's/^(.* SMTP protocol synchronization error .* next input=.{8}).*$/$1<suppressed>/',
1644       'rejectlog' => 's/^(.* SMTP protocol synchronization error .* next input=.{8}).*$/$1<suppressed>/'},
1645
1646     'debuglog_stdout' =>
1647     { 'stdout' => 's/^\d\d:\d\d:\d\d\s+\d+ //;
1648                   s/Process \d+ is ready for new message/Process pppp is ready for new message/'
1649     },
1650
1651     'timeout_errno' =>          # actual errno differs Solaris vs. Linux
1652     { 'mainlog' => 's/(host deferral .* errno) <\d+> /$1 <EEE> /' },
1653
1654     'peer_terminated_conn' =>   # actual error differs FreedBSD vs. Linux
1655     { 'stderr' => 's/^(  SMTP\()Connection reset by peer(\)<<)$/$1closed$2/' },
1656
1657     'perl_variants' =>          # result of hash-in-scalar-context changed from bucket-fill to keycount
1658     { 'stdout' => 's%^> X/X$%> X%' },
1659   };
1660
1661
1662 sub max {
1663   my ($a, $b) = @_;
1664   return $a if ($a > $b);
1665   return $b;
1666 }
1667
1668 ##################################################
1669 #    Subroutine to check the output of a test    #
1670 ##################################################
1671
1672 # This function is called when the series of subtests is complete. It makes
1673 # use of check_file(), whose arguments are:
1674 #
1675 #  [0] the name of the main raw output file
1676 #  [1] the name of the server raw output file or undef
1677 #  [2] where to put the munged copy
1678 #  [3] the name of the saved file
1679 #  [4] TRUE if this is a log file whose deliveries must be sorted
1680 #  [5] an optional custom munge command
1681 #
1682 # Arguments: Optionally, name of a single custom munge to run.
1683 # Returns:   0 if the output compared equal
1684 #            1 if comparison failed; differences to be ignored
1685 #            2 if re-run needed (files may have been updated)
1686
1687 sub check_output{
1688 my($mungename) = $_[0];
1689 my($yield) = 0;
1690 my($munge) = $munges->{$mungename} if defined $mungename;
1691
1692 $yield = max($yield,  check_file("spool/log/paniclog",
1693                        "spool/log/serverpaniclog",
1694                        "test-paniclog-munged",
1695                        "paniclog/$testno", 0,
1696                        $munge->{paniclog}));
1697
1698 $yield = max($yield,  check_file("spool/log/rejectlog",
1699                        "spool/log/serverrejectlog",
1700                        "test-rejectlog-munged",
1701                        "rejectlog/$testno", 0,
1702                        $munge->{rejectlog}));
1703
1704 $yield = max($yield,  check_file("spool/log/mainlog",
1705                        "spool/log/servermainlog",
1706                        "test-mainlog-munged",
1707                        "log/$testno", $sortlog,
1708                        $munge->{mainlog}));
1709
1710 if (!$stdout_skip)
1711   {
1712   $yield = max($yield,  check_file("test-stdout",
1713                        "test-stdout-server",
1714                        "test-stdout-munged",
1715                        "stdout/$testno", 0,
1716                        $munge->{stdout}));
1717   }
1718
1719 if (!$stderr_skip)
1720   {
1721   $yield = max($yield,  check_file("test-stderr",
1722                        "test-stderr-server",
1723                        "test-stderr-munged",
1724                        "stderr/$testno", 0,
1725                        $munge->{stderr}));
1726   }
1727
1728 # Compare any delivered messages, unless this test is skipped.
1729
1730 if (! $message_skip)
1731   {
1732   my($msgno) = 0;
1733
1734   # Get a list of expected mailbox files for this script. We don't bother with
1735   # directories, just the files within them.
1736
1737   foreach $oldmail (@oldmails)
1738     {
1739     next unless $oldmail =~ /^mail\/$testno\./;
1740     print ">> EXPECT $oldmail\n" if $debug;
1741     $expected_mails{$oldmail} = 1;
1742     }
1743
1744   # If there are any files in test-mail, compare them. Note that "." and
1745   # ".." are automatically omitted by list_files_below().
1746
1747   @mails = list_files_below("test-mail");
1748
1749   foreach $mail (@mails)
1750     {
1751     next if $mail eq "test-mail/oncelog";
1752
1753     $saved_mail = substr($mail, 10);               # Remove "test-mail/"
1754     $saved_mail =~ s/^$parm_caller(\/|$)/CALLER/;  # Convert caller name
1755
1756     if ($saved_mail =~ /(\d+\.[^.]+\.)/)
1757       {
1758       $msgno++;
1759       $saved_mail =~ s/(\d+\.[^.]+\.)/$msgno./gx;
1760       }
1761
1762     print ">> COMPARE $mail mail/$testno.$saved_mail\n" if $debug;
1763     $yield = max($yield,  check_file($mail, undef, "test-mail-munged",
1764       "mail/$testno.$saved_mail", 0,
1765       $munge->{mail}));
1766     delete $expected_mails{"mail/$testno.$saved_mail"};
1767     }
1768
1769   # Complain if not all expected mails have been found
1770
1771   if (scalar(keys %expected_mails) != 0)
1772     {
1773     foreach $key (keys %expected_mails)
1774       { print "** no test file found for $key\n"; }
1775
1776     for (;;)
1777       {
1778       $_ = interact('Continue, Update & retry, or Quit? [Q] ', $force_update, $force_continue);
1779       tests_exit(1) if /^q?$/;
1780       if (/^c$/ && $force_continue) {
1781         log_failure($log_failed_filename, $testno, "missing email");
1782         log_test($log_summary_filename, $testno, 'F')
1783       }
1784       last if /^c$/;
1785
1786       # For update, we not only have to unlink the file, but we must also
1787       # remove it from the @oldmails vector, as otherwise it will still be
1788       # checked for when we re-run the test.
1789
1790       if (/^u$/)
1791         {
1792         foreach $key (keys %expected_mails)
1793           {
1794           my($i);
1795           tests_exit(-1, "Failed to unlink $key") if !unlink("$key");
1796           for ($i = 0; $i < @oldmails; $i++)
1797             {
1798             if ($oldmails[$i] eq $key)
1799               {
1800               splice @oldmails, $i, 1;
1801               last;
1802               }
1803             }
1804           }
1805         last;
1806         }
1807       }
1808     }
1809   }
1810
1811 # Compare any remaining message logs, unless this test is skipped.
1812
1813 if (! $msglog_skip)
1814   {
1815   # Get a list of expected msglog files for this test
1816
1817   foreach $oldmsglog (@oldmsglogs)
1818     {
1819     next unless $oldmsglog =~ /^$testno\./;
1820     $expected_msglogs{$oldmsglog} = 1;
1821     }
1822
1823   # If there are any files in spool/msglog, compare them. However, we have
1824   # to munge the file names because they are message ids, which are
1825   # time dependent.
1826
1827   if (opendir(DIR, "spool/msglog"))
1828     {
1829     @msglogs = sort readdir(DIR);
1830     closedir(DIR);
1831
1832     foreach $msglog (@msglogs)
1833       {
1834       next if ($msglog eq "." || $msglog eq ".." || $msglog eq "CVS");
1835       ($munged_msglog = $msglog) =~
1836         s/((?:[^\W_]{6}-){2}[^\W_]{2})
1837           /new_value($1, "10Hm%s-0005vi-00", \$next_msgid)/egx;
1838       $yield = max($yield,  check_file("spool/msglog/$msglog", undef,
1839         "test-msglog-munged", "msglog/$testno.$munged_msglog", 0,
1840         $munge->{msglog}));
1841       delete $expected_msglogs{"$testno.$munged_msglog"};
1842       }
1843     }
1844
1845   # Complain if not all expected msglogs have been found
1846
1847   if (scalar(keys %expected_msglogs) != 0)
1848     {
1849     foreach $key (keys %expected_msglogs)
1850       {
1851       print "** no test msglog found for msglog/$key\n";
1852       ($msgid) = $key =~ /^\d+\.(.*)$/;
1853       foreach $cachekey (keys %cache)
1854         {
1855         if ($cache{$cachekey} eq $msgid)
1856           {
1857           print "** original msgid $cachekey\n";
1858           last;
1859           }
1860         }
1861       }
1862
1863     for (;;)
1864       {
1865       $_ = interact('Continue, Update, or Quit? [Q] ', $force_update, $force_continue);
1866       tests_exit(1) if /^q?$/;
1867       if (/^c$/ && $force_continue) {
1868         log_failure($log_failed_filename, $testno, "missing msglog");
1869         log_test($log_summary_filename, $testno, 'F')
1870       }
1871       last if /^c$/;
1872       if (/^u$/)
1873         {
1874         foreach $key (keys %expected_msglogs)
1875           {
1876           tests_exit(-1, "Failed to unlink msglog/$key")
1877             if !unlink("msglog/$key");
1878           }
1879         last;
1880         }
1881       }
1882     }
1883   }
1884
1885 return $yield;
1886 }
1887
1888
1889
1890 ##################################################
1891 #     Subroutine to run one "system" command     #
1892 ##################################################
1893
1894 # We put this in a subroutine so that the command can be reflected when
1895 # debugging.
1896 #
1897 # Argument: the command to be run
1898 # Returns:  nothing
1899
1900 sub run_system {
1901 my($cmd) = $_[0];
1902 if ($debug)
1903   {
1904   my($prcmd) = $cmd;
1905   $prcmd =~ s/; /;\n>> /;
1906   print ">> $prcmd\n";
1907   }
1908 system("$cmd");
1909 }
1910
1911
1912
1913 ##################################################
1914 #      Subroutine to run one script command      #
1915 ##################################################
1916
1917 # The <SCRIPT> file is open for us to read an optional return code line,
1918 # followed by the command line and any following data lines for stdin. The
1919 # command line can be continued by the use of \. Data lines are not continued
1920 # in this way. In all lines, the following substitutions are made:
1921 #
1922 # DIR    => the current directory
1923 # CALLER => the caller of this script
1924 #
1925 # Arguments: the current test number
1926 #            reference to the subtest number, holding previous value
1927 #            reference to the expected return code value
1928 #            reference to where to put the command name (for messages)
1929 #            auxiliary information returned from a previous run
1930 #
1931 # Returns:   0 the command was executed inline, no subprocess was run
1932 #            1 a non-exim command was run and waited for
1933 #            2 an exim command was run and waited for
1934 #            3 a command was run and not waited for (daemon, server, exim_lock)
1935 #            4 EOF was encountered after an initial return code line
1936 # Optionally also a second parameter, a hash-ref, with auxiliary information:
1937 #            exim_pid: pid of a run process
1938 #            munge: name of a post-script results munger
1939
1940 sub run_command{
1941 my($testno) = $_[0];
1942 my($subtestref) = $_[1];
1943 my($commandnameref) = $_[3];
1944 my($aux_info) = $_[4];
1945 my($yield) = 1;
1946
1947 our %ENV = map { $_ => $ENV{$_} } grep { /^(?:USER|SHELL|PATH|TERM|EXIM_TEST_.*)$/ } keys %ENV;
1948
1949 if (/^(\d+)\s*$/)                # Handle unusual return code
1950   {
1951   my($r) = $_[2];
1952   $$r = $1 << 8;
1953   $_ = <SCRIPT>;
1954   return 4 if !defined $_;       # Missing command
1955   $lineno++;
1956   }
1957
1958 chomp;
1959 $wait_time = 0;
1960
1961 # Handle concatenated command lines
1962
1963 s/\s+$//;
1964 while (substr($_, -1) eq"\\")
1965   {
1966   my($temp);
1967   $_ = substr($_, 0, -1);
1968   chomp($temp = <SCRIPT>);
1969   if (defined $temp)
1970     {
1971     $lineno++;
1972     $temp =~ s/\s+$//;
1973     $temp =~ s/^\s+//;
1974     $_ .= $temp;
1975     }
1976   }
1977
1978 # Do substitutions
1979
1980 do_substitute($testno);
1981 if ($debug) { printf ">> $_\n"; }
1982
1983 # Pass back the command name (for messages)
1984
1985 ($$commandnameref) = /^(\S+)/;
1986
1987 # Here follows code for handling the various different commands that are
1988 # supported by this script. The first group of commands are all freestanding
1989 # in that they share no common code and are not followed by any data lines.
1990
1991
1992 ###################
1993 ###################
1994
1995 # The "dbmbuild" command runs exim_dbmbuild. This is used both to test the
1996 # utility and to make DBM files for testing DBM lookups.
1997
1998 if (/^dbmbuild\s+(\S+)\s+(\S+)/)
1999   {
2000   run_system("(./eximdir/exim_dbmbuild $parm_cwd/$1 $parm_cwd/$2;" .
2001          "echo exim_dbmbuild exit code = \$?)" .
2002          ">>test-stdout");
2003   return 1;
2004   }
2005
2006
2007 # The "dump" command runs exim_dumpdb. On different systems, the output for
2008 # some types of dump may appear in a different order because it's just hauled
2009 # out of the DBM file. We can solve this by sorting. Ignore the leading
2010 # date/time, as it will be flattened later during munging.
2011
2012 if (/^dump\s+(\S+)/)
2013   {
2014   my($which) = $1;
2015   my(@temp);
2016   print ">> ./eximdir/exim_dumpdb $parm_cwd/spool $which\n" if $debug;
2017   open(IN, "./eximdir/exim_dumpdb $parm_cwd/spool $which |");
2018   open(OUT, ">>test-stdout");
2019   print OUT "+++++++++++++++++++++++++++\n";
2020
2021   if ($which eq "retry")
2022     {
2023     $/ = "\n  ";
2024     @temp = <IN>;
2025     $/ = "\n";
2026
2027     @temp = sort {
2028                    my($aa) = split(' ', $a);
2029                    my($bb) = split(' ', $b);
2030                    return $aa cmp $bb;
2031                  } @temp;
2032
2033     foreach $item (@temp)
2034       {
2035       $item =~ s/^\s*(.*)\n(.*)\n?\s*$/$1\n$2/m;
2036       print OUT "  $item\n";
2037       }
2038     }
2039   else
2040     {
2041     @temp = <IN>;
2042     if ($which eq "callout")
2043       {
2044       @temp = sort {
2045                    my($aa) = substr $a, 21;
2046                    my($bb) = substr $b, 21;
2047                    return $aa cmp $bb;
2048                    } @temp;
2049       }
2050     print OUT @temp;
2051     }
2052
2053   close(IN);
2054   close(OUT);
2055   return 1;
2056   }
2057
2058
2059 # verbose comments start with ###
2060 if (/^###\s/) {
2061   for my $file (qw(test-stdout test-stderr test-stderr-server test-stdout-server)) {
2062     open my $fh, '>>', $file or die "Can't open >>$file: $!\n";
2063     say {$fh} $_;
2064   }
2065   return 0;
2066 }
2067
2068 # The "echo" command is a way of writing comments to the screen.
2069 if (/^echo\s+(.*)$/)
2070   {
2071   print "$1\n";
2072   return 0;
2073   }
2074
2075
2076 # The "exim_lock" command runs exim_lock in the same manner as "server",
2077 # but it doesn't use any input.
2078
2079 if (/^exim_lock\s+(.*)$/)
2080   {
2081   $cmd = "./eximdir/exim_lock $1 >>test-stdout";
2082   $server_pid = open SERVERCMD, "|$cmd" ||
2083     tests_exit(-1, "Failed to run $cmd\n");
2084
2085   # This gives the process time to get started; otherwise the next
2086   # process may not find it there when it expects it.
2087
2088   select(undef, undef, undef, 0.1);
2089   return 3;
2090   }
2091
2092
2093 # The "exinext" command runs exinext
2094
2095 if (/^exinext\s+(.*)/)
2096   {
2097   run_system("(./eximdir/exinext " .
2098     "-DEXIM_PATH=$parm_cwd/eximdir/exim " .
2099     "-C $parm_cwd/test-config $1;" .
2100     "echo exinext exit code = \$?)" .
2101     ">>test-stdout");
2102   return 1;
2103   }
2104
2105
2106 # The "exigrep" command runs exigrep on the current mainlog
2107
2108 if (/^exigrep\s+(.*)/)
2109   {
2110   run_system("(./eximdir/exigrep " .
2111     "$1 $parm_cwd/spool/log/mainlog;" .
2112     "echo exigrep exit code = \$?)" .
2113     ">>test-stdout");
2114   return 1;
2115   }
2116
2117
2118 # The "eximstats" command runs eximstats on the current mainlog
2119
2120 if (/^eximstats\s+(.*)/)
2121   {
2122   run_system("(./eximdir/eximstats " .
2123     "$1 $parm_cwd/spool/log/mainlog;" .
2124     "echo eximstats exit code = \$?)" .
2125     ">>test-stdout");
2126   return 1;
2127   }
2128
2129
2130 # The "gnutls" command makes a copy of saved GnuTLS parameter data in the
2131 # spool directory, to save Exim from re-creating it each time.
2132
2133 if (/^gnutls/)
2134   {
2135   my $gen_fn = "spool/gnutls-params-$gnutls_dh_bits_normal";
2136   run_system "sudo cp -p aux-fixed/gnutls-params $gen_fn;" .
2137          "sudo chown $parm_eximuser:$parm_eximgroup $gen_fn;" .
2138          "sudo chmod 0400 $gen_fn";
2139   return 1;
2140   }
2141
2142
2143 # The "killdaemon" command should ultimately follow the starting of any Exim
2144 # daemon with the -bd option. We kill with SIGINT rather than SIGTERM to stop
2145 # it outputting "Terminated" to the terminal when not in the background.
2146
2147 if (/^killdaemon/)
2148   {
2149   my $return_extra = {};
2150   if (exists $aux_info->{exim_pid})
2151     {
2152     $pid = $aux_info->{exim_pid};
2153     $return_extra->{exim_pid} = undef;
2154     print ">> killdaemon: recovered pid $pid\n" if $debug;
2155     if ($pid)
2156       {
2157       run_system("sudo /bin/kill -INT $pid");
2158       wait;
2159       }
2160     } else {
2161     $pid = `cat $parm_cwd/spool/exim-daemon.*`;
2162     if ($pid)
2163       {
2164       run_system("sudo /bin/kill -INT $pid");
2165       close DAEMONCMD;                                   # Waits for process
2166       }
2167     }
2168     run_system("sudo /bin/rm -f spool/exim-daemon.*");
2169   return (1, $return_extra);
2170   }
2171
2172
2173 # The "millisleep" command is like "sleep" except that its argument is in
2174 # milliseconds, thus allowing for a subsecond sleep, which is, in fact, all it
2175 # is used for.
2176
2177 elsif (/^millisleep\s+(.*)$/)
2178   {
2179   select(undef, undef, undef, $1/1000);
2180   return 0;
2181   }
2182
2183
2184 # The "munge" command selects one of a hardwired set of test-result modifications
2185 # to be made before result compares are run agains the golden set.  This lets
2186 # us account for test-system dependent things which only affect a few, but known,
2187 # test-cases.
2188 # Currently only the last munge takes effect.
2189
2190 if (/^munge\s+(.*)$/)
2191   {
2192   return (0, { munge => $1 });
2193   }
2194
2195
2196 # The "sleep" command does just that. For sleeps longer than 1 second we
2197 # tell the user what's going on.
2198
2199 if (/^sleep\s+(.*)$/)
2200   {
2201   if ($1 == 1)
2202     {
2203     sleep(1);
2204     }
2205   else
2206     {
2207     printf("  Test %d sleep $1 ", $$subtestref);
2208     for (1..$1)
2209       {
2210       print ".";
2211       sleep(1);
2212       }
2213     printf("\r  Test %d                            $cr", $$subtestref);
2214     }
2215   return 0;
2216   }
2217
2218
2219 # Various Unix management commands are recognized
2220
2221 if (/^(ln|ls|du|mkdir|mkfifo|touch|cp|cat)\s/ ||
2222     /^sudo\s(rmdir|rm|mv|chown|chmod)\s/)
2223   {
2224   run_system("$_ >>test-stdout 2>>test-stderr");
2225   return 1;
2226   }
2227
2228
2229
2230 ###################
2231 ###################
2232
2233 # The next group of commands are also freestanding, but they are all followed
2234 # by data lines.
2235
2236
2237 # The "server" command starts up a script-driven server that runs in parallel
2238 # with the following exim command. Therefore, we want to run a subprocess and
2239 # not yet wait for it to complete. The waiting happens after the next exim
2240 # command, triggered by $server_pid being non-zero. The server sends its output
2241 # to a different file. The variable $server_opts, if not empty, contains
2242 # options to disable IPv4 or IPv6 if necessary.
2243 # This works because "server" swallows its stdin before waiting for a connection.
2244
2245 if (/^server\s+(.*)$/)
2246   {
2247   $pidfile = "$parm_cwd/aux-var/server-daemon.pid";
2248   $cmd = "./bin/server $server_opts -oP $pidfile $1 >>test-stdout-server";
2249   print ">> $cmd\n" if ($debug);
2250   $server_pid = open SERVERCMD, "|$cmd" || tests_exit(-1, "Failed to run $cmd");
2251   SERVERCMD->autoflush(1);
2252   print ">> Server pid is $server_pid\n" if $debug;
2253   while (<SCRIPT>)
2254     {
2255     $lineno++;
2256     last if /^\*{4}\s*$/;
2257     print SERVERCMD;
2258     }
2259   print SERVERCMD "++++\n"; # Send end to server; can't send EOF yet
2260                             # because close() waits for the process.
2261
2262   # Interlock the server startup; otherwise the next
2263   # process may not find it there when it expects it.
2264   while (! stat("$pidfile") ) { select(undef, undef, undef, 0.3); }
2265   return 3;
2266   }
2267
2268
2269 # The "write" command is a way of creating files of specific sizes for
2270 # buffering tests, or containing specific data lines from within the script
2271 # (rather than hold lots of little files). The "catwrite" command does the
2272 # same, but it also copies the lines to test-stdout.
2273
2274 if (/^(cat)?write\s+(\S+)(?:\s+(.*))?\s*$/)
2275   {
2276   my($cat) = defined $1;
2277   @sizes = ();
2278   @sizes = split /\s+/, $3 if defined $3;
2279   open FILE, ">$2" || tests_exit(-1, "Failed to open \"$2\": $!");
2280
2281   if ($cat)
2282     {
2283     open CAT, ">>test-stdout" ||
2284       tests_exit(-1, "Failed to open test-stdout: $!");
2285     print CAT "==========\n";
2286     }
2287
2288   if (scalar @sizes > 0)
2289     {
2290     # Pre-data
2291
2292     while (<SCRIPT>)
2293       {
2294       $lineno++;
2295       last if /^\+{4}\s*$/;
2296       print FILE;
2297       print CAT if $cat;
2298       }
2299
2300     # Sized data
2301
2302     while (scalar @sizes > 0)
2303       {
2304       ($count,$len,$leadin) = (shift @sizes) =~ /(\d+)x(\d+)(?:=(.*))?/;
2305       $leadin = '' if !defined $leadin;
2306       $leadin =~ s/_/ /g;
2307       $len -= length($leadin) + 1;
2308       while ($count-- > 0)
2309         {
2310         print FILE $leadin, "a" x $len, "\n";
2311         print CAT $leadin, "a" x $len, "\n" if $cat;
2312         }
2313       }
2314     }
2315
2316   # Post data, or only data if no sized data
2317
2318   while (<SCRIPT>)
2319     {
2320     $lineno++;
2321     last if /^\*{4}\s*$/;
2322     print FILE;
2323     print CAT if $cat;
2324     }
2325   close FILE;
2326
2327   if ($cat)
2328     {
2329     print CAT "==========\n";
2330     close CAT;
2331     }
2332
2333   return 0;
2334   }
2335
2336
2337 ###################
2338 ###################
2339
2340 # From this point on, script commands are implemented by setting up a shell
2341 # command in the variable $cmd. Shared code to run this command and handle its
2342 # input and output follows.
2343
2344 # The "client", "client-gnutls", and "client-ssl" commands run a script-driven
2345 # program that plays the part of an email client. We also have the availability
2346 # of running Perl for doing one-off special things. Note that all these
2347 # commands expect stdin data to be supplied.
2348
2349 if (/^client/ || /^(sudo\s+)?perl\b/)
2350   {
2351   s"client"./bin/client";
2352   $cmd = "$_ >>test-stdout 2>>test-stderr";
2353   }
2354
2355 # For the "exim" command, replace the text "exim" with the path for the test
2356 # binary, plus -D options to pass over various parameters, and a -C option for
2357 # the testing configuration file. When running in the test harness, Exim does
2358 # not drop privilege when -C and -D options are present. To run the exim
2359 # command as root, we use sudo.
2360
2361 elsif (/^((?i:[A-Z\d_]+=\S+\s+)+)?(\d+)?\s*(sudo(?:\s+-u\s+(\w+))?\s+)?exim(_\S+)?\s+(.*)$/)
2362   {
2363   $args = $6;
2364   my($envset) = (defined $1)? $1      : '';
2365   my($sudo)   = (defined $3)? "sudo " . (defined $4 ? "-u $4 ":'')  : '';
2366   my($special)= (defined $5)? $5      : '';
2367   $wait_time  = (defined $2)? $2      : 0;
2368
2369   # Return 2 rather than 1 afterwards
2370
2371   $yield = 2;
2372
2373   # Update the test number
2374
2375   $$subtestref = $$subtestref + 1;
2376   printf("  Test %d       $cr", $$subtestref);
2377
2378   # Copy the configuration file, making the usual substitutions.
2379
2380   open (IN, "$parm_cwd/confs/$testno") ||
2381     tests_exit(-1, "Couldn't open $parm_cwd/confs/$testno: $!\n");
2382   open (OUT, ">test-config") ||
2383     tests_exit(-1, "Couldn't open test-config: $!\n");
2384   while (<IN>)
2385     {
2386     do_substitute($testno);
2387     print OUT;
2388     }
2389   close(IN);
2390   close(OUT);
2391
2392   # The string $msg1 in args substitutes the message id of the first
2393   # message on the queue, and so on. */
2394
2395   if ($args =~ /\$msg/)
2396     {
2397     my @listcmd  = ("$parm_cwd/eximdir/exim", '-bp',
2398                    "-DEXIM_PATH=$parm_cwd/eximdir/exim",
2399                    -C => "$parm_cwd/test-config");
2400     print ">> Getting queue list from:\n>>    @listcmd\n" if $debug;
2401     # We need the message ids sorted in ascending order.
2402     # Message id is: <timestamp>-<pid>-<fractional-time>. On some systems (*BSD) the
2403     # PIDs are randomized, so sorting just the whole PID doesn't work.
2404     # We do the Schartz' transformation here (sort on
2405     # <timestamp><fractional-time>). Thanks to Kirill Miazine
2406     my @msglist =
2407       map { $_->[1] }                                   # extract the values
2408       sort { $a->[0] cmp $b->[0] }                      # sort by key
2409       map { [join('.' => (split /-/, $_)[0,2]) => $_] } # key (timestamp.fractional-time) => value(message_id)
2410       map { /^\s*\d+[smhdw]\s+\S+\s+(\S+)/ } `@listcmd` or tests_exit(-1, "No output from `exim -bp` (@listcmd)\n");
2411
2412     # Done backwards just in case there are more than 9
2413
2414     for (my $i = @msglist; $i > 0; $i--) { $args =~ s/\$msg$i/$msglist[$i-1]/g; }
2415     if ( $args =~ /\$msg\d/ )
2416       {
2417       tests_exit(-1, "Not enough messages in spool, for test $testno line $lineno\n")
2418         unless $force_continue;
2419       }
2420     }
2421
2422   # If -d is specified in $optargs, remove it from $args; i.e. let
2423   # the command line for runtest override. Then run Exim.
2424
2425   $args =~ s/(?:^|\s)-d\S*// if $optargs =~ /(?:^|\s)-d/;
2426
2427   my $opt_valgrind = $valgrind ? "valgrind --leak-check=yes --suppressions=$parm_cwd/aux-fixed/valgrind.supp " : '';
2428
2429   $cmd = "$envset$sudo$opt_valgrind" .
2430          "$parm_cwd/eximdir/exim$special$optargs " .
2431          "-DEXIM_PATH=$parm_cwd/eximdir/exim$special " .
2432          "-C $parm_cwd/test-config $args " .
2433          ">>test-stdout 2>>test-stderr";
2434   # If the command is starting an Exim daemon, we run it in the same
2435   # way as the "server" command above, that is, we don't want to wait
2436   # for the process to finish. That happens when "killdaemon" is obeyed later
2437   # in the script. We also send the stderr output to test-stderr-server. The
2438   # daemon has its log files put in a different place too (by configuring with
2439   # log_file_path). This requires the  directory to be set up in advance.
2440   #
2441   # There are also times when we want to run a non-daemon version of Exim
2442   # (e.g. a queue runner) with the server configuration. In this case,
2443   # we also define -DNOTDAEMON.
2444
2445   if ($cmd =~ /\s-DSERVER=server\s/ && $cmd !~ /\s-DNOTDAEMON\s/)
2446     {
2447     if ($debug) { printf ">> daemon: $cmd\n"; }
2448     run_system("sudo mkdir spool/log 2>/dev/null");
2449     run_system("sudo chown $parm_eximuser:$parm_eximgroup spool/log");
2450
2451     # Before running the command, convert the -bd option into -bdf so that an
2452     # Exim daemon doesn't double fork. This means that when we wait close
2453     # DAEMONCMD, it waits for the correct process. Also, ensure that the pid
2454     # file is written to the spool directory, in case the Exim binary was
2455     # built with PID_FILE_PATH pointing somewhere else.
2456
2457     if ($cmd =~ /\s-oP\s/)
2458       {
2459       ($pidfile = $cmd) =~ s/^.*-oP ([^ ]+).*$/$1/;
2460       $cmd =~ s!\s-bd\s! -bdf !;
2461       }
2462     else
2463       {
2464       $pidfile = "$parm_cwd/spool/exim-daemon.pid";
2465       $cmd =~ s!\s-bd\s! -bdf -oP $pidfile !;
2466       }
2467     print ">> |${cmd}-server\n" if ($debug);
2468     open DAEMONCMD, "|${cmd}-server" || tests_exit(-1, "Failed to run $cmd");
2469     DAEMONCMD->autoflush(1);
2470     while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; }   # Ignore any input
2471
2472     # Interlock with daemon startup
2473     for (my $count = 0; ! stat("$pidfile") && $count < 30; $count++ )
2474       { select(undef, undef, undef, 0.3); }
2475     return 3;                                     # Don't wait
2476     }
2477   elsif ($cmd =~ /\s-DSERVER=wait:(\d+)\s/)
2478     {
2479
2480     # The port and the $dynamic_socket was already allocated while parsing the
2481     # script file, where -DSERVER=wait:PORT_DYNAMIC was encountered.
2482
2483     my $listen_port = $1;
2484     if ($debug) { printf ">> wait-mode daemon: $cmd\n"; }
2485     run_system("sudo mkdir spool/log 2>/dev/null");
2486     run_system("sudo chown $parm_eximuser:$parm_eximgroup spool/log");
2487
2488     my $pid = fork();
2489     if (not defined $pid) { die "** fork failed: $!\n" }
2490     if (not $pid) {
2491       close(STDIN);
2492       open(STDIN, '<&', $dynamic_socket) or die "** dup sock to stdin failed: $!\n";
2493       close($dynamic_socket);
2494       print "[$$]>> ${cmd}-server\n" if ($debug);
2495       exec "exec ${cmd}-server";
2496       die "Can't exec ${cmd}-server: $!\n";
2497     }
2498     while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; }   # Ignore any input
2499     select(undef, undef, undef, 0.3);             # Let the daemon get going
2500     return (3, { exim_pid => $pid });             # Don't wait
2501     }
2502   }
2503
2504 # The "background" command is run but not waited-for, like exim -DSERVER=server.
2505 # One script line is read and fork-exec'd.  The PID is stored for a later
2506 # killdaemon.
2507
2508 elsif (/^background$/)
2509   {
2510   my $line;
2511 #  $pidfile = "$parm_cwd/aux-var/server-daemon.pid";
2512
2513   $_ = <SCRIPT>; $lineno++;
2514   chomp;
2515   do_substitute($testno);
2516   $line = $_;
2517   if ($debug) { printf ">> daemon: $line >>test-stdout 2>>test-stderr\n"; }
2518
2519   my $pid = fork();
2520   if (not defined $pid) { die "** fork failed: $!\n" }
2521   if (not $pid) {
2522     print "[$$]>> ${line}\n" if ($debug);
2523     close(STDIN);
2524     open(STDIN, "<", "test-stdout");
2525     close(STDOUT);
2526     open(STDOUT, ">>", "test-stdout");
2527     close(STDERR);
2528     open(STDERR, ">>", "test-stderr-server");
2529     exec "exec ${line}";
2530     exit(1);
2531   }
2532
2533 #  open(my $fh, ">", $pidfile) ||
2534 #      tests_exit(-1, "Failed to open $pidfile: $!");
2535 #  printf($fh, "%d\n", $pid);
2536 #  close($fh);
2537
2538   while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; }   # Ignore any input
2539   select(undef, undef, undef, 0.3);             # Let the daemon get going
2540   return (3, { exim_pid => $pid });             # Don't wait
2541   }
2542
2543
2544
2545 # Unknown command
2546
2547 else { tests_exit(-1, "Command unrecognized in line $lineno: $_"); }
2548
2549
2550 # Run the command, with stdin connected to a pipe, and write the stdin data
2551 # to it, with appropriate substitutions. If a line ends with \NONL\, chop off
2552 # the terminating newline (and the \NONL\). If the command contains
2553 # -DSERVER=server add "-server" to the command, where it will adjoin the name
2554 # for the stderr file. See comment above about the use of -DSERVER.
2555
2556 $stderrsuffix = ($cmd =~ /\s-DSERVER=server\s/)? "-server" : '';
2557 print ">> |${cmd}${stderrsuffix}\n" if ($debug);
2558 open CMD, "|${cmd}${stderrsuffix}" || tests_exit(1, "Failed to run $cmd");
2559
2560 CMD->autoflush(1);
2561 while (<SCRIPT>)
2562   {
2563   $lineno++;
2564   last if /^\*{4}\s*$/;
2565   do_substitute($testno);
2566   if (/^(.*)\\NONL\\\s*$/) { print CMD $1; } else { print CMD; }
2567   }
2568
2569 # For timeout tests, wait before closing the pipe; we expect a
2570 # SIGPIPE error in this case.
2571
2572 if ($wait_time > 0)
2573   {
2574   printf("  Test %d sleep $wait_time ", $$subtestref);
2575   while ($wait_time-- > 0)
2576     {
2577     print ".";
2578     sleep(1);
2579     }
2580   printf("\r  Test %d                                       $cr", $$subtestref);
2581   }
2582
2583 $sigpipehappened = 0;
2584 close CMD;                # Waits for command to finish
2585 return $yield;            # Ran command and waited
2586 }
2587
2588
2589
2590
2591 ###############################################################################
2592 ###############################################################################
2593
2594 # Here begins the Main Program ...
2595
2596 ###############################################################################
2597 ###############################################################################
2598
2599
2600 autoflush STDOUT 1;
2601 print "Exim tester $testversion\n";
2602
2603 # extend the PATH with .../sbin
2604 # we map all (.../bin) to (.../sbin:.../bin)
2605 $ENV{PATH} = do {
2606   my %seen = map { $_, 1 } split /:/, $ENV{PATH};
2607   join ':' => map { m{(.*)/bin$}
2608                 ? ( $seen{"$1/sbin"} ? () : ("$1/sbin"), $_)
2609                 : ($_) }
2610       split /:/, $ENV{PATH};
2611 };
2612
2613 ##################################################
2614 #      Some tests check created file modes       #
2615 ##################################################
2616
2617 umask 022;
2618
2619
2620 ##################################################
2621 #       Check for the "less" command             #
2622 ##################################################
2623
2624 $more = 'more' if system('which less >/dev/null 2>&1') != 0;
2625
2626
2627
2628 ##################################################
2629 #      See if an Exim binary has been given      #
2630 ##################################################
2631
2632 # If the first character of the first argument is '/', the argument is taken
2633 # as the path to the binary. If the first argument does not start with a
2634 # '/' but exists in the file system, it's assumed to be the Exim binary.
2635
2636
2637 ##################################################
2638 # Sort out options and which tests are to be run #
2639 ##################################################
2640
2641 # There are a few possible options for the test script itself; after these, any
2642 # options are passed on to Exim calls within the tests. Typically, this is used
2643 # to turn on Exim debugging while setting up a test.
2644
2645 Getopt::Long::Configure qw(no_getopt_compat);
2646 GetOptions(
2647     'debug'    => sub { $debug          = 1; $cr   = "\n" },
2648     'diff'     => sub { $cf             = 'diff -u' },
2649     'continue' => sub { $force_continue = 1; $more = 'cat' },
2650     'update'   => \$force_update,
2651     'ipv4!'    => \$have_ipv4,
2652     'ipv6!'    => \$have_ipv6,
2653     'keep'     => \$save_output,
2654     'slow'     => \$slow,
2655     'valgrind' => \$valgrind,
2656     'range=s{2}'       => \my @range_wanted,
2657     'test=i@'          => \my @tests_wanted,
2658     'flavor|flavour=s' => $flavour,
2659     'help'             => sub { pod2usage(-exit => 0) },
2660     'man'              => sub {
2661         pod2usage(
2662             -exit      => 0,
2663             -verbose   => 2,
2664             -noperldoc => system('perldoc -V 2>/dev/null 1>&2')
2665         );
2666     },
2667 ) or pod2usage;
2668
2669 ($parm_exim, @ARGV) = Exim::Runtest::exim_binary(@ARGV);
2670 print "Exim binary is `$parm_exim'\n" if defined $parm_exim;
2671
2672
2673 my @wanted = sort numerically uniq
2674   @tests_wanted ? @tests_wanted : (),
2675   @range_wanted ? $range_wanted[0] .. $range_wanted[1] : (),
2676   @ARGV ? @ARGV == 1 ? $ARGV[0] :
2677           $ARGV[1] eq '+' ? $ARGV[0]..($ARGV[0] >= 9000 ? TEST_SPECIAL_TOP : TEST_TOP) :
2678           0+$ARGV[0]..0+$ARGV[1]    # add 0 to cope with test numbers starting with zero
2679         : ();
2680 @wanted = 1..TEST_TOP if not @wanted;
2681
2682 ##################################################
2683 #        Check for sudo access to root           #
2684 ##################################################
2685
2686 print "You need to have sudo access to root to run these tests. Checking ...\n";
2687 if (system('sudo true >/dev/null') != 0)
2688   {
2689   die "** Test for sudo failed: testing abandoned.\n";
2690   }
2691 else
2692   {
2693   print "Test for sudo OK\n";
2694   }
2695
2696
2697
2698
2699 ##################################################
2700 #      Make the command's directory current      #
2701 ##################################################
2702
2703 # After doing so, we find its absolute path name.
2704
2705 $cwd = $0;
2706 $cwd = '.' if ($cwd !~ s|/[^/]+$||);
2707 chdir($cwd) || die "** Failed to chdir to \"$cwd\": $!\n";
2708 $parm_cwd = Cwd::getcwd();
2709
2710
2711 ##################################################
2712 #     Search for an Exim binary to test          #
2713 ##################################################
2714
2715 # If an Exim binary hasn't been provided, try to find one. We can handle the
2716 # case where exim-testsuite is installed alongside Exim source directories. For
2717 # PH's private convenience, if there's a directory just called "exim4", that
2718 # takes precedence; otherwise exim-snapshot takes precedence over any numbered
2719 # releases.
2720
2721 # If $parm_exim is still empty, ask the caller
2722
2723 if (not $parm_exim)
2724   {
2725   print "** Did not find an Exim binary to test\n";
2726   for ($i = 0; $i < 5; $i++)
2727     {
2728     my($trybin);
2729     print "** Enter pathname for Exim binary: ";
2730     chomp($trybin = <STDIN>);
2731     if (-e $trybin)
2732       {
2733       $parm_exim = $trybin;
2734       last;
2735       }
2736     else
2737       {
2738       print "** $trybin does not exist\n";
2739       }
2740     }
2741   die "** Too many tries\n" if $parm_exim eq '';
2742   }
2743
2744
2745
2746 ##################################################
2747 #          Find what is in the binary            #
2748 ##################################################
2749
2750 # deal with TRUSTED_CONFIG_LIST restrictions
2751 unlink("$parm_cwd/test-config") if -e "$parm_cwd/test-config";
2752 open (IN, "$parm_cwd/confs/0000") ||
2753   tests_exit(-1, "Couldn't open $parm_cwd/confs/0000: $!\n");
2754 open (OUT, ">test-config") ||
2755   tests_exit(-1, "Couldn't open test-config: $!\n");
2756 while (<IN>) { print OUT; }
2757 close(IN);
2758 close(OUT);
2759
2760 print("Probing with config file: $parm_cwd/test-config\n");
2761
2762 my $eximinfo = "$parm_exim -d -C $parm_cwd/test-config -DDIR=$parm_cwd -bP exim_user exim_group";
2763 chomp(my @eximinfo = `$eximinfo 2>&1`);
2764 die "$0: Can't run $eximinfo\n" if $? == -1;
2765
2766 warn 'Got ' . $?>>8 . " from $eximinfo\n" if $?;
2767 foreach (@eximinfo)
2768   {
2769   if (my ($version) = /^Exim version (\S+)/) {
2770     my $git = `git describe --dirty=-XX --match 'exim-4*'`;
2771     if (defined $git and $? == 0) {
2772       chomp $git;
2773       $version =~ s/^\d+\K\./_/;
2774       $git =~ s/^exim-//i;
2775       $git =~ s/.*-\Kg([[:xdigit:]]+(?:-XX)?)/$1/;
2776       print <<___
2777
2778 *** Version mismatch
2779 *** Exim binary: $version
2780 *** Git        : $git
2781
2782 ___
2783         if not $version eq $git;
2784     }
2785   }
2786   $parm_eximuser = $1 if /^exim_user = (.*)$/;
2787   $parm_eximgroup = $1 if /^exim_group = (.*)$/;
2788   $parm_trusted_config_list = $1 if /^TRUSTED_CONFIG_LIST:.*?"(.*?)"$/;
2789   ($parm_configure_owner, $parm_configure_group) = ($1, $2)
2790         if /^Configure owner:\s*(\d+):(\d+)/;
2791   print if /wrong owner/;
2792   }
2793
2794 if (not defined $parm_eximuser) {
2795   die <<XXX, map { "|$_\n" } @eximinfo;
2796 Unable to extract exim_user from binary.
2797 Check if Exim refused to run; if so, consider:
2798   TRUSTED_CONFIG_LIST ALT_CONFIG_PREFIX WHITELIST_D_MACROS
2799 If debug permission denied, are you in the exim group?
2800 Failing to get information from binary.
2801 Output from $eximinfo:
2802 XXX
2803
2804 }
2805
2806 if ($parm_eximuser =~ /^\d+$/) { $parm_exim_uid = $parm_eximuser; }
2807 else { $parm_exim_uid = getpwnam($parm_eximuser); }
2808
2809 if (defined $parm_eximgroup)
2810   {
2811   if ($parm_eximgroup =~ /^\d+$/) { $parm_exim_gid = $parm_eximgroup; }
2812     else { $parm_exim_gid = getgrnam($parm_eximgroup); }
2813   }
2814
2815 # check the permissions on the TRUSTED_CONFIG_LIST
2816 if (defined $parm_trusted_config_list)
2817   {
2818   die "TRUSTED_CONFIG_LIST: $parm_trusted_config_list: $!\n"
2819     if not -f $parm_trusted_config_list;
2820
2821   die "TRUSTED_CONFIG_LIST $parm_trusted_config_list must not be world writable!\n"
2822     if 02 & (stat _)[2];
2823
2824   die sprintf "TRUSTED_CONFIG_LIST: $parm_trusted_config_list %d is group writable, but not owned by group '%s' or '%s'.\n",
2825   (stat _)[1],
2826     scalar(getgrgid 0), scalar(getgrgid $>)
2827     if (020 & (stat _)[2]) and not ((stat _)[5] == $> or (stat _)[5] == 0);
2828
2829   die sprintf "TRUSTED_CONFIG_LIST: $parm_trusted_config_list is not owned by user '%s' or '%s'.\n",
2830   scalar(getpwuid 0), scalar(getpwuid $>)
2831      if (not (-o _ or (stat _)[4] == 0));
2832
2833   open(TCL, $parm_trusted_config_list) or die "Can't open $parm_trusted_config_list: $!\n";
2834   my $test_config = getcwd() . '/test-config';
2835   die "Can't find '$test_config' in TRUSTED_CONFIG_LIST $parm_trusted_config_list."
2836   if not grep { /^\Q$test_config\E$/ } <TCL>;
2837   }
2838 else
2839   {
2840   die "Unable to check the TRUSTED_CONFIG_LIST, seems to be empty?\n";
2841   }
2842
2843 die "CONFIGURE_OWNER ($parm_configure_owner) does not match the user invoking $0 ($>)\n"
2844         if $parm_configure_owner != $>;
2845
2846 die "CONFIGURE_GROUP ($parm_configure_group) does not match the group invoking $0 ($))\n"
2847         if 0020 & (stat "$parm_cwd/test-config")[2]
2848         and $parm_configure_group != $);
2849
2850 die "aux-fixed file is world-writeable; best to strip them all, recursively\n"
2851         if 0020 & (stat "aux-fixed/0037.f-1")[2];
2852
2853
2854 open(EXIMINFO, "$parm_exim -d-all+transport -bV -C $parm_cwd/test-config -DDIR=$parm_cwd |") ||
2855   die "** Cannot run $parm_exim: $!\n";
2856
2857 print "-" x 78, "\n";
2858
2859 while (<EXIMINFO>)
2860   {
2861   my(@temp);
2862
2863   if (/^(Exim|Library) version/) { print; }
2864   if (/Runtime: /) {print; }
2865
2866   elsif (/^Size of off_t: (\d+)/)
2867     {
2868     print;
2869     $have_largefiles = 1 if $1 > 4;
2870     die "** Size of off_t > 32 which seems improbable, not running tests\n"
2871         if ($1 > 32);
2872     }
2873
2874   elsif (/^Support for: (.*)/)
2875     {
2876     print;
2877     @temp = split /(\s+)/, $1;
2878     push(@temp, ' ');
2879     %parm_support = @temp;
2880     }
2881
2882   elsif (/^Lookups \(built-in\): (.*)/)
2883     {
2884     print;
2885     @temp = split /(\s+)/, $1;
2886     push(@temp, ' ');
2887     %parm_lookups = @temp;
2888     }
2889
2890   elsif (/^Authenticators: (.*)/)
2891     {
2892     print;
2893     @temp = split /(\s+)/, $1;
2894     push(@temp, ' ');
2895     %parm_authenticators = @temp;
2896     }
2897
2898   elsif (/^Routers: (.*)/)
2899     {
2900     print;
2901     @temp = split /(\s+)/, $1;
2902     push(@temp, ' ');
2903     %parm_routers = @temp;
2904     }
2905
2906   # Some transports have options, e.g. appendfile/maildir. For those, ensure
2907   # that the basic transport name is set, and then the name with each of the
2908   # options.
2909
2910   elsif (/^Transports: (.*)/)
2911     {
2912     print;
2913     @temp = split /(\s+)/, $1;
2914     my($i,$k);
2915     push(@temp, ' ');
2916     %parm_transports = @temp;
2917     foreach $k (keys %parm_transports)
2918       {
2919       if ($k =~ "/")
2920         {
2921         @temp = split /\//, $k;
2922         $parm_transports{$temp[0]} = " ";
2923         for ($i = 1; $i < @temp; $i++)
2924           { $parm_transports{"$temp[0]/$temp[$i]"} = " "; }
2925         }
2926       }
2927     }
2928
2929   elsif (/^Malware: (.*)/)
2930     {
2931     print;
2932     @temp = split /(\s+)/, $1;
2933     push(@temp, ' ');
2934     %parm_malware = @temp;
2935     }
2936
2937   }
2938 close(EXIMINFO);
2939 print "-" x 78, "\n";
2940
2941 unlink("$parm_cwd/test-config");
2942
2943 ##################################################
2944 #    Check for SpamAssassin and ClamAV           #
2945 ##################################################
2946
2947 # These are crude tests. If they aren't good enough, we'll have to improve
2948 # them, for example by actually passing a message through spamc or clamscan.
2949
2950 if (defined $parm_support{Content_Scanning})
2951   {
2952   my $sock = new FileHandle;
2953
2954   if (system("spamc -h 2>/dev/null >/dev/null") == 0)
2955     {
2956     print "The spamc command works:\n";
2957
2958     # This test for an active SpamAssassin is courtesy of John Jetmore.
2959     # The tests are hard coded to localhost:783, so no point in making
2960     # this test flexible like the clamav test until the test scripts are
2961     # changed.  spamd doesn't have the nice PING/PONG protocol that
2962     # clamd does, but it does respond to errors in an informative manner,
2963     # so use that.
2964
2965     my($sint,$sport) = ('127.0.0.1',783);
2966     eval
2967       {
2968       my $sin = sockaddr_in($sport, inet_aton($sint))
2969           or die "** Failed packing $sint:$sport\n";
2970       socket($sock, PF_INET, SOCK_STREAM, getprotobyname('tcp'))
2971           or die "** Unable to open socket $sint:$sport\n";
2972
2973       local $SIG{ALRM} =
2974           sub { die "** Timeout while connecting to socket $sint:$sport\n"; };
2975       alarm(5);
2976       connect($sock, $sin)
2977           or die "** Unable to connect to socket $sint:$sport\n";
2978       alarm(0);
2979
2980       select((select($sock), $| = 1)[0]);
2981       print $sock "bad command\r\n";
2982
2983       $SIG{ALRM} =
2984           sub { die "** Timeout while reading from socket $sint:$sport\n"; };
2985       alarm(10);
2986       my $res = <$sock>;
2987       alarm(0);
2988
2989       $res =~ m|^SPAMD/|
2990           or die "** Did not get SPAMD from socket $sint:$sport. "
2991                 ."It said: $res\n";
2992       };
2993     alarm(0);
2994     if($@)
2995       {
2996       print "  $@";
2997       print "  Assume SpamAssassin (spamd) is not running\n";
2998       }
2999     else
3000       {
3001       $parm_running{SpamAssassin} = ' ';
3002       print "  SpamAssassin (spamd) seems to be running\n";
3003       }
3004     }
3005   else
3006     {
3007     print "The spamc command failed: assume SpamAssassin (spamd) is not running\n";
3008     }
3009
3010   # For ClamAV, we need to find the clamd socket for use in the Exim
3011   # configuration. Search for the clamd configuration file.
3012
3013   if (system("clamscan -h 2>/dev/null >/dev/null") == 0)
3014     {
3015     my($f, $clamconf, $test_prefix);
3016
3017     print "The clamscan command works";
3018
3019     $test_prefix = $ENV{EXIM_TEST_PREFIX};
3020     $test_prefix = '' if !defined $test_prefix;
3021
3022     foreach $f ("$test_prefix/etc/clamd.conf",
3023                 "$test_prefix/usr/local/etc/clamd.conf",
3024                 "$test_prefix/etc/clamav/clamd.conf", '')
3025       {
3026       if (-e $f)
3027         {
3028         $clamconf = $f;
3029         last;
3030         }
3031       }
3032
3033     # Read the ClamAV configuration file and find the socket interface.
3034
3035     if ($clamconf ne '')
3036       {
3037       my $socket_domain;
3038       open(IN, "$clamconf") || die "\n** Unable to open $clamconf: $!\n";
3039       while (<IN>)
3040         {
3041         if (/^LocalSocket\s+(.*)/)
3042           {
3043           $parm_clamsocket = $1;
3044           $socket_domain = AF_UNIX;
3045           last;
3046           }
3047         if (/^TCPSocket\s+(\d+)/)
3048           {
3049           if (defined $parm_clamsocket)
3050             {
3051             $parm_clamsocket .= " $1";
3052             $socket_domain = AF_INET;
3053             last;
3054             }
3055           else
3056             {
3057             $parm_clamsocket = " $1";
3058             }
3059           }
3060         elsif (/^TCPAddr\s+(\S+)/)
3061           {
3062           if (defined $parm_clamsocket)
3063             {
3064             $parm_clamsocket = $1 . $parm_clamsocket;
3065             $socket_domain = AF_INET;
3066             last;
3067             }
3068           else
3069             {
3070             $parm_clamsocket = $1;
3071             }
3072           }
3073         }
3074       close(IN);
3075
3076       if (defined $socket_domain)
3077         {
3078         print ":\n  The clamd socket is $parm_clamsocket\n";
3079         # This test for an active ClamAV is courtesy of Daniel Tiefnig.
3080         eval
3081           {
3082           my $socket;
3083           if ($socket_domain == AF_UNIX)
3084             {
3085             $socket = sockaddr_un($parm_clamsocket) or die "** Failed packing '$parm_clamsocket'\n";
3086             }
3087           elsif ($socket_domain == AF_INET)
3088             {
3089             my ($ca_host, $ca_port) = split(/\s+/,$parm_clamsocket);
3090             my $ca_hostent = gethostbyname($ca_host) or die "** Failed to get raw address for host '$ca_host'\n";
3091             $socket = sockaddr_in($ca_port, $ca_hostent) or die "** Failed packing '$parm_clamsocket'\n";
3092             }
3093           else
3094             {
3095             die "** Unknown socket domain '$socket_domain' (should not happen)\n";
3096             }
3097           socket($sock, $socket_domain, SOCK_STREAM, 0) or die "** Unable to open socket '$parm_clamsocket'\n";
3098           local $SIG{ALRM} = sub { die "** Timeout while connecting to socket '$parm_clamsocket'\n"; };
3099           alarm(5);
3100           connect($sock, $socket) or die "** Unable to connect to socket '$parm_clamsocket'\n";
3101           alarm(0);
3102
3103           my $ofh = select $sock; $| = 1; select $ofh;
3104           print $sock "PING\n";
3105
3106           $SIG{ALRM} = sub { die "** Timeout while reading from socket '$parm_clamsocket'\n"; };
3107           alarm(10);
3108           my $res = <$sock>;
3109           alarm(0);
3110
3111           $res =~ /PONG/ or die "** Did not get PONG from socket '$parm_clamsocket'. It said: $res\n";
3112           };
3113         alarm(0);
3114
3115         if($@)
3116           {
3117           print "  $@";
3118           print "  Assume ClamAV is not running\n";
3119           }
3120         else
3121           {
3122           $parm_running{ClamAV} = ' ';
3123           print "  ClamAV seems to be running\n";
3124           }
3125         }
3126       else
3127         {
3128         print ", but the socket for clamd could not be determined\n";
3129         print "Assume ClamAV is not running\n";
3130         }
3131       }
3132
3133     else
3134       {
3135       print ", but I can't find a configuration for clamd\n";
3136       print "Assume ClamAV is not running\n";
3137       }
3138     }
3139   }
3140
3141
3142 ##################################################
3143 #       Check for redis                          #
3144 ##################################################
3145 if (defined $parm_lookups{redis})
3146   {
3147   if (system("redis-server -v 2>/dev/null >/dev/null") == 0)
3148     {
3149     print "The redis-server command works\n";
3150     $parm_running{redis} = ' ';
3151     }
3152   else
3153     {
3154     print "The redis-server command failed: assume Redis not installed\n";
3155     }
3156   }
3157
3158 ##################################################
3159 #         Test for the basic requirements        #
3160 ##################################################
3161
3162 # This test suite assumes that Exim has been built with at least the "usual"
3163 # set of routers, transports, and lookups. Ensure that this is so.
3164
3165 $missing = '';
3166
3167 $missing .= "     Lookup: lsearch\n" if (!defined $parm_lookups{lsearch});
3168
3169 $missing .= "     Router: accept\n" if (!defined $parm_routers{accept});
3170 $missing .= "     Router: dnslookup\n" if (!defined $parm_routers{dnslookup});
3171 $missing .= "     Router: manualroute\n" if (!defined $parm_routers{manualroute});
3172 $missing .= "     Router: redirect\n" if (!defined $parm_routers{redirect});
3173
3174 $missing .= "     Transport: appendfile\n" if (!defined $parm_transports{appendfile});
3175 $missing .= "     Transport: autoreply\n" if (!defined $parm_transports{autoreply});
3176 $missing .= "     Transport: pipe\n" if (!defined $parm_transports{pipe});
3177 $missing .= "     Transport: smtp\n" if (!defined $parm_transports{smtp});
3178
3179 if ($missing ne '')
3180   {
3181   print "\n";
3182   print "** Many features can be included or excluded from Exim binaries.\n";
3183   print "** This test suite requires that Exim is built to contain a certain\n";
3184   print "** set of basic facilities. It seems that some of these are missing\n";
3185   print "** from the binary that is under test, so the test cannot proceed.\n";
3186   print "** The missing facilities are:\n";
3187   print "$missing";
3188   die "** Test script abandoned\n";
3189   }
3190
3191
3192 ##################################################
3193 #      Check for the auxiliary programs          #
3194 ##################################################
3195
3196 # These are always required:
3197
3198 for $prog ("cf", "checkaccess", "client", "client-ssl", "client-gnutls",
3199            "fakens", "iefbr14", "server")
3200   {
3201   next if ($prog eq "client-ssl" && !defined $parm_support{OpenSSL});
3202   next if ($prog eq "client-gnutls" && !defined $parm_support{GnuTLS});
3203   if (!-e "bin/$prog")
3204     {
3205     print "\n";
3206     print "** bin/$prog does not exist. Have you run ./configure and make?\n";
3207     die "** Test script abandoned\n";
3208     }
3209   }
3210
3211 # If the "loaded" binary is missing, we cut out tests for ${dlfunc. It isn't
3212 # compiled on systems where we don't know how to. However, if Exim does not
3213 # have that functionality compiled, we needn't bother.
3214
3215 $dlfunc_deleted = 0;
3216 if (defined $parm_support{Expand_dlfunc} && !-e 'bin/loaded')
3217   {
3218   delete $parm_support{Expand_dlfunc};
3219   $dlfunc_deleted = 1;
3220   }
3221
3222
3223 ##################################################
3224 #          Find environmental details            #
3225 ##################################################
3226
3227 # Find the caller of this program.
3228
3229 ($parm_caller,$pwpw,$parm_caller_uid,$parm_caller_gid,$pwquota,$pwcomm,
3230  $parm_caller_gecos, $parm_caller_home) = getpwuid($>);
3231
3232 $pwpw = $pwpw;       # Kill Perl warnings
3233 $pwquota = $pwquota;
3234 $pwcomm = $pwcomm;
3235
3236 $parm_caller_group = getgrgid($parm_caller_gid);
3237
3238 print "Program caller is $parm_caller ($parm_caller_uid), whose group is $parm_caller_group ($parm_caller_gid)\n";
3239 print "Home directory is $parm_caller_home\n";
3240
3241 unless (defined $parm_eximgroup)
3242   {
3243   print "Unable to derive \$parm_eximgroup.\n";
3244   die "** ABANDONING.\n";
3245   }
3246
3247 if ($parm_caller_home eq $parm_cwd)
3248   {
3249   print "will confuse working dir with homedir; change homedir\n";
3250   die "** ABANDONING.\n";
3251   }
3252
3253 print "You need to be in the Exim group to run these tests. Checking ...";
3254
3255 if (`groups` =~ /\b\Q$parm_eximgroup\E\b/)
3256   {
3257   print " OK\n";
3258   }
3259 else
3260   {
3261   print "\nOh dear, you are not in the Exim group.\n";
3262   die "** Testing abandoned.\n";
3263   }
3264
3265 # Find this host's IP addresses - there may be many, of course, but we keep
3266 # one of each type (IPv4 and IPv6).
3267
3268 open(IFCONFIG, '-|', (grep { -x "$_/ip" } split /:/, $ENV{PATH}) ? 'ip address' : 'ifconfig -a')
3269   or die "** Cannot run 'ip address' or 'ifconfig -a'\n";
3270 while (not ($parm_ipv4 and $parm_ipv6) and defined($_ = <IFCONFIG>))
3271   {
3272   if (not $parm_ipv4 and /^\s*inet(?:\saddr)?:?\s?(\d+\.\d+\.\d+\.\d+)(?:\/\d+)?\s/i)
3273     {
3274     next if $1 =~ /^(?:127|10)\./;
3275     $parm_ipv4 = $1;
3276     }
3277
3278   if (not $parm_ipv6 and /^\s*inet6(?:\saddr)?:?\s?([abcdef\d:]+)(?:\/\d+)/i)
3279     {
3280     next if $1 eq '::1' or $1 =~ /^fe80/i;
3281     $parm_ipv6 = $1;
3282     }
3283   }
3284 close(IFCONFIG);
3285
3286 # Use private IP addresses if there are no public ones.
3287
3288 # If either type of IP address is missing, we need to set the value to
3289 # something other than empty, because that wrecks the substitutions. The value
3290 # is reflected, so use a meaningful string. Set appropriate options for the
3291 # "server" command. In practice, however, many tests assume 127.0.0.1 is
3292 # available, so things will go wrong if there is no IPv4 address. The lack
3293 # of IPV4 or IPv6 can be simulated by command options, which force $have_ipv4
3294 # and $have_ipv6 false.
3295
3296 if (not $parm_ipv4)
3297   {
3298   $have_ipv4 = 0;
3299   $parm_ipv4 = "<no IPv4 address found>";
3300   $server_opts .= " -noipv4";
3301   }
3302 elsif ($have_ipv4 == 0)
3303   {
3304   $parm_ipv4 = "<IPv4 testing disabled>";
3305   $server_opts .= " -noipv4";
3306   }
3307 else
3308   {
3309   $parm_running{IPv4} = " ";
3310   }
3311
3312 if (not $parm_ipv6)
3313   {
3314   $have_ipv6 = 0;
3315   $parm_ipv6 = "<no IPv6 address found>";
3316   $server_opts .= " -noipv6";
3317   delete($parm_support{IPv6});
3318   }
3319 elsif ($have_ipv6 == 0)
3320   {
3321   $parm_ipv6 = "<IPv6 testing disabled>";
3322   $server_opts .= " -noipv6";
3323   delete($parm_support{IPv6});
3324   }
3325 elsif (!defined $parm_support{IPv6})
3326   {
3327   $have_ipv6 = 0;
3328   $parm_ipv6 = "<no IPv6 support in Exim binary>";
3329   $server_opts .= " -noipv6";
3330   }
3331 else
3332   {
3333   $parm_running{IPv6} = " ";
3334   }
3335
3336 print "IPv4 address is $parm_ipv4\n";
3337 print "IPv6 address is $parm_ipv6\n";
3338
3339 # For munging test output, we need the reversed IP addresses.
3340
3341 $parm_ipv4r = ($parm_ipv4 !~ /^\d/)? '' :
3342   join(".", reverse(split /\./, $parm_ipv4));
3343
3344 $parm_ipv6r = $parm_ipv6;             # Appropriate if not in use
3345 if ($parm_ipv6 =~ /^[\da-f]/)
3346   {
3347   my(@comps) = split /:/, $parm_ipv6;
3348   my(@nibbles);
3349   foreach $comp (@comps)
3350     {
3351     push @nibbles, sprintf("%lx", hex($comp) >> 8);
3352     push @nibbles, sprintf("%lx", hex($comp) & 0xff);
3353     }
3354   $parm_ipv6r = join(".", reverse(@nibbles));
3355   }
3356
3357 # Find the host name, fully qualified.
3358
3359 chomp($temp = `hostname`);
3360 die "'hostname' didn't return anything\n" unless defined $temp and length $temp;
3361 if ($temp =~ /\./)
3362   {
3363   $parm_hostname = $temp;
3364   }
3365 else
3366   {
3367   $parm_hostname = (gethostbyname($temp))[0];
3368   $parm_hostname = "no.host.name.found" unless defined $parm_hostname and length $parm_hostname;
3369   }
3370 print "Hostname is $parm_hostname\n";
3371
3372 if ($parm_hostname !~ /\./)
3373   {
3374   print "\n*** Host name is not fully qualified: this may cause problems ***\n\n";
3375   }
3376
3377 if ($parm_hostname =~ /[[:upper:]]/)
3378   {
3379   print "\n*** Host name has upper case characters: this may cause problems ***\n\n";
3380   }
3381
3382
3383
3384 ##################################################
3385 #     Create a testing version of Exim           #
3386 ##################################################
3387
3388 # We want to be able to run Exim with a variety of configurations. Normally,
3389 # the use of -C to change configuration causes Exim to give up its root
3390 # privilege (unless the caller is exim or root). For these tests, we do not
3391 # want this to happen. Also, we want Exim to know that it is running in its
3392 # test harness.
3393
3394 # We achieve this by copying the binary and patching it as we go. The new
3395 # binary knows it is a testing copy, and it allows -C and -D without loss of
3396 # privilege. Clearly, this file is dangerous to have lying around on systems
3397 # where there are general users with login accounts. To protect against this,
3398 # we put the new binary in a special directory that is accessible only to the
3399 # caller of this script, who is known to have sudo root privilege from the test
3400 # that was done above. Furthermore, we ensure that the binary is deleted at the
3401 # end of the test. First ensure the directory exists.
3402
3403 if (-d "eximdir")
3404   { unlink "eximdir/exim"; }     # Just in case
3405 else
3406   {
3407   mkdir("eximdir", 0710) || die "** Unable to mkdir $parm_cwd/eximdir: $!\n";
3408   system("sudo chgrp $parm_eximgroup eximdir");
3409   }
3410
3411 # The construction of the patched binary must be done as root, so we use
3412 # a separate script. As well as indicating that this is a test-harness binary,
3413 # the version number is patched to "x.yz" so that its length is always the
3414 # same. Otherwise, when it appears in Received: headers, it affects the length
3415 # of the message, which breaks certain comparisons.
3416
3417 die "** Unable to make patched exim: $!\n"
3418   if (system("sudo ./patchexim $parm_exim") != 0);
3419
3420 # From this point on, exits from the program must go via the subroutine
3421 # tests_exit(), so that suitable cleaning up can be done when required.
3422 # Arrange to catch interrupting signals, to assist with this.
3423
3424 $SIG{INT} = \&inthandler;
3425 $SIG{PIPE} = \&pipehandler;
3426
3427 # For some tests, we need another copy of the binary that is setuid exim rather
3428 # than root.
3429
3430 system("sudo cp eximdir/exim eximdir/exim_exim;" .
3431        "sudo chown $parm_eximuser eximdir/exim_exim;" .
3432        "sudo chgrp $parm_eximgroup eximdir/exim_exim;" .
3433        "sudo chmod 06755 eximdir/exim_exim");
3434
3435 ##################################################
3436 #     Make copies of utilities we might need     #
3437 ##################################################
3438
3439 # Certain of the tests make use of some of Exim's utilities. We do not need
3440 # to be root to copy these.
3441
3442 ($parm_exim_dir) = $parm_exim =~ m?^(.*)/exim?;
3443
3444 $dbm_build_deleted = 0;
3445 if (defined $parm_lookups{dbm} &&
3446     system("cp $parm_exim_dir/exim_dbmbuild eximdir") != 0)
3447   {
3448   delete $parm_lookups{dbm};
3449   $dbm_build_deleted = 1;
3450   }
3451
3452 if (system("cp $parm_exim_dir/exim_dumpdb eximdir") != 0)
3453   {
3454   tests_exit(-1, "Failed to make a copy of exim_dumpdb: $!");
3455   }
3456
3457 if (system("cp $parm_exim_dir/exim_lock eximdir") != 0)
3458   {
3459   tests_exit(-1, "Failed to make a copy of exim_lock: $!");
3460   }
3461
3462 if (system("cp $parm_exim_dir/exinext eximdir") != 0)
3463   {
3464   tests_exit(-1, "Failed to make a copy of exinext: $!");
3465   }
3466
3467 if (system("cp $parm_exim_dir/exigrep eximdir") != 0)
3468   {
3469   tests_exit(-1, "Failed to make a copy of exigrep: $!");
3470   }
3471
3472 if (system("cp $parm_exim_dir/eximstats eximdir") != 0)
3473   {
3474   tests_exit(-1, "Failed to make a copy of eximstats: $!");
3475   }
3476
3477 # Collect some version information
3478 print '-' x 78, "\n";
3479 print "Perl version for runtest: $]\n";
3480 foreach (map { "./eximdir/$_" } qw(exigrep exinext eximstats)) {
3481   # fold (or unfold?) multiline output into a one-liner
3482   print join(', ', map { chomp; $_ } `$_ --version`), "\n";
3483 }
3484 print '-' x 78, "\n";
3485
3486
3487 ##################################################
3488 #    Check that the Exim user can access stuff   #
3489 ##################################################
3490
3491 # We delay this test till here so that we can check access to the actual test
3492 # binary. This will be needed when Exim re-exec's itself to do deliveries.
3493
3494 print "Exim user is $parm_eximuser ($parm_exim_uid)\n";
3495 print "Exim group is $parm_eximgroup ($parm_exim_gid)\n";
3496
3497 if ($parm_caller_uid eq $parm_exim_uid) {
3498   tests_exit(-1, "Exim user ($parm_eximuser,$parm_exim_uid) cannot be "
3499                 ."the same as caller ($parm_caller,$parm_caller_uid)");
3500 }
3501 if ($parm_caller_gid eq $parm_exim_gid) {
3502   tests_exit(-1, "Exim group ($parm_eximgroup,$parm_exim_gid) cannot be "
3503                 ."the same as caller's ($parm_caller) group as it confuses "
3504                 ."results analysis");
3505 }
3506
3507 print "The Exim user needs access to the test suite directory. Checking ...";
3508
3509 if (($rc = system("sudo bin/checkaccess $parm_cwd/eximdir/exim $parm_eximuser $parm_eximgroup")) != 0)
3510   {
3511   my($why) = "unknown failure $rc";
3512   $rc >>= 8;
3513   $why = "Couldn't find user \"$parm_eximuser\"" if $rc == 1;
3514   $why = "Couldn't find group \"$parm_eximgroup\"" if $rc == 2;
3515   $why = "Couldn't read auxiliary group list" if $rc == 3;
3516   $why = "Couldn't get rid of auxiliary groups" if $rc == 4;
3517   $why = "Couldn't set gid" if $rc == 5;
3518   $why = "Couldn't set uid" if $rc == 6;
3519   $why = "Couldn't open \"$parm_cwd/eximdir/exim\"" if $rc == 7;
3520   print "\n** $why\n";
3521   tests_exit(-1, "$parm_eximuser cannot access the test suite directory");
3522   }
3523 else
3524   {
3525   print " OK\n";
3526   }
3527
3528 tests_exit(-1, "Failed to unlink $log_summary_filename: $!")
3529   if not unlink($log_summary_filename) and -e $log_summary_filename;
3530
3531 ##################################################
3532 #        Create a list of available tests        #
3533 ##################################################
3534
3535 # The scripts directory contains a number of subdirectories whose names are
3536 # of the form 0000-xxxx, 1100-xxxx, 2000-xxxx, etc. Each set of tests apart
3537 # from the first requires certain optional features to be included in the Exim
3538 # binary. These requirements are contained in a file called "REQUIRES" within
3539 # the directory. We scan all these tests, discarding those that cannot be run
3540 # because the current binary does not support the right facilities, and also
3541 # those that are outside the numerical range selected.
3542
3543 printf "\nWill run %d tests between %d and %d for flavour %s\n",
3544   scalar(@wanted), $wanted[0], $wanted[-1], $flavour;
3545
3546 print "Omitting \${dlfunc expansion tests (loadable module not present)\n"
3547   if $dlfunc_deleted;
3548 print "Omitting dbm tests (unable to copy exim_dbmbuild)\n"
3549   if $dbm_build_deleted;
3550
3551
3552 my @test_dirs = grep { not /^CVS$/ } map { basename $_ } glob 'scripts/*'
3553   or die tests_exit(-1, "Failed to find test scripts in 'scripts/*`: $!");
3554
3555 # Scan for relevant tests
3556 # HS12: Needs to be reworked.
3557 DIR: for (my $i = 0; $i < @test_dirs; $i++)
3558   {
3559   my($testdir) = $test_dirs[$i];
3560   my($wantthis) = 1;
3561
3562   print ">>Checking $testdir\n" if $debug;
3563
3564   # Skip this directory if the first test is equal or greater than the first
3565   # test in the next directory.
3566
3567   next DIR if ($i < @test_dirs - 1) &&
3568           ($wanted[0] >= substr($test_dirs[$i+1], 0, 4));
3569
3570   # No need to carry on if the end test is less than the first test in this
3571   # subdirectory.
3572
3573   last DIR if $wanted[-1] < substr($testdir, 0, 4);
3574
3575   # Check requirements, if any.
3576
3577   if (open(my $requires, "scripts/$testdir/REQUIRES"))
3578     {
3579     while (<$requires>)
3580       {
3581       next if /^\s*$/;
3582       s/\s+$//;
3583       if (/^support (.*)$/)
3584         {
3585         if (!defined $parm_support{$1}) { $wantthis = 0; last; }
3586         }
3587       elsif (/^running (.*)$/)
3588         {
3589         if (!defined $parm_running{$1}) { $wantthis = 0; last; }
3590         }
3591       elsif (/^lookup (.*)$/)
3592         {
3593         if (!defined $parm_lookups{$1}) { $wantthis = 0; last; }
3594         }
3595       elsif (/^authenticators? (.*)$/)
3596         {
3597         if (!defined $parm_authenticators{$1}) { $wantthis = 0; last; }
3598         }
3599       elsif (/^router (.*)$/)
3600         {
3601         if (!defined $parm_routers{$1}) { $wantthis = 0; last; }
3602         }
3603       elsif (/^transport (.*)$/)
3604         {
3605         if (!defined $parm_transports{$1}) { $wantthis = 0; last; }
3606         }
3607       elsif (/^malware (.*)$/)
3608         {
3609         if (!defined $parm_malware{$1}) { $wantthis = 0; last; }
3610         }
3611       elsif (/^feature (.*)$/)
3612         {
3613         # move to a subroutine?
3614         my $eximinfo = "$parm_exim -C $parm_cwd/test-config -DDIR=$parm_cwd -bP macro $1";
3615
3616         open (IN, "$parm_cwd/confs/0000") ||
3617           tests_exit(-1, "Couldn't open $parm_cwd/confs/0000: $!\n");
3618         open (OUT, ">test-config") ||
3619           tests_exit(-1, "Couldn't open test-config: $!\n");
3620         while (<IN>)
3621           {
3622           do_substitute($testno);
3623           print OUT;
3624           }
3625         close(IN);
3626         close(OUT);
3627
3628         system($eximinfo . " >/dev/null 2>&1");
3629         if ($? != 0) {
3630           unlink("$parm_cwd/test-config");
3631           $wantthis = 0;
3632           $_ = "feature $1";
3633           last;
3634         }
3635         unlink("$parm_cwd/test-config");
3636         }
3637       else
3638         {
3639         tests_exit(-1, "Unknown line in \"scripts/$testdir/REQUIRES\": \"$_\"");
3640         }
3641       }
3642     }
3643   else
3644     {
3645     tests_exit(-1, "Failed to open \"scripts/$testdir/REQUIRES\": $!")
3646       unless $!{ENOENT};
3647     }
3648
3649   # Loop if we do not want the tests in this subdirectory.
3650
3651   if (!$wantthis)
3652     {
3653     chomp;
3654     print "Omitting tests in $testdir (missing $_)\n";
3655     }
3656
3657   # We want the tests from this subdirectory, provided they are in the
3658   # range that was selected.
3659
3660   @testlist = grep { $_ ~~ @wanted } grep { /^\d+(?:\.\d+)?$/ } map { basename $_ } glob "scripts/$testdir/*";
3661   tests_exit(-1, "Failed to read test scripts from `scripts/$testdir/*': $!")
3662     if not @testlist;
3663
3664   foreach $test (@testlist)
3665     {
3666     if (!$wantthis)
3667       {
3668       log_test($log_summary_filename, $test, '.');
3669       }
3670     else
3671       {
3672       push @test_list, "$testdir/$test";
3673       }
3674     }
3675   }
3676
3677 print ">>Test List:\n", join "\n", @test_list, '' if $debug;
3678
3679
3680 ##################################################
3681 #         Munge variable auxiliary data          #
3682 ##################################################
3683
3684 # Some of the auxiliary data files have to refer to the current testing
3685 # directory and other parameter data. The generic versions of these files are
3686 # stored in the aux-var-src directory. At this point, we copy each of them
3687 # to the aux-var directory, making appropriate substitutions. There aren't very
3688 # many of them, so it's easiest just to do this every time. Ensure the mode
3689 # is standardized, as this path is used as a test for the ${stat: expansion.
3690
3691 # A similar job has to be done for the files in the dnszones-src directory, to
3692 # make the fake DNS zones for testing. Most of the zone files are copied to
3693 # files of the same name, but db.ipv4.V4NET and db.ipv6.V6NET use the testing
3694 # networks that are defined by parameter.
3695
3696 foreach $basedir ("aux-var", "dnszones")
3697   {
3698   system("sudo rm -rf $parm_cwd/$basedir");
3699   mkdir("$parm_cwd/$basedir", 0777);
3700   chmod(0755, "$parm_cwd/$basedir");
3701
3702   opendir(AUX, "$parm_cwd/$basedir-src") ||
3703     tests_exit(-1, "Failed to opendir $parm_cwd/$basedir-src: $!");
3704   my(@filelist) = readdir(AUX);
3705   close(AUX);
3706
3707   foreach $file (@filelist)
3708     {
3709     my($outfile) = $file;
3710     next if $file =~ /^\./;
3711
3712     if ($file eq "db.ip4.V4NET")
3713       {
3714       $outfile = "db.ip4.$parm_ipv4_test_net";
3715       }
3716     elsif ($file eq "db.ip6.V6NET")
3717       {
3718       my(@nibbles) = reverse(split /\s*/, $parm_ipv6_test_net);
3719       $" = '.';
3720       $outfile = "db.ip6.@nibbles";
3721       $" = ' ';
3722       }
3723
3724     print ">>Copying $basedir-src/$file to $basedir/$outfile\n" if $debug;
3725     open(IN, "$parm_cwd/$basedir-src/$file") ||
3726       tests_exit(-1, "Failed to open $parm_cwd/$basedir-src/$file: $!");
3727     open(OUT, ">$parm_cwd/$basedir/$outfile") ||
3728       tests_exit(-1, "Failed to open $parm_cwd/$basedir/$outfile: $!");
3729     while (<IN>)
3730       {
3731       do_substitute(0);
3732       print OUT;
3733       }
3734     close(IN);
3735     close(OUT);
3736     }
3737   }
3738
3739 # Set a user's shell, distinguishable from /bin/sh
3740
3741 symlink('/bin/sh' => 'aux-var/sh');
3742 $ENV{SHELL} = $parm_shell = "$parm_cwd/aux-var/sh";
3743
3744 ##################################################
3745 #     Create fake DNS zones for this host        #
3746 ##################################################
3747
3748 # There are fixed zone files for 127.0.0.1 and ::1, but we also want to be
3749 # sure that there are forward and reverse registrations for this host, using
3750 # its real IP addresses. Dynamically created zone files achieve this.
3751
3752 if ($have_ipv4 || $have_ipv6)
3753   {
3754   my($shortname,$domain) = $parm_hostname =~ /^([^.]+)(.*)/;
3755   open(OUT, ">$parm_cwd/dnszones/db$domain") ||
3756     tests_exit(-1, "Failed to open $parm_cwd/dnszones/db$domain: $!");
3757   print OUT "; This is a dynamically constructed fake zone file.\n" .
3758     "; The following line causes fakens to return PASS_ON\n" .
3759     "; for queries that it cannot answer\n\n" .
3760     "PASS ON NOT FOUND\n\n";
3761   print OUT "$shortname  A     $parm_ipv4\n" if $have_ipv4;
3762   print OUT "$shortname  AAAA  $parm_ipv6\n" if $have_ipv6;
3763   print OUT "\n; End\n";
3764   close(OUT);
3765   }
3766
3767 if ($have_ipv4 && $parm_ipv4 ne "127.0.0.1")
3768   {
3769   my(@components) = $parm_ipv4 =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)/;
3770   open(OUT, ">$parm_cwd/dnszones/db.ip4.$components[0]") ||
3771     tests_exit(-1,
3772       "Failed  to open $parm_cwd/dnszones/db.ip4.$components[0]: $!");
3773   print OUT "; This is a dynamically constructed fake zone file.\n" .
3774     "; The zone is $components[0].in-addr.arpa.\n\n" .
3775     "$components[3].$components[2].$components[1]  PTR  $parm_hostname.\n\n" .
3776     "; End\n";
3777   close(OUT);
3778   }
3779
3780 if ($have_ipv6 && $parm_ipv6 ne "::1")
3781   {
3782   my($exp_v6) = $parm_ipv6;
3783   $exp_v6 =~ s/[^:]//g;
3784   if ( $parm_ipv6 =~ /^([^:].+)::$/ ) {
3785     $exp_v6 = $1 . ':0' x (9-length($exp_v6));
3786   } elsif ( $parm_ipv6 =~ /^(.+)::(.+)$/ ) {
3787     $exp_v6 = $1 . ':0' x (8-length($exp_v6)) . ':' . $2;
3788   } elsif ( $parm_ipv6 =~ /^::(.+[^:])$/ ) {
3789     $exp_v6 = '0:' x (9-length($exp_v6)) . $1;
3790   } else {
3791     $exp_v6 = $parm_ipv6;
3792   }
3793   my(@components) = split /:/, $exp_v6;
3794   my(@nibbles) = reverse (split /\s*/, shift @components);
3795   my($sep) =  '';
3796
3797   $" = ".";
3798   open(OUT, ">$parm_cwd/dnszones/db.ip6.@nibbles") ||
3799     tests_exit(-1,
3800       "Failed  to open $parm_cwd/dnszones/db.ip6.@nibbles: $!");
3801   print OUT "; This is a dynamically constructed fake zone file.\n" .
3802     "; The zone is @nibbles.ip6.arpa.\n\n";
3803
3804   @components = reverse @components;
3805   foreach $c (@components)
3806     {
3807     $c = "0$c" until $c =~ /^..../;
3808     @nibbles = reverse(split /\s*/, $c);
3809     print OUT "$sep@nibbles";
3810     $sep = ".";
3811     }
3812
3813   print OUT "  PTR  $parm_hostname.\n\n; End\n";
3814   close(OUT);
3815   $" = " ";
3816   }
3817
3818
3819
3820 ##################################################
3821 #    Create lists of mailboxes and message logs  #
3822 ##################################################
3823
3824 # We use these lists to check that a test has created the expected files. It
3825 # should be faster than looking for the file each time. For mailboxes, we have
3826 # to scan a complete subtree, in order to handle maildirs. For msglogs, there
3827 # is just a flat list of files.
3828
3829 @oldmails = list_files_below("mail");
3830 opendir(DIR, "msglog") || tests_exit(-1, "Failed to opendir msglog: $!");
3831 @oldmsglogs = readdir(DIR);
3832 closedir(DIR);
3833
3834
3835
3836 ##################################################
3837 #         Run the required tests                 #
3838 ##################################################
3839
3840 # Each test script contains a number of tests, separated by a line that
3841 # contains ****. We open input from the terminal so that we can read responses
3842 # to prompts.
3843
3844 if (not $force_continue) {
3845   # runtest needs to interact if we're not in continue
3846   # mode. It does so by communicate to /dev/tty
3847   open(T, '<', '/dev/tty') or tests_exit(-1, "Failed to open /dev/tty: $!");
3848   print "\nPress RETURN to run the tests: ";
3849   <T>;
3850 }
3851
3852
3853 foreach $test (@test_list)
3854   {
3855   state $lasttestdir = '';
3856
3857   local $lineno     = 0;
3858   local $commandno  = 0;
3859   local $subtestno  = 0;
3860   local $sortlog    = 0;
3861
3862   (local $testno = $test) =~ s|.*/||;
3863
3864   # Leaving traces in the process table and in the environment
3865   # gives us a chance to identify hanging processes (exim daemons)
3866   local $0 = "[runtest $testno]";
3867   local $ENV{EXIM_TEST_NUMBER} = $testno;
3868
3869   my $gnutls   = 0;
3870   my $docheck  = 1;
3871   my $thistestdir  = substr($test, 0, -5);
3872
3873   $dynamic_socket->close() if $dynamic_socket;
3874
3875   if ($lasttestdir ne $thistestdir)
3876     {
3877     $gnutls = 0;
3878     if (-s "scripts/$thistestdir/REQUIRES")
3879       {
3880       my $indent = '';
3881       print "\n>>> The following tests require: ";
3882       open(my $requires, '<', "scripts/$thistestdir/REQUIRES") ||
3883         tests_exit(-1, "Failed to open scripts/$thistestdir/REQUIRES: $!");
3884       while (<$requires>)
3885         {
3886         $gnutls = 1 if /^support GnuTLS/;
3887         print $indent, $_;
3888         $indent = ">>>                              ";
3889         }
3890       }
3891       $lasttestdir = $thistestdir;
3892     }
3893
3894   # Remove any debris in the spool directory and the test-mail directory
3895   # and also the files for collecting stdout and stderr. Then put back
3896   # the test-mail directory for appendfile deliveries.
3897
3898   system "sudo /bin/rm -rf spool test-*";
3899   system "mkdir test-mail 2>/dev/null";
3900
3901   # A privileged Exim will normally make its own spool directory, but some of
3902   # the tests run in unprivileged modes that don't always work if the spool
3903   # directory isn't already there. What is more, we want anybody to be able
3904   # to read it in order to find the daemon's pid.
3905
3906   system "mkdir spool; " .
3907          "sudo chown $parm_eximuser:$parm_eximgroup spool; " .
3908          "sudo chmod 0755 spool";
3909
3910   # Empty the cache that keeps track of things like message id mappings, and
3911   # set up the initial sequence strings.
3912
3913   undef %cache;
3914   $next_msgid = "aX";
3915   $next_pid = 1234;
3916   $next_port = 1111;
3917   $message_skip = 0;
3918   $msglog_skip = 0;
3919   $stderr_skip = 0;
3920   $stdout_skip = 0;
3921   $rmfiltertest = 0;
3922   $is_ipv6test = 0;
3923   $TEST_STATE->{munge} = '';
3924
3925   # Remove the associative arrays used to hold checked mail files and msglogs
3926
3927   undef %expected_mails;
3928   undef %expected_msglogs;
3929
3930   # Open the test's script
3931   open(SCRIPT, "scripts/$test") ||
3932     tests_exit(-1, "Failed to open \"scripts/$test\": $!");
3933   # Run through the script once to set variables which should be global
3934   while (<SCRIPT>)
3935     {
3936     if (/^no_message_check/) { $message_skip = 1; next; }
3937     if (/^no_msglog_check/)  { $msglog_skip = 1; next; }
3938     if (/^no_stderr_check/)  { $stderr_skip = 1; next; }
3939     if (/^no_stdout_check/)  { $stdout_skip = 1; next; }
3940     if (/^rmfiltertest/)     { $rmfiltertest = 1; next; }
3941     if (/^sortlog/)          { $sortlog = 1; next; }
3942     if (/\bPORT_DYNAMIC\b/)  { $dynamic_socket = Exim::Runtest::dynamic_socket(); next; }
3943     }
3944   # Reset to beginning of file for per test interpreting/processing
3945   seek(SCRIPT, 0, 0);
3946
3947   # The first line in the script must be a comment that is used to identify
3948   # the set of tests as a whole.
3949
3950   $_ = <SCRIPT>;
3951   $lineno++;
3952   tests_exit(-1, "Missing identifying comment at start of $test") if (!/^#/);
3953   printf("%s %s", (substr $test, 5), (substr $_, 2));
3954
3955   # Loop for each of the subtests within the script. The variable $server_pid
3956   # is used to remember the pid of a "server" process, for which we do not
3957   # wait until we have waited for a subsequent command.
3958
3959   local($server_pid) = 0;
3960   for ($commandno = 1; !eof SCRIPT; $commandno++)
3961     {
3962     # Skip further leading comments and blank lines, handle the flag setting
3963     # commands, and deal with tests for IP support.
3964
3965     while (<SCRIPT>)
3966       {
3967       $lineno++;
3968       # Could remove these variable settings because they are already
3969       # set above, but doesn't hurt to leave them here.
3970       if (/^no_message_check/) { $message_skip = 1; next; }
3971       if (/^no_msglog_check/)  { $msglog_skip = 1; next; }
3972       if (/^no_stderr_check/)  { $stderr_skip = 1; next; }
3973       if (/^no_stdout_check/)  { $stdout_skip = 1; next; }
3974       if (/^rmfiltertest/)     { $rmfiltertest = 1; next; }
3975       if (/^sortlog/)          { $sortlog = 1; next; }
3976
3977       if (/^need_largefiles/)
3978         {
3979         next if $have_largefiles;
3980         print ">>> Large file support is needed for test $testno, but is not available: skipping\n";
3981         $docheck = 0;      # don't check output
3982         undef $_;          # pretend EOF
3983         last;
3984         }
3985
3986       if (/^need_ipv4/)
3987         {
3988         next if $have_ipv4;
3989         print&n