test/runtest

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