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