test/runtest

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