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