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