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