test/runtest

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