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