test/runtest

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