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