test/runtest

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