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