test/runtest

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