test/runtest

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