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     'optional_cert_hostnames' =>
1366     { 'stderr' => '/in tls_verify_cert_hostnames\? no/' },
1367
1368     'loopback' =>
1369     { 'stdout' => 's/[[](127\.0\.0\.1|::1)]/[IP_LOOPBACK_ADDR]/' },
1370
1371     'scanfile_size' =>
1372     { 'stdout' => 's/(Content-length:) \d\d\d/$1 ddd/' },
1373
1374     'delay_1500' =>
1375     { 'stderr' => 's/(1[5-9]|23\d)\d\d msec/ssss msec/' },
1376
1377     'tls_anycipher' =>
1378     { 'mainlog' => 's/ X=TLS\S+ / X=TLS_proto_and_cipher /' },
1379
1380     'debug_pid' =>
1381     { 'stderr' => 's/(^\s{0,4}|(?<=Process )|(?<=child ))\d{1,5}/ppppp/g' },
1382
1383   };
1384
1385
1386 ##################################################
1387 #    Subroutine to check the output of a test    #
1388 ##################################################
1389
1390 # This function is called when the series of subtests is complete. It makes
1391 # use of check_file(), whose arguments are:
1392 #
1393 #  [0] the name of the main raw output file
1394 #  [1] the name of the server raw output file or undef
1395 #  [2] where to put the munged copy
1396 #  [3] the name of the saved file
1397 #  [4] TRUE if this is a log file whose deliveries must be sorted
1398 #  [5] an optional custom munge command
1399 #
1400 # Arguments: Optionally, name of a single custom munge to run.
1401 # Returns:   0 if the output compared equal
1402 #            1 if re-run needed (files may have been updated)
1403
1404 sub check_output{
1405 my($mungename) = $_[0];
1406 my($yield) = 0;
1407 my($munge) = $munges->{$mungename} if defined $mungename;
1408
1409 $yield = 1 if check_file("spool/log/paniclog",
1410                        "spool/log/serverpaniclog",
1411                        "test-paniclog-munged",
1412                        "paniclog/$testno", 0,
1413                        $munge->{'paniclog'});
1414
1415 $yield = 1 if check_file("spool/log/rejectlog",
1416                        "spool/log/serverrejectlog",
1417                        "test-rejectlog-munged",
1418                        "rejectlog/$testno", 0,
1419                        $munge->{'rejectlog'});
1420
1421 $yield = 1 if check_file("spool/log/mainlog",
1422                        "spool/log/servermainlog",
1423                        "test-mainlog-munged",
1424                        "log/$testno", $sortlog,
1425                        $munge->{'mainlog'});
1426
1427 if (!$stdout_skip)
1428   {
1429   $yield = 1 if check_file("test-stdout",
1430                        "test-stdout-server",
1431                        "test-stdout-munged",
1432                        "stdout/$testno", 0,
1433                        $munge->{'stdout'});
1434   }
1435
1436 if (!$stderr_skip)
1437   {
1438   $yield = 1 if check_file("test-stderr",
1439                        "test-stderr-server",
1440                        "test-stderr-munged",
1441                        "stderr/$testno", 0,
1442                        $munge->{'stderr'});
1443   }
1444
1445 # Compare any delivered messages, unless this test is skipped.
1446
1447 if (! $message_skip)
1448   {
1449   my($msgno) = 0;
1450
1451   # Get a list of expected mailbox files for this script. We don't bother with
1452   # directories, just the files within them.
1453
1454   foreach $oldmail (@oldmails)
1455     {
1456     next unless $oldmail =~ /^mail\/$testno\./;
1457     print ">> EXPECT $oldmail\n" if $debug;
1458     $expected_mails{$oldmail} = 1;
1459     }
1460
1461   # If there are any files in test-mail, compare them. Note that "." and
1462   # ".." are automatically omitted by list_files_below().
1463
1464   @mails = list_files_below("test-mail");
1465
1466   foreach $mail (@mails)
1467     {
1468     next if $mail eq "test-mail/oncelog";
1469
1470     $saved_mail = substr($mail, 10);               # Remove "test-mail/"
1471     $saved_mail =~ s/^$parm_caller(\/|$)/CALLER/;  # Convert caller name
1472
1473     if ($saved_mail =~ /(\d+\.[^.]+\.)/)
1474       {
1475       $msgno++;
1476       $saved_mail =~ s/(\d+\.[^.]+\.)/$msgno./gx;
1477       }
1478
1479     print ">> COMPARE $mail mail/$testno.$saved_mail\n" if $debug;
1480     $yield = 1 if check_file($mail, undef, "test-mail-munged",
1481       "mail/$testno.$saved_mail", 0,
1482       $munge->{'mail'});
1483     delete $expected_mails{"mail/$testno.$saved_mail"};
1484     }
1485
1486   # Complain if not all expected mails have been found
1487
1488   if (scalar(keys %expected_mails) != 0)
1489     {
1490     foreach $key (keys %expected_mails)
1491       { print "** no test file found for $key\n"; }
1492
1493     for (;;)
1494       {
1495       interact("Continue, Update & retry, or Quit? [Q] ", $force_update, $force_continue);
1496       tests_exit(1) if /^q?$/i;
1497       log_failure($log_failed_filename, $testno, "missing email") if (/^c$/i && $force_continue);
1498       last if /^c$/i;
1499
1500       # For update, we not only have to unlink the file, but we must also
1501       # remove it from the @oldmails vector, as otherwise it will still be
1502       # checked for when we re-run the test.
1503
1504       if (/^u$/i)
1505         {
1506         foreach $key (keys %expected_mails)
1507           {
1508           my($i);
1509           tests_exit(-1, "Failed to unlink $key") if !unlink("$key");
1510           for ($i = 0; $i < @oldmails; $i++)
1511             {
1512             if ($oldmails[$i] eq $key)
1513               {
1514               splice @oldmails, $i, 1;
1515               last;
1516               }
1517             }
1518           }
1519         last;
1520         }
1521       }
1522     }
1523   }
1524
1525 # Compare any remaining message logs, unless this test is skipped.
1526
1527 if (! $msglog_skip)
1528   {
1529   # Get a list of expected msglog files for this test
1530
1531   foreach $oldmsglog (@oldmsglogs)
1532     {
1533     next unless $oldmsglog =~ /^$testno\./;
1534     $expected_msglogs{$oldmsglog} = 1;
1535     }
1536
1537   # If there are any files in spool/msglog, compare them. However, we have
1538   # to munge the file names because they are message ids, which are
1539   # time dependent.
1540
1541   if (opendir(DIR, "spool/msglog"))
1542     {
1543     @msglogs = sort readdir(DIR);
1544     closedir(DIR);
1545
1546     foreach $msglog (@msglogs)
1547       {
1548       next if ($msglog eq "." || $msglog eq ".." || $msglog eq "CVS");
1549       ($munged_msglog = $msglog) =~
1550         s/((?:[^\W_]{6}-){2}[^\W_]{2})
1551           /new_value($1, "10Hm%s-0005vi-00", \$next_msgid)/egx;
1552       $yield = 1 if check_file("spool/msglog/$msglog", undef,
1553         "test-msglog-munged", "msglog/$testno.$munged_msglog", 0,
1554         $munge->{'msglog'});
1555       delete $expected_msglogs{"$testno.$munged_msglog"};
1556       }
1557     }
1558
1559   # Complain if not all expected msglogs have been found
1560
1561   if (scalar(keys %expected_msglogs) != 0)
1562     {
1563     foreach $key (keys %expected_msglogs)
1564       {
1565       print "** no test msglog found for msglog/$key\n";
1566       ($msgid) = $key =~ /^\d+\.(.*)$/;
1567       foreach $cachekey (keys %cache)
1568         {
1569         if ($cache{$cachekey} eq $msgid)
1570           {
1571           print "** original msgid $cachekey\n";
1572           last;
1573           }
1574         }
1575       }
1576
1577     for (;;)
1578       {
1579       interact("Continue, Update, or Quit? [Q] ", $force_update, $force_continue);
1580       tests_exit(1) if /^q?$/i;
1581       log_failure($log_failed_filename, $testno, "missing msglog") if (/^c$/i && $force_continue);
1582       last if /^c$/i;
1583       if (/^u$/i)
1584         {
1585         foreach $key (keys %expected_msglogs)
1586           {
1587           tests_exit(-1, "Failed to unlink msglog/$key")
1588             if !unlink("msglog/$key");
1589           }
1590         last;
1591         }
1592       }
1593     }
1594   }
1595
1596 return $yield;
1597 }
1598
1599
1600
1601 ##################################################
1602 #     Subroutine to run one "system" command     #
1603 ##################################################
1604
1605 # We put this in a subroutine so that the command can be reflected when
1606 # debugging.
1607 #
1608 # Argument: the command to be run
1609 # Returns:  nothing
1610
1611 sub run_system {
1612 my($cmd) = $_[0];
1613 if ($debug)
1614   {
1615   my($prcmd) = $cmd;
1616   $prcmd =~ s/; /;\n>> /;
1617   print ">> $prcmd\n";
1618   }
1619 system("$cmd");
1620 }
1621
1622
1623
1624 ##################################################
1625 #      Subroutine to run one script command      #
1626 ##################################################
1627
1628 # The <SCRIPT> file is open for us to read an optional return code line,
1629 # followed by the command line and any following data lines for stdin. The
1630 # command line can be continued by the use of \. Data lines are not continued
1631 # in this way. In all lines, the following substutions are made:
1632 #
1633 # DIR    => the current directory
1634 # CALLER => the caller of this script
1635 #
1636 # Arguments: the current test number
1637 #            reference to the subtest number, holding previous value
1638 #            reference to the expected return code value
1639 #            reference to where to put the command name (for messages)
1640 #            auxilliary information returned from a previous run
1641 #
1642 # Returns:   0 the commmand was executed inline, no subprocess was run
1643 #            1 a non-exim command was run and waited for
1644 #            2 an exim command was run and waited for
1645 #            3 a command was run and not waited for (daemon, server, exim_lock)
1646 #            4 EOF was encountered after an initial return code line
1647 # Optionally alse a second parameter, a hash-ref, with auxilliary information:
1648 #            exim_pid: pid of a run process
1649 #            munge: name of a post-script results munger
1650
1651 sub run_command{
1652 my($testno) = $_[0];
1653 my($subtestref) = $_[1];
1654 my($commandnameref) = $_[3];
1655 my($aux_info) = $_[4];
1656 my($yield) = 1;
1657
1658 if (/^(\d+)\s*$/)                # Handle unusual return code
1659   {
1660   my($r) = $_[2];
1661   $$r = $1 << 8;
1662   $_ = <SCRIPT>;
1663   return 4 if !defined $_;       # Missing command
1664   $lineno++;
1665   }
1666
1667 chomp;
1668 $wait_time = 0;
1669
1670 # Handle concatenated command lines
1671
1672 s/\s+$//;
1673 while (substr($_, -1) eq"\\")
1674   {
1675   my($temp);
1676   $_ = substr($_, 0, -1);
1677   chomp($temp = <SCRIPT>);
1678   if (defined $temp)
1679     {
1680     $lineno++;
1681     $temp =~ s/\s+$//;
1682     $temp =~ s/^\s+//;
1683     $_ .= $temp;
1684     }
1685   }
1686
1687 # Do substitutions
1688
1689 do_substitute($testno);
1690 if ($debug) { printf ">> $_\n"; }
1691
1692 # Pass back the command name (for messages)
1693
1694 ($$commandnameref) = /^(\S+)/;
1695
1696 # Here follows code for handling the various different commands that are
1697 # supported by this script. The first group of commands are all freestanding
1698 # in that they share no common code and are not followed by any data lines.
1699
1700
1701 ###################
1702 ###################
1703
1704 # The "dbmbuild" command runs exim_dbmbuild. This is used both to test the
1705 # utility and to make DBM files for testing DBM lookups.
1706
1707 if (/^dbmbuild\s+(\S+)\s+(\S+)/)
1708   {
1709   run_system("(./eximdir/exim_dbmbuild $parm_cwd/$1 $parm_cwd/$2;" .
1710          "echo exim_dbmbuild exit code = \$?)" .
1711          ">>test-stdout");
1712   return 1;
1713   }
1714
1715
1716 # The "dump" command runs exim_dumpdb. On different systems, the output for
1717 # some types of dump may appear in a different order because it's just hauled
1718 # out of the DBM file. We can solve this by sorting. Ignore the leading
1719 # date/time, as it will be flattened later during munging.
1720
1721 if (/^dump\s+(\S+)/)
1722   {
1723   my($which) = $1;
1724   my(@temp);
1725   print ">> ./eximdir/exim_dumpdb $parm_cwd/spool $which\n" if $debug;
1726   open(IN, "./eximdir/exim_dumpdb $parm_cwd/spool $which |");
1727   open(OUT, ">>test-stdout");
1728   print OUT "+++++++++++++++++++++++++++\n";
1729
1730   if ($which eq "retry")
1731     {
1732     $/ = "\n  ";
1733     @temp = <IN>;
1734     $/ = "\n";
1735
1736     @temp = sort {
1737                    my($aa) = split(' ', $a);
1738                    my($bb) = split(' ', $b);
1739                    return $aa cmp $bb;
1740                  } @temp;
1741
1742     foreach $item (@temp)
1743       {
1744       $item =~ s/^\s*(.*)\n(.*)\n?\s*$/$1\n$2/m;
1745       print OUT "  $item\n";
1746       }
1747     }
1748   else
1749     {
1750     @temp = <IN>;
1751     if ($which eq "callout")
1752       {
1753       @temp = sort {
1754                    my($aa) = substr $a, 21;
1755                    my($bb) = substr $b, 21;
1756                    return $aa cmp $bb;
1757                    } @temp;
1758       }
1759     print OUT @temp;
1760     }
1761
1762   close(IN);
1763   close(OUT);
1764   return 1;
1765   }
1766
1767
1768 # The "echo" command is a way of writing comments to the screen.
1769
1770 if (/^echo\s+(.*)$/)
1771   {
1772   print "$1\n";
1773   return 0;
1774   }
1775
1776
1777 # The "exim_lock" command runs exim_lock in the same manner as "server",
1778 # but it doesn't use any input.
1779
1780 if (/^exim_lock\s+(.*)$/)
1781   {
1782   $cmd = "./eximdir/exim_lock $1 >>test-stdout";
1783   $server_pid = open SERVERCMD, "|$cmd" ||
1784     tests_exit(-1, "Failed to run $cmd\n");
1785
1786   # This gives the process time to get started; otherwise the next
1787   # process may not find it there when it expects it.
1788
1789   select(undef, undef, undef, 0.1);
1790   return 3;
1791   }
1792
1793
1794 # The "exinext" command runs exinext
1795
1796 if (/^exinext\s+(.*)/)
1797   {
1798   run_system("(./eximdir/exinext " .
1799     "-DEXIM_PATH=$parm_cwd/eximdir/exim " .
1800     "-C $parm_cwd/test-config $1;" .
1801     "echo exinext exit code = \$?)" .
1802     ">>test-stdout");
1803   return 1;
1804   }
1805
1806
1807 # The "exigrep" command runs exigrep on the current mainlog
1808
1809 if (/^exigrep\s+(.*)/)
1810   {
1811   run_system("(./eximdir/exigrep " .
1812     "$1 $parm_cwd/spool/log/mainlog;" .
1813     "echo exigrep exit code = \$?)" .
1814     ">>test-stdout");
1815   return 1;
1816   }
1817
1818
1819 # The "eximstats" command runs eximstats on the current mainlog
1820
1821 if (/^eximstats\s+(.*)/)
1822   {
1823   run_system("(./eximdir/eximstats " .
1824     "$1 $parm_cwd/spool/log/mainlog;" .
1825     "echo eximstats exit code = \$?)" .
1826     ">>test-stdout");
1827   return 1;
1828   }
1829
1830
1831 # The "gnutls" command makes a copy of saved GnuTLS parameter data in the
1832 # spool directory, to save Exim from re-creating it each time.
1833
1834 if (/^gnutls/)
1835   {
1836   my $gen_fn = "spool/gnutls-params-$gnutls_dh_bits_normal";
1837   run_system "sudo cp -p aux-fixed/gnutls-params $gen_fn;" .
1838          "sudo chown $parm_eximuser:$parm_eximgroup $gen_fn;" .
1839          "sudo chmod 0400 $gen_fn";
1840   return 1;
1841   }
1842
1843
1844 # The "killdaemon" command should ultimately follow the starting of any Exim
1845 # daemon with the -bd option. We kill with SIGINT rather than SIGTERM to stop
1846 # it outputting "Terminated" to the terminal when not in the background.
1847
1848 if (/^killdaemon/)
1849   {
1850   my $return_extra = {};
1851   if (exists $aux_info->{exim_pid})
1852     {
1853     $pid = $aux_info->{exim_pid};
1854     $return_extra->{exim_pid} = undef;
1855     print ">> killdaemon: recovered pid $pid\n" if $debug;
1856     if ($pid)
1857       {
1858       run_system("sudo /bin/kill -INT $pid");
1859       wait;
1860       }
1861     } else {
1862     $pid = `cat $parm_cwd/spool/exim-daemon.*`;
1863     if ($pid)
1864       {
1865       run_system("sudo /bin/kill -INT $pid");
1866       close DAEMONCMD;                                   # Waits for process
1867       }
1868     }
1869     run_system("sudo /bin/rm -f spool/exim-daemon.*");
1870   return (1, $return_extra);
1871   }
1872
1873
1874 # The "millisleep" command is like "sleep" except that its argument is in
1875 # milliseconds, thus allowing for a subsecond sleep, which is, in fact, all it
1876 # is used for.
1877
1878 elsif (/^millisleep\s+(.*)$/)
1879   {
1880   select(undef, undef, undef, $1/1000);
1881   return 0;
1882   }
1883
1884
1885 # The "munge" command selects one of a hardwired set of test-result modifications
1886 # to be made before result compares are run agains the golden set.  This lets
1887 # us account for test-system dependent things which only affect a few, but known,
1888 # test-cases.
1889 # Currently only the last munge takes effect.
1890
1891 if (/^munge\s+(.*)$/)
1892   {
1893   return (0, { munge => $1 });
1894   }
1895
1896
1897 # The "sleep" command does just that. For sleeps longer than 1 second we
1898 # tell the user what's going on.
1899
1900 if (/^sleep\s+(.*)$/)
1901   {
1902   if ($1 == 1)
1903     {
1904     sleep(1);
1905     }
1906   else
1907     {
1908     printf("  Test %d sleep $1 ", $$subtestref);
1909     for (1..$1)
1910       {
1911       print ".";
1912       sleep(1);
1913       }
1914     printf("\r  Test %d                            $cr", $$subtestref);
1915     }
1916   return 0;
1917   }
1918
1919
1920 # Various Unix management commands are recognized
1921
1922 if (/^(ln|ls|du|mkdir|mkfifo|touch|cp|cat)\s/ ||
1923     /^sudo (rmdir|rm|chown|chmod)\s/)
1924   {
1925   run_system("$_ >>test-stdout 2>>test-stderr");
1926   return 1;
1927   }
1928
1929
1930
1931 ###################
1932 ###################
1933
1934 # The next group of commands are also freestanding, but they are all followed
1935 # by data lines.
1936
1937
1938 # The "server" command starts up a script-driven server that runs in parallel
1939 # with the following exim command. Therefore, we want to run a subprocess and
1940 # not yet wait for it to complete. The waiting happens after the next exim
1941 # command, triggered by $server_pid being non-zero. The server sends its output
1942 # to a different file. The variable $server_opts, if not empty, contains
1943 # options to disable IPv4 or IPv6 if necessary.
1944
1945 if (/^server\s+(.*)$/)
1946   {
1947   $pidfile = "$parm_cwd/aux-var/server-daemon.pid";
1948   $cmd = "./bin/server $server_opts -oP $pidfile $1 >>test-stdout-server";
1949   print ">> $cmd\n" if ($debug);
1950   $server_pid = open SERVERCMD, "|$cmd" || tests_exit(-1, "Failed to run $cmd");
1951   SERVERCMD->autoflush(1);
1952   print ">> Server pid is $server_pid\n" if $debug;
1953   while (<SCRIPT>)
1954     {
1955     $lineno++;
1956     last if /^\*{4}\s*$/;
1957     print SERVERCMD;
1958     }
1959   print SERVERCMD "++++\n"; # Send end to server; can't send EOF yet
1960                             # because close() waits for the process.
1961
1962   # Interlock the server startup; otherwise the next
1963   # process may not find it there when it expects it.
1964   while (! stat("$pidfile") ) { select(undef, undef, undef, 0.3); }
1965   return 3;
1966   }
1967
1968
1969 # The "write" command is a way of creating files of specific sizes for
1970 # buffering tests, or containing specific data lines from within the script
1971 # (rather than hold lots of little files). The "catwrite" command does the
1972 # same, but it also copies the lines to test-stdout.
1973
1974 if (/^(cat)?write\s+(\S+)(?:\s+(.*))?\s*$/)
1975   {
1976   my($cat) = defined $1;
1977   @sizes = ();
1978   @sizes = split /\s+/, $3 if defined $3;
1979   open FILE, ">$2" || tests_exit(-1, "Failed to open \"$2\": $!");
1980
1981   if ($cat)
1982     {
1983     open CAT, ">>test-stdout" ||
1984       tests_exit(-1, "Failed to open test-stdout: $!");
1985     print CAT "==========\n";
1986     }
1987
1988   if (scalar @sizes > 0)
1989     {
1990     # Pre-data
1991
1992     while (<SCRIPT>)
1993       {
1994       $lineno++;
1995       last if /^\+{4}\s*$/;
1996       print FILE;
1997       print CAT if $cat;
1998       }
1999
2000     # Sized data
2001
2002     while (scalar @sizes > 0)
2003       {
2004       ($count,$len,$leadin) = (shift @sizes) =~ /(\d+)x(\d+)(?:=(.*))?/;
2005       $leadin = "" if !defined $leadin;
2006       $leadin =~ s/_/ /g;
2007       $len -= length($leadin) + 1;
2008       while ($count-- > 0)
2009         {
2010         print FILE $leadin, "a" x $len, "\n";
2011         print CAT $leadin, "a" x $len, "\n" if $cat;
2012         }
2013       }
2014     }
2015
2016   # Post data, or only data if no sized data
2017
2018   while (<SCRIPT>)
2019     {
2020     $lineno++;
2021     last if /^\*{4}\s*$/;
2022     print FILE;
2023     print CAT if $cat;
2024     }
2025   close FILE;
2026
2027   if ($cat)
2028     {
2029     print CAT "==========\n";
2030     close CAT;
2031     }
2032
2033   return 0;
2034   }
2035
2036
2037 ###################
2038 ###################
2039
2040 # From this point on, script commands are implemented by setting up a shell
2041 # command in the variable $cmd. Shared code to run this command and handle its
2042 # input and output follows.
2043
2044 # The "client", "client-gnutls", and "client-ssl" commands run a script-driven
2045 # program that plays the part of an email client. We also have the availability
2046 # of running Perl for doing one-off special things. Note that all these
2047 # commands expect stdin data to be supplied.
2048
2049 if (/^client/ || /^(sudo\s+)?perl\b/)
2050   {
2051   s"client"./bin/client";
2052   $cmd = "$_ >>test-stdout 2>>test-stderr";
2053   }
2054
2055 # For the "exim" command, replace the text "exim" with the path for the test
2056 # binary, plus -D options to pass over various parameters, and a -C option for
2057 # the testing configuration file. When running in the test harness, Exim does
2058 # not drop privilege when -C and -D options are present. To run the exim
2059 # command as root, we use sudo.
2060
2061 elsif (/^([A-Z_]+=\S+\s+)?(\d+)?\s*(sudo(?:\s+-u\s+(\w+))?\s+)?exim(_\S+)?\s+(.*)$/)
2062   {
2063   $args = $6;
2064   my($envset) = (defined $1)? $1      : "";
2065   my($sudo)   = (defined $3)? "sudo " . (defined $4 ? "-u $4 ":"")  : "";
2066   my($special)= (defined $5)? $5      : "";
2067   $wait_time  = (defined $2)? $2      : 0;
2068
2069   # Return 2 rather than 1 afterwards
2070
2071   $yield = 2;
2072
2073   # Update the test number
2074
2075   $$subtestref = $$subtestref + 1;
2076   printf("  Test %d       $cr", $$subtestref);
2077
2078   # Copy the configuration file, making the usual substitutions.
2079
2080   open (IN, "$parm_cwd/confs/$testno") ||
2081     tests_exit(-1, "Couldn't open $parm_cwd/confs/$testno: $!\n");
2082   open (OUT, ">test-config") ||
2083     tests_exit(-1, "Couldn't open test-config: $!\n");
2084   while (<IN>)
2085     {
2086     do_substitute($testno);
2087     print OUT;
2088     }
2089   close(IN);
2090   close(OUT);
2091
2092   # The string $msg1 in args substitutes the message id of the first
2093   # message on the queue, and so on. */
2094
2095   if ($args =~ /\$msg/)
2096     {
2097     my($listcmd) = "$parm_cwd/eximdir/exim -bp " .
2098                    "-DEXIM_PATH=$parm_cwd/eximdir/exim " .
2099                    "-C $parm_cwd/test-config |";
2100     print ">> Getting queue list from:\n>>    $listcmd\n" if ($debug);
2101     open (QLIST, $listcmd) || tests_exit(-1, "Couldn't run \"exim -bp\": $!\n");
2102     my(@msglist) = ();
2103     while (<QLIST>) { push (@msglist, $1) if /^\s*\d+[smhdw]\s+\S+\s+(\S+)/; }
2104     close(QLIST);
2105
2106     # Done backwards just in case there are more than 9
2107
2108     my($i);
2109     for ($i = @msglist; $i > 0; $i--) { $args =~ s/\$msg$i/$msglist[$i-1]/g; }
2110     if ( $args =~ /\$msg\d/ )
2111       {
2112       tests_exit(-1, "Not enough messages in spool, for test $testno line $lineno\n")
2113         unless $force_continue;
2114       }
2115     }
2116
2117   # If -d is specified in $optargs, remove it from $args; i.e. let
2118   # the command line for runtest override. Then run Exim.
2119
2120   $args =~ s/(?:^|\s)-d\S*// if $optargs =~ /(?:^|\s)-d/;
2121
2122   $cmd = "$envset$sudo$parm_cwd/eximdir/exim$special$optargs " .
2123          "-DEXIM_PATH=$parm_cwd/eximdir/exim$special " .
2124          "-C $parm_cwd/test-config $args " .
2125          ">>test-stdout 2>>test-stderr";
2126   # If the command is starting an Exim daemon, we run it in the same
2127   # way as the "server" command above, that is, we don't want to wait
2128   # for the process to finish. That happens when "killdaemon" is obeyed later
2129   # in the script. We also send the stderr output to test-stderr-server. The
2130   # daemon has its log files put in a different place too (by configuring with
2131   # log_file_path). This requires the  directory to be set up in advance.
2132   #
2133   # There are also times when we want to run a non-daemon version of Exim
2134   # (e.g. a queue runner) with the server configuration. In this case,
2135   # we also define -DNOTDAEMON.
2136
2137   if ($cmd =~ /\s-DSERVER=server\s/ && $cmd !~ /\s-DNOTDAEMON\s/)
2138     {
2139     $pidfile = "$parm_cwd/spool/exim-daemon.pid";
2140     if ($debug) { printf ">> daemon: $cmd\n"; }
2141     run_system("sudo mkdir spool/log 2>/dev/null");
2142     run_system("sudo chown $parm_eximuser:$parm_eximgroup spool/log");
2143
2144     # Before running the command, convert the -bd option into -bdf so that an
2145     # Exim daemon doesn't double fork. This means that when we wait close
2146     # DAEMONCMD, it waits for the correct process. Also, ensure that the pid
2147     # file is written to the spool directory, in case the Exim binary was
2148     # built with PID_FILE_PATH pointing somewhere else.
2149
2150     if ($cmd =~ /\s-oP\s/)
2151       {
2152       ($pidfile = $cmd) =~ s/^.*-oP ([^ ]+).*$/$1/;
2153       $cmd =~ s!\s-bd\s! -bdf !;
2154       }
2155     else
2156       {
2157       $pidfile = "$parm_cwd/spool/exim-daemon.pid";
2158       $cmd =~ s!\s-bd\s! -bdf -oP $pidfile !;
2159       }
2160     print ">> |${cmd}-server\n" if ($debug);
2161     open DAEMONCMD, "|${cmd}-server" || tests_exit(-1, "Failed to run $cmd");
2162     DAEMONCMD->autoflush(1);
2163     while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; }   # Ignore any input
2164
2165     # Interlock with daemon startup
2166     while (! stat("$pidfile") ) { select(undef, undef, undef, 0.3); }
2167     return 3;                                     # Don't wait
2168     }
2169   elsif ($cmd =~ /\s-DSERVER=wait:(\d+)\s/)
2170     {
2171     my $listen_port = $1;
2172     my $waitmode_sock = new FileHandle;
2173     if ($debug) { printf ">> wait-mode daemon: $cmd\n"; }
2174     run_system("sudo mkdir spool/log 2>/dev/null");
2175     run_system("sudo chown $parm_eximuser:$parm_eximgroup spool/log");
2176
2177     my ($s_ip,$s_port) = ('127.0.0.1', $listen_port);
2178     my $sin = sockaddr_in($s_port, inet_aton($s_ip))
2179         or die "** Failed packing $s_ip:$s_port\n";
2180     socket($waitmode_sock, PF_INET, SOCK_STREAM, getprotobyname('tcp'))
2181         or die "** Unable to open socket $s_ip:$s_port: $!\n";
2182     setsockopt($waitmode_sock, SOL_SOCKET, SO_REUSEADDR, 1)
2183         or die "** Unable to setsockopt(SO_REUSEADDR): $!\n";
2184     bind($waitmode_sock, $sin)
2185         or die "** Unable to bind socket ($s_port): $!\n";
2186     listen($waitmode_sock, 5);
2187     my $pid = fork();
2188     if (not defined $pid) { die "** fork failed: $!\n" }
2189     if (not $pid) {
2190       close(STDIN);
2191       open(STDIN, "<&", $waitmode_sock) or die "** dup sock to stdin failed: $!\n";
2192       close($waitmode_sock);
2193       print "[$$]>> ${cmd}-server\n" if ($debug);
2194       exec "exec ${cmd}-server";
2195       exit(1);
2196     }
2197     while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; }   # Ignore any input
2198     select(undef, undef, undef, 0.3);             # Let the daemon get going
2199     return (3, { exim_pid => $pid });             # Don't wait
2200     }
2201   }
2202
2203
2204 # Unknown command
2205
2206 else { tests_exit(-1, "Command unrecognized in line $lineno: $_"); }
2207
2208
2209 # Run the command, with stdin connected to a pipe, and write the stdin data
2210 # to it, with appropriate substitutions. If a line ends with \NONL\, chop off
2211 # the terminating newline (and the \NONL\). If the command contains
2212 # -DSERVER=server add "-server" to the command, where it will adjoin the name
2213 # for the stderr file. See comment above about the use of -DSERVER.
2214
2215 $stderrsuffix = ($cmd =~ /\s-DSERVER=server\s/)? "-server" : "";
2216 print ">> |${cmd}${stderrsuffix}\n" if ($debug);
2217 open CMD, "|${cmd}${stderrsuffix}" || tests_exit(1, "Failed to run $cmd");
2218
2219 CMD->autoflush(1);
2220 while (<SCRIPT>)
2221   {
2222   $lineno++;
2223   last if /^\*{4}\s*$/;
2224   do_substitute($testno);
2225   if (/^(.*)\\NONL\\\s*$/) { print CMD $1; } else { print CMD; }
2226   }
2227
2228 # For timeout tests, wait before closing the pipe; we expect a
2229 # SIGPIPE error in this case.
2230
2231 if ($wait_time > 0)
2232   {
2233   printf("  Test %d sleep $wait_time ", $$subtestref);
2234   while ($wait_time-- > 0)
2235     {
2236     print ".";
2237     sleep(1);
2238     }
2239   printf("\r  Test %d                                       $cr", $$subtestref);
2240   }
2241
2242 $sigpipehappened = 0;
2243 close CMD;                # Waits for command to finish
2244 return $yield;            # Ran command and waited
2245 }
2246
2247
2248
2249
2250 ###############################################################################
2251 ###############################################################################
2252
2253 # Here beginneth the Main Program ...
2254
2255 ###############################################################################
2256 ###############################################################################
2257
2258
2259 autoflush STDOUT 1;
2260 print "Exim tester $testversion\n";
2261
2262 # extend the PATH with .../sbin
2263 # we map all (.../bin) to (.../sbin:.../bin)
2264 $ENV{PATH} = do {
2265   my %seen = map { $_, 1 } split /:/, $ENV{PATH};
2266   join ':' => map { m{(.*)/bin$}
2267                 ? ( $seen{"$1/sbin"} ? () : ("$1/sbin"), $_)
2268                 : ($_) }
2269       split /:/, $ENV{PATH};
2270 };
2271
2272 ##################################################
2273 #      Some tests check created file modes       #
2274 ##################################################
2275
2276 umask 022;
2277
2278
2279 ##################################################
2280 #       Check for the "less" command             #
2281 ##################################################
2282
2283 $more = "more" if system("which less >/dev/null 2>&1") != 0;
2284
2285
2286
2287 ##################################################
2288 #        Check for sudo access to root           #
2289 ##################################################
2290
2291 print "You need to have sudo access to root to run these tests. Checking ...\n";
2292 if (system("sudo date >/dev/null") != 0)
2293   {
2294   die "** Test for sudo failed: testing abandoned.\n";
2295   }
2296 else
2297   {
2298   print "Test for sudo OK\n";
2299   }
2300
2301
2302
2303 ##################################################
2304 #      See if an Exim binary has been given      #
2305 ##################################################
2306
2307 # If the first character of the first argument is '/', the argument is taken
2308 # as the path to the binary. If the first argument does not start with a
2309 # '/' but exists in the file system, it's assumed to be the Exim binary.
2310
2311 $parm_exim = (@ARGV > 0 && (-x $ARGV[0] or $ARGV[0] =~ m?^/?))? Cwd::abs_path(shift @ARGV) : "";
2312 print "Exim binary is $parm_exim\n" if $parm_exim ne "";
2313
2314
2315
2316 ##################################################
2317 # Sort out options and which tests are to be run #
2318 ##################################################
2319
2320 # There are a few possible options for the test script itself; after these, any
2321 # options are passed on to Exim calls within the tests. Typically, this is used
2322 # to turn on Exim debugging while setting up a test.
2323
2324 while (@ARGV > 0 && $ARGV[0] =~ /^-/)
2325   {
2326   my($arg) = shift @ARGV;
2327   if ($optargs eq "")
2328     {
2329     if ($arg eq "-DEBUG")  { $debug = 1; $cr = "\n"; next; }
2330     if ($arg eq "-DIFF")   { $cf = "diff -u"; next; }
2331     if ($arg eq "-CONTINUE"){$force_continue = 1;
2332                              $more = "cat";
2333                              next; }
2334     if ($arg eq "-UPDATE") { $force_update = 1; next; }
2335     if ($arg eq "-NOIPV4") { $have_ipv4 = 0; next; }
2336     if ($arg eq "-NOIPV6") { $have_ipv6 = 0; next; }
2337     if ($arg eq "-KEEP")   { $save_output = 1; next; }
2338     if ($arg =~ /^-FLAVOU?R$/) { $flavour = shift; next; }
2339     }
2340   $optargs .= " $arg";
2341   }
2342
2343 # Any subsequent arguments are a range of test numbers.
2344
2345 if (@ARGV > 0)
2346   {
2347   $test_end = $test_start = $ARGV[0];
2348   $test_end = $ARGV[1] if (@ARGV > 1);
2349   $test_end = ($test_start >= 9000)? $test_special_top : $test_top
2350     if $test_end eq "+";
2351   die "** Test numbers out of order\n" if ($test_end < $test_start);
2352   }
2353
2354
2355 ##################################################
2356 #      Make the command's directory current      #
2357 ##################################################
2358
2359 # After doing so, we find its absolute path name.
2360
2361 $cwd = $0;
2362 $cwd = '.' if ($cwd !~ s|/[^/]+$||);
2363 chdir($cwd) || die "** Failed to chdir to \"$cwd\": $!\n";
2364 $parm_cwd = Cwd::getcwd();
2365
2366
2367 ##################################################
2368 #     Search for an Exim binary to test          #
2369 ##################################################
2370
2371 # If an Exim binary hasn't been provided, try to find one. We can handle the
2372 # case where exim-testsuite is installed alongside Exim source directories. For
2373 # PH's private convenience, if there's a directory just called "exim4", that
2374 # takes precedence; otherwise exim-snapshot takes precedence over any numbered
2375 # releases.
2376
2377 if ($parm_exim eq "")
2378   {
2379   my($use_srcdir) = "";
2380
2381   opendir DIR, ".." || die "** Failed to opendir \"..\": $!\n";
2382   while ($f = readdir(DIR))
2383     {
2384     my($srcdir);
2385
2386     # Try this directory if it is "exim4" or if it is exim-snapshot or exim-n.m
2387     # possibly followed by -RCx where n.m is greater than any previously tried
2388     # directory. Thus, we should choose the highest version of Exim that has
2389     # been compiled.
2390
2391     if ($f eq "exim4" || $f eq "exim-snapshot" || $f eq 'src')
2392       { $srcdir = $f; }
2393     else
2394       { $srcdir = $f
2395         if ($f =~ /^exim-\d+\.\d+(-RC\d+)?$/ && $f gt $use_srcdir); }
2396
2397     # Look for a build directory with a binary in it. If we find a binary,
2398     # accept this source directory.
2399
2400     if ($srcdir)
2401       {
2402       opendir SRCDIR, "../$srcdir" ||
2403         die "** Failed to opendir \"$cwd/../$srcdir\": $!\n";
2404       while ($f = readdir(SRCDIR))
2405         {
2406         if ($f =~ /^build-/ && -e "../$srcdir/$f/exim")
2407           {
2408           $use_srcdir = $srcdir;
2409           $parm_exim = "$cwd/../$srcdir/$f/exim";
2410           $parm_exim =~ s'/[^/]+/\.\./'/';
2411           last;
2412           }
2413         }
2414       closedir(SRCDIR);
2415       }
2416
2417     # If we have found "exim4" or "exim-snapshot", that takes precedence.
2418     # Otherwise, continue to see if there's a later version.
2419
2420     last if $use_srcdir eq "exim4" || $use_srcdir eq "exim-snapshot";
2421     }
2422   closedir(DIR);
2423   print "Exim binary found in $parm_exim\n" if $parm_exim ne "";
2424   }
2425
2426 # If $parm_exim is still empty, ask the caller
2427
2428 if ($parm_exim eq "")
2429   {
2430   print "** Did not find an Exim binary to test\n";
2431   for ($i = 0; $i < 5; $i++)
2432     {
2433     my($trybin);
2434     print "** Enter pathname for Exim binary: ";
2435     chomp($trybin = <STDIN>);
2436     if (-e $trybin)
2437       {
2438       $parm_exim = $trybin;
2439       last;
2440       }
2441     else
2442       {
2443       print "** $trybin does not exist\n";
2444       }
2445     }
2446   die "** Too many tries\n" if $parm_exim eq "";
2447   }
2448
2449
2450
2451 ##################################################
2452 #          Find what is in the binary            #
2453 ##################################################
2454
2455 # deal with TRUSTED_CONFIG_LIST restrictions
2456 unlink("$parm_cwd/test-config") if -e "$parm_cwd/test-config";
2457 symlink("$parm_cwd/confs/0000", "$parm_cwd/test-config")
2458   or die "Unable to link initial config into place: $!\n";
2459
2460 print("Probing with config file: $parm_cwd/test-config\n");
2461 open(EXIMINFO, "$parm_exim -d -C $parm_cwd/test-config -DDIR=$parm_cwd " .
2462                "-bP exim_user exim_group 2>&1|") ||
2463   die "** Cannot run $parm_exim: $!\n";
2464 while(<EXIMINFO>)
2465   {
2466   $parm_eximuser = $1 if /^exim_user = (.*)$/;
2467   $parm_eximgroup = $1 if /^exim_group = (.*)$/;
2468   $parm_trusted_config_list = $1 if /^TRUSTED_CONFIG_LIST:.*?"(.*?)"$/;
2469   }
2470 close(EXIMINFO);
2471
2472 if (defined $parm_eximuser)
2473   {
2474   if ($parm_eximuser =~ /^\d+$/) { $parm_exim_uid = $parm_eximuser; }
2475     else { $parm_exim_uid = getpwnam($parm_eximuser); }
2476   }
2477 else
2478   {
2479   print "Unable to extract exim_user from binary.\n";
2480   print "Check if Exim refused to run; if so, consider:\n";
2481   print "  TRUSTED_CONFIG_LIST ALT_CONFIG_PREFIX WHITELIST_D_MACROS\n";
2482   die "Failing to get information from binary.\n";
2483   }
2484
2485 if (defined $parm_eximgroup)
2486   {
2487   if ($parm_eximgroup =~ /^\d+$/) { $parm_exim_gid = $parm_eximgroup; }
2488     else { $parm_exim_gid = getgrnam($parm_eximgroup); }
2489   }
2490
2491 # check the permissions on the TRUSTED_CONFIG_LIST
2492 if (defined $parm_trusted_config_list)
2493   {
2494   die "TRUSTED_CONFIG_LIST: $parm_trusted_config_list: $!\n"
2495     if not -f $parm_trusted_config_list;
2496
2497   die "TRUSTED_CONFIG_LIST $parm_trusted_config_list must not be world writable!\n"
2498     if 02 & (stat _)[2];
2499
2500   die sprintf "TRUSTED_CONFIG_LIST: $parm_trusted_config_list %d is group writable, but not owned by group '%s' or '%s'.\n",
2501   (stat _)[1],
2502     scalar(getgrgid 0), scalar(getgrgid $>)
2503     if (020 & (stat _)[2]) and not ((stat _)[5] == $> or (stat _)[5] == 0);
2504
2505   die sprintf "TRUSTED_CONFIG_LIST: $parm_trusted_config_list is not owned by user '%s' or '%s'.\n",
2506   scalar(getpwuid 0), scalar(getpwuid $>)
2507      if (not (-o _ or (stat _)[4] == 0));
2508
2509   open(TCL, $parm_trusted_config_list) or die "Can't open $parm_trusted_config_list: $!\n";
2510   my $test_config = getcwd() . '/test-config';
2511   die "Can't find '$test_config' in TRUSTED_CONFIG_LIST $parm_trusted_config_list."
2512   if not grep { /^$test_config$/ } <TCL>;
2513   }
2514 else
2515   {
2516   die "Unable to check the TRUSTED_CONFIG_LIST, seems to be empty?\n";
2517   }
2518
2519 open(EXIMINFO, "$parm_exim -bV -C $parm_cwd/test-config -DDIR=$parm_cwd |") ||
2520   die "** Cannot run $parm_exim: $!\n";
2521
2522 print "-" x 78, "\n";
2523
2524 while (<EXIMINFO>)
2525   {
2526   my(@temp);
2527
2528   if (/^Exim version/) { print; }
2529
2530   elsif (/^Size of off_t: (\d+)/)
2531     {
2532     print;
2533     $have_largefiles = 1 if $1 > 4;
2534     die "** Size of off_t > 32 which seems improbable, not running tests\n"
2535         if ($1 > 32);
2536     }
2537
2538   elsif (/^Support for: (.*)/)
2539     {
2540     print;
2541     @temp = split /(\s+)/, $1;
2542     push(@temp, ' ');
2543     %parm_support = @temp;
2544     }
2545
2546   elsif (/^Lookups \(built-in\): (.*)/)
2547     {
2548     print;
2549     @temp = split /(\s+)/, $1;
2550     push(@temp, ' ');
2551     %parm_lookups = @temp;
2552     }
2553
2554   elsif (/^Authenticators: (.*)/)
2555     {
2556     print;
2557     @temp = split /(\s+)/, $1;
2558     push(@temp, ' ');
2559     %parm_authenticators = @temp;
2560     }
2561
2562   elsif (/^Routers: (.*)/)
2563     {
2564     print;
2565     @temp = split /(\s+)/, $1;
2566     push(@temp, ' ');
2567     %parm_routers = @temp;
2568     }
2569
2570   # Some transports have options, e.g. appendfile/maildir. For those, ensure
2571   # that the basic transport name is set, and then the name with each of the
2572   # options.
2573
2574   elsif (/^Transports: (.*)/)
2575     {
2576     print;
2577     @temp = split /(\s+)/, $1;
2578     my($i,$k);
2579     push(@temp, ' ');
2580     %parm_transports = @temp;
2581     foreach $k (keys %parm_transports)
2582       {
2583       if ($k =~ "/")
2584         {
2585         @temp = split /\//, $k;
2586         $parm_transports{"$temp[0]"} = " ";
2587         for ($i = 1; $i < @temp; $i++)
2588           { $parm_transports{"$temp[0]/$temp[$i]"} = " "; }
2589         }
2590       }
2591     }
2592   }
2593 close(EXIMINFO);
2594 print "-" x 78, "\n";
2595
2596 unlink("$parm_cwd/test-config");
2597
2598 ##################################################
2599 #    Check for SpamAssassin and ClamAV           #
2600 ##################################################
2601
2602 # These are crude tests. If they aren't good enough, we'll have to improve
2603 # them, for example by actually passing a message through spamc or clamscan.
2604
2605 if (defined $parm_support{'Content_Scanning'})
2606   {
2607   my $sock = new FileHandle;
2608
2609   if (system("spamc -h 2>/dev/null >/dev/null") == 0)
2610     {
2611     print "The spamc command works:\n";
2612
2613     # This test for an active SpamAssassin is courtesy of John Jetmore.
2614     # The tests are hard coded to localhost:783, so no point in making
2615     # this test flexible like the clamav test until the test scripts are
2616     # changed.  spamd doesn't have the nice PING/PONG protoccol that
2617     # clamd does, but it does respond to errors in an informative manner,
2618     # so use that.
2619
2620     my($sint,$sport) = ('127.0.0.1',783);
2621     eval
2622       {
2623       my $sin = sockaddr_in($sport, inet_aton($sint))
2624           or die "** Failed packing $sint:$sport\n";
2625       socket($sock, PF_INET, SOCK_STREAM, getprotobyname('tcp'))
2626           or die "** Unable to open socket $sint:$sport\n";
2627
2628       local $SIG{ALRM} =
2629           sub { die "** Timeout while connecting to socket $sint:$sport\n"; };
2630       alarm(5);
2631       connect($sock, $sin)
2632           or die "** Unable to connect to socket $sint:$sport\n";
2633       alarm(0);
2634
2635       select((select($sock), $| = 1)[0]);
2636       print $sock "bad command\r\n";
2637
2638       $SIG{ALRM} =
2639           sub { die "** Timeout while reading from socket $sint:$sport\n"; };
2640       alarm(10);
2641       my $res = <$sock>;
2642       alarm(0);
2643
2644       $res =~ m|^SPAMD/|
2645           or die "** Did not get SPAMD from socket $sint:$sport. "
2646                 ."It said: $res\n";
2647       };
2648     alarm(0);
2649     if($@)
2650       {
2651       print "  $@";
2652       print "  Assume SpamAssassin (spamd) is not running\n";
2653       }
2654     else
2655       {
2656       $parm_running{'SpamAssassin'} = ' ';
2657       print "  SpamAssassin (spamd) seems to be running\n";
2658       }
2659     }
2660   else
2661     {
2662     print "The spamc command failed: assume SpamAssassin (spamd) is not running\n";
2663     }
2664
2665   # For ClamAV, we need to find the clamd socket for use in the Exim
2666   # configuration. Search for the clamd configuration file.
2667
2668   if (system("clamscan -h 2>/dev/null >/dev/null") == 0)
2669     {
2670     my($f, $clamconf, $test_prefix);
2671
2672     print "The clamscan command works";
2673
2674     $test_prefix = $ENV{EXIM_TEST_PREFIX};
2675     $test_prefix = "" if !defined $test_prefix;
2676
2677     foreach $f ("$test_prefix/etc/clamd.conf",
2678                 "$test_prefix/usr/local/etc/clamd.conf",
2679                 "$test_prefix/etc/clamav/clamd.conf", "")
2680       {
2681       if (-e $f)
2682         {
2683         $clamconf = $f;
2684         last;
2685         }
2686       }
2687
2688     # Read the ClamAV configuration file and find the socket interface.
2689
2690     if ($clamconf ne "")
2691       {
2692       my $socket_domain;
2693       open(IN, "$clamconf") || die "\n** Unable to open $clamconf: $!\n";
2694       while (<IN>)
2695         {
2696         if (/^LocalSocket\s+(.*)/)
2697           {
2698           $parm_clamsocket = $1;
2699           $socket_domain = AF_UNIX;
2700           last;
2701           }
2702         if (/^TCPSocket\s+(\d+)/)
2703           {
2704           if (defined $parm_clamsocket)
2705             {
2706             $parm_clamsocket .= " $1";
2707             $socket_domain = AF_INET;
2708             last;
2709             }
2710           else
2711             {
2712             $parm_clamsocket = " $1";
2713             }
2714           }
2715         elsif (/^TCPAddr\s+(\S+)/)
2716           {
2717           if (defined $parm_clamsocket)
2718             {
2719             $parm_clamsocket = $1 . $parm_clamsocket;
2720             $socket_domain = AF_INET;
2721             last;
2722             }
2723           else
2724             {
2725             $parm_clamsocket = $1;
2726             }
2727           }
2728         }
2729       close(IN);
2730
2731       if (defined $socket_domain)
2732         {
2733         print ":\n  The clamd socket is $parm_clamsocket\n";
2734         # This test for an active ClamAV is courtesy of Daniel Tiefnig.
2735         eval
2736           {
2737           my $socket;
2738           if ($socket_domain == AF_UNIX)
2739             {
2740             $socket = sockaddr_un($parm_clamsocket) or die "** Failed packing '$parm_clamsocket'\n";
2741             }
2742           elsif ($socket_domain == AF_INET)
2743             {
2744             my ($ca_host, $ca_port) = split(/\s+/,$parm_clamsocket);
2745             my $ca_hostent = gethostbyname($ca_host) or die "** Failed to get raw address for host '$ca_host'\n";
2746             $socket = sockaddr_in($ca_port, $ca_hostent) or die "** Failed packing '$parm_clamsocket'\n";
2747             }
2748           else
2749             {
2750             die "** Unknown socket domain '$socket_domain' (should not happen)\n";
2751             }
2752           socket($sock, $socket_domain, SOCK_STREAM, 0) or die "** Unable to open socket '$parm_clamsocket'\n";
2753           local $SIG{ALRM} = sub { die "** Timeout while connecting to socket '$parm_clamsocket'\n"; };
2754           alarm(5);
2755           connect($sock, $socket) or die "** Unable to connect to socket '$parm_clamsocket'\n";
2756           alarm(0);
2757
2758           my $ofh = select $sock; $| = 1; select $ofh;
2759           print $sock "PING\n";
2760
2761           $SIG{ALRM} = sub { die "** Timeout while reading from socket '$parm_clamsocket'\n"; };
2762           alarm(10);
2763           my $res = <$sock>;
2764           alarm(0);
2765
2766           $res =~ /PONG/ or die "** Did not get PONG from socket '$parm_clamsocket'. It said: $res\n";
2767           };
2768         alarm(0);
2769
2770         if($@)
2771           {
2772           print "  $@";
2773           print "  Assume ClamAV is not running\n";
2774           }
2775         else
2776           {
2777           $parm_running{'ClamAV'} = ' ';
2778           print "  ClamAV seems to be running\n";
2779           }
2780         }
2781       else
2782         {
2783         print ", but the socket for clamd could not be determined\n";
2784         print "Assume ClamAV is not running\n";
2785         }
2786       }
2787
2788     else
2789       {
2790       print ", but I can't find a configuration for clamd\n";
2791       print "Assume ClamAV is not running\n";
2792       }
2793     }
2794   }
2795
2796
2797 ##################################################
2798 #         Test for the basic requirements        #
2799 ##################################################
2800
2801 # This test suite assumes that Exim has been built with at least the "usual"
2802 # set of routers, transports, and lookups. Ensure that this is so.
2803
2804 $missing = "";
2805
2806 $missing .= "     Lookup: lsearch\n" if (!defined $parm_lookups{'lsearch'});
2807
2808 $missing .= "     Router: accept\n" if (!defined $parm_routers{'accept'});
2809 $missing .= "     Router: dnslookup\n" if (!defined $parm_routers{'dnslookup'});
2810 $missing .= "     Router: manualroute\n" if (!defined $parm_routers{'manualroute'});
2811 $missing .= "     Router: redirect\n" if (!defined $parm_routers{'redirect'});
2812
2813 $missing .= "     Transport: appendfile\n" if (!defined $parm_transports{'appendfile'});
2814 $missing .= "     Transport: autoreply\n" if (!defined $parm_transports{'autoreply'});
2815 $missing .= "     Transport: pipe\n" if (!defined $parm_transports{'pipe'});
2816 $missing .= "     Transport: smtp\n" if (!defined $parm_transports{'smtp'});
2817
2818 if ($missing ne "")
2819   {
2820   print "\n";
2821   print "** Many features can be included or excluded from Exim binaries.\n";
2822   print "** This test suite requires that Exim is built to contain a certain\n";
2823   print "** set of basic facilities. It seems that some of these are missing\n";
2824   print "** from the binary that is under test, so the test cannot proceed.\n";
2825   print "** The missing facilities are:\n";
2826   print "$missing";
2827   die "** Test script abandoned\n";
2828   }
2829
2830
2831 ##################################################
2832 #      Check for the auxiliary programs          #
2833 ##################################################
2834
2835 # These are always required:
2836
2837 for $prog ("cf", "checkaccess", "client", "client-ssl", "client-gnutls",
2838            "fakens", "iefbr14", "server")
2839   {
2840   next if ($prog eq "client-ssl" && !defined $parm_support{'OpenSSL'});
2841   next if ($prog eq "client-gnutls" && !defined $parm_support{'GnuTLS'});
2842   if (!-e "bin/$prog")
2843     {
2844     print "\n";
2845     print "** bin/$prog does not exist. Have you run ./configure and make?\n";
2846     die "** Test script abandoned\n";
2847     }
2848   }
2849
2850 # If the "loaded" binary is missing, we cut out tests for ${dlfunc. It isn't
2851 # compiled on systems where we don't know how to. However, if Exim does not
2852 # have that functionality compiled, we needn't bother.
2853
2854 $dlfunc_deleted = 0;
2855 if (defined $parm_support{'Expand_dlfunc'} && !-e "bin/loaded")
2856   {
2857   delete $parm_support{'Expand_dlfunc'};
2858   $dlfunc_deleted = 1;
2859   }
2860
2861
2862 ##################################################
2863 #          Find environmental details            #
2864 ##################################################
2865
2866 # Find the caller of this program.
2867
2868 ($parm_caller,$pwpw,$parm_caller_uid,$parm_caller_gid,$pwquota,$pwcomm,
2869  $parm_caller_gecos, $parm_caller_home) = getpwuid($>);
2870
2871 $pwpw = $pwpw;       # Kill Perl warnings
2872 $pwquota = $pwquota;
2873 $pwcomm = $pwcomm;
2874
2875 $parm_caller_group = getgrgid($parm_caller_gid);
2876
2877 print "Program caller is $parm_caller ($parm_caller_uid), whose group is $parm_caller_group ($parm_caller_gid)\n";
2878 print "Home directory is $parm_caller_home\n";
2879
2880 unless (defined $parm_eximgroup)
2881   {
2882   print "Unable to derive \$parm_eximgroup.\n";
2883   die "** ABANDONING.\n";
2884   }
2885
2886 print "You need to be in the Exim group to run these tests. Checking ...";
2887
2888 if (`groups` =~ /\b\Q$parm_eximgroup\E\b/)
2889   {
2890   print " OK\n";
2891   }
2892 else
2893   {
2894   print "\nOh dear, you are not in the Exim group.\n";
2895   die "** Testing abandoned.\n";
2896   }
2897
2898 # Find this host's IP addresses - there may be many, of course, but we keep
2899 # one of each type (IPv4 and IPv6).
2900
2901 $parm_ipv4 = "";
2902 $parm_ipv6 = "";
2903
2904 $local_ipv4 = "";
2905 $local_ipv6 = "";
2906
2907 open(IFCONFIG, "ifconfig -a|") || die "** Cannot run \"ifconfig\": $!\n";
2908 while (($parm_ipv4 eq "" || $parm_ipv6 eq "") && ($_ = <IFCONFIG>))
2909   {
2910   my($ip);
2911   if ($parm_ipv4 eq "" &&
2912       $_ =~ /^\s*inet(?:\saddr)?:?\s?(\d+\.\d+\.\d+\.\d+)\s/i)
2913     {
2914     $ip = $1;
2915     next if ($ip =~ /^127\./ || $ip =~ /^10\./);
2916     $parm_ipv4 = $ip;
2917     }
2918
2919   if ($parm_ipv6 eq "" &&
2920       $_ =~ /^\s*inet6(?:\saddr)?:?\s?([abcdef\d:]+)/i)
2921     {
2922     $ip = $1;
2923     next if ($ip eq "::1" || $ip =~ /^fe80/i);
2924     $parm_ipv6 = $ip;
2925     }
2926   }
2927 close(IFCONFIG);
2928
2929 # Use private IP addresses if there are no public ones.
2930
2931 $parm_ipv4 = $local_ipv4 if ($parm_ipv4 eq "");
2932 $parm_ipv6 = $local_ipv6 if ($parm_ipv6 eq "");
2933
2934 # If either type of IP address is missing, we need to set the value to
2935 # something other than empty, because that wrecks the substitutions. The value
2936 # is reflected, so use a meaningful string. Set appropriate options for the
2937 # "server" command. In practice, however, many tests assume 127.0.0.1 is
2938 # available, so things will go wrong if there is no IPv4 address. The lack
2939 # of IPV4 or IPv6 can be simulated by command options, which force $have_ipv4
2940 # and $have_ipv6 false.
2941
2942 if ($parm_ipv4 eq "")
2943   {
2944   $have_ipv4 = 0;
2945   $parm_ipv4 = "<no IPv4 address found>";
2946   $server_opts .= " -noipv4";
2947   }
2948 elsif ($have_ipv4 == 0)
2949   {
2950   $parm_ipv4 = "<IPv4 testing disabled>";
2951   $server_opts .= " -noipv4";
2952   }
2953 else
2954   {
2955   $parm_running{"IPv4"} = " ";
2956   }
2957
2958 if ($parm_ipv6 eq "")
2959   {
2960   $have_ipv6 = 0;
2961   $parm_ipv6 = "<no IPv6 address found>";
2962   $server_opts .= " -noipv6";
2963   delete($parm_support{"IPv6"});
2964   }
2965 elsif ($have_ipv6 == 0)
2966   {
2967   $parm_ipv6 = "<IPv6 testing disabled>";
2968   $server_opts .= " -noipv6";
2969   delete($parm_support{"IPv6"});
2970   }
2971 elsif (!defined $parm_support{'IPv6'})
2972   {
2973   $have_ipv6 = 0;
2974   $parm_ipv6 = "<no IPv6 support in Exim binary>";
2975   $server_opts .= " -noipv6";
2976   }
2977 else
2978   {
2979   $parm_running{"IPv6"} = " ";
2980   }
2981
2982 print "IPv4 address is $parm_ipv4\n";
2983 print "IPv6 address is $parm_ipv6\n";
2984
2985 # For munging test output, we need the reversed IP addresses.
2986
2987 $parm_ipv4r = ($parm_ipv4 !~ /^\d/)? "" :
2988   join(".", reverse(split /\./, $parm_ipv4));
2989
2990 $parm_ipv6r = $parm_ipv6;             # Appropriate if not in use
2991 if ($parm_ipv6 =~ /^[\da-f]/)
2992   {
2993   my(@comps) = split /:/, $parm_ipv6;
2994   my(@nibbles);
2995   foreach $comp (@comps)
2996     {
2997     push @nibbles, sprintf("%lx", hex($comp) >> 8);
2998     push @nibbles, sprintf("%lx", hex($comp) & 0xff);
2999     }
3000   $parm_ipv6r = join(".", reverse(@nibbles));
3001   }
3002
3003 # Find the host name, fully qualified.
3004
3005 chomp($temp = `hostname`);
3006 $parm_hostname = (gethostbyname($temp))[0];
3007 $parm_hostname = "no.host.name.found" if $parm_hostname eq "";
3008 print "Hostname is $parm_hostname\n";
3009
3010 if ($parm_hostname !~ /\./)
3011   {
3012   print "\n*** Host name is not fully qualified: this may cause problems ***\n\n";
3013   }
3014
3015 if ($parm_hostname =~ /[[:upper:]]/)
3016   {
3017   print "\n*** Host name has upper case characters: this may cause problems ***\n\n";
3018   }
3019
3020
3021
3022 ##################################################
3023 #     Create a testing version of Exim           #
3024 ##################################################
3025
3026 # We want to be able to run Exim with a variety of configurations. Normally,
3027 # the use of -C to change configuration causes Exim to give up its root
3028 # privilege (unless the caller is exim or root). For these tests, we do not
3029 # want this to happen. Also, we want Exim to know that it is running in its
3030 # test harness.
3031
3032 # We achieve this by copying the binary and patching it as we go. The new
3033 # binary knows it is a testing copy, and it allows -C and -D without loss of
3034 # privilege. Clearly, this file is dangerous to have lying around on systems
3035 # where there are general users with login accounts. To protect against this,
3036 # we put the new binary in a special directory that is accessible only to the
3037 # caller of this script, who is known to have sudo root privilege from the test
3038 # that was done above. Furthermore, we ensure that the binary is deleted at the
3039 # end of the test. First ensure the directory exists.
3040
3041 if (-d "eximdir")
3042   { unlink "eximdir/exim"; }     # Just in case
3043 else
3044   {
3045   mkdir("eximdir", 0710) || die "** Unable to mkdir $parm_cwd/eximdir: $!\n";
3046   system("sudo chgrp $parm_eximgroup eximdir");
3047   }
3048
3049 # The construction of the patched binary must be done as root, so we use
3050 # a separate script. As well as indicating that this is a test-harness binary,
3051 # the version number is patched to "x.yz" so that its length is always the
3052 # same. Otherwise, when it appears in Received: headers, it affects the length
3053 # of the message, which breaks certain comparisons.
3054
3055 die "** Unable to make patched exim: $!\n"
3056   if (system("sudo ./patchexim $parm_exim") != 0);
3057
3058 # From this point on, exits from the program must go via the subroutine
3059 # tests_exit(), so that suitable cleaning up can be done when required.
3060 # Arrange to catch interrupting signals, to assist with this.
3061
3062 $SIG{'INT'} = \&inthandler;
3063 $SIG{'PIPE'} = \&pipehandler;
3064
3065 # For some tests, we need another copy of the binary that is setuid exim rather
3066 # than root.
3067
3068 system("sudo cp eximdir/exim eximdir/exim_exim;" .
3069        "sudo chown $parm_eximuser eximdir/exim_exim;" .
3070        "sudo chgrp $parm_eximgroup eximdir/exim_exim;" .
3071        "sudo chmod 06755 eximdir/exim_exim");
3072
3073
3074 ##################################################
3075 #     Make copies of utilities we might need     #
3076 ##################################################
3077
3078 # Certain of the tests make use of some of Exim's utilities. We do not need
3079 # to be root to copy these.
3080
3081 ($parm_exim_dir) = $parm_exim =~ m?^(.*)/exim?;
3082
3083 $dbm_build_deleted = 0;
3084 if (defined $parm_lookups{'dbm'} &&
3085     system("cp $parm_exim_dir/exim_dbmbuild eximdir") != 0)
3086   {
3087   delete $parm_lookups{'dbm'};
3088   $dbm_build_deleted = 1;
3089   }
3090
3091 if (system("cp $parm_exim_dir/exim_dumpdb eximdir") != 0)
3092   {
3093   tests_exit(-1, "Failed to make a copy of exim_dumpdb: $!");
3094   }
3095
3096 if (system("cp $parm_exim_dir/exim_lock eximdir") != 0)
3097   {
3098   tests_exit(-1, "Failed to make a copy of exim_lock: $!");
3099   }
3100
3101 if (system("cp $parm_exim_dir/exinext eximdir") != 0)
3102   {
3103   tests_exit(-1, "Failed to make a copy of exinext: $!");
3104   }
3105
3106 if (system("cp $parm_exim_dir/exigrep eximdir") != 0)
3107   {
3108   tests_exit(-1, "Failed to make a copy of exigrep: $!");
3109   }
3110
3111 if (system("cp $parm_exim_dir/eximstats eximdir") != 0)
3112   {
3113   tests_exit(-1, "Failed to make a copy of eximstats: $!");
3114   }
3115
3116
3117 ##################################################
3118 #    Check that the Exim user can access stuff   #
3119 ##################################################
3120
3121 # We delay this test till here so that we can check access to the actual test
3122 # binary. This will be needed when Exim re-exec's itself to do deliveries.
3123
3124 print "Exim user is $parm_eximuser ($parm_exim_uid)\n";
3125 print "Exim group is $parm_eximgroup ($parm_exim_gid)\n";
3126
3127 if ($parm_caller_uid eq $parm_exim_uid) {
3128   tests_exit(-1, "Exim user ($parm_eximuser,$parm_exim_uid) cannot be "
3129                 ."the same as caller ($parm_caller,$parm_caller_uid)");
3130 }
3131
3132 print "The Exim user needs access to the test suite directory. Checking ...";
3133
3134 if (($rc = system("sudo bin/checkaccess $parm_cwd/eximdir/exim $parm_eximuser $parm_eximgroup")) != 0)
3135   {
3136   my($why) = "unknown failure $rc";
3137   $rc >>= 8;
3138   $why = "Couldn't find user \"$parm_eximuser\"" if $rc == 1;
3139   $why = "Couldn't find group \"$parm_eximgroup\"" if $rc == 2;
3140   $why = "Couldn't read auxiliary group list" if $rc == 3;
3141   $why = "Couldn't get rid of auxiliary groups" if $rc == 4;
3142   $why = "Couldn't set gid" if $rc == 5;
3143   $why = "Couldn't set uid" if $rc == 6;
3144   $why = "Couldn't open \"$parm_cwd/eximdir/exim\"" if $rc == 7;
3145   print "\n** $why\n";
3146   tests_exit(-1, "$parm_eximuser cannot access the test suite directory");
3147   }
3148 else
3149   {
3150   print " OK\n";
3151   }
3152
3153
3154 ##################################################
3155 #        Create a list of available tests        #
3156 ##################################################
3157
3158 # The scripts directory contains a number of subdirectories whose names are
3159 # of the form 0000-xxxx, 1100-xxxx, 2000-xxxx, etc. Each set of tests apart
3160 # from the first requires certain optional features to be included in the Exim
3161 # binary. These requirements are contained in a file called "REQUIRES" within
3162 # the directory. We scan all these tests, discarding those that cannot be run
3163 # because the current binary does not support the right facilities, and also
3164 # those that are outside the numerical range selected.
3165
3166 print "\nTest range is $test_start to $test_end (flavour $flavour)\n";
3167 print "Omitting \${dlfunc expansion tests (loadable module not present)\n"
3168   if $dlfunc_deleted;
3169 print "Omitting dbm tests (unable to copy exim_dbmbuild)\n"
3170   if $dbm_build_deleted;
3171
3172 opendir(DIR, "scripts") || tests_exit(-1, "Failed to opendir(\"scripts\"): $!");
3173 @test_dirs = sort readdir(DIR);
3174 closedir(DIR);
3175
3176 # Remove . and .. and CVS from the list.
3177
3178 for ($i = 0; $i < @test_dirs; $i++)
3179   {
3180   my($d) = $test_dirs[$i];
3181   if ($d eq "." || $d eq ".." || $d eq "CVS")
3182     {
3183     splice @test_dirs, $i, 1;
3184     $i--;
3185     }
3186   }
3187
3188 # Scan for relevant tests
3189
3190 for ($i = 0; $i < @test_dirs; $i++)
3191   {
3192   my($testdir) = $test_dirs[$i];
3193   my($wantthis) = 1;
3194
3195   print ">>Checking $testdir\n" if $debug;
3196
3197   # Skip this directory if the first test is equal or greater than the first
3198   # test in the next directory.
3199
3200   next if ($i < @test_dirs - 1) &&
3201           ($test_start >= substr($test_dirs[$i+1], 0, 4));
3202
3203   # No need to carry on if the end test is less than the first test in this
3204   # subdirectory.
3205
3206   last if $test_end < substr($testdir, 0, 4);
3207
3208   # Check requirements, if any.
3209
3210   if (open(REQUIRES, "scripts/$testdir/REQUIRES"))
3211     {
3212     while (<REQUIRES>)
3213       {
3214       next if /^\s*$/;
3215       s/\s+$//;
3216       if (/^support (.*)$/)
3217         {
3218         if (!defined $parm_support{$1}) { $wantthis = 0; last; }
3219         }
3220       elsif (/^running (.*)$/)
3221         {
3222         if (!defined $parm_running{$1}) { $wantthis = 0; last; }
3223         }
3224       elsif (/^lookup (.*)$/)
3225         {
3226         if (!defined $parm_lookups{$1}) { $wantthis = 0; last; }
3227         }
3228       elsif (/^authenticators? (.*)$/)
3229         {
3230         if (!defined $parm_authenticators{$1}) { $wantthis = 0; last; }
3231         }
3232       elsif (/^router (.*)$/)
3233         {
3234         if (!defined $parm_routers{$1}) { $wantthis = 0; last; }
3235         }
3236       elsif (/^transport (.*)$/)
3237         {
3238         if (!defined $parm_transports{$1}) { $wantthis = 0; last; }
3239         }
3240       else
3241         {
3242         tests_exit(-1, "Unknown line in \"scripts/$testdir/REQUIRES\": \"$_\"");
3243         }
3244       }
3245     close(REQUIRES);
3246     }
3247   else
3248     {
3249     tests_exit(-1, "Failed to open \"scripts/$testdir/REQUIRES\": $!")
3250       unless $!{ENOENT};
3251     }
3252
3253   # Loop if we do not want the tests in this subdirectory.
3254
3255   if (!$wantthis)
3256     {
3257     chomp;
3258     print "Omitting tests in $testdir (missing $_)\n";
3259     next;
3260     }
3261
3262   # We want the tests from this subdirectory, provided they are in the
3263   # range that was selected.
3264
3265   opendir(SUBDIR, "scripts/$testdir") ||
3266     tests_exit(-1, "Failed to opendir(\"scripts/$testdir\"): $!");
3267   @testlist = sort readdir(SUBDIR);
3268   close(SUBDIR);
3269
3270   foreach $test (@testlist)
3271     {
3272     next if $test !~ /^\d{4}(?:\.\d+)?$/;
3273     next if $test < $test_start || $test > $test_end;
3274     push @test_list, "$testdir/$test";
3275     }
3276   }
3277
3278 print ">>Test List: @test_list\n", if $debug;
3279
3280
3281 ##################################################
3282 #         Munge variable auxiliary data          #
3283 ##################################################
3284
3285 # Some of the auxiliary data files have to refer to the current testing
3286 # directory and other parameter data. The generic versions of these files are
3287 # stored in the aux-var-src directory. At this point, we copy each of them
3288 # to the aux-var directory, making appropriate substitutions. There aren't very
3289 # many of them, so it's easiest just to do this every time. Ensure the mode
3290 # is standardized, as this path is used as a test for the ${stat: expansion.
3291
3292 # A similar job has to be done for the files in the dnszones-src directory, to
3293 # make the fake DNS zones for testing. Most of the zone files are copied to
3294 # files of the same name, but db.ipv4.V4NET and db.ipv6.V6NET use the testing
3295 # networks that are defined by parameter.
3296
3297 foreach $basedir ("aux-var", "dnszones")
3298   {
3299   system("sudo rm -rf $parm_cwd/$basedir");
3300   mkdir("$parm_cwd/$basedir", 0777);
3301   chmod(0755, "$parm_cwd/$basedir");
3302
3303   opendir(AUX, "$parm_cwd/$basedir-src") ||
3304     tests_exit(-1, "Failed to opendir $parm_cwd/$basedir-src: $!");
3305   my(@filelist) = readdir(AUX);
3306   close(AUX);
3307
3308   foreach $file (@filelist)
3309     {
3310     my($outfile) = $file;
3311     next if $file =~ /^\./;
3312
3313     if ($file eq "db.ip4.V4NET")
3314       {
3315       $outfile = "db.ip4.$parm_ipv4_test_net";
3316       }
3317     elsif ($file eq "db.ip6.V6NET")
3318       {
3319       my(@nibbles) = reverse(split /\s*/, $parm_ipv6_test_net);
3320       $" = '.';
3321       $outfile = "db.ip6.@nibbles";
3322       $" = ' ';
3323       }
3324
3325     print ">>Copying $basedir-src/$file to $basedir/$outfile\n" if $debug;
3326     open(IN, "$parm_cwd/$basedir-src/$file") ||
3327       tests_exit(-1, "Failed to open $parm_cwd/$basedir-src/$file: $!");
3328     open(OUT, ">$parm_cwd/$basedir/$outfile") ||
3329       tests_exit(-1, "Failed to open $parm_cwd/$basedir/$outfile: $!");
3330     while (<IN>)
3331       {
3332       do_substitute(0);
3333       print OUT;
3334       }
3335     close(IN);
3336     close(OUT);
3337     }
3338   }
3339
3340 # Set a user's shell, distinguishable from /bin/sh
3341
3342 symlink("/bin/sh","aux-var/sh");
3343 $ENV{'SHELL'} = $parm_shell = $parm_cwd . "/aux-var/sh";
3344
3345 ##################################################
3346 #     Create fake DNS zones for this host        #
3347 ##################################################
3348
3349 # There are fixed zone files for 127.0.0.1 and ::1, but we also want to be
3350 # sure that there are forward and reverse registrations for this host, using
3351 # its real IP addresses. Dynamically created zone files achieve this.
3352
3353 if ($have_ipv4 || $have_ipv6)
3354   {
3355   my($shortname,$domain) = $parm_hostname =~ /^([^.]+)(.*)/;
3356   open(OUT, ">$parm_cwd/dnszones/db$domain") ||
3357     tests_exit(-1, "Failed to open $parm_cwd/dnszones/db$domain: $!");
3358   print OUT "; This is a dynamically constructed fake zone file.\n" .
3359     "; The following line causes fakens to return PASS_ON\n" .
3360     "; for queries that it cannot answer\n\n" .
3361     "PASS ON NOT FOUND\n\n";
3362   print OUT "$shortname  A     $parm_ipv4\n" if $have_ipv4;
3363   print OUT "$shortname  AAAA  $parm_ipv6\n" if $have_ipv6;
3364   print OUT "\n; End\n";
3365   close(OUT);
3366   }
3367
3368 if ($have_ipv4 && $parm_ipv4 ne "127.0.0.1")
3369   {
3370   my(@components) = $parm_ipv4 =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)/;
3371   open(OUT, ">$parm_cwd/dnszones/db.ip4.$components[0]") ||
3372     tests_exit(-1,
3373       "Failed  to open $parm_cwd/dnszones/db.ip4.$components[0]: $!");
3374   print OUT "; This is a dynamically constructed fake zone file.\n" .
3375     "; The zone is $components[0].in-addr.arpa.\n\n" .
3376     "$components[3].$components[2].$components[1]  PTR  $parm_hostname.\n\n" .
3377     "; End\n";
3378   close(OUT);
3379   }
3380
3381 if ($have_ipv6 && $parm_ipv6 ne "::1")
3382   {
3383   my($exp_v6) = $parm_ipv6;
3384   $exp_v6 =~ s/[^:]//g;
3385   if ( $parm_ipv6 =~ /^([^:].+)::$/ ) {
3386     $exp_v6 = $1 . ':0' x (9-length($exp_v6));
3387   } elsif ( $parm_ipv6 =~ /^(.+)::(.+)$/ ) {
3388     $exp_v6 = $1 . ':0' x (8-length($exp_v6)) . ':' . $2;
3389   } elsif ( $parm_ipv6 =~ /^::(.+[^:])$/ ) {
3390     $exp_v6 = '0:' x (9-length($exp_v6)) . $1;
3391   } else {
3392     $exp_v6 = $parm_ipv6;
3393   }
3394   my(@components) = split /:/, $exp_v6;
3395   my(@nibbles) = reverse (split /\s*/, shift @components);
3396   my($sep) =  "";
3397
3398   $" = ".";
3399   open(OUT, ">$parm_cwd/dnszones/db.ip6.@nibbles") ||
3400     tests_exit(-1,
3401       "Failed  to open $parm_cwd/dnszones/db.ip6.@nibbles: $!");
3402   print OUT "; This is a dynamically constructed fake zone file.\n" .
3403     "; The zone is @nibbles.ip6.arpa.\n\n";
3404
3405   @components = reverse @components;
3406   foreach $c (@components)
3407     {
3408     $c = "0$c" until $c =~ /^..../;
3409     @nibbles = reverse(split /\s*/, $c);
3410     print OUT "$sep@nibbles";
3411     $sep = ".";
3412     }
3413
3414   print OUT "  PTR  $parm_hostname.\n\n; End\n";
3415   close(OUT);
3416   $" = " ";
3417   }
3418
3419
3420
3421 ##################################################
3422 #    Create lists of mailboxes and message logs  #
3423 ##################################################
3424
3425 # We use these lists to check that a test has created the expected files. It
3426 # should be faster than looking for the file each time. For mailboxes, we have
3427 # to scan a complete subtree, in order to handle maildirs. For msglogs, there
3428 # is just a flat list of files.
3429
3430 @oldmails = list_files_below("mail");
3431 opendir(DIR, "msglog") || tests_exit(-1, "Failed to opendir msglog: $!");
3432 @oldmsglogs = readdir(DIR);
3433 closedir(DIR);
3434
3435
3436
3437 ##################################################
3438 #         Run the required tests                 #
3439 ##################################################
3440
3441 # Each test script contains a number of tests, separated by a line that
3442 # contains ****. We open input from the terminal so that we can read responses
3443 # to prompts.
3444
3445 open(T, "/dev/tty") || tests_exit(-1, "Failed to open /dev/tty: $!");
3446
3447 print "\nPress RETURN to run the tests: ";
3448 $_ = $force_continue ? "c" : <T>;
3449 print "\n";
3450
3451 $lasttestdir = "";
3452
3453 foreach $test (@test_list)
3454   {
3455   local($lineno) = 0;
3456   local($commandno) = 0;
3457   local($subtestno) = 0;
3458   (local $testno = $test) =~ s|.*/||;
3459   local($sortlog) = 0;
3460
3461   my($gnutls) = 0;
3462   my($docheck) = 1;
3463   my($thistestdir) = substr($test, 0, -5);
3464
3465   if ($lasttestdir ne $thistestdir)
3466     {
3467     $gnutls = 0;
3468     if (-s "scripts/$thistestdir/REQUIRES")
3469       {
3470       my($indent) = "";
3471       print "\n>>> The following tests require: ";
3472       open(IN, "scripts/$thistestdir/REQUIRES") ||
3473         tests_exit(-1, "Failed to open scripts/$thistestdir/REQUIRES: $1");
3474       while (<IN>)
3475         {
3476         $gnutls = 1 if /^support GnuTLS/;
3477         print $indent, $_;
3478         $indent = ">>>                              ";
3479         }
3480       close(IN);
3481       }
3482     }
3483   $lasttestdir = $thistestdir;
3484
3485   # Remove any debris in the spool directory and the test-mail directory
3486   # and also the files for collecting stdout and stderr. Then put back
3487   # the test-mail directory for appendfile deliveries.
3488
3489   system "sudo /bin/rm -rf spool test-*";
3490   system "mkdir test-mail 2>/dev/null";
3491
3492   # A privileged Exim will normally make its own spool directory, but some of
3493   # the tests run in unprivileged modes that don't always work if the spool
3494   # directory isn't already there. What is more, we want anybody to be able
3495   # to read it in order to find the daemon's pid.
3496
3497   system "mkdir spool; " .
3498          "sudo chown $parm_eximuser:$parm_eximgroup spool; " .
3499          "sudo chmod 0755 spool";
3500
3501   # Empty the cache that keeps track of things like message id mappings, and
3502   # set up the initial sequence strings.
3503
3504   undef %cache;
3505   $next_msgid = "aX";
3506   $next_pid = 1234;
3507   $next_port = 1111;
3508   $message_skip = 0;
3509   $msglog_skip = 0;
3510   $stderr_skip = 0;
3511   $stdout_skip = 0;
3512   $rmfiltertest = 0;
3513   $is_ipv6test = 0;
3514   $TEST_STATE->{munge} = "";
3515
3516   # Remove the associative arrays used to hold checked mail files and msglogs
3517
3518   undef %expected_mails;
3519   undef %expected_msglogs;
3520
3521   # Open the test's script
3522   open(SCRIPT, "scripts/$test") ||
3523     tests_exit(-1, "Failed to open \"scripts/$test\": $!");
3524   # Run through the script once to set variables which should be global
3525   while (<SCRIPT>)
3526     {
3527     if (/^no_message_check/) { $message_skip = 1; next; }
3528     if (/^no_msglog_check/)  { $msglog_skip = 1; next; }
3529     if (/^no_stderr_check/)  { $stderr_skip = 1; next; }
3530     if (/^no_stdout_check/)  { $stdout_skip = 1; next; }
3531     if (/^rmfiltertest/)     { $rmfiltertest = 1; next; }
3532     if (/^sortlog/)          { $sortlog = 1; next; }
3533     }
3534   # Reset to beginning of file for per test interpreting/processing
3535   seek(SCRIPT, 0, 0);
3536
3537   # The first line in the script must be a comment that is used to identify
3538   # the set of tests as a whole.
3539
3540   $_ = <SCRIPT>;
3541   $lineno++;
3542   tests_exit(-1, "Missing identifying comment at start of $test") if (!/^#/);
3543   printf("%s %s", (substr $test, 5), (substr $_, 2));
3544
3545   # Loop for each of the subtests within the script. The variable $server_pid
3546   # is used to remember the pid of a "server" process, for which we do not
3547   # wait until we have waited for a subsequent command.
3548
3549   local($server_pid) = 0;
3550   for ($commandno = 1; !eof SCRIPT; $commandno++)
3551     {
3552     # Skip further leading comments and blank lines, handle the flag setting
3553     # commands, and deal with tests for IP support.
3554
3555     while (<SCRIPT>)
3556       {
3557       $lineno++;
3558       # Could remove these variable settings because they are already
3559       # set above, but doesn't hurt to leave them here.
3560       if (/^no_message_check/) { $message_skip = 1; next; }
3561       if (/^no_msglog_check/)  { $msglog_skip = 1; next; }
3562       if (/^no_stderr_check/)  { $stderr_skip = 1; next; }
3563       if (/^no_stdout_check/)  { $stdout_skip = 1; next; }
3564       if (/^rmfiltertest/)     { $rmfiltertest = 1; next; }
3565       if (/^sortlog/)          { $sortlog = 1; next; }
3566
3567       if (/^need_largefiles/)
3568         {
3569         next if $have_largefiles;
3570         print ">>> Large file support is needed for test $testno, but is not available: skipping\n";
3571         $docheck = 0;      # don't check output
3572         undef $_;          # pretend EOF
3573         last;
3574         }
3575
3576       if (/^need_ipv4/)
3577         {
3578         next if $have_ipv4;
3579         print ">>> IPv4 is needed for test $testno, but is not available: skipping\n";
3580         $docheck = 0;      # don't check output
3581         undef $_;          # pretend EOF
3582         last;
3583         }
3584
3585       if (/^need_ipv6/)
3586         {
3587         if ($have_ipv6)
3588           {
3589           $is_ipv6test = 1;
3590           next;
3591           }
3592         print ">>> IPv6 is needed for test $testno, but is not available: skipping\n";
3593         $docheck = 0;      # don't check output
3594         undef $_;          # pretend EOF
3595         last;
3596         }
3597
3598       if (/^need_move_frozen_messages/)
3599         {
3600         next if defined $parm_support{"move_frozen_messages"};
3601         print ">>> move frozen message support is needed for test $testno, " .
3602           "but is not\n>>> available: skipping\n";
3603         $docheck = 0;      # don't check output
3604         undef $_;          # pretend EOF
3605         last;
3606         }
3607
3608       last unless /^(#|\s*$)/;
3609       }
3610     last if !defined $_;  # Hit EOF
3611
3612     my($subtest_startline) = $lineno;
3613
3614     # Now run the command. The function returns 0 if exim was run and waited
3615     # for, 1 if any other command was run and waited for, and 2 if a command
3616     # was run and not waited for (usually a daemon or server startup).
3617
3618     my($commandname) = "";
3619     my($expectrc) = 0;
3620     my($rc, $run_extra) = run_command($testno, \$subtestno, \$expectrc, \$commandname, $TEST_STATE);
3621     my($cmdrc) = $?;
3622
3623 $0 = "[runtest $testno]";
3624
3625     if ($debug) {
3626       print ">> rc=$rc cmdrc=$cmdrc\n";
3627       if (defined $run_extra) {
3628         foreach my $k (keys %$run_extra) {
3629           my $v = defined $run_extra->{$k} ? qq!"$run_extra->{$k}"! : '<undef>';
3630           print ">>   $k -> $v\n";
3631         }
3632       }
3633     }
3634     $run_extra = {} unless defined $run_extra;
3635     foreach my $k (keys %$run_extra) {
3636       if (exists $TEST_STATE->{$k}) {
3637         my $nv = defined $run_extra->{$k} ? qq!"$run_extra->{$k}"! : 'removed';
3638         print ">> override of $k; was $TEST_STATE->{$k}, now $nv\n" if $debug;
3639       }
3640       if (defined $run_extra->{$k}) {
3641         $TEST_STATE->{$k} = $run_extra->{$k};
3642       } elsif (exists $TEST_STATE->{$k}) {
3643         delete $TEST_STATE->{$k};
3644       }
3645     }
3646
3647     # Hit EOF after an initial return code number
3648
3649     tests_exit(-1, "Unexpected EOF in script") if ($rc == 4);
3650
3651     # Carry on with the next command if we did not wait for this one. $rc == 0
3652     # if no subprocess was run; $rc == 3 if we started a process but did not
3653     # wait for it.
3654
3655     next if ($rc == 0 || $rc == 3);
3656
3657     # We ran and waited for a command. Check for the expected result unless
3658     # it died.
3659
3660     if ($cmdrc != $expectrc && !$sigpipehappened)
3661       {
3662       printf("** Command $commandno (\"$commandname\", starting at line $subtest_startline)\n");
3663       if (($cmdrc & 0xff) == 0)
3664         {
3665         printf("** Return code %d (expected %d)", $cmdrc/256, $expectrc/256);
3666         }
3667       elsif (($cmdrc & 0xff00) == 0)
3668         { printf("** Killed by signal %d", $cmdrc & 255); }
3669       else
3670         { printf("** Status %x", $cmdrc); }
3671
3672       for (;;)
3673         {
3674         print "\nshow stdErr, show stdOut, Retry, Continue (without file comparison), or Quit? [Q] ";
3675         $_ = $force_continue ? "c" : <T>;
3676         tests_exit(1) if /^q?$/i;
3677         log_failure($log_failed_filename, $testno, "exit code unexpected") if (/^c$/i && $force_continue);
3678         print "... continue forced\n" if $force_continue;
3679         last if /^[rc]$/i;
3680         if (/^e$/i)
3681           {
3682           system("$more test-stderr");
3683           }
3684         elsif (/^o$/i)
3685           {
3686           system("$more test-stdout");
3687           }
3688         }
3689
3690       $retry = 1 if /^r$/i;
3691       $docheck = 0;
3692       }
3693
3694     # If the command was exim, and a listening server is running, we can now
3695     # close its input, which causes us to wait for it to finish, which is why
3696     # we didn't close it earlier.
3697
3698     if ($rc == 2 && $server_pid != 0)
3699       {
3700       close SERVERCMD;
3701       $server_pid = 0;
3702       if ($? != 0)
3703         {
3704         if (($? & 0xff) == 0)
3705           { printf("Server return code %d", $?/256); }
3706         elsif (($? & 0xff00) == 0)
3707           { printf("Server killed by signal %d", $? & 255); }
3708         else
3709           { printf("Server status %x", $?); }
3710
3711         for (;;)
3712           {
3713           print "\nShow server stdout, Retry, Continue, or Quit? [Q] ";
3714           $_ = $force_continue ? "c" : <T>;
3715           tests_exit(1) if /^q?$/i;
3716           log_failure($log_failed_filename, $testno, "exit code unexpected") if (/^c$/i && $force_continue);
3717           print "... continue forced\n" if $force_continue;
3718           last if /^[rc]$/i;
3719
3720           if (/^s$/i)
3721             {
3722             open(S, "test-stdout-server") ||
3723               tests_exit(-1, "Failed to open test-stdout-server: $!");
3724             print while <S>;
3725             close(S);
3726             }
3727           }
3728         $retry = 1 if /^r$/i;
3729         }
3730       }
3731     }
3732
3733   close SCRIPT;
3734
3735   # The script has finished. Check the all the output that was generated. The
3736   # function returns 0 if all is well, 1 if we should rerun the test (the files
3737   # function returns 0 if all is well, 1 if we should rerun the test (the files
3738   # have been updated). It does not return if the user responds Q to a prompt.
3739
3740   if ($retry)
3741     {
3742     $retry = '0';
3743     print (("#" x 79) . "\n");
3744     redo;
3745     }
3746
3747   if ($docheck)
3748     {
3749     if (check_output($TEST_STATE->{munge}) != 0)
3750       {
3751       print (("#" x 79) . "\n");
3752       redo;
3753       }
3754     else
3755       {
3756       print ("  Script completed\n");
3757       }
3758     }
3759   }
3760
3761
3762 ##################################################
3763 #         Exit from the test script              #
3764 ##################################################
3765
3766 tests_exit(-1, "No runnable tests selected") if @test_list == 0;
3767 tests_exit(0);
3768
3769 # End of runtest script
3770 # vim: set sw=2 et :