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