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