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