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