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