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