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