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