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