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