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