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