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