test/runtest

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