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