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