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