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
1215   # ======== All files other than stderr ========
1216
1217   print MUNGED;
1218   }
1219
1220 close(IN);
1221 return $yield;
1222 }
1223
1224
1225
1226
1227 ##################################################
1228 #        Subroutine to interact with caller      #
1229 ##################################################
1230
1231 # Arguments: [0] the prompt string
1232 #            [1] if there is a U in the prompt and $force_update is true
1233 #            [2] if there is a C in the prompt and $force_continue is true
1234 # Returns:   returns the answer
1235
1236 sub interact {
1237   my ($prompt, $have_u, $have_c) = @_;
1238
1239   print $prompt;
1240
1241   if ($have_u) {
1242     print "... update forced\n";
1243     return 'u';
1244   }
1245
1246   if ($have_c) {
1247     print "... continue forced\n";
1248     return 'c';
1249   }
1250
1251   return lc <T>;
1252 }
1253
1254
1255
1256 ##################################################
1257 #    Subroutine to log in force_continue mode    #
1258 ##################################################
1259
1260 # In force_continue mode, we just want a terse output to a statically
1261 # named logfile.  If multiple files in same batch (stdout, stderr, etc)
1262 # all have mismatches, it will log multiple times.
1263 #
1264 # Arguments: [0] the logfile to append to
1265 #            [1] the testno that failed
1266 # Returns:   nothing
1267
1268
1269
1270 sub log_failure {
1271   my ($logfile, $testno, $detail) = @_;
1272
1273   open(my $fh, '>>', $logfile) or return;
1274
1275   print $fh "Test $testno "
1276         . (defined $detail ? "$detail " : '')
1277         . "failed\n";
1278 }
1279
1280 # Computer-readable summary results logfile
1281
1282 sub log_test {
1283   my ($logfile, $testno, $resultchar) = @_;
1284
1285   open(my $fh, '>>', $logfile) or return;
1286   print $fh "$testno $resultchar\n";
1287 }
1288
1289
1290
1291 ##################################################
1292 #    Subroutine to compare one output file       #
1293 ##################################################
1294
1295 # When an Exim server is part of the test, its output is in separate files from
1296 # an Exim client. The server data is concatenated with the client data as part
1297 # of the munging operation.
1298 #
1299 # Arguments:  [0] the name of the main raw output file
1300 #             [1] the name of the server raw output file or undef
1301 #             [2] where to put the munged copy
1302 #             [3] the name of the saved file
1303 #             [4] TRUE if this is a log file whose deliveries must be sorted
1304 #             [5] optionally, a custom munge command
1305 #
1306 # Returns:    0 comparison succeeded
1307 #             1 comparison failed; differences to be ignored
1308 #             2 comparison failed; files may have been updated (=> re-compare)
1309 #
1310 # Does not return if the user replies "Q" to a prompt.
1311
1312 sub check_file{
1313 my($rf,$rsf,$mf,$sf,$sortfile,$extra) = @_;
1314
1315 # If there is no saved file, the raw files must either not exist, or be
1316 # empty. The test ! -s is TRUE if the file does not exist or is empty.
1317
1318 # we check if there is a flavour specific file, but we remember
1319 # the original file name as "generic"
1320 $sf_generic = $sf;
1321 $sf_flavour = "$sf_generic.$flavour";
1322 $sf_current = -e $sf_flavour ? $sf_flavour : $sf_generic;
1323
1324 if (! -e $sf_current)
1325   {
1326   return 0 if (! -s $rf && (! defined $rsf || ! -s $rsf));
1327
1328   print "\n";
1329   print "** $rf is not empty\n" if (-s $rf);
1330   print "** $rsf is not empty\n" if (defined $rsf && -s $rsf);
1331
1332   for (;;)
1333     {
1334     $_ = interact('Continue, Show, or Quit? [Q] ', undef, $force_continue);
1335     tests_exit(1) if /^q?$/;
1336     if (/^c$/ && $force_continue) {
1337       log_failure($log_failed_filename, $testno, $rf);
1338       log_test($log_summary_filename, $testno, 'F') if ($force_continue);
1339     }
1340     return 1 if /^c$/i && $rf !~ /paniclog/ && $rsf !~ /paniclog/;
1341     last if (/^[sc]$/);
1342     }
1343
1344   foreach $f ($rf, $rsf)
1345     {
1346     if (defined $f && -s $f)
1347       {
1348       print "\n";
1349       print "------------ $f -----------\n"
1350         if (defined $rf && -s $rf && defined $rsf && -s $rsf);
1351       system("$more '$f'");
1352       }
1353     }
1354
1355   print "\n";
1356   for (;;)
1357     {
1358     $_ = interact('Continue, Update & retry, Quit? [Q] ', $force_update, $force_continue);
1359     tests_exit(1) if /^q?$/;
1360     if (/^c$/ && $force_continue) {
1361       log_failure($log_failed_filename, $testno, $rf);
1362       log_test($log_summary_filename, $testno, 'F')
1363     }
1364     return 1 if /^c$/i;
1365     last if (/^u$/i);
1366     }
1367   }
1368
1369 #### $_
1370
1371 # Control reaches here if either (a) there is a saved file ($sf), or (b) there
1372 # was a request to create a saved file. First, create the munged file from any
1373 # data that does exist.
1374
1375 open(MUNGED, '>', $mf) || tests_exit(-1, "Failed to open $mf: $!");
1376 my($truncated) = munge($rf, $extra) if -e $rf;
1377
1378 # Append the raw server log, if it is non-empty
1379 if (defined $rsf && -e $rsf)
1380   {
1381   print MUNGED "\n******** SERVER ********\n";
1382   $truncated |= munge($rsf, $extra);
1383   }
1384 close(MUNGED);
1385
1386 # If a saved file exists, do the comparison. There are two awkward cases:
1387 #
1388 # If "*** truncated ***" was found in the new file, it means that a log line
1389 # was overlong, and truncated. The problem is that it may be truncated at
1390 # different points on different systems, because of different user name
1391 # lengths. We reload the file and the saved file, and remove lines from the new
1392 # file that precede "*** truncated ***" until we reach one that matches the
1393 # line that precedes it in the saved file.
1394 #
1395 # If $sortfile is set, we are dealing with a mainlog file where the deliveries
1396 # for an individual message might vary in their order from system to system, as
1397 # a result of parallel deliveries. We load the munged file and sort sequences
1398 # of delivery lines.
1399
1400 if (-e $sf_current)
1401   {
1402   # Deal with truncated text items
1403
1404   if ($truncated)
1405     {
1406     my(@munged, @saved, $i, $j, $k);
1407
1408     open(MUNGED, $mf) || tests_exit(-1, "Failed to open $mf: $!");
1409     @munged = <MUNGED>;
1410     close(MUNGED);
1411     open(SAVED, $sf_current) || tests_exit(-1, "Failed to open $sf_current: $!");
1412     @saved = <SAVED>;
1413     close(SAVED);
1414
1415     $j = 0;
1416     for ($i = 0; $i < @munged; $i++)
1417       {
1418       if ($munged[$i] =~ /\*\*\* truncated \*\*\*/)
1419         {
1420         for (; $j < @saved; $j++)
1421           { last if $saved[$j] =~ /\*\*\* truncated \*\*\*/; }
1422         last if $j >= @saved;     # not found in saved
1423
1424         for ($k = $i - 1; $k >= 0; $k--)
1425           { last if $munged[$k] eq $saved[$j - 1]; }
1426
1427         last if $k <= 0;          # failed to find previous match
1428         splice @munged, $k + 1, $i - $k - 1;
1429         $i = $k + 1;
1430         }
1431       }
1432
1433     open(MUNGED, '>', $mf) || tests_exit(-1, "Failed to open $mf: $!");
1434     for ($i = 0; $i < @munged; $i++)
1435       { print MUNGED $munged[$i]; }
1436     close(MUNGED);
1437     }
1438
1439   # Deal with log sorting
1440
1441   if ($sortfile)
1442     {
1443     my(@munged, $i, $j);
1444
1445     open(MUNGED, $mf) || tests_exit(-1, "Failed to open $mf: $!");
1446     @munged = <MUNGED>;
1447     close(MUNGED);
1448
1449     for ($i = 0; $i < @munged; $i++)
1450       {
1451       if ($munged[$i] =~ /^[-\d]{10}\s[:\d]{8}\s[-A-Za-z\d]{16}\s[-=*]>/)
1452         {
1453         for ($j = $i + 1; $j < @munged; $j++)
1454           {
1455           last if $munged[$j] !~
1456             /^[-\d]{10}\s[:\d]{8}\s[-A-Za-z\d]{16}\s[-=*]>/;
1457           }
1458         @temp = splice(@munged, $i, $j - $i);
1459         @temp = sort(@temp);
1460         splice(@munged, $i, 0, @temp);
1461         }
1462       }
1463
1464     open(MUNGED, ">$mf") || tests_exit(-1, "Failed to open $mf: $!");
1465     print MUNGED "**NOTE: The delivery lines in this file have been sorted.\n";
1466     for ($i = 0; $i < @munged; $i++)
1467       { print MUNGED $munged[$i]; }
1468     close(MUNGED);
1469     }
1470
1471   # Do the comparison
1472
1473   return 0 if (system("$cf '$mf' '$sf_current' >test-cf") == 0);
1474
1475   # Handle comparison failure
1476
1477   print "** Comparison of $mf with $sf_current failed";
1478   system("$more test-cf");
1479
1480   print "\n";
1481   for (;;)
1482     {
1483     $_ = interact('Continue, Retry, Update current'
1484         . ($sf_current ne $sf_flavour  ? "/Save for flavour '$flavour'" : '')
1485         . ' & retry, Quit? [Q] ', $force_update, $force_continue);
1486     tests_exit(1) if /^q?$/;
1487     if (/^c$/ && $force_continue) {
1488       log_failure($log_failed_filename, $testno, $sf_current);
1489       log_test($log_summary_filename, $testno, 'F')
1490     }
1491     return 1 if /^c$/i;
1492     return 2 if /^r$/i;
1493     last if (/^[us]$/i);
1494     }
1495   }
1496
1497 # Update or delete the saved file, and give the appropriate return code.
1498
1499 if (-s $mf)
1500   {
1501     my $sf = /^u/i ? $sf_current : $sf_flavour;
1502     tests_exit(-1, "Failed to cp $mf $sf") if system("cp '$mf' '$sf'") != 0;
1503   }
1504 else
1505   {
1506     # if we deal with a flavour file, we can't delete it, because next time the generic
1507     # file would be used again
1508     if ($sf_current eq $sf_flavour) {
1509       open(FOO, ">$sf_current");
1510       close(FOO);
1511     }
1512     else {
1513       tests_exit(-1, "Failed to unlink $sf_current") if !unlink($sf_current);
1514     }
1515   }
1516
1517 return 2;
1518 }
1519
1520
1521
1522 ##################################################
1523 # Custom munges
1524 # keyed by name of munge; value is a ref to a hash
1525 # which is keyed by file, value a string to look for.
1526 # Usable files are:
1527 #  paniclog, rejectlog, mainlog, stdout, stderr, msglog, mail
1528 # Search strings starting with 's' do substitutions;
1529 # with '/' do line-skips.
1530 # Triggered by a scriptfile line "munge <name>"
1531 ##################################################
1532 $munges =
1533   { 'dnssec' =>
1534     { 'stderr' => '/^Reverse DNS security status: unverified\n/' },
1535
1536     'gnutls_unexpected' =>
1537     { 'mainlog' => '/\(recv\): A TLS packet with unexpected length was received./' },
1538
1539     'gnutls_handshake' =>
1540     { 'mainlog' => 's/\(gnutls_handshake\): Error in the push function/\(gnutls_handshake\): A TLS packet with unexpected length was received/' },
1541
1542     'optional_events' =>
1543     { 'stdout' => '/event_action =/' },
1544
1545     'optional_ocsp' =>
1546     { 'stderr' => '/127.0.0.1 in hosts_requ(ire|est)_ocsp/' },
1547
1548     'optional_cert_hostnames' =>
1549     { 'stderr' => '/in tls_verify_cert_hostnames\? no/' },
1550
1551     'loopback' =>
1552     { 'stdout' => 's/[[](127\.0\.0\.1|::1)]/[IP_LOOPBACK_ADDR]/' },
1553
1554     'scanfile_size' =>
1555     { 'stdout' => 's/(Content-length:) \d\d\d/$1 ddd/' },
1556
1557     'delay_1500' =>
1558     { 'stderr' => 's/(1[5-9]|23\d)\d\d msec/ssss msec/' },
1559
1560     'tls_anycipher' =>
1561     { 'mainlog' => 's/ X=TLS\S+ / X=TLS_proto_and_cipher /' },
1562
1563     'debug_pid' =>
1564     { 'stderr' => 's/(^\s{0,4}|(?<=Process )|(?<=child ))\d{1,5}/ppppp/g' },
1565
1566     'optional_dsn_info' =>
1567     { 'mail' => '/^(X-(Remote-MTA-(smtp-greeting|helo-response)|Exim-Diagnostic|(body|message)-linecount):|Remote-MTA: X-ip;)/'
1568     },
1569
1570     'optional_config' =>
1571     { 'stdout' => '/^(
1572                   dkim_(canon|domain|private_key|selector|sign_headers|strict|hash|identity)
1573                   |gnutls_require_(kx|mac|protocols)
1574                   |hosts_(requ(est|ire)|try)_(dane|ocsp)
1575                   |dane_require_tls_ciphers
1576                   |hosts_(avoid|nopass|noproxy|require|verify_avoid)_tls
1577                   |socks_proxy
1578                   |tls_[^ ]*
1579                   )($|[ ]=)/x'
1580     },
1581
1582     'sys_bindir' =>
1583     { 'mainlog' => 's%/(usr/(local/)?)?bin/%SYSBINDIR/%' },
1584
1585     'sync_check_data' =>
1586     { 'mainlog'   => 's/^(.* SMTP protocol synchronization error .* next input=.{8}).*$/$1<suppressed>/',
1587       'rejectlog' => 's/^(.* SMTP protocol synchronization error .* next input=.{8}).*$/$1<suppressed>/'},
1588
1589     'debuglog_stdout' =>
1590     { 'stdout' => 's/^\d\d:\d\d:\d\d\s+\d+ //;
1591                   s/Process \d+ is ready for new message/Process pppp is ready for new message/'
1592     },
1593
1594     'timeout_errno' =>          # actual errno differs Solaris vs. Linux
1595     { 'mainlog' => 's/(host deferral .* errno) <\d+> /$1 <EEE> /' },
1596
1597     'peer_terminated_conn' =>   # actual error differs FreedBSD vs. Linux
1598     { 'stderr' => 's/^(  SMTP\()Connection reset by peer(\)<<)$/$1closed$2/' },
1599
1600     'perl_variants' =>          # result of hash-in-scalar-context changed from bucket-fill to keycount
1601     { 'stdout' => 's%^> X/X$%> X%' },
1602   };
1603
1604
1605 sub max {
1606   my ($a, $b) = @_;
1607   return $a if ($a > $b);
1608   return $b;
1609 }
1610
1611 ##################################################
1612 #    Subroutine to check the output of a test    #
1613 ##################################################
1614
1615 # This function is called when the series of subtests is complete. It makes
1616 # use of check_file(), whose arguments are:
1617 #
1618 #  [0] the name of the main raw output file
1619 #  [1] the name of the server raw output file or undef
1620 #  [2] where to put the munged copy
1621 #  [3] the name of the saved file
1622 #  [4] TRUE if this is a log file whose deliveries must be sorted
1623 #  [5] an optional custom munge command
1624 #
1625 # Arguments: Optionally, name of a single custom munge to run.
1626 # Returns:   0 if the output compared equal
1627 #            1 if comparison failed; differences to be ignored
1628 #            2 if re-run needed (files may have been updated)
1629
1630 sub check_output{
1631 my($mungename) = $_[0];
1632 my($yield) = 0;
1633 my($munge) = $munges->{$mungename} if defined $mungename;
1634
1635 $yield = max($yield,  check_file("spool/log/paniclog",
1636                        "spool/log/serverpaniclog",
1637                        "test-paniclog-munged",
1638                        "paniclog/$testno", 0,
1639                        $munge->{paniclog}));
1640
1641 $yield = max($yield,  check_file("spool/log/rejectlog",
1642                        "spool/log/serverrejectlog",
1643                        "test-rejectlog-munged",
1644                        "rejectlog/$testno", 0,
1645                        $munge->{rejectlog}));
1646
1647 $yield = max($yield,  check_file("spool/log/mainlog",
1648                        "spool/log/servermainlog",
1649                        "test-mainlog-munged",
1650                        "log/$testno", $sortlog,
1651                        $munge->{mainlog}));
1652
1653 if (!$stdout_skip)
1654   {
1655   $yield = max($yield,  check_file("test-stdout",
1656                        "test-stdout-server",
1657                        "test-stdout-munged",
1658                        "stdout/$testno", 0,
1659                        $munge->{stdout}));
1660   }
1661
1662 if (!$stderr_skip)
1663   {
1664   $yield = max($yield,  check_file("test-stderr",
1665                        "test-stderr-server",
1666                        "test-stderr-munged",
1667                        "stderr/$testno", 0,
1668                        $munge->{stderr}));
1669   }
1670
1671 # Compare any delivered messages, unless this test is skipped.
1672
1673 if (! $message_skip)
1674   {
1675   my($msgno) = 0;
1676
1677   # Get a list of expected mailbox files for this script. We don't bother with
1678   # directories, just the files within them.
1679
1680   foreach $oldmail (@oldmails)
1681     {
1682     next unless $oldmail =~ /^mail\/$testno\./;
1683     print ">> EXPECT $oldmail\n" if $debug;
1684     $expected_mails{$oldmail} = 1;
1685     }
1686
1687   # If there are any files in test-mail, compare them. Note that "." and
1688   # ".." are automatically omitted by list_files_below().
1689
1690   @mails = list_files_below("test-mail");
1691
1692   foreach $mail (@mails)
1693     {
1694     next if $mail eq "test-mail/oncelog";
1695
1696     $saved_mail = substr($mail, 10);               # Remove "test-mail/"
1697     $saved_mail =~ s/^$parm_caller(\/|$)/CALLER/;  # Convert caller name
1698
1699     if ($saved_mail =~ /(\d+\.[^.]+\.)/)
1700       {
1701       $msgno++;
1702       $saved_mail =~ s/(\d+\.[^.]+\.)/$msgno./gx;
1703       }
1704
1705     print ">> COMPARE $mail mail/$testno.$saved_mail\n" if $debug;
1706     $yield = max($yield,  check_file($mail, undef, "test-mail-munged",
1707       "mail/$testno.$saved_mail", 0,
1708       $munge->{mail}));
1709     delete $expected_mails{"mail/$testno.$saved_mail"};
1710     }
1711
1712   # Complain if not all expected mails have been found
1713
1714   if (scalar(keys %expected_mails) != 0)
1715     {
1716     foreach $key (keys %expected_mails)
1717       { print "** no test file found for $key\n"; }
1718
1719     for (;;)
1720       {
1721       $_ = interact('Continue, Update & retry, or Quit? [Q] ', $force_update, $force_continue);
1722       tests_exit(1) if /^q?$/;
1723       if (/^c$/ && $force_continue) {
1724         log_failure($log_failed_filename, $testno, "missing email");
1725         log_test($log_summary_filename, $testno, 'F')
1726       }
1727       last if /^c$/;
1728
1729       # For update, we not only have to unlink the file, but we must also
1730       # remove it from the @oldmails vector, as otherwise it will still be
1731       # checked for when we re-run the test.
1732
1733       if (/^u$/)
1734         {
1735         foreach $key (keys %expected_mails)
1736           {
1737           my($i);
1738           tests_exit(-1, "Failed to unlink $key") if !unlink("$key");
1739           for ($i = 0; $i < @oldmails; $i++)
1740             {
1741             if ($oldmails[$i] eq $key)
1742               {
1743               splice @oldmails, $i, 1;
1744               last;
1745               }
1746             }
1747           }
1748         last;
1749         }
1750       }
1751     }
1752   }
1753
1754 # Compare any remaining message logs, unless this test is skipped.
1755
1756 if (! $msglog_skip)
1757   {
1758   # Get a list of expected msglog files for this test
1759
1760   foreach $oldmsglog (@oldmsglogs)
1761     {
1762     next unless $oldmsglog =~ /^$testno\./;
1763     $expected_msglogs{$oldmsglog} = 1;
1764     }
1765
1766   # If there are any files in spool/msglog, compare them. However, we have
1767   # to munge the file names because they are message ids, which are
1768   # time dependent.
1769
1770   if (opendir(DIR, "spool/msglog"))
1771     {
1772     @msglogs = sort readdir(DIR);
1773     closedir(DIR);
1774
1775     foreach $msglog (@msglogs)
1776       {
1777       next if ($msglog eq "." || $msglog eq ".." || $msglog eq "CVS");
1778       ($munged_msglog = $msglog) =~
1779         s/((?:[^\W_]{6}-){2}[^\W_]{2})
1780           /new_value($1, "10Hm%s-0005vi-00", \$next_msgid)/egx;
1781       $yield = max($yield,  check_file("spool/msglog/$msglog", undef,
1782         "test-msglog-munged", "msglog/$testno.$munged_msglog", 0,
1783         $munge->{msglog}));
1784       delete $expected_msglogs{"$testno.$munged_msglog"};
1785       }
1786     }
1787
1788   # Complain if not all expected msglogs have been found
1789
1790   if (scalar(keys %expected_msglogs) != 0)
1791     {
1792     foreach $key (keys %expected_msglogs)
1793       {
1794       print "** no test msglog found for msglog/$key\n";
1795       ($msgid) = $key =~ /^\d+\.(.*)$/;
1796       foreach $cachekey (keys %cache)
1797         {
1798         if ($cache{$cachekey} eq $msgid)
1799           {
1800           print "** original msgid $cachekey\n";
1801           last;
1802           }
1803         }
1804       }
1805
1806     for (;;)
1807       {
1808       $_ = interact('Continue, Update, or Quit? [Q] ', $force_update, $force_continue);
1809       tests_exit(1) if /^q?$/;
1810       if (/^c$/ && $force_continue) {
1811         log_failure($log_failed_filename, $testno, "missing msglog");
1812         log_test($log_summary_filename, $testno, 'F')
1813       }
1814       last if /^c$/;
1815       if (/^u$/)
1816         {
1817         foreach $key (keys %expected_msglogs)
1818           {
1819           tests_exit(-1, "Failed to unlink msglog/$key")
1820             if !unlink("msglog/$key");
1821           }
1822         last;
1823         }
1824       }
1825     }
1826   }
1827
1828 return $yield;
1829 }
1830
1831
1832
1833 ##################################################
1834 #     Subroutine to run one "system" command     #
1835 ##################################################
1836
1837 # We put this in a subroutine so that the command can be reflected when
1838 # debugging.
1839 #
1840 # Argument: the command to be run
1841 # Returns:  nothing
1842
1843 sub run_system {
1844 my($cmd) = $_[0];
1845 if ($debug)
1846   {
1847   my($prcmd) = $cmd;
1848   $prcmd =~ s/; /;\n>> /;
1849   print ">> $prcmd\n";
1850   }
1851 system("$cmd");
1852 }
1853
1854
1855
1856 ##################################################
1857 #      Subroutine to run one script command      #
1858 ##################################################
1859
1860 # The <SCRIPT> file is open for us to read an optional return code line,
1861 # followed by the command line and any following data lines for stdin. The
1862 # command line can be continued by the use of \. Data lines are not continued
1863 # in this way. In all lines, the following substitutions are made:
1864 #
1865 # DIR    => the current directory
1866 # CALLER => the caller of this script
1867 #
1868 # Arguments: the current test number
1869 #            reference to the subtest number, holding previous value
1870 #            reference to the expected return code value
1871 #            reference to where to put the command name (for messages)
1872 #            auxiliary information returned from a previous run
1873 #
1874 # Returns:   0 the command was executed inline, no subprocess was run
1875 #            1 a non-exim command was run and waited for
1876 #            2 an exim command was run and waited for
1877 #            3 a command was run and not waited for (daemon, server, exim_lock)
1878 #            4 EOF was encountered after an initial return code line
1879 # Optionally also a second parameter, a hash-ref, with auxiliary information:
1880 #            exim_pid: pid of a run process
1881 #            munge: name of a post-script results munger
1882
1883 sub run_command{
1884 my($testno) = $_[0];
1885 my($subtestref) = $_[1];
1886 my($commandnameref) = $_[3];
1887 my($aux_info) = $_[4];
1888 my($yield) = 1;
1889
1890 our %ENV = map { $_ => $ENV{$_} } grep { /^(?:USER|SHELL|PATH|TERM|EXIM_TEST_.*)$/ } keys %ENV;
1891
1892 if (/^(\d+)\s*$/)                # Handle unusual return code
1893   {
1894   my($r) = $_[2];
1895   $$r = $1 << 8;
1896   $_ = <SCRIPT>;
1897   return 4 if !defined $_;       # Missing command
1898   $lineno++;
1899   }
1900
1901 chomp;
1902 $wait_time = 0;
1903
1904 # Handle concatenated command lines
1905
1906 s/\s+$//;
1907 while (substr($_, -1) eq"\\")
1908   {
1909   my($temp);
1910   $_ = substr($_, 0, -1);
1911   chomp($temp = <SCRIPT>);
1912   if (defined $temp)
1913     {
1914     $lineno++;
1915     $temp =~ s/\s+$//;
1916     $temp =~ s/^\s+//;
1917     $_ .= $temp;
1918     }
1919   }
1920
1921 # Do substitutions
1922
1923 do_substitute($testno);
1924 if ($debug) { printf ">> $_\n"; }
1925
1926 # Pass back the command name (for messages)
1927
1928 ($$commandnameref) = /^(\S+)/;
1929
1930 # Here follows code for handling the various different commands that are
1931 # supported by this script. The first group of commands are all freestanding
1932 # in that they share no common code and are not followed by any data lines.
1933
1934
1935 ###################
1936 ###################
1937
1938 # The "dbmbuild" command runs exim_dbmbuild. This is used both to test the
1939 # utility and to make DBM files for testing DBM lookups.
1940
1941 if (/^dbmbuild\s+(\S+)\s+(\S+)/)
1942   {
1943   run_system("(./eximdir/exim_dbmbuild $parm_cwd/$1 $parm_cwd/$2;" .
1944          "echo exim_dbmbuild exit code = \$?)" .
1945          ">>test-stdout");
1946   return 1;
1947   }
1948
1949
1950 # The "dump" command runs exim_dumpdb. On different systems, the output for
1951 # some types of dump may appear in a different order because it's just hauled
1952 # out of the DBM file. We can solve this by sorting. Ignore the leading
1953 # date/time, as it will be flattened later during munging.
1954
1955 if (/^dump\s+(\S+)/)
1956   {
1957   my($which) = $1;
1958   my(@temp);
1959   print ">> ./eximdir/exim_dumpdb $parm_cwd/spool $which\n" if $debug;
1960   open(IN, "./eximdir/exim_dumpdb $parm_cwd/spool $which |");
1961   open(OUT, ">>test-stdout");
1962   print OUT "+++++++++++++++++++++++++++\n";
1963
1964   if ($which eq "retry")
1965     {
1966     $/ = "\n  ";
1967     @temp = <IN>;
1968     $/ = "\n";
1969
1970     @temp = sort {
1971                    my($aa) = split(' ', $a);
1972                    my($bb) = split(' ', $b);
1973                    return $aa cmp $bb;
1974                  } @temp;
1975
1976     foreach $item (@temp)
1977       {
1978       $item =~ s/^\s*(.*)\n(.*)\n?\s*$/$1\n$2/m;
1979       print OUT "  $item\n";
1980       }
1981     }
1982   else
1983     {
1984     @temp = <IN>;
1985     if ($which eq "callout")
1986       {
1987       @temp = sort {
1988                    my($aa) = substr $a, 21;
1989                    my($bb) = substr $b, 21;
1990                    return $aa cmp $bb;
1991                    } @temp;
1992       }
1993     print OUT @temp;
1994     }
1995
1996   close(IN);
1997   close(OUT);
1998   return 1;
1999   }
2000
2001
2002 # verbose comments start with ###
2003 if (/^###\s/) {
2004   for my $file (qw(test-stdout test-stderr test-stderr-server test-stdout-server)) {
2005     open my $fh, '>>', $file or die "Can't open >>$file: $!\n";
2006     say {$fh} $_;
2007   }
2008   return 0;
2009 }
2010
2011 # The "echo" command is a way of writing comments to the screen.
2012 if (/^echo\s+(.*)$/)
2013   {
2014   print "$1\n";
2015   return 0;
2016   }
2017
2018
2019 # The "exim_lock" command runs exim_lock in the same manner as "server",
2020 # but it doesn't use any input.
2021
2022 if (/^exim_lock\s+(.*)$/)
2023   {
2024   $cmd = "./eximdir/exim_lock $1 >>test-stdout";
2025   $server_pid = open SERVERCMD, "|$cmd" ||
2026     tests_exit(-1, "Failed to run $cmd\n");
2027
2028   # This gives the process time to get started; otherwise the next
2029   # process may not find it there when it expects it.
2030
2031   select(undef, undef, undef, 0.1);
2032   return 3;
2033   }
2034
2035
2036 # The "exinext" command runs exinext
2037
2038 if (/^exinext\s+(.*)/)
2039   {
2040   run_system("(./eximdir/exinext " .
2041     "-DEXIM_PATH=$parm_cwd/eximdir/exim " .
2042     "-C $parm_cwd/test-config $1;" .
2043     "echo exinext exit code = \$?)" .
2044     ">>test-stdout");
2045   return 1;
2046   }
2047
2048
2049 # The "exigrep" command runs exigrep on the current mainlog
2050
2051 if (/^exigrep\s+(.*)/)
2052   {
2053   run_system("(./eximdir/exigrep " .
2054     "$1 $parm_cwd/spool/log/mainlog;" .
2055     "echo exigrep exit code = \$?)" .
2056     ">>test-stdout");
2057   return 1;
2058   }
2059
2060
2061 # The "eximstats" command runs eximstats on the current mainlog
2062
2063 if (/^eximstats\s+(.*)/)
2064   {
2065   run_system("(./eximdir/eximstats " .
2066     "$1 $parm_cwd/spool/log/mainlog;" .
2067     "echo eximstats exit code = \$?)" .
2068     ">>test-stdout");
2069   return 1;
2070   }
2071
2072
2073 # The "gnutls" command makes a copy of saved GnuTLS parameter data in the
2074 # spool directory, to save Exim from re-creating it each time.
2075
2076 if (/^gnutls/)
2077   {
2078   my $gen_fn = "spool/gnutls-params-$gnutls_dh_bits_normal";
2079   run_system "sudo cp -p aux-fixed/gnutls-params $gen_fn;" .
2080          "sudo chown $parm_eximuser:$parm_eximgroup $gen_fn;" .
2081          "sudo chmod 0400 $gen_fn";
2082   return 1;
2083   }
2084
2085
2086 # The "killdaemon" command should ultimately follow the starting of any Exim
2087 # daemon with the -bd option. We kill with SIGINT rather than SIGTERM to stop
2088 # it outputting "Terminated" to the terminal when not in the background.
2089
2090 if (/^killdaemon/)
2091   {
2092   my $return_extra = {};
2093   if (exists $aux_info->{exim_pid})
2094     {
2095     $pid = $aux_info->{exim_pid};
2096     $return_extra->{exim_pid} = undef;
2097     print ">> killdaemon: recovered pid $pid\n" if $debug;
2098     if ($pid)
2099       {
2100       run_system("sudo /bin/kill -INT $pid");
2101       wait;
2102       }
2103     } else {
2104     $pid = `cat $parm_cwd/spool/exim-daemon.*`;
2105     if ($pid)
2106       {
2107       run_system("sudo /bin/kill -INT $pid");
2108       close DAEMONCMD;                                   # Waits for process
2109       }
2110     }
2111     run_system("sudo /bin/rm -f spool/exim-daemon.*");
2112   return (1, $return_extra);
2113   }
2114
2115
2116 # The "millisleep" command is like "sleep" except that its argument is in
2117 # milliseconds, thus allowing for a subsecond sleep, which is, in fact, all it
2118 # is used for.
2119
2120 elsif (/^millisleep\s+(.*)$/)
2121   {
2122   select(undef, undef, undef, $1/1000);
2123   return 0;
2124   }
2125
2126
2127 # The "munge" command selects one of a hardwired set of test-result modifications
2128 # to be made before result compares are run agains the golden set.  This lets
2129 # us account for test-system dependent things which only affect a few, but known,
2130 # test-cases.
2131 # Currently only the last munge takes effect.
2132
2133 if (/^munge\s+(.*)$/)
2134   {
2135   return (0, { munge => $1 });
2136   }
2137
2138
2139 # The "sleep" command does just that. For sleeps longer than 1 second we
2140 # tell the user what's going on.
2141
2142 if (/^sleep\s+(.*)$/)
2143   {
2144   if ($1 == 1)
2145     {
2146     sleep(1);
2147     }
2148   else
2149     {
2150     printf("  Test %d sleep $1 ", $$subtestref);
2151     for (1..$1)
2152       {
2153       print ".";
2154       sleep(1);
2155       }
2156     printf("\r  Test %d                            $cr", $$subtestref);
2157     }
2158   return 0;
2159   }
2160
2161
2162 # Various Unix management commands are recognized
2163
2164 if (/^(ln|ls|du|mkdir|mkfifo|touch|cp|cat)\s/ ||
2165     /^sudo\s(rmdir|rm|mv|chown|chmod)\s/)
2166   {
2167   run_system("$_ >>test-stdout 2>>test-stderr");
2168   return 1;
2169   }
2170
2171
2172
2173 ###################
2174 ###################
2175
2176 # The next group of commands are also freestanding, but they are all followed
2177 # by data lines.
2178
2179
2180 # The "server" command starts up a script-driven server that runs in parallel
2181 # with the following exim command. Therefore, we want to run a subprocess and
2182 # not yet wait for it to complete. The waiting happens after the next exim
2183 # command, triggered by $server_pid being non-zero. The server sends its output
2184 # to a different file. The variable $server_opts, if not empty, contains
2185 # options to disable IPv4 or IPv6 if necessary.
2186 # This works because "server" swallows its stdin before waiting for a connection.
2187
2188 if (/^server\s+(.*)$/)
2189   {
2190   $pidfile = "$parm_cwd/aux-var/server-daemon.pid";
2191   $cmd = "./bin/server $server_opts -oP $pidfile $1 >>test-stdout-server";
2192   print ">> $cmd\n" if ($debug);
2193   $server_pid = open SERVERCMD, "|$cmd" || tests_exit(-1, "Failed to run $cmd");
2194   SERVERCMD->autoflush(1);
2195   print ">> Server pid is $server_pid\n" if $debug;
2196   while (<SCRIPT>)
2197     {
2198     $lineno++;
2199     last if /^\*{4}\s*$/;
2200     print SERVERCMD;
2201     }
2202   print SERVERCMD "++++\n"; # Send end to server; can't send EOF yet
2203                             # because close() waits for the process.
2204
2205   # Interlock the server startup; otherwise the next
2206   # process may not find it there when it expects it.
2207   while (! stat("$pidfile") ) { select(undef, undef, undef, 0.3); }
2208   return 3;
2209   }
2210
2211
2212 # The "write" command is a way of creating files of specific sizes for
2213 # buffering tests, or containing specific data lines from within the script
2214 # (rather than hold lots of little files). The "catwrite" command does the
2215 # same, but it also copies the lines to test-stdout.
2216
2217 if (/^(cat)?write\s+(\S+)(?:\s+(.*))?\s*$/)
2218   {
2219   my($cat) = defined $1;
2220   @sizes = ();
2221   @sizes = split /\s+/, $3 if defined $3;
2222   open FILE, ">$2" || tests_exit(-1, "Failed to open \"$2\": $!");
2223
2224   if ($cat)
2225     {
2226     open CAT, ">>test-stdout" ||
2227       tests_exit(-1, "Failed to open test-stdout: $!");
2228     print CAT "==========\n";
2229     }
2230
2231   if (scalar @sizes > 0)
2232     {
2233     # Pre-data
2234
2235     while (<SCRIPT>)
2236       {
2237       $lineno++;
2238       last if /^\+{4}\s*$/;
2239       print FILE;
2240       print CAT if $cat;
2241       }
2242
2243     # Sized data
2244
2245     while (scalar @sizes > 0)
2246       {
2247       ($count,$len,$leadin) = (shift @sizes) =~ /(\d+)x(\d+)(?:=(.*))?/;
2248       $leadin = '' if !defined $leadin;
2249       $leadin =~ s/_/ /g;
2250       $len -= length($leadin) + 1;
2251       while ($count-- > 0)
2252         {
2253         print FILE $leadin, "a" x $len, "\n";
2254         print CAT $leadin, "a" x $len, "\n" if $cat;
2255         }
2256       }
2257     }
2258
2259   # Post data, or only data if no sized data
2260
2261   while (<SCRIPT>)
2262     {
2263     $lineno++;
2264     last if /^\*{4}\s*$/;
2265     print FILE;
2266     print CAT if $cat;
2267     }
2268   close FILE;
2269
2270   if ($cat)
2271     {
2272     print CAT "==========\n";
2273     close CAT;
2274     }
2275
2276   return 0;
2277   }
2278
2279
2280 ###################
2281 ###################
2282
2283 # From this point on, script commands are implemented by setting up a shell
2284 # command in the variable $cmd. Shared code to run this command and handle its
2285 # input and output follows.
2286
2287 # The "client", "client-gnutls", and "client-ssl" commands run a script-driven
2288 # program that plays the part of an email client. We also have the availability
2289 # of running Perl for doing one-off special things. Note that all these
2290 # commands expect stdin data to be supplied.
2291
2292 if (/^client/ || /^(sudo\s+)?perl\b/)
2293   {
2294   s"client"./bin/client";
2295   $cmd = "$_ >>test-stdout 2>>test-stderr";
2296   }
2297
2298 # For the "exim" command, replace the text "exim" with the path for the test
2299 # binary, plus -D options to pass over various parameters, and a -C option for
2300 # the testing configuration file. When running in the test harness, Exim does
2301 # not drop privilege when -C and -D options are present. To run the exim
2302 # command as root, we use sudo.
2303
2304 elsif (/^((?i:[A-Z\d_]+=\S+\s+)+)?(\d+)?\s*(sudo(?:\s+-u\s+(\w+))?\s+)?exim(_\S+)?\s+(.*)$/)
2305   {
2306   $args = $6;
2307   my($envset) = (defined $1)? $1      : '';
2308   my($sudo)   = (defined $3)? "sudo " . (defined $4 ? "-u $4 ":'')  : '';
2309   my($special)= (defined $5)? $5      : '';
2310   $wait_time  = (defined $2)? $2      : 0;
2311
2312   # Return 2 rather than 1 afterwards
2313
2314   $yield = 2;
2315
2316   # Update the test number
2317
2318   $$subtestref = $$subtestref + 1;
2319   printf("  Test %d       $cr", $$subtestref);
2320
2321   # Copy the configuration file, making the usual substitutions.
2322
2323   open (IN, "$parm_cwd/confs/$testno") ||
2324     tests_exit(-1, "Couldn't open $parm_cwd/confs/$testno: $!\n");
2325   open (OUT, ">test-config") ||
2326     tests_exit(-1, "Couldn't open test-config: $!\n");
2327   while (<IN>)
2328     {
2329     do_substitute($testno);
2330     print OUT;
2331     }
2332   close(IN);
2333   close(OUT);
2334
2335   # The string $msg1 in args substitutes the message id of the first
2336   # message on the queue, and so on. */
2337
2338   if ($args =~ /\$msg/)
2339     {
2340     my @listcmd  = ("$parm_cwd/eximdir/exim", '-bp',
2341                    "-DEXIM_PATH=$parm_cwd/eximdir/exim",
2342                    -C => "$parm_cwd/test-config");
2343     print ">> Getting queue list from:\n>>    @listcmd\n" if $debug;
2344     # We need the message ids sorted in ascending order.
2345     # Message id is: <timestamp>-<pid>-<fractional-time>. On some systems (*BSD) the
2346     # PIDs are randomized, so sorting just the whole PID doesn't work.
2347     # We do the Schartz' transformation here (sort on
2348     # <timestamp><fractional-time>). Thanks to Kirill Miazine
2349     my @msglist =
2350       map { $_->[1] }                                   # extract the values
2351       sort { $a->[0] cmp $b->[0] }                      # sort by key
2352       map { [join('.' => (split /-/, $_)[0,2]) => $_] } # key (timestamp.fractional-time) => value(message_id)
2353       map { /^\s*\d+[smhdw]\s+\S+\s+(\S+)/ } `@listcmd` or tests_exit(-1, "No output from `exim -bp` (@listcmd)\n");
2354
2355     # Done backwards just in case there are more than 9
2356
2357     for (my $i = @msglist; $i > 0; $i--) { $args =~ s/\$msg$i/$msglist[$i-1]/g; }
2358     if ( $args =~ /\$msg\d/ )
2359       {
2360       tests_exit(-1, "Not enough messages in spool, for test $testno line $lineno\n")
2361         unless $force_continue;
2362       }
2363     }
2364
2365   # If -d is specified in $optargs, remove it from $args; i.e. let
2366   # the command line for runtest override. Then run Exim.
2367
2368   $args =~ s/(?:^|\s)-d\S*// if $optargs =~ /(?:^|\s)-d/;
2369
2370   my $opt_valgrind = $valgrind ? "valgrind --leak-check=yes --suppressions=$parm_cwd/aux-fixed/valgrind.supp " : '';
2371
2372   $cmd = "$envset$sudo$opt_valgrind" .
2373          "$parm_cwd/eximdir/exim$special$optargs " .
2374          "-DEXIM_PATH=$parm_cwd/eximdir/exim$special " .
2375          "-C $parm_cwd/test-config $args " .
2376          ">>test-stdout 2>>test-stderr";
2377   # If the command is starting an Exim daemon, we run it in the same
2378   # way as the "server" command above, that is, we don't want to wait
2379   # for the process to finish. That happens when "killdaemon" is obeyed later
2380   # in the script. We also send the stderr output to test-stderr-server. The
2381   # daemon has its log files put in a different place too (by configuring with
2382   # log_file_path). This requires the  directory to be set up in advance.
2383   #
2384   # There are also times when we want to run a non-daemon version of Exim
2385   # (e.g. a queue runner) with the server configuration. In this case,
2386   # we also define -DNOTDAEMON.
2387
2388   if ($cmd =~ /\s-DSERVER=server\s/ && $cmd !~ /\s-DNOTDAEMON\s/)
2389     {
2390     if ($debug) { printf ">> daemon: $cmd\n"; }
2391     run_system("sudo mkdir spool/log 2>/dev/null");
2392     run_system("sudo chown $parm_eximuser:$parm_eximgroup spool/log");
2393
2394     # Before running the command, convert the -bd option into -bdf so that an
2395     # Exim daemon doesn't double fork. This means that when we wait close
2396     # DAEMONCMD, it waits for the correct process. Also, ensure that the pid
2397     # file is written to the spool directory, in case the Exim binary was
2398     # built with PID_FILE_PATH pointing somewhere else.
2399
2400     if ($cmd =~ /\s-oP\s/)
2401       {
2402       ($pidfile = $cmd) =~ s/^.*-oP ([^ ]+).*$/$1/;
2403       $cmd =~ s!\s-bd\s! -bdf !;
2404       }
2405     else
2406       {
2407       $pidfile = "$parm_cwd/spool/exim-daemon.pid";
2408       $cmd =~ s!\s-bd\s! -bdf -oP $pidfile !;
2409       }
2410     print ">> |${cmd}-server\n" if ($debug);
2411     open DAEMONCMD, "|${cmd}-server" || tests_exit(-1, "Failed to run $cmd");
2412     DAEMONCMD->autoflush(1);
2413     while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; }   # Ignore any input
2414
2415     # Interlock with daemon startup
2416     for (my $count = 0; ! stat("$pidfile") && $count < 30; $count++ )
2417       { select(undef, undef, undef, 0.3); }
2418     return 3;                                     # Don't wait
2419     }
2420   elsif ($cmd =~ /\s-DSERVER=wait:(\d+)\s/)
2421     {
2422
2423     # The port and the $dynamic_socket was already allocated while parsing the
2424     # script file, where -DSERVER=wait:PORT_DYNAMIC was encountered.
2425
2426     my $listen_port = $1;
2427     if ($debug) { printf ">> wait-mode daemon: $cmd\n"; }
2428     run_system("sudo mkdir spool/log 2>/dev/null");
2429     run_system("sudo chown $parm_eximuser:$parm_eximgroup spool/log");
2430
2431     my $pid = fork();
2432     if (not defined $pid) { die "** fork failed: $!\n" }
2433     if (not $pid) {
2434       close(STDIN);
2435       open(STDIN, '<&', $dynamic_socket) or die "** dup sock to stdin failed: $!\n";
2436       close($dynamic_socket);
2437       print "[$$]>> ${cmd}-server\n" if ($debug);
2438       exec "exec ${cmd}-server";
2439       die "Can't exec ${cmd}-server: $!\n";
2440     }
2441     while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; }   # Ignore any input
2442     select(undef, undef, undef, 0.3);             # Let the daemon get going
2443     return (3, { exim_pid => $pid });             # Don't wait
2444     }
2445   }
2446
2447 # The "background" command is run but not waited-for, like exim -DSERVER=server.
2448 # One script line is read and fork-exec'd.  The PID is stored for a later
2449 # killdaemon.
2450
2451 elsif (/^background$/)
2452   {
2453   my $line;
2454 #  $pidfile = "$parm_cwd/aux-var/server-daemon.pid";
2455
2456   $_ = <SCRIPT>; $lineno++;
2457   chomp;
2458   do_substitute($testno);
2459   $line = $_;
2460   if ($debug) { printf ">> daemon: $line >>test-stdout 2>>test-stderr\n"; }
2461
2462   my $pid = fork();
2463   if (not defined $pid) { die "** fork failed: $!\n" }
2464   if (not $pid) {
2465     print "[$$]>> ${line}\n" if ($debug);
2466     close(STDIN);
2467     open(STDIN, "<", "test-stdout");
2468     close(STDOUT);
2469     open(STDOUT, ">>", "test-stdout");
2470     close(STDERR);
2471     open(STDERR, ">>", "test-stderr-server");
2472     exec "exec ${line}";
2473     exit(1);
2474   }
2475
2476 #  open(my $fh, ">", $pidfile) ||
2477 #      tests_exit(-1, "Failed to open $pidfile: $!");
2478 #  printf($fh, "%d\n", $pid);
2479 #  close($fh);
2480
2481   while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; }   # Ignore any input
2482   select(undef, undef, undef, 0.3);             # Let the daemon get going
2483   return (3, { exim_pid => $pid });             # Don't wait
2484   }
2485
2486
2487
2488 # Unknown command
2489
2490 else { tests_exit(-1, "Command unrecognized in line $lineno: $_"); }
2491
2492
2493 # Run the command, with stdin connected to a pipe, and write the stdin data
2494 # to it, with appropriate substitutions. If a line ends with \NONL\, chop off
2495 # the terminating newline (and the \NONL\). If the command contains
2496 # -DSERVER=server add "-server" to the command, where it will adjoin the name
2497 # for the stderr file. See comment above about the use of -DSERVER.
2498
2499 $stderrsuffix = ($cmd =~ /\s-DSERVER=server\s/)? "-server" : '';
2500 print ">> |${cmd}${stderrsuffix}\n" if ($debug);
2501 open CMD, "|${cmd}${stderrsuffix}" || tests_exit(1, "Failed to run $cmd");
2502
2503 CMD->autoflush(1);
2504 while (<SCRIPT>)
2505   {
2506   $lineno++;
2507   last if /^\*{4}\s*$/;
2508   do_substitute($testno);
2509   if (/^(.*)\\NONL\\\s*$/) { print CMD $1; } else { print CMD; }
2510   }
2511
2512 # For timeout tests, wait before closing the pipe; we expect a
2513 # SIGPIPE error in this case.
2514
2515 if ($wait_time > 0)
2516   {
2517   printf("  Test %d sleep $wait_time ", $$subtestref);
2518   while ($wait_time-- > 0)
2519     {
2520     print ".";
2521     sleep(1);
2522     }
2523   printf("\r  Test %d                                       $cr", $$subtestref);
2524   }
2525
2526 $sigpipehappened = 0;
2527 close CMD;                # Waits for command to finish
2528 return $yield;            # Ran command and waited
2529 }
2530
2531
2532
2533
2534 ###############################################################################
2535 ###############################################################################
2536
2537 # Here begins the Main Program ...
2538
2539 ###############################################################################
2540 ###############################################################################
2541
2542
2543 autoflush STDOUT 1;
2544 print "Exim tester $testversion\n";
2545
2546 # extend the PATH with .../sbin
2547 # we map all (.../bin) to (.../sbin:.../bin)
2548 $ENV{PATH} = do {
2549   my %seen = map { $_, 1 } split /:/, $ENV{PATH};
2550   join ':' => map { m{(.*)/bin$}
2551                 ? ( $seen{"$1/sbin"} ? () : ("$1/sbin"), $_)
2552                 : ($_) }
2553       split /:/, $ENV{PATH};
2554 };
2555
2556 ##################################################
2557 #      Some tests check created file modes       #
2558 ##################################################
2559
2560 umask 022;
2561
2562
2563 ##################################################
2564 #       Check for the "less" command             #
2565 ##################################################
2566
2567 $more = 'more' if system('which less >/dev/null 2>&1') != 0;
2568
2569
2570
2571 ##################################################
2572 #      See if an Exim binary has been given      #
2573 ##################################################
2574
2575 # If the first character of the first argument is '/', the argument is taken
2576 # as the path to the binary. If the first argument does not start with a
2577 # '/' but exists in the file system, it's assumed to be the Exim binary.
2578
2579
2580 ##################################################
2581 # Sort out options and which tests are to be run #
2582 ##################################################
2583
2584 # There are a few possible options for the test script itself; after these, any
2585 # options are passed on to Exim calls within the tests. Typically, this is used
2586 # to turn on Exim debugging while setting up a test.
2587
2588 Getopt::Long::Configure qw(no_getopt_compat);
2589 GetOptions(
2590     'debug'    => sub { $debug          = 1; $cr   = "\n" },
2591     'diff'     => sub { $cf             = 'diff -u' },
2592     'continue' => sub { $force_continue = 1; $more = 'cat' },
2593     'update'   => \$force_update,
2594     'ipv4!'    => \$have_ipv4,
2595     'ipv6!'    => \$have_ipv6,
2596     'keep'     => \$save_output,
2597     'slow'     => \$slow,
2598     'valgrind' => \$valgrind,
2599     'range=s{2}'       => \my @range_wanted,
2600     'test=i@'          => \my @tests_wanted,
2601     'flavor|flavour=s' => $flavour,
2602     'help'             => sub { pod2usage(-exit => 0) },
2603     'man'              => sub {
2604         pod2usage(
2605             -exit      => 0,
2606             -verbose   => 2,
2607             -noperldoc => system('perldoc -V 2>/dev/null 1>&2')
2608         );
2609     },
2610 ) or pod2usage;
2611
2612 ($parm_exim, @ARGV) = Exim::Runtest::exim_binary(@ARGV);
2613 print "Exim binary is `$parm_exim'\n" if defined $parm_exim;
2614
2615
2616 my @wanted = sort numerically uniq
2617   @tests_wanted ? @tests_wanted : (),
2618   @range_wanted ? $range_wanted[0] .. $range_wanted[1] : (),
2619   @ARGV ? @ARGV == 1 ? $ARGV[0] :
2620           $ARGV[1] eq '+' ? $ARGV[0]..($ARGV[0] >= 9000 ? TEST_SPECIAL_TOP : TEST_TOP) :
2621           0+$ARGV[0]..0+$ARGV[1]    # add 0 to cope with test numbers starting with zero
2622         : ();
2623 @wanted = 1..TEST_TOP if not @wanted;
2624
2625 ##################################################
2626 #        Check for sudo access to root           #
2627 ##################################################
2628
2629 print "You need to have sudo access to root to run these tests. Checking ...\n";
2630 if (system('sudo true >/dev/null') != 0)
2631   {
2632   die "** Test for sudo failed: testing abandoned.\n";
2633   }
2634 else
2635   {
2636   print "Test for sudo OK\n";
2637   }
2638
2639
2640
2641
2642 ##################################################
2643 #      Make the command's directory current      #
2644 ##################################################
2645
2646 # After doing so, we find its absolute path name.
2647
2648 $cwd = $0;
2649 $cwd = '.' if ($cwd !~ s|/[^/]+$||);
2650 chdir($cwd) || die "** Failed to chdir to \"$cwd\": $!\n";
2651 $parm_cwd = Cwd::getcwd();
2652
2653
2654 ##################################################
2655 #     Search for an Exim binary to test          #
2656 ##################################################
2657
2658 # If an Exim binary hasn't been provided, try to find one. We can handle the
2659 # case where exim-testsuite is installed alongside Exim source directories. For
2660 # PH's private convenience, if there's a directory just called "exim4", that
2661 # takes precedence; otherwise exim-snapshot takes precedence over any numbered
2662 # releases.
2663
2664 # If $parm_exim is still empty, ask the caller
2665
2666 if (not $parm_exim)
2667   {
2668   print "** Did not find an Exim binary to test\n";
2669   for ($i = 0; $i < 5; $i++)
2670     {
2671     my($trybin);
2672     print "** Enter pathname for Exim binary: ";
2673     chomp($trybin = <STDIN>);
2674     if (-e $trybin)
2675       {
2676       $parm_exim = $trybin;
2677       last;
2678       }
2679     else
2680       {
2681       print "** $trybin does not exist\n";
2682       }
2683     }
2684   die "** Too many tries\n" if $parm_exim eq '';
2685   }
2686
2687
2688
2689 ##################################################
2690 #          Find what is in the binary            #
2691 ##################################################
2692
2693 # deal with TRUSTED_CONFIG_LIST restrictions
2694 unlink("$parm_cwd/test-config") if -e "$parm_cwd/test-config";
2695 open (IN, "$parm_cwd/confs/0000") ||
2696   tests_exit(-1, "Couldn't open $parm_cwd/confs/0000: $!\n");
2697 open (OUT, ">test-config") ||
2698   tests_exit(-1, "Couldn't open test-config: $!\n");
2699 while (<IN>) { print OUT; }
2700 close(IN);
2701 close(OUT);
2702
2703 print("Probing with config file: $parm_cwd/test-config\n");
2704
2705 my $eximinfo = "$parm_exim -d -C $parm_cwd/test-config -DDIR=$parm_cwd -bP exim_user exim_group";
2706 chomp(my @eximinfo = `$eximinfo 2>&1`);
2707 die "$0: Can't run $eximinfo\n" if $? == -1;
2708
2709 warn 'Got ' . $?>>8 . " from $eximinfo\n" if $?;
2710 foreach (@eximinfo)
2711   {
2712   if (my ($version) = /^Exim version (\S+)/) {
2713     my $git = `git describe --dirty=-XX --match 'exim-4*'`;
2714     if (defined $git and $? == 0) {
2715       chomp $git;
2716       $version =~ s/^\d+\K\./_/;
2717       $git =~ s/^exim-//i;
2718       $git =~ s/.*-\Kg([[:xdigit:]]+(?:-XX)?)/$1/;
2719       print <<___
2720
2721 *** Version mismatch
2722 *** Exim binary: $version
2723 *** Git        : $git
2724
2725 ___
2726         if not $version eq $git;
2727     }
2728   }
2729   $parm_eximuser = $1 if /^exim_user = (.*)$/;
2730   $parm_eximgroup = $1 if /^exim_group = (.*)$/;
2731   $parm_trusted_config_list = $1 if /^TRUSTED_CONFIG_LIST:.*?"(.*?)"$/;
2732   ($parm_configure_owner, $parm_configure_group) = ($1, $2)
2733         if /^Configure owner:\s*(\d+):(\d+)/;
2734   print if /wrong owner/;
2735   }
2736
2737 if (not defined $parm_eximuser) {
2738   die <<XXX, map { "|$_\n" } @eximinfo;
2739 Unable to extract exim_user from binary.
2740 Check if Exim refused to run; if so, consider:
2741   TRUSTED_CONFIG_LIST ALT_CONFIG_PREFIX WHITELIST_D_MACROS
2742 If debug permission denied, are you in the exim group?
2743 Failing to get information from binary.
2744 Output from $eximinfo:
2745 XXX
2746
2747 }
2748
2749 if ($parm_eximuser =~ /^\d+$/) { $parm_exim_uid = $parm_eximuser; }
2750 else { $parm_exim_uid = getpwnam($parm_eximuser); }
2751
2752 if (defined $parm_eximgroup)
2753   {
2754   if ($parm_eximgroup =~ /^\d+$/) { $parm_exim_gid = $parm_eximgroup; }
2755     else { $parm_exim_gid = getgrnam($parm_eximgroup); }
2756   }
2757
2758 # check the permissions on the TRUSTED_CONFIG_LIST
2759 if (defined $parm_trusted_config_list)
2760   {
2761   die "TRUSTED_CONFIG_LIST: $parm_trusted_config_list: $!\n"
2762     if not -f $parm_trusted_config_list;
2763
2764   die "TRUSTED_CONFIG_LIST $parm_trusted_config_list must not be world writable!\n"
2765     if 02 & (stat _)[2];
2766
2767   die sprintf "TRUSTED_CONFIG_LIST: $parm_trusted_config_list %d is group writable, but not owned by group '%s' or '%s'.\n",
2768   (stat _)[1],
2769     scalar(getgrgid 0), scalar(getgrgid $>)
2770     if (020 & (stat _)[2]) and not ((stat _)[5] == $> or (stat _)[5] == 0);
2771
2772   die sprintf "TRUSTED_CONFIG_LIST: $parm_trusted_config_list is not owned by user '%s' or '%s'.\n",
2773   scalar(getpwuid 0), scalar(getpwuid $>)
2774      if (not (-o _ or (stat _)[4] == 0));
2775
2776   open(TCL, $parm_trusted_config_list) or die "Can't open $parm_trusted_config_list: $!\n";
2777   my $test_config = getcwd() . '/test-config';
2778   die "Can't find '$test_config' in TRUSTED_CONFIG_LIST $parm_trusted_config_list."
2779   if not grep { /^\Q$test_config\E$/ } <TCL>;
2780   }
2781 else
2782   {
2783   die "Unable to check the TRUSTED_CONFIG_LIST, seems to be empty?\n";
2784   }
2785
2786 die "CONFIGURE_OWNER ($parm_configure_owner) does not match the user invoking $0 ($>)\n"
2787         if $parm_configure_owner != $>;
2788
2789 die "CONFIGURE_GROUP ($parm_configure_group) does not match the group invoking $0 ($))\n"
2790         if 0020 & (stat "$parm_cwd/test-config")[2]
2791         and $parm_configure_group != $);
2792
2793 die "aux-fixed file is world-writeable; best to strip them all, recursively\n"
2794         if 0020 & (stat "aux-fixed/0037.f-1")[2];
2795
2796
2797 open(EXIMINFO, "$parm_exim -d-all+transport -bV -C $parm_cwd/test-config -DDIR=$parm_cwd |") ||
2798   die "** Cannot run $parm_exim: $!\n";
2799
2800 print "-" x 78, "\n";
2801
2802 while (<EXIMINFO>)
2803   {
2804   my(@temp);
2805
2806   if (/^(Exim|Library) version/) { print; }
2807   if (/Runtime: /) {print; }
2808
2809   elsif (/^Size of off_t: (\d+)/)
2810     {
2811     print;
2812     $have_largefiles = 1 if $1 > 4;
2813     die "** Size of off_t > 32 which seems improbable, not running tests\n"
2814         if ($1 > 32);
2815     }
2816
2817   elsif (/^Support for: (.*)/)
2818     {
2819     print;
2820     @temp = split /(\s+)/, $1;
2821     push(@temp, ' ');
2822     %parm_support = @temp;
2823     }
2824
2825   elsif (/^Lookups \(built-in\): (.*)/)
2826     {
2827     print;
2828     @temp = split /(\s+)/, $1;
2829     push(@temp, ' ');
2830     %parm_lookups = @temp;
2831     }
2832
2833   elsif (/^Authenticators: (.*)/)
2834     {
2835     print;
2836     @temp = split /(\s+)/, $1;
2837     push(@temp, ' ');
2838     %parm_authenticators = @temp;
2839     }
2840
2841   elsif (/^Routers: (.*)/)
2842     {
2843     print;
2844     @temp = split /(\s+)/, $1;
2845     push(@temp, ' ');
2846     %parm_routers = @temp;
2847     }
2848
2849   # Some transports have options, e.g. appendfile/maildir. For those, ensure
2850   # that the basic transport name is set, and then the name with each of the
2851   # options.
2852
2853   elsif (/^Transports: (.*)/)
2854     {
2855     print;
2856     @temp = split /(\s+)/, $1;
2857     my($i,$k);
2858     push(@temp, ' ');
2859     %parm_transports = @temp;
2860     foreach $k (keys %parm_transports)
2861       {
2862       if ($k =~ "/")
2863         {
2864         @temp = split /\//, $k;
2865         $parm_transports{$temp[0]} = " ";
2866         for ($i = 1; $i < @temp; $i++)
2867           { $parm_transports{"$temp[0]/$temp[$i]"} = " "; }
2868         }
2869       }
2870     }
2871
2872   elsif (/^Malware: (.*)/)
2873     {
2874     print;
2875     @temp = split /(\s+)/, $1;
2876     push(@temp, ' ');
2877     %parm_malware = @temp;
2878     }
2879
2880   }
2881 close(EXIMINFO);
2882 print "-" x 78, "\n";
2883
2884 unlink("$parm_cwd/test-config");
2885
2886 ##################################################
2887 #    Check for SpamAssassin and ClamAV           #
2888 ##################################################
2889
2890 # These are crude tests. If they aren't good enough, we'll have to improve
2891 # them, for example by actually passing a message through spamc or clamscan.
2892
2893 if (defined $parm_support{Content_Scanning})
2894   {
2895   my $sock = new FileHandle;
2896
2897   if (system("spamc -h 2>/dev/null >/dev/null") == 0)
2898     {
2899     print "The spamc command works:\n";
2900
2901     # This test for an active SpamAssassin is courtesy of John Jetmore.
2902     # The tests are hard coded to localhost:783, so no point in making
2903     # this test flexible like the clamav test until the test scripts are
2904     # changed.  spamd doesn't have the nice PING/PONG protocol that
2905     # clamd does, but it does respond to errors in an informative manner,
2906     # so use that.
2907
2908     my($sint,$sport) = ('127.0.0.1',783);
2909     eval
2910       {
2911       my $sin = sockaddr_in($sport, inet_aton($sint))
2912           or die "** Failed packing $sint:$sport\n";
2913       socket($sock, PF_INET, SOCK_STREAM, getprotobyname('tcp'))
2914           or die "** Unable to open socket $sint:$sport\n";
2915
2916       local $SIG{ALRM} =
2917           sub { die "** Timeout while connecting to socket $sint:$sport\n"; };
2918       alarm(5);
2919       connect($sock, $sin)
2920           or die "** Unable to connect to socket $sint:$sport\n";
2921       alarm(0);
2922
2923       select((select($sock), $| = 1)[0]);
2924       print $sock "bad command\r\n";
2925
2926       $SIG{ALRM} =
2927           sub { die "** Timeout while reading from socket $sint:$sport\n"; };
2928       alarm(10);
2929       my $res = <$sock>;
2930       alarm(0);
2931
2932       $res =~ m|^SPAMD/|
2933           or die "** Did not get SPAMD from socket $sint:$sport. "
2934                 ."It said: $res\n";
2935       };
2936     alarm(0);
2937     if($@)
2938       {
2939       print "  $@";
2940       print "  Assume SpamAssassin (spamd) is not running\n";
2941       }
2942     else
2943       {
2944       $parm_running{SpamAssassin} = ' ';
2945       print "  SpamAssassin (spamd) seems to be running\n";
2946       }
2947     }
2948   else
2949     {
2950     print "The spamc command failed: assume SpamAssassin (spamd) is not running\n";
2951     }
2952
2953   # For ClamAV, we need to find the clamd socket for use in the Exim
2954   # configuration. Search for the clamd configuration file.
2955
2956   if (system("clamscan -h 2>/dev/null >/dev/null") == 0)
2957     {
2958     my($f, $clamconf, $test_prefix);
2959
2960     print "The clamscan command works";
2961
2962     $test_prefix = $ENV{EXIM_TEST_PREFIX};
2963     $test_prefix = '' if !defined $test_prefix;
2964
2965     foreach $f ("$test_prefix/etc/clamd.conf",
2966                 "$test_prefix/usr/local/etc/clamd.conf",
2967                 "$test_prefix/etc/clamav/clamd.conf", '')
2968       {
2969       if (-e $f)
2970         {
2971         $clamconf = $f;
2972         last;
2973         }
2974       }
2975
2976     # Read the ClamAV configuration file and find the socket interface.
2977
2978     if ($clamconf ne '')
2979       {
2980       my $socket_domain;
2981       open(IN, "$clamconf") || die "\n** Unable to open $clamconf: $!\n";
2982       while (<IN>)
2983         {
2984         if (/^LocalSocket\s+(.*)/)
2985           {
2986           $parm_clamsocket = $1;
2987           $socket_domain = AF_UNIX;
2988           last;
2989           }
2990         if (/^TCPSocket\s+(\d+)/)
2991           {
2992           if (defined $parm_clamsocket)
2993             {
2994             $parm_clamsocket .= " $1";
2995             $socket_domain = AF_INET;
2996             last;
2997             }
2998           else
2999             {
3000             $parm_clamsocket = " $1";
3001             }
3002           }
3003         elsif (/^TCPAddr\s+(\S+)/)
3004           {
3005           if (defined $parm_clamsocket)
3006             {
3007             $parm_clamsocket = $1 . $parm_clamsocket;
3008             $socket_domain = AF_INET;
3009             last;
3010             }
3011           else
3012             {
3013             $parm_clamsocket = $1;
3014             }
3015           }
3016         }
3017       close(IN);
3018
3019       if (defined $socket_domain)
3020         {
3021         print ":\n  The clamd socket is $parm_clamsocket\n";
3022         # This test for an active ClamAV is courtesy of Daniel Tiefnig.
3023         eval
3024           {
3025           my $socket;
3026           if ($socket_domain == AF_UNIX)
3027             {
3028             $socket = sockaddr_un($parm_clamsocket) or die "** Failed packing '$parm_clamsocket'\n";
3029             }
3030           elsif ($socket_domain == AF_INET)
3031             {
3032             my ($ca_host, $ca_port) = split(/\s+/,$parm_clamsocket);
3033             my $ca_hostent = gethostbyname($ca_host) or die "** Failed to get raw address for host '$ca_host'\n";
3034             $socket = sockaddr_in($ca_port, $ca_hostent) or die "** Failed packing '$parm_clamsocket'\n";
3035             }
3036           else
3037             {
3038             die "** Unknown socket domain '$socket_domain' (should not happen)\n";
3039             }
3040           socket($sock, $socket_domain, SOCK_STREAM, 0) or die "** Unable to open socket '$parm_clamsocket'\n";
3041           local $SIG{ALRM} = sub { die "** Timeout while connecting to socket '$parm_clamsocket'\n"; };
3042           alarm(5);
3043           connect($sock, $socket) or die "** Unable to connect to socket '$parm_clamsocket'\n";
3044           alarm(0);
3045
3046           my $ofh = select $sock; $| = 1; select $ofh;
3047           print $sock "PING\n";
3048
3049           $SIG{ALRM} = sub { die "** Timeout while reading from socket '$parm_clamsocket'\n"; };
3050           alarm(10);
3051           my $res = <$sock>;
3052           alarm(0);
3053
3054           $res =~ /PONG/ or die "** Did not get PONG from socket '$parm_clamsocket'. It said: $res\n";
3055           };
3056         alarm(0);
3057
3058         if($@)
3059           {
3060           print "  $@";
3061           print "  Assume ClamAV is not running\n";
3062           }
3063         else
3064           {
3065           $parm_running{ClamAV} = ' ';
3066           print "  ClamAV seems to be running\n";
3067           }
3068         }
3069       else
3070         {
3071         print ", but the socket for clamd could not be determined\n";
3072         print "Assume ClamAV is not running\n";
3073         }
3074       }
3075
3076     else
3077       {
3078       print ", but I can't find a configuration for clamd\n";
3079       print "Assume ClamAV is not running\n";
3080       }
3081     }
3082   }
3083
3084
3085 ##################################################
3086 #       Check for redis                          #
3087 ##################################################
3088 if (defined $parm_lookups{redis})
3089   {
3090   if (system("redis-server -v 2>/dev/null >/dev/null") == 0)
3091     {
3092     print "The redis-server command works\n";
3093     $parm_running{redis} = ' ';
3094     }
3095   else
3096     {
3097     print "The redis-server command failed: assume Redis not installed\n";
3098     }
3099   }
3100
3101 ##################################################
3102 #         Test for the basic requirements        #
3103 ##################################################
3104
3105 # This test suite assumes that Exim has been built with at least the "usual"
3106 # set of routers, transports, and lookups. Ensure that this is so.
3107
3108 $missing = '';
3109
3110 $missing .= "     Lookup: lsearch\n" if (!defined $parm_lookups{lsearch});
3111
3112 $missing .= "     Router: accept\n" if (!defined $parm_routers{accept});
3113 $missing .= "     Router: dnslookup\n" if (!defined $parm_routers{dnslookup});
3114 $missing .= "     Router: manualroute\n" if (!defined $parm_routers{manualroute});
3115 $missing .= "     Router: redirect\n" if (!defined $parm_routers{redirect});
3116
3117 $missing .= "     Transport: appendfile\n" if (!defined $parm_transports{appendfile});
3118 $missing .= "     Transport: autoreply\n" if (!defined $parm_transports{autoreply});
3119 $missing .= "     Transport: pipe\n" if (!defined $parm_transports{pipe});
3120 $missing .= "     Transport: smtp\n" if (!defined $parm_transports{smtp});
3121
3122 if ($missing ne '')
3123   {
3124   print "\n";
3125   print "** Many features can be included or excluded from Exim binaries.\n";
3126   print "** This test suite requires that Exim is built to contain a certain\n";
3127   print "** set of basic facilities. It seems that some of these are missing\n";
3128   print "** from the binary that is under test, so the test cannot proceed.\n";
3129   print "** The missing facilities are:\n";
3130   print "$missing";
3131   die "** Test script abandoned\n";
3132   }
3133
3134
3135 ##################################################
3136 #      Check for the auxiliary programs          #
3137 ##################################################
3138
3139 # These are always required:
3140
3141 for $prog ("cf", "checkaccess", "client", "client-ssl", "client-gnutls",
3142            "fakens", "iefbr14", "server")
3143   {
3144   next if ($prog eq "client-ssl" && !defined $parm_support{OpenSSL});
3145   next if ($prog eq "client-gnutls" && !defined $parm_support{GnuTLS});
3146   if (!-e "bin/$prog")
3147     {
3148     print "\n";
3149     print "** bin/$prog does not exist. Have you run ./configure and make?\n";
3150     die "** Test script abandoned\n";
3151     }
3152   }
3153
3154 # If the "loaded" binary is missing, we cut out tests for ${dlfunc. It isn't
3155 # compiled on systems where we don't know how to. However, if Exim does not
3156 # have that functionality compiled, we needn't bother.
3157
3158 $dlfunc_deleted = 0;
3159 if (defined $parm_support{Expand_dlfunc} && !-e 'bin/loaded')
3160   {
3161   delete $parm_support{Expand_dlfunc};
3162   $dlfunc_deleted = 1;
3163   }
3164
3165
3166 ##################################################
3167 #          Find environmental details            #
3168 ##################################################
3169
3170 # Find the caller of this program.
3171
3172 ($parm_caller,$pwpw,$parm_caller_uid,$parm_caller_gid,$pwquota,$pwcomm,
3173  $parm_caller_gecos, $parm_caller_home) = getpwuid($>);
3174
3175 $pwpw = $pwpw;       # Kill Perl warnings
3176 $pwquota = $pwquota;
3177 $pwcomm = $pwcomm;
3178
3179 $parm_caller_group = getgrgid($parm_caller_gid);
3180
3181 print "Program caller is $parm_caller ($parm_caller_uid), whose group is $parm_caller_group ($parm_caller_gid)\n";
3182 print "Home directory is $parm_caller_home\n";
3183
3184 unless (defined $parm_eximgroup)
3185   {
3186   print "Unable to derive \$parm_eximgroup.\n";
3187   die "** ABANDONING.\n";
3188   }
3189
3190 if ($parm_caller_home eq $parm_cwd)
3191   {
3192   print "will confuse working dir with homedir; change homedir\n";
3193   die "** ABANDONING.\n";
3194   }
3195
3196 print "You need to be in the Exim group to run these tests. Checking ...";
3197
3198 if (`groups` =~ /\b\Q$parm_eximgroup\E\b/)
3199   {
3200   print " OK\n";
3201   }
3202 else
3203   {
3204   print "\nOh dear, you are not in the Exim group.\n";
3205   die "** Testing abandoned.\n";
3206   }
3207
3208 # Find this host's IP addresses - there may be many, of course, but we keep
3209 # one of each type (IPv4 and IPv6).
3210
3211 open(IFCONFIG, '-|', (grep { -x "$_/ip" } split /:/, $ENV{PATH}) ? 'ip address' : 'ifconfig -a')
3212   or die "** Cannot run 'ip address' or 'ifconfig -a'\n";
3213 while (not ($parm_ipv4 and $parm_ipv6) and defined($_ = <IFCONFIG>))
3214   {
3215   if (not $parm_ipv4 and /^\s*inet(?:\saddr)?:?\s?(\d+\.\d+\.\d+\.\d+)(?:\/\d+)?\s/i)
3216     {
3217     next if $1 =~ /^(?:127|10)\./;
3218     $parm_ipv4 = $1;
3219     }
3220
3221   if (not $parm_ipv6 and /^\s*inet6(?:\saddr)?:?\s?([abcdef\d:]+)(?:\/\d+)/i)
3222     {
3223     next if $1 eq '::1' or $1 =~ /^fe80/i;
3224     $parm_ipv6 = $1;
3225     }
3226   }
3227 close(IFCONFIG);
3228
3229 # Use private IP addresses if there are no public ones.
3230
3231 # If either type of IP address is missing, we need to set the value to
3232 # something other than empty, because that wrecks the substitutions. The value
3233 # is reflected, so use a meaningful string. Set appropriate options for the
3234 # "server" command. In practice, however, many tests assume 127.0.0.1 is
3235 # available, so things will go wrong if there is no IPv4 address. The lack
3236 # of IPV4 or IPv6 can be simulated by command options, which force $have_ipv4
3237 # and $have_ipv6 false.
3238
3239 if (not $parm_ipv4)
3240   {
3241   $have_ipv4 = 0;
3242   $parm_ipv4 = "<no IPv4 address found>";
3243   $server_opts .= " -noipv4";
3244   }
3245 elsif ($have_ipv4 == 0)
3246   {
3247   $parm_ipv4 = "<IPv4 testing disabled>";
3248   $server_opts .= " -noipv4";
3249   }
3250 else
3251   {
3252   $parm_running{IPv4} = " ";
3253   }
3254
3255 if (not $parm_ipv6)
3256   {
3257   $have_ipv6 = 0;
3258   $parm_ipv6 = "<no IPv6 address found>";
3259   $server_opts .= " -noipv6";
3260   delete($parm_support{IPv6});
3261   }
3262 elsif ($have_ipv6 == 0)
3263   {
3264   $parm_ipv6 = "<IPv6 testing disabled>";
3265   $server_opts .= " -noipv6";
3266   delete($parm_support{IPv6});
3267   }
3268 elsif (!defined $parm_support{IPv6})
3269   {
3270   $have_ipv6 = 0;
3271   $parm_ipv6 = "<no IPv6 support in Exim binary>";
3272   $server_opts .= " -noipv6";
3273   }
3274 else
3275   {
3276   $parm_running{IPv6} = " ";
3277   }
3278
3279 print "IPv4 address is $parm_ipv4\n";
3280 print "IPv6 address is $parm_ipv6\n";
3281
3282 # For munging test output, we need the reversed IP addresses.
3283
3284 $parm_ipv4r = ($parm_ipv4 !~ /^\d/)? '' :
3285   join(".", reverse(split /\./, $parm_ipv4));
3286
3287 $parm_ipv6r = $parm_ipv6;             # Appropriate if not in use
3288 if ($parm_ipv6 =~ /^[\da-f]/)
3289   {
3290   my(@comps) = split /:/, $parm_ipv6;
3291   my(@nibbles);
3292   foreach $comp (@comps)
3293     {
3294     push @nibbles, sprintf("%lx", hex($comp) >> 8);
3295     push @nibbles, sprintf("%lx", hex($comp) & 0xff);
3296     }
3297   $parm_ipv6r = join(".", reverse(@nibbles));
3298   }
3299
3300 # Find the host name, fully qualified.
3301
3302 chomp($temp = `hostname`);
3303 die "'hostname' didn't return anything\n" unless defined $temp and length $temp;
3304 if ($temp =~ /\./)
3305   {
3306   $parm_hostname = $temp;
3307   }
3308 else
3309   {
3310   $parm_hostname = (gethostbyname($temp))[0];
3311   $parm_hostname = "no.host.name.found" unless defined $parm_hostname and length $parm_hostname;
3312   }
3313 print "Hostname is $parm_hostname\n";
3314
3315 if ($parm_hostname !~ /\./)
3316   {
3317   print "\n*** Host name is not fully qualified: this may cause problems ***\n\n";
3318   }
3319
3320 if ($parm_hostname =~ /[[:upper:]]/)
3321   {
3322   print "\n*** Host name has upper case characters: this may cause problems ***\n\n";
3323   }
3324
3325
3326
3327 ##################################################
3328 #     Create a testing version of Exim           #
3329 ##################################################
3330
3331 # We want to be able to run Exim with a variety of configurations. Normally,
3332 # the use of -C to change configuration causes Exim to give up its root
3333 # privilege (unless the caller is exim or root). For these tests, we do not
3334 # want this to happen. Also, we want Exim to know that it is running in its
3335 # test harness.
3336
3337 # We achieve this by copying the binary and patching it as we go. The new
3338 # binary knows it is a testing copy, and it allows -C and -D without loss of
3339 # privilege. Clearly, this file is dangerous to have lying around on systems
3340 # where there are general users with login accounts. To protect against this,
3341 # we put the new binary in a special directory that is accessible only to the
3342 # caller of this script, who is known to have sudo root privilege from the test
3343 # that was done above. Furthermore, we ensure that the binary is deleted at the
3344 # end of the test. First ensure the directory exists.
3345
3346 if (-d "eximdir")
3347   { unlink "eximdir/exim"; }     # Just in case
3348 else
3349   {
3350   mkdir("eximdir", 0710) || die "** Unable to mkdir $parm_cwd/eximdir: $!\n";
3351   system("sudo chgrp $parm_eximgroup eximdir");
3352   }
3353
3354 # The construction of the patched binary must be done as root, so we use
3355 # a separate script. As well as indicating that this is a test-harness binary,
3356 # the version number is patched to "x.yz" so that its length is always the
3357 # same. Otherwise, when it appears in Received: headers, it affects the length
3358 # of the message, which breaks certain comparisons.
3359
3360 die "** Unable to make patched exim: $!\n"
3361   if (system("sudo ./patchexim $parm_exim") != 0);
3362
3363 # From this point on, exits from the program must go via the subroutine
3364 # tests_exit(), so that suitable cleaning up can be done when required.
3365 # Arrange to catch interrupting signals, to assist with this.
3366
3367 $SIG{INT} = \&inthandler;
3368 $SIG{PIPE} = \&pipehandler;
3369
3370 # For some tests, we need another copy of the binary that is setuid exim rather
3371 # than root.
3372
3373 system("sudo cp eximdir/exim eximdir/exim_exim;" .
3374        "sudo chown $parm_eximuser eximdir/exim_exim;" .
3375        "sudo chgrp $parm_eximgroup eximdir/exim_exim;" .
3376        "sudo chmod 06755 eximdir/exim_exim");
3377
3378 ##################################################
3379 #     Make copies of utilities we might need     #
3380 ##################################################
3381
3382 # Certain of the tests make use of some of Exim's utilities. We do not need
3383 # to be root to copy these.
3384
3385 ($parm_exim_dir) = $parm_exim =~ m?^(.*)/exim?;
3386
3387 $dbm_build_deleted = 0;
3388 if (defined $parm_lookups{dbm} &&
3389     system("cp $parm_exim_dir/exim_dbmbuild eximdir") != 0)
3390   {
3391   delete $parm_lookups{dbm};
3392   $dbm_build_deleted = 1;
3393   }
3394
3395 if (system("cp $parm_exim_dir/exim_dumpdb eximdir") != 0)
3396   {
3397   tests_exit(-1, "Failed to make a copy of exim_dumpdb: $!");
3398   }
3399
3400 if (system("cp $parm_exim_dir/exim_lock eximdir") != 0)
3401   {
3402   tests_exit(-1, "Failed to make a copy of exim_lock: $!");
3403   }
3404
3405 if (system("cp $parm_exim_dir/exinext eximdir") != 0)
3406   {
3407   tests_exit(-1, "Failed to make a copy of exinext: $!");
3408   }
3409
3410 if (system("cp $parm_exim_dir/exigrep eximdir") != 0)
3411   {
3412   tests_exit(-1, "Failed to make a copy of exigrep: $!");
3413   }
3414
3415 if (system("cp $parm_exim_dir/eximstats eximdir") != 0)
3416   {
3417   tests_exit(-1, "Failed to make a copy of eximstats: $!");
3418   }
3419
3420 # Collect some version information
3421 print '-' x 78, "\n";
3422 print "Perl version for runtest: $]\n";
3423 foreach (map { "./eximdir/$_" } qw(exigrep exinext eximstats)) {
3424   # fold (or unfold?) multiline output into a one-liner
3425   print join(', ', map { chomp; $_ } `$_ --version`), "\n";
3426 }
3427 print '-' x 78, "\n";
3428
3429
3430 ##################################################
3431 #    Check that the Exim user can access stuff   #
3432 ##################################################
3433
3434 # We delay this test till here so that we can check access to the actual test
3435 # binary. This will be needed when Exim re-exec's itself to do deliveries.
3436
3437 print "Exim user is $parm_eximuser ($parm_exim_uid)\n";
3438 print "Exim group is $parm_eximgroup ($parm_exim_gid)\n";
3439
3440 if ($parm_caller_uid eq $parm_exim_uid) {
3441   tests_exit(-1, "Exim user ($parm_eximuser,$parm_exim_uid) cannot be "
3442                 ."the same as caller ($parm_caller,$parm_caller_uid)");
3443 }
3444 if ($parm_caller_gid eq $parm_exim_gid) {
3445   tests_exit(-1, "Exim group ($parm_eximgroup,$parm_exim_gid) cannot be "
3446                 ."the same as caller's ($parm_caller) group as it confuses "
3447                 ."results analysis");
3448 }
3449
3450 print "The Exim user needs access to the test suite directory. Checking ...";
3451
3452 if (($rc = system("sudo bin/checkaccess $parm_cwd/eximdir/exim $parm_eximuser $parm_eximgroup")) != 0)
3453   {
3454   my($why) = "unknown failure $rc";
3455   $rc >>= 8;
3456   $why = "Couldn't find user \"$parm_eximuser\"" if $rc == 1;
3457   $why = "Couldn't find group \"$parm_eximgroup\"" if $rc == 2;
3458   $why = "Couldn't read auxiliary group list" if $rc == 3;
3459   $why = "Couldn't get rid of auxiliary groups" if $rc == 4;
3460   $why = "Couldn't set gid" if $rc == 5;
3461   $why = "Couldn't set uid" if $rc == 6;
3462   $why = "Couldn't open \"$parm_cwd/eximdir/exim\"" if $rc == 7;
3463   print "\n** $why\n";
3464   tests_exit(-1, "$parm_eximuser cannot access the test suite directory");
3465   }
3466 else
3467   {
3468   print " OK\n";
3469   }
3470
3471 tests_exit(-1, "Failed to unlink $log_summary_filename: $!")
3472   if not unlink($log_summary_filename) and -e $log_summary_filename;
3473
3474 ##################################################
3475 #        Create a list of available tests        #
3476 ##################################################
3477
3478 # The scripts directory contains a number of subdirectories whose names are
3479 # of the form 0000-xxxx, 1100-xxxx, 2000-xxxx, etc. Each set of tests apart
3480 # from the first requires certain optional features to be included in the Exim
3481 # binary. These requirements are contained in a file called "REQUIRES" within
3482 # the directory. We scan all these tests, discarding those that cannot be run
3483 # because the current binary does not support the right facilities, and also
3484 # those that are outside the numerical range selected.
3485
3486 printf "\nWill run %d tests between %d and %d for flavour %s\n",
3487   scalar(@wanted), $wanted[0], $wanted[-1], $flavour;
3488
3489 print "Omitting \${dlfunc expansion tests (loadable module not present)\n"
3490   if $dlfunc_deleted;
3491 print "Omitting dbm tests (unable to copy exim_dbmbuild)\n"
3492   if $dbm_build_deleted;
3493
3494
3495 my @test_dirs = grep { not /^CVS$/ } map { basename $_ } glob 'scripts/*'
3496   or die tests_exit(-1, "Failed to find test scripts in 'scripts/*`: $!");
3497
3498 # Scan for relevant tests
3499 # HS12: Needs to be reworked.
3500 DIR: for (my $i = 0; $i < @test_dirs; $i++)
3501   {
3502   my($testdir) = $test_dirs[$i];
3503   my($wantthis) = 1;
3504
3505   print ">>Checking $testdir\n" if $debug;
3506
3507   # Skip this directory if the first test is equal or greater than the first
3508   # test in the next directory.
3509
3510   next DIR if ($i < @test_dirs - 1) &&
3511           ($wanted[0] >= substr($test_dirs[$i+1], 0, 4));
3512
3513   # No need to carry on if the end test is less than the first test in this
3514   # subdirectory.
3515
3516   last DIR if $wanted[-1] < substr($testdir, 0, 4);
3517
3518   # Check requirements, if any.
3519
3520   if (open(my $requires, "scripts/$testdir/REQUIRES"))
3521     {
3522     while (<$requires>)
3523       {
3524       next if /^\s*$/;
3525       s/\s+$//;
3526       if (/^support (.*)$/)
3527         {
3528         if (!defined $parm_support{$1}) { $wantthis = 0; last; }
3529         }
3530       elsif (/^running (.*)$/)
3531         {
3532         if (!defined $parm_running{$1}) { $wantthis = 0; last; }
3533         }
3534       elsif (/^lookup (.*)$/)
3535         {
3536         if (!defined $parm_lookups{$1}) { $wantthis = 0; last; }
3537         }
3538       elsif (/^authenticators? (.*)$/)
3539         {
3540         if (!defined $parm_authenticators{$1}) { $wantthis = 0; last; }
3541         }
3542       elsif (/^router (.*)$/)
3543         {
3544         if (!defined $parm_routers{$1}) { $wantthis = 0; last; }
3545         }
3546       elsif (/^transport (.*)$/)
3547         {
3548         if (!defined $parm_transports{$1}) { $wantthis = 0; last; }
3549         }
3550       elsif (/^malware (.*)$/)
3551         {
3552         if (!defined $parm_malware{$1}) { $wantthis = 0; last; }
3553         }
3554       elsif (/^feature (.*)$/)
3555         {
3556         # move to a subroutine?
3557         my $eximinfo = "$parm_exim -C $parm_cwd/test-config -DDIR=$parm_cwd -bP macro $1";
3558
3559         open (IN, "$parm_cwd/confs/0000") ||
3560           tests_exit(-1, "Couldn't open $parm_cwd/confs/0000: $!\n");
3561         open (OUT, ">test-config") ||
3562           tests_exit(-1, "Couldn't open test-config: $!\n");
3563         while (<IN>)
3564           {
3565           do_substitute($testno);
3566           print OUT;
3567           }
3568         close(IN);
3569         close(OUT);
3570
3571         system($eximinfo . " >/dev/null 2>&1");
3572         if ($? != 0) {
3573           unlink("$parm_cwd/test-config");
3574           $wantthis = 0;
3575           $_ = "feature $1";
3576           last;
3577         }
3578         unlink("$parm_cwd/test-config");
3579         }
3580       else
3581         {
3582         tests_exit(-1, "Unknown line in \"scripts/$testdir/REQUIRES\": \"$_\"");
3583         }
3584       }
3585     }
3586   else
3587     {
3588     tests_exit(-1, "Failed to open \"scripts/$testdir/REQUIRES\": $!")
3589       unless $!{ENOENT};
3590     }
3591
3592   # Loop if we do not want the tests in this subdirectory.
3593
3594   if (!$wantthis)
3595     {
3596     chomp;
3597     print "Omitting tests in $testdir (missing $_)\n";
3598     }
3599
3600   # We want the tests from this subdirectory, provided they are in the
3601   # range that was selected.
3602
3603   @testlist = grep { $_ ~~ @wanted } grep { /^\d+(?:\.\d+)?$/ } map { basename $_ } glob "scripts/$testdir/*";
3604   tests_exit(-1, "Failed to read test scripts from `scripts/$testdir/*': $!")
3605     if not @testlist;
3606
3607   foreach $test (@testlist)
3608     {
3609     if (!$wantthis)
3610       {
3611       log_test($log_summary_filename, $test, '.');
3612       }
3613     else
3614       {
3615       push @test_list, "$testdir/$test";
3616       }
3617     }
3618   }
3619
3620 print ">>Test List:\n", join "\n", @test_list, '' if $debug;
3621
3622
3623 ##################################################
3624 #         Munge variable auxiliary data          #
3625 ##################################################
3626
3627 # Some of the auxiliary data files have to refer to the current testing
3628 # directory and other parameter data. The generic versions of these files are
3629 # stored in the aux-var-src directory. At this point, we copy each of them
3630 # to the aux-var directory, making appropriate substitutions. There aren't very
3631 # many of them, so it's easiest just to do this every time. Ensure the mode
3632 # is standardized, as this path is used as a test for the ${stat: expansion.
3633
3634 # A similar job has to be done for the files in the dnszones-src directory, to
3635 # make the fake DNS zones for testing. Most of the zone files are copied to
3636 # files of the same name, but db.ipv4.V4NET and db.ipv6.V6NET use the testing
3637 # networks that are defined by parameter.
3638
3639 foreach $basedir ("aux-var", "dnszones")
3640   {
3641   system("sudo rm -rf $parm_cwd/$basedir");
3642   mkdir("$parm_cwd/$basedir", 0777);
3643   chmod(0755, "$parm_cwd/$basedir");
3644
3645   opendir(AUX, "$parm_cwd/$basedir-src") ||
3646     tests_exit(-1, "Failed to opendir $parm_cwd/$basedir-src: $!");
3647   my(@filelist) = readdir(AUX);
3648   close(AUX);
3649
3650   foreach $file (@filelist)
3651     {
3652     my($outfile) = $file;
3653     next if $file =~ /^\./;
3654
3655     if ($file eq "db.ip4.V4NET")
3656       {
3657       $outfile = "db.ip4.$parm_ipv4_test_net";
3658       }
3659     elsif ($file eq "db.ip6.V6NET")
3660       {
3661       my(@nibbles) = reverse(split /\s*/, $parm_ipv6_test_net);
3662       $" = '.';
3663       $outfile = "db.ip6.@nibbles";
3664       $" = ' ';
3665       }
3666
3667     print ">>Copying $basedir-src/$file to $basedir/$outfile\n" if $debug;
3668     open(IN, "$parm_cwd/$basedir-src/$file") ||
3669       tests_exit(-1, "Failed to open $parm_cwd/$basedir-src/$file: $!");
3670     open(OUT, ">$parm_cwd/$basedir/$outfile") ||
3671       tests_exit(-1, "Failed to open $parm_cwd/$basedir/$outfile: $!");
3672     while (<IN>)
3673       {
3674       do_substitute(0);
3675       print OUT;
3676       }
3677     close(IN);
3678     close(OUT);
3679     }
3680   }
3681
3682 # Set a user's shell, distinguishable from /bin/sh
3683
3684 symlink('/bin/sh' => 'aux-var/sh');
3685 $ENV{SHELL} = $parm_shell = "$parm_cwd/aux-var/sh";
3686
3687 ##################################################
3688 #     Create fake DNS zones for this host        #
3689 ##################################################
3690
3691 # There are fixed zone files for 127.0.0.1 and ::1, but we also want to be
3692 # sure that there are forward and reverse registrations for this host, using
3693 # its real IP addresses. Dynamically created zone files achieve this.
3694
3695 if ($have_ipv4 || $have_ipv6)
3696   {
3697   my($shortname,$domain) = $parm_hostname =~ /^([^.]+)(.*)/;
3698   open(OUT, ">$parm_cwd/dnszones/db$domain") ||
3699     tests_exit(-1, "Failed to open $parm_cwd/dnszones/db$domain: $!");
3700   print OUT "; This is a dynamically constructed fake zone file.\n" .
3701     "; The following line causes fakens to return PASS_ON\n" .
3702     "; for queries that it cannot answer\n\n" .
3703     "PASS ON NOT FOUND\n\n";
3704   print OUT "$shortname  A     $parm_ipv4\n" if $have_ipv4;
3705   print OUT "$shortname  AAAA  $parm_ipv6\n" if $have_ipv6;
3706   print OUT "\n; End\n";
3707   close(OUT);
3708   }
3709
3710 if ($have_ipv4 && $parm_ipv4 ne "127.0.0.1")
3711   {
3712   my(@components) = $parm_ipv4 =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)/;
3713   open(OUT, ">$parm_cwd/dnszones/db.ip4.$components[0]") ||
3714     tests_exit(-1,
3715       "Failed  to open $parm_cwd/dnszones/db.ip4.$components[0]: $!");
3716   print OUT "; This is a dynamically constructed fake zone file.\n" .
3717     "; The zone is $components[0].in-addr.arpa.\n\n" .
3718     "$components[3].$components[2].$components[1]  PTR  $parm_hostname.\n\n" .
3719     "; End\n";
3720   close(OUT);
3721   }
3722
3723 if ($have_ipv6 && $parm_ipv6 ne "::1")
3724   {
3725   my($exp_v6) = $parm_ipv6;
3726   $exp_v6 =~ s/[^:]//g;
3727   if ( $parm_ipv6 =~ /^([^:].+)::$/ ) {
3728     $exp_v6 = $1 . ':0' x (9-length($exp_v6));
3729   } elsif ( $parm_ipv6 =~ /^(.+)::(.+)$/ ) {
3730     $exp_v6 = $1 . ':0' x (8-length($exp_v6)) . ':' . $2;
3731   } elsif ( $parm_ipv6 =~ /^::(.+[^:])$/ ) {
3732     $exp_v6 = '0:' x (9-length($exp_v6)) . $1;
3733   } else {
3734     $exp_v6 = $parm_ipv6;
3735   }
3736   my(@components) = split /:/, $exp_v6;
3737   my(@nibbles) = reverse (split /\s*/, shift @components);
3738   my($sep) =  '';
3739
3740   $" = ".";
3741   open(OUT, ">$parm_cwd/dnszones/db.ip6.@nibbles") ||
3742     tests_exit(-1,
3743       "Failed  to open $parm_cwd/dnszones/db.ip6.@nibbles: $!");
3744   print OUT "; This is a dynamically constructed fake zone file.\n" .
3745     "; The zone is @nibbles.ip6.arpa.\n\n";
3746
3747   @components = reverse @components;
3748   foreach $c (@components)
3749     {
3750     $c = "0$c" until $c =~ /^..../;
3751     @nibbles = reverse(split /\s*/, $c);
3752     print OUT "$sep@nibbles";
3753     $sep = ".";
3754     }
3755
3756   print OUT "  PTR  $parm_hostname.\n\n; End\n";
3757   close(OUT);
3758   $" = " ";
3759   }
3760
3761
3762
3763 ##################################################
3764 #    Create lists of mailboxes and message logs  #
3765 ##################################################
3766
3767 # We use these lists to check that a test has created the expected files. It
3768 # should be faster than looking for the file each time. For mailboxes, we have
3769 # to scan a complete subtree, in order to handle maildirs. For msglogs, there
3770 # is just a flat list of files.
3771
3772 @oldmails = list_files_below("mail");
3773 opendir(DIR, "msglog") || tests_exit(-1, "Failed to opendir msglog: $!");
3774 @oldmsglogs = readdir(DIR);
3775 closedir(DIR);
3776
3777
3778
3779 ##################################################
3780 #         Run the required tests                 #
3781 ##################################################
3782
3783 # Each test script contains a number of tests, separated by a line that
3784 # contains ****. We open input from the terminal so that we can read responses
3785 # to prompts.
3786
3787 if (not $force_continue) {
3788   # runtest needs to interact if we're not in continue
3789   # mode. It does so by communicate to /dev/tty
3790   open(T, '<', '/dev/tty') or tests_exit(-1, "Failed to open /dev/tty: $!");
3791   print "\nPress RETURN to run the tests: ";
3792   <T>;
3793 }
3794
3795
3796 foreach $test (@test_list)
3797   {
3798   state $lasttestdir = '';
3799
3800   local $lineno     = 0;
3801   local $commandno  = 0;
3802   local $subtestno  = 0;
3803   local $sortlog    = 0;
3804
3805   (local $testno = $test) =~ s|.*/||;
3806
3807   # Leaving traces in the process table and in the environment
3808   # gives us a chance to identify hanging processes (exim daemons)
3809   local $0 = "[runtest $testno]";
3810   local $ENV{EXIM_TEST_NUMBER} = $testno;
3811
3812   my $gnutls   = 0;
3813   my $docheck  = 1;
3814   my $thistestdir  = substr($test, 0, -5);
3815
3816   $dynamic_socket->close() if $dynamic_socket;
3817
3818   if ($lasttestdir ne $thistestdir)
3819     {
3820     $gnutls = 0;
3821     if (-s "scripts/$thistestdir/REQUIRES")
3822       {
3823       my $indent = '';
3824       print "\n>>> The following tests require: ";
3825       open(my $requires, '<', "scripts/$thistestdir/REQUIRES") ||
3826         tests_exit(-1, "Failed to open scripts/$thistestdir/REQUIRES: $!");
3827       while (<$requires>)
3828         {
3829         $gnutls = 1 if /^support GnuTLS/;
3830         print $indent, $_;
3831         $indent = ">>>                              ";
3832         }
3833       }
3834       $lasttestdir = $thistestdir;
3835     }
3836
3837   # Remove any debris in the spool directory and the test-mail directory
3838   # and also the files for collecting stdout and stderr. Then put back
3839   # the test-mail directory for appendfile deliveries.
3840
3841   system "sudo /bin/rm -rf spool test-*";
3842   system "mkdir test-mail 2>/dev/null";
3843
3844   # A privileged Exim will normally make its own spool directory, but some of
3845   # the tests run in unprivileged modes that don't always work if the spool
3846   # directory isn't already there. What is more, we want anybody to be able
3847   # to read it in order to find the daemon's pid.
3848
3849   system "mkdir spool; " .
3850          "sudo chown $parm_eximuser:$parm_eximgroup spool; " .
3851          "sudo chmod 0755 spool";
3852
3853   # Empty the cache that keeps track of things like message id mappings, and
3854   # set up the initial sequence strings.
3855
3856   undef %cache;
3857   $next_msgid = "aX";
3858   $next_pid = 1234;
3859   $next_port = 1111;
3860   $message_skip = 0;
3861   $msglog_skip = 0;
3862   $stderr_skip = 0;
3863   $stdout_skip = 0;
3864   $rmfiltertest = 0;
3865   $is_ipv6test = 0;
3866   $TEST_STATE->{munge} = '';
3867
3868   # Remove the associative arrays used to hold checked mail files and msglogs
3869
3870   undef %expected_mails;
3871   undef %expected_msglogs;
3872
3873   # Open the test's script
3874   open(SCRIPT, "scripts/$test") ||
3875     tests_exit(-1, "Failed to open \"scripts/$test\": $!");
3876   # Run through the script once to set variables which should be global
3877   while (<SCRIPT>)
3878     {
3879     if (/^no_message_check/) { $message_skip = 1; next; }
3880     if (/^no_msglog_check/)  { $msglog_skip = 1; next; }
3881     if (/^no_stderr_check/)  { $stderr_skip = 1; next; }
3882     if (/^no_stdout_check/)  { $stdout_skip = 1; next; }
3883     if (/^rmfiltertest/)     { $rmfiltertest = 1; next; }
3884     if (/^sortlog/)          { $sortlog = 1; next; }
3885     if (/\bPORT_DYNAMIC\b/)  { $dynamic_socket = Exim::Runtest::dynamic_socket(); next; }
3886     }
3887   # Reset to beginning of file for per test interpreting/processing
3888   seek(SCRIPT, 0, 0);
3889
3890   # The first line in the script must be a comment that is used to identify
3891   # the set of tests as a whole.
3892
3893   $_ = <SCRIPT>;
3894   $lineno++;
3895   tests_exit(-1, "Missing identifying comment at start of $test") if (!/^#/);
3896   printf("%s %s", (substr $test, 5), (substr $_, 2));
3897
3898   # Loop for each of the subtests within the script. The variable $server_pid
3899   # is used to remember the pid of a "server" process, for which we do not
3900   # wait until we have waited for a subsequent command.
3901
3902   local($server_pid) = 0;
3903   for ($commandno = 1; !eof SCRIPT; $commandno++)
3904     {
3905     # Skip further leading comments and blank lines, handle the flag setting
3906     # commands, and deal with tests for IP support.
3907
3908     while (<SCRIPT>)
3909       {
3910       $lineno++;
3911       # Could remove these variable settings because they are already
3912       # set above, but doesn't hurt to leave them here.
3913       if (/^no_message_check/) { $message_skip = 1; next; }
3914       if (/^no_msglog_check/)  { $msglog_skip = 1; next; }
3915       if (/^no_stderr_check/)  { $stderr_skip = 1; next; }
3916       if (/^no_stdout_check/)  { $stdout_skip = 1; next; }
3917       if (/^rmfiltertest/)     { $rmfiltertest = 1; next; }
3918       if (/^sortlog/)          { $sortlog = 1; next; }
3919
3920       if (/^need_largefiles/)
3921         {
3922         next if $have_largefiles;
3923         print ">>> Large file support is needed for test $testno, but is not available: skipping\n";
3924         $docheck = 0;      # don't check output
3925         undef $_;          # pretend EOF
3926         last;
3927         }
3928
3929       if (/^need_ipv4/)
3930         {
3931         next if $have_ipv4;
3932         print ">>> IPv4 is needed for test $testno, but is not available: skipping\n";
3933         $docheck = 0;      # don't check output
3934         undef $_;          # pretend EOF
3935         last;
3936         }
3937
3938       if (/^need_ipv6/)
3939         {
3940         if ($have_ipv6)
3941           {
3942           $is_ipv6test = 1;
3943           next;
3944           }
3945         print ">>> IPv6 is needed for test $testno, but is not available: skipping\n";
3946         $docheck = 0;      # don't check output
3947         undef $_;          # pretend EOF
3948         last;
3949         }
3950
3951       if (/^need_move_frozen_messages/)
3952         {
3953         next if defined $parm_support{move_frozen_messages};
3954         print ">>> move frozen message support is needed for test $testno, " .
3955           "but is not\n>>> available: skipping\n";
3956         $docheck = 0;      # don't check output
3957         undef $_;          # pretend EOF
3958         last;
3959         }
3960
3961       last unless /^(?:#(?!##\s)|\s*$)/;
3962       }
3963     last if !defined $_;  # Hit EOF
3964
3965     my($subtest_startline) = $lineno;
3966
3967     # Now run the command. The function returns 0 for an inline command,
3968     # 1 if a non-exim command was run and waited for, 2 if an exim
3969     # command was run and waited for, and 3 if a command
3970     # was run and not waited for (usually a daemon or server startup).
3971
3972     my($commandname) = '';
3973     my($expectrc) = 0;
3974     my($rc, $run_extra) = run_command($testno, \$subtestno, \$expectrc, \$commandname, $TEST_STATE);
3975     my($cmdrc) = $?;
3976
3977     if ($debug) {
3978       print ">> rc=$rc cmdrc=$cmdrc\n";
3979       if (defined $run_extra) {
3980         foreach my $k (keys %$run_extra) {
3981           my $v = defined $run_extra->{$k} ? qq!"$run_extra->{$k}"! : '<undef>';
3982           print ">>   $k -> $v\n";
3983         }
3984       }
3985     }
3986     $run_extra = {} unless defined $run_extra;
3987     foreach my $k (keys %$run_extra) {
3988       if (exists $TEST_STATE->{$k}) {
3989         my $nv = defined $run_extra->{$k} ? qq!"$run_extra->{$k}"! : 'removed';
3990         print ">> override of $k; was $TEST_STATE->{$k}, now $nv\n" if $debug;
3991       }
3992       if (defined $run_extra->{$k}) {
3993         $TEST_STATE->{$k} = $run_extra->{$k};
3994       } elsif (exists $TEST_STATE->{$k}) {
3995         delete $TEST_STATE->{$k};
3996       }
3997     }
3998
3999     # Hit EOF after an initial return code number
4000
4001     tests_exit(-1, "Unexpected EOF in script") if ($rc == 4);
4002
4003     # Carry on with the next command if we did not wait for this one. $rc == 0
4004     # if no subprocess was run; $rc == 3 if we started a process but did not
4005     # wait for it.
4006
4007     next if ($rc == 0 || $rc == 3);
4008
4009     # We ran and waited for a command. Check for the expected result unless
4010     # it died.
4011
4012     if ($cmdrc != $expectrc && !$sigpipehappened)
4013       {
4014       printf("** Command $commandno (\"$commandname\", starting at line $subtest_startline)\n");
4015       if (($cmdrc & 0xff) == 0)
4016         {
4017         printf("** Return code %d (expected %d)", $cmdrc/256, $expectrc/256);
4018         }
4019       elsif (($cmdrc & 0xff00) == 0)
4020         { printf("** Killed by signal %d", $cmdrc & 255); }
4021       else
4022         { printf("** Status %x", $cmdrc); }
4023
4024       for (;;)
4025         {
4026         print "\nshow stdErr, show stdOut, Retry, Continue (without file comparison), or Quit? [Q] ";
4027         $_ = $force_continue ? "c" : <T>;
4028         tests_exit(1) if /^q?$/i;
4029         if (/^c$/ && $force_continue) {
4030           log_failure($log_failed_filename, $testno, "exit code unexpected");
4031           log_test($log_summary_filename, $testno, 'F')
4032         }
4033         if ($force_continue)
4034           {
4035           print "\nstdout tail:\n";
4036           print "==================>\n";
4037           system("tail -20 test-stdout");
4038           print "===================\n";
4039           print "stderr tail:\n";
4040           print "==================>\n";
4041           system("tail -20 test-stderr");
4042           print "===================\n";
4043           print "... continue forced\n";
4044           }
4045
4046         last if /^[rc]$/i;
4047         if (/^e$/i)
4048           {
4049           system("$more test-stderr");
4050           }
4051         elsif (/^o$/i)
4052           {
4053           system("$more test-stdout");
4054           }
4055         }
4056
4057       $retry = 1 if /^r$/i;
4058       $docheck = 0;
4059       }
4060
4061     # If the command was exim, and a listening server is running, we can now
4062     # close its input, which causes us to wait for it to finish, which is why
4063     # we didn't close it earlier.
4064
4065     if ($rc == 2 && $server_pid != 0)
4066       {
4067       close SERVERCMD;
4068       $server_pid = 0;
4069       if ($? != 0)
4070         {
4071         if (($? & 0xff) == 0)
4072           { printf("Server return code %d for test %d starting line %d", $?/256,
4073                 $testno, $subtest_startline); }
4074         elsif (($? & 0xff00) == 0)
4075           { printf("Server killed by signal %d", $? & 255); }
4076         else
4077           { printf("Server status %x", $?); }
4078
4079         for (;;)
4080           {
4081           print "\nShow server stdout, Retry, Continue, or Quit? [Q] ";
4082           $_ = $force_continue ? "c" : <T>;
4083           tests_exit(1) if /^q?$/i;
4084           if (/^c$/ && $force_continue) {
4085             log_failure($log_failed_filename, $testno, "exit code unexpected");
4086             log_test($log_summary_filename, $testno, 'F')
4087           }
4088           print "... continue forced\n" if $force_continue;
4089           last if /^[rc]$/i;
4090
4091           if (/^s$/i)
4092             {
4093             open(S, "test-stdout-server") ||
4094               tests_exit(-1, "Failed to open test-stdout-server: $!");
4095             print while <S>;
4096             close(S);
4097             }
4098           }
4099         $retry = 1 if /^r$/i;
4100         }
4101       }
4102     }
4103
4104   close SCRIPT;
4105
4106   # The script has finished. Check the all the output that was generated. The
4107   # function returns 0 for a perfect pass, 1 if imperfect but ok, 2 if we should
4108   # rerun the test (the files # have been updated).
4109   # It does not return if the user responds Q to a prompt.
4110
4111   if ($retry)
4112     {
4113     $retry = '0';
4114     print (("#" x 79) . "\n");
4115     redo;
4116     }
4117
4118   if ($docheck)
4119     {
4120     sleep 1 if $slow;
4121     my $rc = check_output($TEST_STATE->{munge});
4122     log_test($log_summary_filename, $testno, 'P') if ($rc == 0);
4123     if ($rc < 2)
4124       {
4125       print ("  Script completed\n");
4126       }
4127     else
4128       {
4129       print (("#" x 79) . "\n");
4130       redo;
4131       }
4132     }
4133   }
4134
4135
4136 ##################################################
4137 #         Exit from the test script              #
4138 ##################################################
4139
4140 tests_exit(-1, "No runnable tests selected") if not @test_list;
4141 tests_exit(0);
4142
4143 __END__
4144
4145 =head1 NAME
4146
4147  runtest - run the exim testsuite
4148
4149 =head1 SYNOPSIS
4150
4151  runtest [exim-path] [options] [test0 [test1]]
4152
4153 =head1 DESCRIPTION
4154
4155 B<runtest> runs the Exim testsuite.
4156
4157 =head1 OPTIONS
4158
4159 For legacy reasons the options are not case sensitive.
4160
4161 =over
4162
4163 =item B<--continue>
4164
4165 Do not stop for user interaction or on errors. (default: off)
4166
4167 =item B<--debug>
4168
4169 This option enables the output of debug information when running the
4170 various test commands. (default: off)
4171
4172 =item B<--diff>
4173
4174 Use C<diff -u> for comparing the expected output with the produced
4175 output. (default: use a built-in routine)
4176
4177 =item B<--flavor>|B<--flavour> I<flavour>
4178
4179 Override the expected results for results for a specific (OS) flavour.
4180 (default: unused)
4181
4182 =item B<--[no]ipv4>
4183
4184 Skip IPv4 related setup and tests (default: use ipv4)
4185
4186 =item B<--[no]ipv6>
4187
4188 Skip IPv6 related setup and tests (default: use ipv6)
4189
4190 =item B<--keep>
4191
4192 Keep the various output files produced during a test run. (default: don't keep)
4193
4194 =item B<--range> I<n0> I<n1>
4195
4196 Run tests between (including) I<n0> and I<n1>. A "+" may be used to specify the "last
4197 test available".
4198
4199 =item B<--slow>
4200
4201 Insert some delays to compensate for a slow host system. (default: off)
4202
4203 =item B<--test> I<n>
4204
4205 Run the specified test. This option may used multiple times.
4206
4207 =item B<--update>
4208
4209 Automatically update the recorded (expected) data on mismatch. (default: off)
4210
4211 =item B<--valgrind>
4212
4213 Start Exim wrapped by I<valgrind>. (default: don't use valgrind)
4214
4215 =back
4216
4217 =cut
4218
4219
4220 # End of runtest script