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