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