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