test/runtest

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