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