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