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