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