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