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