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