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