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