test/runtest

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