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