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