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