test/runtest

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