test/runtest

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