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