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