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