test/runtest

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