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