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