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