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