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     'net_unreach' =>            # platforms not supporting TCP Fast Open difference
1502     { 'stderr' => 's/failed: Network Error/failed: Network is unreachanble/' },
1503   };
1504
1505
1506 ##################################################
1507 #    Subroutine to check the output of a test    #
1508 ##################################################
1509
1510 # This function is called when the series of subtests is complete. It makes
1511 # use of check_file(), whose arguments are:
1512 #
1513 #  [0] the name of the main raw output file
1514 #  [1] the name of the server raw output file or undef
1515 #  [2] where to put the munged copy
1516 #  [3] the name of the saved file
1517 #  [4] TRUE if this is a log file whose deliveries must be sorted
1518 #  [5] an optional custom munge command
1519 #
1520 # Arguments: Optionally, name of a single custom munge to run.
1521 # Returns:   0 if the output compared equal
1522 #            1 if re-run needed (files may have been updated)
1523
1524 sub check_output{
1525 my($mungename) = $_[0];
1526 my($yield) = 0;
1527 my($munge) = $munges->{$mungename} if defined $mungename;
1528
1529 $yield = 1 if check_file("spool/log/paniclog",
1530                        "spool/log/serverpaniclog",
1531                        "test-paniclog-munged",
1532                        "paniclog/$testno", 0,
1533                        $munge->{paniclog});
1534
1535 $yield = 1 if check_file("spool/log/rejectlog",
1536                        "spool/log/serverrejectlog",
1537                        "test-rejectlog-munged",
1538                        "rejectlog/$testno", 0,
1539                        $munge->{rejectlog});
1540
1541 $yield = 1 if check_file("spool/log/mainlog",
1542                        "spool/log/servermainlog",
1543                        "test-mainlog-munged",
1544                        "log/$testno", $sortlog,
1545                        $munge->{mainlog});
1546
1547 if (!$stdout_skip)
1548   {
1549   $yield = 1 if check_file("test-stdout",
1550                        "test-stdout-server",
1551                        "test-stdout-munged",
1552                        "stdout/$testno", 0,
1553                        $munge->{stdout});
1554   }
1555
1556 if (!$stderr_skip)
1557   {
1558   $yield = 1 if check_file("test-stderr",
1559                        "test-stderr-server",
1560                        "test-stderr-munged",
1561                        "stderr/$testno", 0,
1562                        $munge->{stderr});
1563   }
1564
1565 # Compare any delivered messages, unless this test is skipped.
1566
1567 if (! $message_skip)
1568   {
1569   my($msgno) = 0;
1570
1571   # Get a list of expected mailbox files for this script. We don't bother with
1572   # directories, just the files within them.
1573
1574   foreach $oldmail (@oldmails)
1575     {
1576     next unless $oldmail =~ /^mail\/$testno\./;
1577     print ">> EXPECT $oldmail\n" if $debug;
1578     $expected_mails{$oldmail} = 1;
1579     }
1580
1581   # If there are any files in test-mail, compare them. Note that "." and
1582   # ".." are automatically omitted by list_files_below().
1583
1584   @mails = list_files_below("test-mail");
1585
1586   foreach $mail (@mails)
1587     {
1588     next if $mail eq "test-mail/oncelog";
1589
1590     $saved_mail = substr($mail, 10);               # Remove "test-mail/"
1591     $saved_mail =~ s/^$parm_caller(\/|$)/CALLER/;  # Convert caller name
1592
1593     if ($saved_mail =~ /(\d+\.[^.]+\.)/)
1594       {
1595       $msgno++;
1596       $saved_mail =~ s/(\d+\.[^.]+\.)/$msgno./gx;
1597       }
1598
1599     print ">> COMPARE $mail mail/$testno.$saved_mail\n" if $debug;
1600     $yield = 1 if check_file($mail, undef, "test-mail-munged",
1601       "mail/$testno.$saved_mail", 0,
1602       $munge->{mail});
1603     delete $expected_mails{"mail/$testno.$saved_mail"};
1604     }
1605
1606   # Complain if not all expected mails have been found
1607
1608   if (scalar(keys %expected_mails) != 0)
1609     {
1610     foreach $key (keys %expected_mails)
1611       { print "** no test file found for $key\n"; }
1612
1613     for (;;)
1614       {
1615       $_ = interact('Continue, Update & retry, or Quit? [Q] ', $force_update, $force_continue);
1616       tests_exit(1) if /^q?$/;
1617       log_failure($log_failed_filename, $testno, "missing email") if (/^c$/ && $force_continue);
1618       last if /^c$/;
1619
1620       # For update, we not only have to unlink the file, but we must also
1621       # remove it from the @oldmails vector, as otherwise it will still be
1622       # checked for when we re-run the test.
1623
1624       if (/^u$/)
1625         {
1626         foreach $key (keys %expected_mails)
1627           {
1628           my($i);
1629           tests_exit(-1, "Failed to unlink $key") if !unlink("$key");
1630           for ($i = 0; $i < @oldmails; $i++)
1631             {
1632             if ($oldmails[$i] eq $key)
1633               {
1634               splice @oldmails, $i, 1;
1635               last;
1636               }
1637             }
1638           }
1639         last;
1640         }
1641       }
1642     }
1643   }
1644
1645 # Compare any remaining message logs, unless this test is skipped.
1646
1647 if (! $msglog_skip)
1648   {
1649   # Get a list of expected msglog files for this test
1650
1651   foreach $oldmsglog (@oldmsglogs)
1652     {
1653     next unless $oldmsglog =~ /^$testno\./;
1654     $expected_msglogs{$oldmsglog} = 1;
1655     }
1656
1657   # If there are any files in spool/msglog, compare them. However, we have
1658   # to munge the file names because they are message ids, which are
1659   # time dependent.
1660
1661   if (opendir(DIR, "spool/msglog"))
1662     {
1663     @msglogs = sort readdir(DIR);
1664     closedir(DIR);
1665
1666     foreach $msglog (@msglogs)
1667       {
1668       next if ($msglog eq "." || $msglog eq ".." || $msglog eq "CVS");
1669       ($munged_msglog = $msglog) =~
1670         s/((?:[^\W_]{6}-){2}[^\W_]{2})
1671           /new_value($1, "10Hm%s-0005vi-00", \$next_msgid)/egx;
1672       $yield = 1 if check_file("spool/msglog/$msglog", undef,
1673         "test-msglog-munged", "msglog/$testno.$munged_msglog", 0,
1674         $munge->{msglog});
1675       delete $expected_msglogs{"$testno.$munged_msglog"};
1676       }
1677     }
1678
1679   # Complain if not all expected msglogs have been found
1680
1681   if (scalar(keys %expected_msglogs) != 0)
1682     {
1683     foreach $key (keys %expected_msglogs)
1684       {
1685       print "** no test msglog found for msglog/$key\n";
1686       ($msgid) = $key =~ /^\d+\.(.*)$/;
1687       foreach $cachekey (keys %cache)
1688         {
1689         if ($cache{$cachekey} eq $msgid)
1690           {
1691           print "** original msgid $cachekey\n";
1692           last;
1693           }
1694         }
1695       }
1696
1697     for (;;)
1698       {
1699       $_ = interact('Continue, Update, or Quit? [Q] ', $force_update, $force_continue);
1700       tests_exit(1) if /^q?$/;
1701       log_failure($log_failed_filename, $testno, "missing msglog") if (/^c$/ && $force_continue);
1702       last if /^c$/;
1703       if (/^u$/)
1704         {
1705         foreach $key (keys %expected_msglogs)
1706           {
1707           tests_exit(-1, "Failed to unlink msglog/$key")
1708             if !unlink("msglog/$key");
1709           }
1710         last;
1711         }
1712       }
1713     }
1714   }
1715
1716 return $yield;
1717 }
1718
1719
1720
1721 ##################################################
1722 #     Subroutine to run one "system" command     #
1723 ##################################################
1724
1725 # We put this in a subroutine so that the command can be reflected when
1726 # debugging.
1727 #
1728 # Argument: the command to be run
1729 # Returns:  nothing
1730
1731 sub run_system {
1732 my($cmd) = $_[0];
1733 if ($debug)
1734   {
1735   my($prcmd) = $cmd;
1736   $prcmd =~ s/; /;\n>> /;
1737   print ">> $prcmd\n";
1738   }
1739 system("$cmd");
1740 }
1741
1742
1743
1744 ##################################################
1745 #      Subroutine to run one script command      #
1746 ##################################################
1747
1748 # The <SCRIPT> file is open for us to read an optional return code line,
1749 # followed by the command line and any following data lines for stdin. The
1750 # command line can be continued by the use of \. Data lines are not continued
1751 # in this way. In all lines, the following substutions are made:
1752 #
1753 # DIR    => the current directory
1754 # CALLER => the caller of this script
1755 #
1756 # Arguments: the current test number
1757 #            reference to the subtest number, holding previous value
1758 #            reference to the expected return code value
1759 #            reference to where to put the command name (for messages)
1760 #            auxilliary information returned from a previous run
1761 #
1762 # Returns:   0 the commmand was executed inline, no subprocess was run
1763 #            1 a non-exim command was run and waited for
1764 #            2 an exim command was run and waited for
1765 #            3 a command was run and not waited for (daemon, server, exim_lock)
1766 #            4 EOF was encountered after an initial return code line
1767 # Optionally alse a second parameter, a hash-ref, with auxilliary information:
1768 #            exim_pid: pid of a run process
1769 #            munge: name of a post-script results munger
1770
1771 sub run_command{
1772 my($testno) = $_[0];
1773 my($subtestref) = $_[1];
1774 my($commandnameref) = $_[3];
1775 my($aux_info) = $_[4];
1776 my($yield) = 1;
1777
1778 our %ENV = map { $_ => $ENV{$_} } grep { /^(?:USER|SHELL|PATH|TERM|EXIM_TEST_.*)$/ } keys %ENV;
1779
1780 if (/^(\d+)\s*$/)                # Handle unusual return code
1781   {
1782   my($r) = $_[2];
1783   $$r = $1 << 8;
1784   $_ = <SCRIPT>;
1785   return 4 if !defined $_;       # Missing command
1786   $lineno++;
1787   }
1788
1789 chomp;
1790 $wait_time = 0;
1791
1792 # Handle concatenated command lines
1793
1794 s/\s+$//;
1795 while (substr($_, -1) eq"\\")
1796   {
1797   my($temp);
1798   $_ = substr($_, 0, -1);
1799   chomp($temp = <SCRIPT>);
1800   if (defined $temp)
1801     {
1802     $lineno++;
1803     $temp =~ s/\s+$//;
1804     $temp =~ s/^\s+//;
1805     $_ .= $temp;
1806     }
1807   }
1808
1809 # Do substitutions
1810
1811 do_substitute($testno);
1812 if ($debug) { printf ">> $_\n"; }
1813
1814 # Pass back the command name (for messages)
1815
1816 ($$commandnameref) = /^(\S+)/;
1817
1818 # Here follows code for handling the various different commands that are
1819 # supported by this script. The first group of commands are all freestanding
1820 # in that they share no common code and are not followed by any data lines.
1821
1822
1823 ###################
1824 ###################
1825
1826 # The "dbmbuild" command runs exim_dbmbuild. This is used both to test the
1827 # utility and to make DBM files for testing DBM lookups.
1828
1829 if (/^dbmbuild\s+(\S+)\s+(\S+)/)
1830   {
1831   run_system("(./eximdir/exim_dbmbuild $parm_cwd/$1 $parm_cwd/$2;" .
1832          "echo exim_dbmbuild exit code = \$?)" .
1833          ">>test-stdout");
1834   return 1;
1835   }
1836
1837
1838 # The "dump" command runs exim_dumpdb. On different systems, the output for
1839 # some types of dump may appear in a different order because it's just hauled
1840 # out of the DBM file. We can solve this by sorting. Ignore the leading
1841 # date/time, as it will be flattened later during munging.
1842
1843 if (/^dump\s+(\S+)/)
1844   {
1845   my($which) = $1;
1846   my(@temp);
1847   print ">> ./eximdir/exim_dumpdb $parm_cwd/spool $which\n" if $debug;
1848   open(IN, "./eximdir/exim_dumpdb $parm_cwd/spool $which |");
1849   open(OUT, ">>test-stdout");
1850   print OUT "+++++++++++++++++++++++++++\n";
1851
1852   if ($which eq "retry")
1853     {
1854     $/ = "\n  ";
1855     @temp = <IN>;
1856     $/ = "\n";
1857
1858     @temp = sort {
1859                    my($aa) = split(' ', $a);
1860                    my($bb) = split(' ', $b);
1861                    return $aa cmp $bb;
1862                  } @temp;
1863
1864     foreach $item (@temp)
1865       {
1866       $item =~ s/^\s*(.*)\n(.*)\n?\s*$/$1\n$2/m;
1867       print OUT "  $item\n";
1868       }
1869     }
1870   else
1871     {
1872     @temp = <IN>;
1873     if ($which eq "callout")
1874       {
1875       @temp = sort {
1876                    my($aa) = substr $a, 21;
1877                    my($bb) = substr $b, 21;
1878                    return $aa cmp $bb;
1879                    } @temp;
1880       }
1881     print OUT @temp;
1882     }
1883
1884   close(IN);
1885   close(OUT);
1886   return 1;
1887   }
1888
1889
1890 # verbose comments start with ###
1891 if (/^###\s/) {
1892   for my $file (qw(test-stdout test-stderr test-stderr-server test-stdout-server)) {
1893     open my $fh, '>>', $file or die "Can't open >>$file: $!\n";
1894     say {$fh} $_;
1895   }
1896   return 0;
1897 }
1898
1899 # The "echo" command is a way of writing comments to the screen.
1900 if (/^echo\s+(.*)$/)
1901   {
1902   print "$1\n";
1903   return 0;
1904   }
1905
1906
1907 # The "exim_lock" command runs exim_lock in the same manner as "server",
1908 # but it doesn't use any input.
1909
1910 if (/^exim_lock\s+(.*)$/)
1911   {
1912   $cmd = "./eximdir/exim_lock $1 >>test-stdout";
1913   $server_pid = open SERVERCMD, "|$cmd" ||
1914     tests_exit(-1, "Failed to run $cmd\n");
1915
1916   # This gives the process time to get started; otherwise the next
1917   # process may not find it there when it expects it.
1918
1919   select(undef, undef, undef, 0.1);
1920   return 3;
1921   }
1922
1923
1924 # The "exinext" command runs exinext
1925
1926 if (/^exinext\s+(.*)/)
1927   {
1928   run_system("(./eximdir/exinext " .
1929     "-DEXIM_PATH=$parm_cwd/eximdir/exim " .
1930     "-C $parm_cwd/test-config $1;" .
1931     "echo exinext exit code = \$?)" .
1932     ">>test-stdout");
1933   return 1;
1934   }
1935
1936
1937 # The "exigrep" command runs exigrep on the current mainlog
1938
1939 if (/^exigrep\s+(.*)/)
1940   {
1941   run_system("(./eximdir/exigrep " .
1942     "$1 $parm_cwd/spool/log/mainlog;" .
1943     "echo exigrep exit code = \$?)" .
1944     ">>test-stdout");
1945   return 1;
1946   }
1947
1948
1949 # The "eximstats" command runs eximstats on the current mainlog
1950
1951 if (/^eximstats\s+(.*)/)
1952   {
1953   run_system("(./eximdir/eximstats " .
1954     "$1 $parm_cwd/spool/log/mainlog;" .
1955     "echo eximstats exit code = \$?)" .
1956     ">>test-stdout");
1957   return 1;
1958   }
1959
1960
1961 # The "gnutls" command makes a copy of saved GnuTLS parameter data in the
1962 # spool directory, to save Exim from re-creating it each time.
1963
1964 if (/^gnutls/)
1965   {
1966   my $gen_fn = "spool/gnutls-params-$gnutls_dh_bits_normal";
1967   run_system "sudo cp -p aux-fixed/gnutls-params $gen_fn;" .
1968          "sudo chown $parm_eximuser:$parm_eximgroup $gen_fn;" .
1969          "sudo chmod 0400 $gen_fn";
1970   return 1;
1971   }
1972
1973
1974 # The "killdaemon" command should ultimately follow the starting of any Exim
1975 # daemon with the -bd option. We kill with SIGINT rather than SIGTERM to stop
1976 # it outputting "Terminated" to the terminal when not in the background.
1977
1978 if (/^killdaemon/)
1979   {
1980   my $return_extra = {};
1981   if (exists $aux_info->{exim_pid})
1982     {
1983     $pid = $aux_info->{exim_pid};
1984     $return_extra->{exim_pid} = undef;
1985     print ">> killdaemon: recovered pid $pid\n" if $debug;
1986     if ($pid)
1987       {
1988       run_system("sudo /bin/kill -INT $pid");
1989       wait;
1990       }
1991     } else {
1992     $pid = `cat $parm_cwd/spool/exim-daemon.*`;
1993     if ($pid)
1994       {
1995       run_system("sudo /bin/kill -INT $pid");
1996       close DAEMONCMD;                                   # Waits for process
1997       }
1998     }
1999     run_system("sudo /bin/rm -f spool/exim-daemon.*");
2000   return (1, $return_extra);
2001   }
2002
2003
2004 # The "millisleep" command is like "sleep" except that its argument is in
2005 # milliseconds, thus allowing for a subsecond sleep, which is, in fact, all it
2006 # is used for.
2007
2008 elsif (/^millisleep\s+(.*)$/)
2009   {
2010   select(undef, undef, undef, $1/1000);
2011   return 0;
2012   }
2013
2014
2015 # The "munge" command selects one of a hardwired set of test-result modifications
2016 # to be made before result compares are run agains the golden set.  This lets
2017 # us account for test-system dependent things which only affect a few, but known,
2018 # test-cases.
2019 # Currently only the last munge takes effect.
2020
2021 if (/^munge\s+(.*)$/)
2022   {
2023   return (0, { munge => $1 });
2024   }
2025
2026
2027 # The "sleep" command does just that. For sleeps longer than 1 second we
2028 # tell the user what's going on.
2029
2030 if (/^sleep\s+(.*)$/)
2031   {
2032   if ($1 == 1)
2033     {
2034     sleep(1);
2035     }
2036   else
2037     {
2038     printf("  Test %d sleep $1 ", $$subtestref);
2039     for (1..$1)
2040       {
2041       print ".";
2042       sleep(1);
2043       }
2044     printf("\r  Test %d                            $cr", $$subtestref);
2045     }
2046   return 0;
2047   }
2048
2049
2050 # Various Unix management commands are recognized
2051
2052 if (/^(ln|ls|du|mkdir|mkfifo|touch|cp|cat)\s/ ||
2053     /^sudo\s(rmdir|rm|mv|chown|chmod)\s/)
2054   {
2055   run_system("$_ >>test-stdout 2>>test-stderr");
2056   return 1;
2057   }
2058
2059
2060
2061 ###################
2062 ###################
2063
2064 # The next group of commands are also freestanding, but they are all followed
2065 # by data lines.
2066
2067
2068 # The "server" command starts up a script-driven server that runs in parallel
2069 # with the following exim command. Therefore, we want to run a subprocess and
2070 # not yet wait for it to complete. The waiting happens after the next exim
2071 # command, triggered by $server_pid being non-zero. The server sends its output
2072 # to a different file. The variable $server_opts, if not empty, contains
2073 # options to disable IPv4 or IPv6 if necessary.
2074 # This works because "server" swallows its stdin before waiting for a connection.
2075
2076 if (/^server\s+(.*)$/)
2077   {
2078   $pidfile = "$parm_cwd/aux-var/server-daemon.pid";
2079   $cmd = "./bin/server $server_opts -oP $pidfile $1 >>test-stdout-server";
2080   print ">> $cmd\n" if ($debug);
2081   $server_pid = open SERVERCMD, "|$cmd" || tests_exit(-1, "Failed to run $cmd");
2082   SERVERCMD->autoflush(1);
2083   print ">> Server pid is $server_pid\n" if $debug;
2084   while (<SCRIPT>)
2085     {
2086     $lineno++;
2087     last if /^\*{4}\s*$/;
2088     print SERVERCMD;
2089     }
2090   print SERVERCMD "++++\n"; # Send end to server; can't send EOF yet
2091                             # because close() waits for the process.
2092
2093   # Interlock the server startup; otherwise the next
2094   # process may not find it there when it expects it.
2095   while (! stat("$pidfile") ) { select(undef, undef, undef, 0.3); }
2096   return 3;
2097   }
2098
2099
2100 # The "write" command is a way of creating files of specific sizes for
2101 # buffering tests, or containing specific data lines from within the script
2102 # (rather than hold lots of little files). The "catwrite" command does the
2103 # same, but it also copies the lines to test-stdout.
2104
2105 if (/^(cat)?write\s+(\S+)(?:\s+(.*))?\s*$/)
2106   {
2107   my($cat) = defined $1;
2108   @sizes = ();
2109   @sizes = split /\s+/, $3 if defined $3;
2110   open FILE, ">$2" || tests_exit(-1, "Failed to open \"$2\": $!");
2111
2112   if ($cat)
2113     {
2114     open CAT, ">>test-stdout" ||
2115       tests_exit(-1, "Failed to open test-stdout: $!");
2116     print CAT "==========\n";
2117     }
2118
2119   if (scalar @sizes > 0)
2120     {
2121     # Pre-data
2122
2123     while (<SCRIPT>)
2124       {
2125       $lineno++;
2126       last if /^\+{4}\s*$/;
2127       print FILE;
2128       print CAT if $cat;
2129       }
2130
2131     # Sized data
2132
2133     while (scalar @sizes > 0)
2134       {
2135       ($count,$len,$leadin) = (shift @sizes) =~ /(\d+)x(\d+)(?:=(.*))?/;
2136       $leadin = '' if !defined $leadin;
2137       $leadin =~ s/_/ /g;
2138       $len -= length($leadin) + 1;
2139       while ($count-- > 0)
2140         {
2141         print FILE $leadin, "a" x $len, "\n";
2142         print CAT $leadin, "a" x $len, "\n" if $cat;
2143         }
2144       }
2145     }
2146
2147   # Post data, or only data if no sized data
2148
2149   while (<SCRIPT>)
2150     {
2151     $lineno++;
2152     last if /^\*{4}\s*$/;
2153     print FILE;
2154     print CAT if $cat;
2155     }
2156   close FILE;
2157
2158   if ($cat)
2159     {
2160     print CAT "==========\n";
2161     close CAT;
2162     }
2163
2164   return 0;
2165   }
2166
2167
2168 ###################
2169 ###################
2170
2171 # From this point on, script commands are implemented by setting up a shell
2172 # command in the variable $cmd. Shared code to run this command and handle its
2173 # input and output follows.
2174
2175 # The "client", "client-gnutls", and "client-ssl" commands run a script-driven
2176 # program that plays the part of an email client. We also have the availability
2177 # of running Perl for doing one-off special things. Note that all these
2178 # commands expect stdin data to be supplied.
2179
2180 if (/^client/ || /^(sudo\s+)?perl\b/)
2181   {
2182   s"client"./bin/client";
2183   $cmd = "$_ >>test-stdout 2>>test-stderr";
2184   }
2185
2186 # For the "exim" command, replace the text "exim" with the path for the test
2187 # binary, plus -D options to pass over various parameters, and a -C option for
2188 # the testing configuration file. When running in the test harness, Exim does
2189 # not drop privilege when -C and -D options are present. To run the exim
2190 # command as root, we use sudo.
2191
2192 elsif (/^((?i:[A-Z\d_]+=\S+\s+)+)?(\d+)?\s*(sudo(?:\s+-u\s+(\w+))?\s+)?exim(_\S+)?\s+(.*)$/)
2193   {
2194   $args = $6;
2195   my($envset) = (defined $1)? $1      : '';
2196   my($sudo)   = (defined $3)? "sudo " . (defined $4 ? "-u $4 ":'')  : '';
2197   my($special)= (defined $5)? $5      : '';
2198   $wait_time  = (defined $2)? $2      : 0;
2199
2200   # Return 2 rather than 1 afterwards
2201
2202   $yield = 2;
2203
2204   # Update the test number
2205
2206   $$subtestref = $$subtestref + 1;
2207   printf("  Test %d       $cr", $$subtestref);
2208
2209   # Copy the configuration file, making the usual substitutions.
2210
2211   open (IN, "$parm_cwd/confs/$testno") ||
2212     tests_exit(-1, "Couldn't open $parm_cwd/confs/$testno: $!\n");
2213   open (OUT, ">test-config") ||
2214     tests_exit(-1, "Couldn't open test-config: $!\n");
2215   while (<IN>)
2216     {
2217     do_substitute($testno);
2218     print OUT;
2219     }
2220   close(IN);
2221   close(OUT);
2222
2223   # The string $msg1 in args substitutes the message id of the first
2224   # message on the queue, and so on. */
2225
2226   if ($args =~ /\$msg/)
2227     {
2228     my($listcmd) = "$parm_cwd/eximdir/exim -bp " .
2229                    "-DEXIM_PATH=$parm_cwd/eximdir/exim " .
2230                    "-C $parm_cwd/test-config |";
2231     print ">> Getting queue list from:\n>>    $listcmd\n" if ($debug);
2232     open (QLIST, $listcmd) || tests_exit(-1, "Couldn't run \"exim -bp\": $!\n");
2233     my(@msglist) = ();
2234     while (<QLIST>) { push (@msglist, $1) if /^\s*\d+[smhdw]\s+\S+\s+(\S+)/; }
2235     close(QLIST);
2236
2237     # Done backwards just in case there are more than 9
2238
2239     for (my $i = @msglist; $i > 0; $i--) { $args =~ s/\$msg$i/$msglist[$i-1]/g; }
2240     if ( $args =~ /\$msg\d/ )
2241       {
2242       tests_exit(-1, "Not enough messages in spool, for test $testno line $lineno\n")
2243         unless $force_continue;
2244       }
2245     }
2246
2247   # If -d is specified in $optargs, remove it from $args; i.e. let
2248   # the command line for runtest override. Then run Exim.
2249
2250   $args =~ s/(?:^|\s)-d\S*// if $optargs =~ /(?:^|\s)-d/;
2251
2252   my $opt_valgrind = $valgrind ? "valgrind --leak-check=yes --suppressions=$parm_cwd/aux-fixed/valgrind.supp " : '';
2253
2254   $cmd = "$envset$sudo$opt_valgrind" .
2255          "$parm_cwd/eximdir/exim$special$optargs " .
2256          "-DEXIM_PATH=$parm_cwd/eximdir/exim$special " .
2257          "-C $parm_cwd/test-config $args " .
2258          ">>test-stdout 2>>test-stderr";
2259   # If the command is starting an Exim daemon, we run it in the same
2260   # way as the "server" command above, that is, we don't want to wait
2261   # for the process to finish. That happens when "killdaemon" is obeyed later
2262   # in the script. We also send the stderr output to test-stderr-server. The
2263   # daemon has its log files put in a different place too (by configuring with
2264   # log_file_path). This requires the  directory to be set up in advance.
2265   #
2266   # There are also times when we want to run a non-daemon version of Exim
2267   # (e.g. a queue runner) with the server configuration. In this case,
2268   # we also define -DNOTDAEMON.
2269
2270   if ($cmd =~ /\s-DSERVER=server\s/ && $cmd !~ /\s-DNOTDAEMON\s/)
2271     {
2272     $pidfile = "$parm_cwd/spool/exim-daemon.pid";
2273     if ($debug) { printf ">> daemon: $cmd\n"; }
2274     run_system("sudo mkdir spool/log 2>/dev/null");
2275     run_system("sudo chown $parm_eximuser:$parm_eximgroup spool/log");
2276
2277     # Before running the command, convert the -bd option into -bdf so that an
2278     # Exim daemon doesn't double fork. This means that when we wait close
2279     # DAEMONCMD, it waits for the correct process. Also, ensure that the pid
2280     # file is written to the spool directory, in case the Exim binary was
2281     # built with PID_FILE_PATH pointing somewhere else.
2282
2283     if ($cmd =~ /\s-oP\s/)
2284       {
2285       ($pidfile = $cmd) =~ s/^.*-oP ([^ ]+).*$/$1/;
2286       $cmd =~ s!\s-bd\s! -bdf !;
2287       }
2288     else
2289       {
2290       $pidfile = "$parm_cwd/spool/exim-daemon.pid";
2291       $cmd =~ s!\s-bd\s! -bdf -oP $pidfile !;
2292       }
2293     print ">> |${cmd}-server\n" if ($debug);
2294     open DAEMONCMD, "|${cmd}-server" || tests_exit(-1, "Failed to run $cmd");
2295     DAEMONCMD->autoflush(1);
2296     while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; }   # Ignore any input
2297
2298     # Interlock with daemon startup
2299     while (! stat("$pidfile") ) { select(undef, undef, undef, 0.3); }
2300     return 3;                                     # Don't wait
2301     }
2302   elsif ($cmd =~ /\s-DSERVER=wait:(\d+)\s/)
2303     {
2304
2305     # The port and the $dynamic_socket was already allocated while parsing the
2306     # script file, where -DSERVER=wait:PORT_DYNAMIC was encountered.
2307
2308     my $listen_port = $1;
2309     if ($debug) { printf ">> wait-mode daemon: $cmd\n"; }
2310     run_system("sudo mkdir spool/log 2>/dev/null");
2311     run_system("sudo chown $parm_eximuser:$parm_eximgroup spool/log");
2312
2313     my $pid = fork();
2314     if (not defined $pid) { die "** fork failed: $!\n" }
2315     if (not $pid) {
2316       close(STDIN);
2317       open(STDIN, '<&', $dynamic_socket) or die "** dup sock to stdin failed: $!\n";
2318       close($dynamic_socket);
2319       print "[$$]>> ${cmd}-server\n" if ($debug);
2320       exec "exec ${cmd}-server";
2321       die "Can't exec ${cmd}-server: $!\n";
2322     }
2323     while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; }   # Ignore any input
2324     select(undef, undef, undef, 0.3);             # Let the daemon get going
2325     return (3, { exim_pid => $pid });             # Don't wait
2326     }
2327   }
2328
2329 # The "background" command is run but not waited-for, like exim -DSERVER=server.
2330 # One script line is read and fork-exec'd.  The PID is stored for a later
2331 # killdaemon.
2332
2333 elsif (/^background$/)
2334   {
2335   my $line;
2336 #  $pidfile = "$parm_cwd/aux-var/server-daemon.pid";
2337
2338   $_ = <SCRIPT>; $lineno++;
2339   chomp;
2340   $line = $_;
2341   if ($debug) { printf ">> daemon: $line >>test-stdout 2>>test-stderr\n"; }
2342
2343   my $pid = fork();
2344   if (not defined $pid) { die "** fork failed: $!\n" }
2345   if (not $pid) {
2346     print "[$$]>> ${line}\n" if ($debug);
2347     close(STDIN);
2348     open(STDIN, "<", "test-stdout");
2349     close(STDOUT);
2350     open(STDOUT, ">>", "test-stdout");
2351     close(STDERR);
2352     open(STDERR, ">>", "test-stderr-server");
2353     exec "exec ${line}";
2354     exit(1);
2355   }
2356
2357 #  open(my $fh, ">", $pidfile) ||
2358 #      tests_exit(-1, "Failed to open $pidfile: $!");
2359 #  printf($fh, "%d\n", $pid);
2360 #  close($fh);
2361
2362   while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; }   # Ignore any input
2363   select(undef, undef, undef, 0.3);             # Let the daemon get going
2364   return (3, { exim_pid => $pid });             # Don't wait
2365   }
2366
2367
2368
2369 # Unknown command
2370
2371 else { tests_exit(-1, "Command unrecognized in line $lineno: $_"); }
2372
2373
2374 # Run the command, with stdin connected to a pipe, and write the stdin data
2375 # to it, with appropriate substitutions. If a line ends with \NONL\, chop off
2376 # the terminating newline (and the \NONL\). If the command contains
2377 # -DSERVER=server add "-server" to the command, where it will adjoin the name
2378 # for the stderr file. See comment above about the use of -DSERVER.
2379
2380 $stderrsuffix = ($cmd =~ /\s-DSERVER=server\s/)? "-server" : '';
2381 print ">> |${cmd}${stderrsuffix}\n" if ($debug);
2382 open CMD, "|${cmd}${stderrsuffix}" || tests_exit(1, "Failed to run $cmd");
2383
2384 CMD->autoflush(1);
2385 while (<SCRIPT>)
2386   {
2387   $lineno++;
2388   last if /^\*{4}\s*$/;
2389   do_substitute($testno);
2390   if (/^(.*)\\NONL\\\s*$/) { print CMD $1; } else { print CMD; }
2391   }
2392
2393 # For timeout tests, wait before closing the pipe; we expect a
2394 # SIGPIPE error in this case.
2395
2396 if ($wait_time > 0)
2397   {
2398   printf("  Test %d sleep $wait_time ", $$subtestref);
2399   while ($wait_time-- > 0)
2400     {
2401     print ".";
2402     sleep(1);
2403     }
2404   printf("\r  Test %d                                       $cr", $$subtestref);
2405   }
2406
2407 $sigpipehappened = 0;
2408 close CMD;                # Waits for command to finish
2409 return $yield;            # Ran command and waited
2410 }
2411
2412
2413
2414
2415 ###############################################################################
2416 ###############################################################################
2417
2418 # Here begins the Main Program ...
2419
2420 ###############################################################################
2421 ###############################################################################
2422
2423
2424 autoflush STDOUT 1;
2425 print "Exim tester $testversion\n";
2426
2427 # extend the PATH with .../sbin
2428 # we map all (.../bin) to (.../sbin:.../bin)
2429 $ENV{PATH} = do {
2430   my %seen = map { $_, 1 } split /:/, $ENV{PATH};
2431   join ':' => map { m{(.*)/bin$}
2432                 ? ( $seen{"$1/sbin"} ? () : ("$1/sbin"), $_)
2433                 : ($_) }
2434       split /:/, $ENV{PATH};
2435 };
2436
2437 ##################################################
2438 #      Some tests check created file modes       #
2439 ##################################################
2440
2441 umask 022;
2442
2443
2444 ##################################################
2445 #       Check for the "less" command             #
2446 ##################################################
2447
2448 $more = 'more' if system('which less >/dev/null 2>&1') != 0;
2449
2450
2451
2452 ##################################################
2453 #        Check for sudo access to root           #
2454 ##################################################
2455
2456 print "You need to have sudo access to root to run these tests. Checking ...\n";
2457 if (system('sudo true >/dev/null') != 0)
2458   {
2459   die "** Test for sudo failed: testing abandoned.\n";
2460   }
2461 else
2462   {
2463   print "Test for sudo OK\n";
2464   }
2465
2466
2467
2468 ##################################################
2469 #      See if an Exim binary has been given      #
2470 ##################################################
2471
2472 # If the first character of the first argument is '/', the argument is taken
2473 # as the path to the binary. If the first argument does not start with a
2474 # '/' but exists in the file system, it's assumed to be the Exim binary.
2475
2476 ($parm_exim, @ARGV) = Exim::Runtest::exim_binary(@ARGV);
2477 print "Exim binary is $parm_exim\n" if $parm_exim ne '';
2478
2479
2480
2481 ##################################################
2482 # Sort out options and which tests are to be run #
2483 ##################################################
2484
2485 # There are a few possible options for the test script itself; after these, any
2486 # options are passed on to Exim calls within the tests. Typically, this is used
2487 # to turn on Exim debugging while setting up a test.
2488
2489 while (@ARGV > 0 && $ARGV[0] =~ /^-/)
2490   {
2491   my($arg) = shift @ARGV;
2492   if ($optargs eq '')
2493     {
2494     if ($arg eq "-DEBUG")  { $debug = 1; $cr = "\n"; next; }
2495     if ($arg eq "-DIFF")   { $cf = "diff -u"; next; }
2496     if ($arg eq "-CONTINUE"){$force_continue = 1;
2497                              $more = "cat";
2498                              next; }
2499     if ($arg eq "-UPDATE") { $force_update = 1; next; }
2500     if ($arg eq "-NOIPV4") { $have_ipv4 = 0; next; }
2501     if ($arg eq "-NOIPV6") { $have_ipv6 = 0; next; }
2502     if ($arg eq "-KEEP")   { $save_output = 1; next; }
2503     if ($arg eq "-VALGRIND")   { $valgrind = 1; next; }
2504     if ($arg =~ /^-FLAVOU?R$/) { $flavour = shift; next; }
2505     }
2506   $optargs .= " $arg";
2507   }
2508
2509 # Any subsequent arguments are a range of test numbers.
2510
2511 if (@ARGV > 0)
2512   {
2513   $test_end = $test_start = $ARGV[0];
2514   $test_end = $ARGV[1] if (@ARGV > 1);
2515   $test_end = ($test_start >= 9000)? $test_special_top : $test_top
2516     if $test_end eq "+";
2517   die "** Test numbers out of order\n" if ($test_end < $test_start);
2518   }
2519
2520
2521 ##################################################
2522 #      Make the command's directory current      #
2523 ##################################################
2524
2525 # After doing so, we find its absolute path name.
2526
2527 $cwd = $0;
2528 $cwd = '.' if ($cwd !~ s|/[^/]+$||);
2529 chdir($cwd) || die "** Failed to chdir to \"$cwd\": $!\n";
2530 $parm_cwd = Cwd::getcwd();
2531
2532
2533 ##################################################
2534 #     Search for an Exim binary to test          #
2535 ##################################################
2536
2537 # If an Exim binary hasn't been provided, try to find one. We can handle the
2538 # case where exim-testsuite is installed alongside Exim source directories. For
2539 # PH's private convenience, if there's a directory just called "exim4", that
2540 # takes precedence; otherwise exim-snapshot takes precedence over any numbered
2541 # releases.
2542
2543 # If $parm_exim is still empty, ask the caller
2544
2545 if ($parm_exim eq '')
2546   {
2547   print "** Did not find an Exim binary to test\n";
2548   for ($i = 0; $i < 5; $i++)
2549     {
2550     my($trybin);
2551     print "** Enter pathname for Exim binary: ";
2552     chomp($trybin = <STDIN>);
2553     if (-e $trybin)
2554       {
2555       $parm_exim = $trybin;
2556       last;
2557       }
2558     else
2559       {
2560       print "** $trybin does not exist\n";
2561       }
2562     }
2563   die "** Too many tries\n" if $parm_exim eq '';
2564   }
2565
2566
2567
2568 ##################################################
2569 #          Find what is in the binary            #
2570 ##################################################
2571
2572 # deal with TRUSTED_CONFIG_LIST restrictions
2573 unlink("$parm_cwd/test-config") if -e "$parm_cwd/test-config";
2574 open (IN, "$parm_cwd/confs/0000") ||
2575   tests_exit(-1, "Couldn't open $parm_cwd/confs/0000: $!\n");
2576 open (OUT, ">test-config") ||
2577   tests_exit(-1, "Couldn't open test-config: $!\n");
2578 while (<IN>) { print OUT; }
2579 close(IN);
2580 close(OUT);
2581
2582 print("Probing with config file: $parm_cwd/test-config\n");
2583 open(EXIMINFO, "$parm_exim -d -C $parm_cwd/test-config -DDIR=$parm_cwd " .
2584                "-bP exim_user exim_group 2>&1|") ||
2585   die "** Cannot run $parm_exim: $!\n";
2586 while(<EXIMINFO>)
2587   {
2588   if (my ($version) = /^Exim version (\S+)/) {
2589     my $git = `git describe --dirty=-XX --match 'exim-4*'`;
2590     if (defined $git and $? == 0) {
2591       chomp $git;
2592       $version =~ s/^\d+\K\./_/;
2593       $git =~ s/^exim-//i;
2594       $git =~ s/.*-\Kg([[:xdigit:]]+(?:-XX)?)/$1/;
2595       print <<___
2596
2597 *** Version mismatch
2598 *** Exim binary: $version
2599 *** Git        : $git
2600
2601 ___
2602         if not $version eq $git;
2603     }
2604   }
2605   $parm_eximuser = $1 if /^exim_user = (.*)$/;
2606   $parm_eximgroup = $1 if /^exim_group = (.*)$/;
2607   $parm_trusted_config_list = $1 if /^TRUSTED_CONFIG_LIST:.*?"(.*?)"$/;
2608   ($parm_configure_owner, $parm_configure_group) = ($1, $2)
2609         if /^Configure owner:\s*(\d+):(\d+)/;
2610   print if /wrong owner/;
2611   }
2612 close(EXIMINFO);
2613
2614 if (defined $parm_eximuser)
2615   {
2616   if ($parm_eximuser =~ /^\d+$/) { $parm_exim_uid = $parm_eximuser; }
2617     else { $parm_exim_uid = getpwnam($parm_eximuser); }
2618   }
2619 else
2620   {
2621   print "Unable to extract exim_user from binary.\n";
2622   print "Check if Exim refused to run; if so, consider:\n";
2623   print "  TRUSTED_CONFIG_LIST ALT_CONFIG_PREFIX WHITELIST_D_MACROS\n";
2624   print "If debug permission denied, are you in the exim group?\n";
2625   die "Failing to get information from binary.\n";
2626   }
2627
2628 if (defined $parm_eximgroup)
2629   {
2630   if ($parm_eximgroup =~ /^\d+$/) { $parm_exim_gid = $parm_eximgroup; }
2631     else { $parm_exim_gid = getgrnam($parm_eximgroup); }
2632   }
2633
2634 # check the permissions on the TRUSTED_CONFIG_LIST
2635 if (defined $parm_trusted_config_list)
2636   {
2637   die "TRUSTED_CONFIG_LIST: $parm_trusted_config_list: $!\n"
2638     if not -f $parm_trusted_config_list;
2639
2640   die "TRUSTED_CONFIG_LIST $parm_trusted_config_list must not be world writable!\n"
2641     if 02 & (stat _)[2];
2642
2643   die sprintf "TRUSTED_CONFIG_LIST: $parm_trusted_config_list %d is group writable, but not owned by group '%s' or '%s'.\n",
2644   (stat _)[1],
2645     scalar(getgrgid 0), scalar(getgrgid $>)
2646     if (020 & (stat _)[2]) and not ((stat _)[5] == $> or (stat _)[5] == 0);
2647
2648   die sprintf "TRUSTED_CONFIG_LIST: $parm_trusted_config_list is not owned by user '%s' or '%s'.\n",
2649   scalar(getpwuid 0), scalar(getpwuid $>)
2650      if (not (-o _ or (stat _)[4] == 0));
2651
2652   open(TCL, $parm_trusted_config_list) or die "Can't open $parm_trusted_config_list: $!\n";
2653   my $test_config = getcwd() . '/test-config';
2654   die "Can't find '$test_config' in TRUSTED_CONFIG_LIST $parm_trusted_config_list."
2655   if not grep { /^$test_config$/ } <TCL>;
2656   }
2657 else
2658   {
2659   die "Unable to check the TRUSTED_CONFIG_LIST, seems to be empty?\n";
2660   }
2661
2662 die "CONFIGURE_OWNER ($parm_configure_owner) does not match the user invoking $0 ($>)\n"
2663         if $parm_configure_owner != $>;
2664
2665 die "CONFIGURE_GROUP ($parm_configure_group) does not match the group invoking $0 ($))\n"
2666         if 0020 & (stat "$parm_cwd/test-config")[2]
2667         and $parm_configure_group != $);
2668
2669
2670 open(EXIMINFO, "$parm_exim -d-all+transport -bV -C $parm_cwd/test-config -DDIR=$parm_cwd |") ||
2671   die "** Cannot run $parm_exim: $!\n";
2672
2673 print "-" x 78, "\n";
2674
2675 while (<EXIMINFO>)
2676   {
2677   my(@temp);
2678
2679   if (/^(Exim|Library) version/) { print; }
2680
2681   elsif (/^Size of off_t: (\d+)/)
2682     {
2683     print;
2684     $have_largefiles = 1 if $1 > 4;
2685     die "** Size of off_t > 32 which seems improbable, not running tests\n"
2686         if ($1 > 32);
2687     }
2688
2689   elsif (/^Support for: (.*)/)
2690     {
2691     print;
2692     @temp = split /(\s+)/, $1;
2693     push(@temp, ' ');
2694     %parm_support = @temp;
2695     }
2696
2697   elsif (/^Lookups \(built-in\): (.*)/)
2698     {
2699     print;
2700     @temp = split /(\s+)/, $1;
2701     push(@temp, ' ');
2702     %parm_lookups = @temp;
2703     }
2704
2705   elsif (/^Authenticators: (.*)/)
2706     {
2707     print;
2708     @temp = split /(\s+)/, $1;
2709     push(@temp, ' ');
2710     %parm_authenticators = @temp;
2711     }
2712
2713   elsif (/^Routers: (.*)/)
2714     {
2715     print;
2716     @temp = split /(\s+)/, $1;
2717     push(@temp, ' ');
2718     %parm_routers = @temp;
2719     }
2720
2721   # Some transports have options, e.g. appendfile/maildir. For those, ensure
2722   # that the basic transport name is set, and then the name with each of the
2723   # options.
2724
2725   elsif (/^Transports: (.*)/)
2726     {
2727     print;
2728     @temp = split /(\s+)/, $1;
2729     my($i,$k);
2730     push(@temp, ' ');
2731     %parm_transports = @temp;
2732     foreach $k (keys %parm_transports)
2733       {
2734       if ($k =~ "/")
2735         {
2736         @temp = split /\//, $k;
2737         $parm_transports{$temp[0]} = " ";
2738         for ($i = 1; $i < @temp; $i++)
2739           { $parm_transports{"$temp[0]/$temp[$i]"} = " "; }
2740         }
2741       }
2742     }
2743   }
2744 close(EXIMINFO);
2745 print "-" x 78, "\n";
2746
2747 unlink("$parm_cwd/test-config");
2748
2749 ##################################################
2750 #    Check for SpamAssassin and ClamAV           #
2751 ##################################################
2752
2753 # These are crude tests. If they aren't good enough, we'll have to improve
2754 # them, for example by actually passing a message through spamc or clamscan.
2755
2756 if (defined $parm_support{Content_Scanning})
2757   {
2758   my $sock = new FileHandle;
2759
2760   if (system("spamc -h 2>/dev/null >/dev/null") == 0)
2761     {
2762     print "The spamc command works:\n";
2763
2764     # This test for an active SpamAssassin is courtesy of John Jetmore.
2765     # The tests are hard coded to localhost:783, so no point in making
2766     # this test flexible like the clamav test until the test scripts are
2767     # changed.  spamd doesn't have the nice PING/PONG protoccol that
2768     # clamd does, but it does respond to errors in an informative manner,
2769     # so use that.
2770
2771     my($sint,$sport) = ('127.0.0.1',783);
2772     eval
2773       {
2774       my $sin = sockaddr_in($sport, inet_aton($sint))
2775           or die "** Failed packing $sint:$sport\n";
2776       socket($sock, PF_INET, SOCK_STREAM, getprotobyname('tcp'))
2777           or die "** Unable to open socket $sint:$sport\n";
2778
2779       local $SIG{ALRM} =
2780           sub { die "** Timeout while connecting to socket $sint:$sport\n"; };
2781       alarm(5);
2782       connect($sock, $sin)
2783           or die "** Unable to connect to socket $sint:$sport\n";
2784       alarm(0);
2785
2786       select((select($sock), $| = 1)[0]);
2787       print $sock "bad command\r\n";
2788
2789       $SIG{ALRM} =
2790           sub { die "** Timeout while reading from socket $sint:$sport\n"; };
2791       alarm(10);
2792       my $res = <$sock>;
2793       alarm(0);
2794
2795       $res =~ m|^SPAMD/|
2796           or die "** Did not get SPAMD from socket $sint:$sport. "
2797                 ."It said: $res\n";
2798       };
2799     alarm(0);
2800     if($@)
2801       {
2802       print "  $@";
2803       print "  Assume SpamAssassin (spamd) is not running\n";
2804       }
2805     else
2806       {
2807       $parm_running{SpamAssassin} = ' ';
2808       print "  SpamAssassin (spamd) seems to be running\n";
2809       }
2810     }
2811   else
2812     {
2813     print "The spamc command failed: assume SpamAssassin (spamd) is not running\n";
2814     }
2815
2816   # For ClamAV, we need to find the clamd socket for use in the Exim
2817   # configuration. Search for the clamd configuration file.
2818
2819   if (system("clamscan -h 2>/dev/null >/dev/null") == 0)
2820     {
2821     my($f, $clamconf, $test_prefix);
2822
2823     print "The clamscan command works";
2824
2825     $test_prefix = $ENV{EXIM_TEST_PREFIX};
2826     $test_prefix = '' if !defined $test_prefix;
2827
2828     foreach $f ("$test_prefix/etc/clamd.conf",
2829                 "$test_prefix/usr/local/etc/clamd.conf",
2830                 "$test_prefix/etc/clamav/clamd.conf", '')
2831       {
2832       if (-e $f)
2833         {
2834         $clamconf = $f;
2835         last;
2836         }
2837       }
2838
2839     # Read the ClamAV configuration file and find the socket interface.
2840
2841     if ($clamconf ne '')
2842       {
2843       my $socket_domain;
2844       open(IN, "$clamconf") || die "\n** Unable to open $clamconf: $!\n";
2845       while (<IN>)
2846         {
2847         if (/^LocalSocket\s+(.*)/)
2848           {
2849           $parm_clamsocket = $1;
2850           $socket_domain = AF_UNIX;
2851           last;
2852           }
2853         if (/^TCPSocket\s+(\d+)/)
2854           {
2855           if (defined $parm_clamsocket)
2856             {
2857             $parm_clamsocket .= " $1";
2858             $socket_domain = AF_INET;
2859             last;
2860             }
2861           else
2862             {
2863             $parm_clamsocket = " $1";
2864             }
2865           }
2866         elsif (/^TCPAddr\s+(\S+)/)
2867           {
2868           if (defined $parm_clamsocket)
2869             {
2870             $parm_clamsocket = $1 . $parm_clamsocket;
2871             $socket_domain = AF_INET;
2872             last;
2873             }
2874           else
2875             {
2876             $parm_clamsocket = $1;
2877             }
2878           }
2879         }
2880       close(IN);
2881
2882       if (defined $socket_domain)
2883         {
2884         print ":\n  The clamd socket is $parm_clamsocket\n";
2885         # This test for an active ClamAV is courtesy of Daniel Tiefnig.
2886         eval
2887           {
2888           my $socket;
2889           if ($socket_domain == AF_UNIX)
2890             {
2891             $socket = sockaddr_un($parm_clamsocket) or die "** Failed packing '$parm_clamsocket'\n";
2892             }
2893           elsif ($socket_domain == AF_INET)
2894             {
2895             my ($ca_host, $ca_port) = split(/\s+/,$parm_clamsocket);
2896             my $ca_hostent = gethostbyname($ca_host) or die "** Failed to get raw address for host '$ca_host'\n";
2897             $socket = sockaddr_in($ca_port, $ca_hostent) or die "** Failed packing '$parm_clamsocket'\n";
2898             }
2899           else
2900             {
2901             die "** Unknown socket domain '$socket_domain' (should not happen)\n";
2902             }
2903           socket($sock, $socket_domain, SOCK_STREAM, 0) or die "** Unable to open socket '$parm_clamsocket'\n";
2904           local $SIG{ALRM} = sub { die "** Timeout while connecting to socket '$parm_clamsocket'\n"; };
2905           alarm(5);
2906           connect($sock, $socket) or die "** Unable to connect to socket '$parm_clamsocket'\n";
2907           alarm(0);
2908
2909           my $ofh = select $sock; $| = 1; select $ofh;
2910           print $sock "PING\n";
2911
2912           $SIG{ALRM} = sub { die "** Timeout while reading from socket '$parm_clamsocket'\n"; };
2913           alarm(10);
2914           my $res = <$sock>;
2915           alarm(0);
2916
2917           $res =~ /PONG/ or die "** Did not get PONG from socket '$parm_clamsocket'. It said: $res\n";
2918           };
2919         alarm(0);
2920
2921         if($@)
2922           {
2923           print "  $@";
2924           print "  Assume ClamAV is not running\n";
2925           }
2926         else
2927           {
2928           $parm_running{ClamAV} = ' ';
2929           print "  ClamAV seems to be running\n";
2930           }
2931         }
2932       else
2933         {
2934         print ", but the socket for clamd could not be determined\n";
2935         print "Assume ClamAV is not running\n";
2936         }
2937       }
2938
2939     else
2940       {
2941       print ", but I can't find a configuration for clamd\n";
2942       print "Assume ClamAV is not running\n";
2943       }
2944     }
2945   }
2946
2947
2948 ##################################################
2949 #       Check for redis                          #
2950 ##################################################
2951 if (defined $parm_lookups{redis})
2952   {
2953   if (system("redis-server -v 2>/dev/null >/dev/null") == 0)
2954     {
2955     print "The redis-server command works\n";
2956     $parm_running{redis} = ' ';
2957     }
2958   else
2959     {
2960     print "The redis-server command failed: assume Redis not installed\n";
2961     }
2962   }
2963
2964 ##################################################
2965 #         Test for the basic requirements        #
2966 ##################################################
2967
2968 # This test suite assumes that Exim has been built with at least the "usual"
2969 # set of routers, transports, and lookups. Ensure that this is so.
2970
2971 $missing = '';
2972
2973 $missing .= "     Lookup: lsearch\n" if (!defined $parm_lookups{lsearch});
2974
2975 $missing .= "     Router: accept\n" if (!defined $parm_routers{accept});
2976 $missing .= "     Router: dnslookup\n" if (!defined $parm_routers{dnslookup});
2977 $missing .= "     Router: manualroute\n" if (!defined $parm_routers{manualroute});
2978 $missing .= "     Router: redirect\n" if (!defined $parm_routers{redirect});
2979
2980 $missing .= "     Transport: appendfile\n" if (!defined $parm_transports{appendfile});
2981 $missing .= "     Transport: autoreply\n" if (!defined $parm_transports{autoreply});
2982 $missing .= "     Transport: pipe\n" if (!defined $parm_transports{pipe});
2983 $missing .= "     Transport: smtp\n" if (!defined $parm_transports{smtp});
2984
2985 if ($missing ne '')
2986   {
2987   print "\n";
2988   print "** Many features can be included or excluded from Exim binaries.\n";
2989   print "** This test suite requires that Exim is built to contain a certain\n";
2990   print "** set of basic facilities. It seems that some of these are missing\n";
2991   print "** from the binary that is under test, so the test cannot proceed.\n";
2992   print "** The missing facilities are:\n";
2993   print "$missing";
2994   die "** Test script abandoned\n";
2995   }
2996
2997
2998 ##################################################
2999 #      Check for the auxiliary programs          #
3000 ##################################################
3001
3002 # These are always required:
3003
3004 for $prog ("cf", "checkaccess", "client", "client-ssl", "client-gnutls",
3005            "fakens", "iefbr14", "server")
3006   {
3007   next if ($prog eq "client-ssl" && !defined $parm_support{OpenSSL});
3008   next if ($prog eq "client-gnutls" && !defined $parm_support{GnuTLS});
3009   if (!-e "bin/$prog")
3010     {
3011     print "\n";
3012     print "** bin/$prog does not exist. Have you run ./configure and make?\n";
3013     die "** Test script abandoned\n";
3014     }
3015   }
3016
3017 # If the "loaded" binary is missing, we cut out tests for ${dlfunc. It isn't
3018 # compiled on systems where we don't know how to. However, if Exim does not
3019 # have that functionality compiled, we needn't bother.
3020
3021 $dlfunc_deleted = 0;
3022 if (defined $parm_support{Expand_dlfunc} && !-e 'bin/loaded')
3023   {
3024   delete $parm_support{Expand_dlfunc};
3025   $dlfunc_deleted = 1;
3026   }
3027
3028
3029 ##################################################
3030 #          Find environmental details            #
3031 ##################################################
3032
3033 # Find the caller of this program.
3034
3035 ($parm_caller,$pwpw,$parm_caller_uid,$parm_caller_gid,$pwquota,$pwcomm,
3036  $parm_caller_gecos, $parm_caller_home) = getpwuid($>);
3037
3038 $pwpw = $pwpw;       # Kill Perl warnings
3039 $pwquota = $pwquota;
3040 $pwcomm = $pwcomm;
3041
3042 $parm_caller_group = getgrgid($parm_caller_gid);
3043
3044 print "Program caller is $parm_caller ($parm_caller_uid), whose group is $parm_caller_group ($parm_caller_gid)\n";
3045 print "Home directory is $parm_caller_home\n";
3046
3047 unless (defined $parm_eximgroup)
3048   {
3049   print "Unable to derive \$parm_eximgroup.\n";
3050   die "** ABANDONING.\n";
3051   }
3052
3053 print "You need to be in the Exim group to run these tests. Checking ...";
3054
3055 if (`groups` =~ /\b\Q$parm_eximgroup\E\b/)
3056   {
3057   print " OK\n";
3058   }
3059 else
3060   {
3061   print "\nOh dear, you are not in the Exim group.\n";
3062   die "** Testing abandoned.\n";
3063   }
3064
3065 # Find this host's IP addresses - there may be many, of course, but we keep
3066 # one of each type (IPv4 and IPv6).
3067
3068 open(IFCONFIG, '-|', (grep { -x "$_/ip" } split /:/, $ENV{PATH}) ? 'ip address' : 'ifconfig -a')
3069   or die "** Cannot run 'ip address' or 'ifconfig -a'\n";
3070 while (not ($parm_ipv4 and $parm_ipv6) and defined($_ = <IFCONFIG>))
3071   {
3072   if (not $parm_ipv4 and /^\s*inet(?:\saddr)?:?\s?(\d+\.\d+\.\d+\.\d+)(?:\/\d+)?\s/i)
3073     {
3074     next if $1 =~ /^(?:127|10)\./;
3075     $parm_ipv4 = $1;
3076     }
3077
3078   if (not $parm_ipv6 and /^\s*inet6(?:\saddr)?:?\s?([abcdef\d:]+)(?:\/\d+)/i)
3079     {
3080     next if $1 eq '::1' or $1 =~ /^fe80/i;
3081     $parm_ipv6 = $1;
3082     }
3083   }
3084 close(IFCONFIG);
3085
3086 # Use private IP addresses if there are no public ones.
3087
3088 # If either type of IP address is missing, we need to set the value to
3089 # something other than empty, because that wrecks the substitutions. The value
3090 # is reflected, so use a meaningful string. Set appropriate options for the
3091 # "server" command. In practice, however, many tests assume 127.0.0.1 is
3092 # available, so things will go wrong if there is no IPv4 address. The lack
3093 # of IPV4 or IPv6 can be simulated by command options, which force $have_ipv4
3094 # and $have_ipv6 false.
3095
3096 if (not $parm_ipv4)
3097   {
3098   $have_ipv4 = 0;
3099   $parm_ipv4 = "<no IPv4 address found>";
3100   $server_opts .= " -noipv4";
3101   }
3102 elsif ($have_ipv4 == 0)
3103   {
3104   $parm_ipv4 = "<IPv4 testing disabled>";
3105   $server_opts .= " -noipv4";
3106   }
3107 else
3108   {
3109   $parm_running{IPv4} = " ";
3110   }
3111
3112 if (not $parm_ipv6)
3113   {
3114   $have_ipv6 = 0;
3115   $parm_ipv6 = "<no IPv6 address found>";
3116   $server_opts .= " -noipv6";
3117   delete($parm_support{IPv6});
3118   }
3119 elsif ($have_ipv6 == 0)
3120   {
3121   $parm_ipv6 = "<IPv6 testing disabled>";
3122   $server_opts .= " -noipv6";
3123   delete($parm_support{IPv6});
3124   }
3125 elsif (!defined $parm_support{IPv6})
3126   {
3127   $have_ipv6 = 0;
3128   $parm_ipv6 = "<no IPv6 support in Exim binary>";
3129   $server_opts .= " -noipv6";
3130   }
3131 else
3132   {
3133   $parm_running{IPv6} = " ";
3134   }
3135
3136 print "IPv4 address is $parm_ipv4\n";
3137 print "IPv6 address is $parm_ipv6\n";
3138
3139 # For munging test output, we need the reversed IP addresses.
3140
3141 $parm_ipv4r = ($parm_ipv4 !~ /^\d/)? '' :
3142   join(".", reverse(split /\./, $parm_ipv4));
3143
3144 $parm_ipv6r = $parm_ipv6;             # Appropriate if not in use
3145 if ($parm_ipv6 =~ /^[\da-f]/)
3146   {
3147   my(@comps) = split /:/, $parm_ipv6;
3148   my(@nibbles);
3149   foreach $comp (@comps)
3150     {
3151     push @nibbles, sprintf("%lx", hex($comp) >> 8);
3152     push @nibbles, sprintf("%lx", hex($comp) & 0xff);
3153     }
3154   $parm_ipv6r = join(".", reverse(@nibbles));
3155   }
3156
3157 # Find the host name, fully qualified.
3158
3159 chomp($temp = `hostname`);
3160 die "'hostname' didn't return anything\n" unless defined $temp and length $temp;
3161 if ($temp =~ /\./)
3162   {
3163   $parm_hostname = $temp;
3164   }
3165 else
3166   {
3167   $parm_hostname = (gethostbyname($temp))[0];
3168   $parm_hostname = "no.host.name.found" unless defined $parm_hostname and length $parm_hostname;
3169   }
3170 print "Hostname is $parm_hostname\n";
3171
3172 if ($parm_hostname !~ /\./)
3173   {
3174   print "\n*** Host name is not fully qualified: this may cause problems ***\n\n";
3175   }
3176
3177 if ($parm_hostname =~ /[[:upper:]]/)
3178   {
3179   print "\n*** Host name has upper case characters: this may cause problems ***\n\n";
3180   }
3181
3182
3183
3184 ##################################################
3185 #     Create a testing version of Exim           #
3186 ##################################################
3187
3188 # We want to be able to run Exim with a variety of configurations. Normally,
3189 # the use of -C to change configuration causes Exim to give up its root
3190 # privilege (unless the caller is exim or root). For these tests, we do not
3191 # want this to happen. Also, we want Exim to know that it is running in its
3192 # test harness.
3193
3194 # We achieve this by copying the binary and patching it as we go. The new
3195 # binary knows it is a testing copy, and it allows -C and -D without loss of
3196 # privilege. Clearly, this file is dangerous to have lying around on systems
3197 # where there are general users with login accounts. To protect against this,
3198 # we put the new binary in a special directory that is accessible only to the
3199 # caller of this script, who is known to have sudo root privilege from the test
3200 # that was done above. Furthermore, we ensure that the binary is deleted at the
3201 # end of the test. First ensure the directory exists.
3202
3203 if (-d "eximdir")
3204   { unlink "eximdir/exim"; }     # Just in case
3205 else
3206   {
3207   mkdir("eximdir", 0710) || die "** Unable to mkdir $parm_cwd/eximdir: $!\n";
3208   system("sudo chgrp $parm_eximgroup eximdir");
3209   }
3210
3211 # The construction of the patched binary must be done as root, so we use
3212 # a separate script. As well as indicating that this is a test-harness binary,
3213 # the version number is patched to "x.yz" so that its length is always the
3214 # same. Otherwise, when it appears in Received: headers, it affects the length
3215 # of the message, which breaks certain comparisons.
3216
3217 die "** Unable to make patched exim: $!\n"
3218   if (system("sudo ./patchexim $parm_exim") != 0);
3219
3220 # From this point on, exits from the program must go via the subroutine
3221 # tests_exit(), so that suitable cleaning up can be done when required.
3222 # Arrange to catch interrupting signals, to assist with this.
3223
3224 $SIG{INT} = \&inthandler;
3225 $SIG{PIPE} = \&pipehandler;
3226
3227 # For some tests, we need another copy of the binary that is setuid exim rather
3228 # than root.
3229
3230 system("sudo cp eximdir/exim eximdir/exim_exim;" .
3231        "sudo chown $parm_eximuser eximdir/exim_exim;" .
3232        "sudo chgrp $parm_eximgroup eximdir/exim_exim;" .
3233        "sudo chmod 06755 eximdir/exim_exim");
3234
3235
3236 ##################################################
3237 #     Make copies of utilities we might need     #
3238 ##################################################
3239
3240 # Certain of the tests make use of some of Exim's utilities. We do not need
3241 # to be root to copy these.
3242
3243 ($parm_exim_dir) = $parm_exim =~ m?^(.*)/exim?;
3244
3245 $dbm_build_deleted = 0;
3246 if (defined $parm_lookups{dbm} &&
3247     system("cp $parm_exim_dir/exim_dbmbuild eximdir") != 0)
3248   {
3249   delete $parm_lookups{dbm};
3250   $dbm_build_deleted = 1;
3251   }
3252
3253 if (system("cp $parm_exim_dir/exim_dumpdb eximdir") != 0)
3254   {
3255   tests_exit(-1, "Failed to make a copy of exim_dumpdb: $!");
3256   }
3257
3258 if (system("cp $parm_exim_dir/exim_lock eximdir") != 0)
3259   {
3260   tests_exit(-1, "Failed to make a copy of exim_lock: $!");
3261   }
3262
3263 if (system("cp $parm_exim_dir/exinext eximdir") != 0)
3264   {
3265   tests_exit(-1, "Failed to make a copy of exinext: $!");
3266   }
3267
3268 if (system("cp $parm_exim_dir/exigrep eximdir") != 0)
3269   {
3270   tests_exit(-1, "Failed to make a copy of exigrep: $!");
3271   }
3272
3273 if (system("cp $parm_exim_dir/eximstats eximdir") != 0)
3274   {
3275   tests_exit(-1, "Failed to make a copy of eximstats: $!");
3276   }
3277
3278
3279 ##################################################
3280 #    Check that the Exim user can access stuff   #
3281 ##################################################
3282
3283 # We delay this test till here so that we can check access to the actual test
3284 # binary. This will be needed when Exim re-exec's itself to do deliveries.
3285
3286 print "Exim user is $parm_eximuser ($parm_exim_uid)\n";
3287 print "Exim group is $parm_eximgroup ($parm_exim_gid)\n";
3288
3289 if ($parm_caller_uid eq $parm_exim_uid) {
3290   tests_exit(-1, "Exim user ($parm_eximuser,$parm_exim_uid) cannot be "
3291                 ."the same as caller ($parm_caller,$parm_caller_uid)");
3292 }
3293 if ($parm_caller_gid eq $parm_exim_gid) {
3294   tests_exit(-1, "Exim group ($parm_eximgroup,$parm_exim_gid) cannot be "
3295                 ."the same as caller's ($parm_caller) group as it confuses "
3296                 ."results analysis");
3297 }
3298
3299 print "The Exim user needs access to the test suite directory. Checking ...";
3300
3301 if (($rc = system("sudo bin/checkaccess $parm_cwd/eximdir/exim $parm_eximuser $parm_eximgroup")) != 0)
3302   {
3303   my($why) = "unknown failure $rc";
3304   $rc >>= 8;
3305   $why = "Couldn't find user \"$parm_eximuser\"" if $rc == 1;
3306   $why = "Couldn't find group \"$parm_eximgroup\"" if $rc == 2;
3307   $why = "Couldn't read auxiliary group list" if $rc == 3;
3308   $why = "Couldn't get rid of auxiliary groups" if $rc == 4;
3309   $why = "Couldn't set gid" if $rc == 5;
3310   $why = "Couldn't set uid" if $rc == 6;
3311   $why = "Couldn't open \"$parm_cwd/eximdir/exim\"" if $rc == 7;
3312   print "\n** $why\n";
3313   tests_exit(-1, "$parm_eximuser cannot access the test suite directory");
3314   }
3315 else
3316   {
3317   print " OK\n";
3318   }
3319
3320
3321 ##################################################
3322 #        Create a list of available tests        #
3323 ##################################################
3324
3325 # The scripts directory contains a number of subdirectories whose names are
3326 # of the form 0000-xxxx, 1100-xxxx, 2000-xxxx, etc. Each set of tests apart
3327 # from the first requires certain optional features to be included in the Exim
3328 # binary. These requirements are contained in a file called "REQUIRES" within
3329 # the directory. We scan all these tests, discarding those that cannot be run
3330 # because the current binary does not support the right facilities, and also
3331 # those that are outside the numerical range selected.
3332
3333 print "\nTest range is $test_start to $test_end (flavour $flavour)\n";
3334 print "Omitting \${dlfunc expansion tests (loadable module not present)\n"
3335   if $dlfunc_deleted;
3336 print "Omitting dbm tests (unable to copy exim_dbmbuild)\n"
3337   if $dbm_build_deleted;
3338
3339 opendir(DIR, "scripts") || tests_exit(-1, "Failed to opendir(\"scripts\"): $!");
3340 @test_dirs = sort readdir(DIR);
3341 closedir(DIR);
3342
3343 # Remove . and .. and CVS from the list.
3344
3345 for ($i = 0; $i < @test_dirs; $i++)
3346   {
3347   my($d) = $test_dirs[$i];
3348   if ($d eq "." || $d eq ".." || $d eq "CVS")
3349     {
3350     splice @test_dirs, $i, 1;
3351     $i--;
3352     }
3353   }
3354
3355 # Scan for relevant tests
3356
3357 for ($i = 0; $i < @test_dirs; $i++)
3358   {
3359   my($testdir) = $test_dirs[$i];
3360   my($wantthis) = 1;
3361
3362   print ">>Checking $testdir\n" if $debug;
3363
3364   # Skip this directory if the first test is equal or greater than the first
3365   # test in the next directory.
3366
3367   next if ($i < @test_dirs - 1) &&
3368           ($test_start >= substr($test_dirs[$i+1], 0, 4));
3369
3370   # No need to carry on if the end test is less than the first test in this
3371   # subdirectory.
3372
3373   last if $test_end < substr($testdir, 0, 4);
3374
3375   # Check requirements, if any.
3376
3377   if (open(REQUIRES, "scripts/$testdir/REQUIRES"))
3378     {
3379     while (<REQUIRES>)
3380       {
3381       next if /^\s*$/;
3382       s/\s+$//;
3383       if (/^support (.*)$/)
3384         {
3385         if (!defined $parm_support{$1}) { $wantthis = 0; last; }
3386         }
3387       elsif (/^running (.*)$/)
3388         {
3389         if (!defined $parm_running{$1}) { $wantthis = 0; last; }
3390         }
3391       elsif (/^lookup (.*)$/)
3392         {
3393         if (!defined $parm_lookups{$1}) { $wantthis = 0; last; }
3394         }
3395       elsif (/^authenticators? (.*)$/)
3396         {
3397         if (!defined $parm_authenticators{$1}) { $wantthis = 0; last; }
3398         }
3399       elsif (/^router (.*)$/)
3400         {
3401         if (!defined $parm_routers{$1}) { $wantthis = 0; last; }
3402         }
3403       elsif (/^transport (.*)$/)
3404         {
3405         if (!defined $parm_transports{$1}) { $wantthis = 0; last; }
3406         }
3407       else
3408         {
3409         tests_exit(-1, "Unknown line in \"scripts/$testdir/REQUIRES\": \"$_\"");
3410         }
3411       }
3412     close(REQUIRES);
3413     }
3414   else
3415     {
3416     tests_exit(-1, "Failed to open \"scripts/$testdir/REQUIRES\": $!")
3417       unless $!{ENOENT};
3418     }
3419
3420   # Loop if we do not want the tests in this subdirectory.
3421
3422   if (!$wantthis)
3423     {
3424     chomp;
3425     print "Omitting tests in $testdir (missing $_)\n";
3426     next;
3427     }
3428
3429   # We want the tests from this subdirectory, provided they are in the
3430   # range that was selected.
3431
3432   opendir(SUBDIR, "scripts/$testdir") ||
3433     tests_exit(-1, "Failed to opendir(\"scripts/$testdir\"): $!");
3434   @testlist = sort readdir(SUBDIR);
3435   close(SUBDIR);
3436
3437   foreach $test (@testlist)
3438     {
3439     next if $test !~ /^\d{4}(?:\.\d+)?$/;
3440     next if $test < $test_start || $test > $test_end;
3441     push @test_list, "$testdir/$test";
3442     }
3443   }
3444
3445 print ">>Test List: @test_list\n", if $debug;
3446
3447
3448 ##################################################
3449 #         Munge variable auxiliary data          #
3450 ##################################################
3451
3452 # Some of the auxiliary data files have to refer to the current testing
3453 # directory and other parameter data. The generic versions of these files are
3454 # stored in the aux-var-src directory. At this point, we copy each of them
3455 # to the aux-var directory, making appropriate substitutions. There aren't very
3456 # many of them, so it's easiest just to do this every time. Ensure the mode
3457 # is standardized, as this path is used as a test for the ${stat: expansion.
3458
3459 # A similar job has to be done for the files in the dnszones-src directory, to
3460 # make the fake DNS zones for testing. Most of the zone files are copied to
3461 # files of the same name, but db.ipv4.V4NET and db.ipv6.V6NET use the testing
3462 # networks that are defined by parameter.
3463
3464 foreach $basedir ("aux-var", "dnszones")
3465   {
3466   system("sudo rm -rf $parm_cwd/$basedir");
3467   mkdir("$parm_cwd/$basedir", 0777);
3468   chmod(0755, "$parm_cwd/$basedir");
3469
3470   opendir(AUX, "$parm_cwd/$basedir-src") ||
3471     tests_exit(-1, "Failed to opendir $parm_cwd/$basedir-src: $!");
3472   my(@filelist) = readdir(AUX);
3473   close(AUX);
3474
3475   foreach $file (@filelist)
3476     {
3477     my($outfile) = $file;
3478     next if $file =~ /^\./;
3479
3480     if ($file eq "db.ip4.V4NET")
3481       {
3482       $outfile = "db.ip4.$parm_ipv4_test_net";
3483       }
3484     elsif ($file eq "db.ip6.V6NET")
3485       {
3486       my(@nibbles) = reverse(split /\s*/, $parm_ipv6_test_net);
3487       $" = '.';
3488       $outfile = "db.ip6.@nibbles";
3489       $" = ' ';
3490       }
3491
3492     print ">>Copying $basedir-src/$file to $basedir/$outfile\n" if $debug;
3493     open(IN, "$parm_cwd/$basedir-src/$file") ||
3494       tests_exit(-1, "Failed to open $parm_cwd/$basedir-src/$file: $!");
3495     open(OUT, ">$parm_cwd/$basedir/$outfile") ||
3496       tests_exit(-1, "Failed to open $parm_cwd/$basedir/$outfile: $!");
3497     while (<IN>)
3498       {
3499       do_substitute(0);
3500       print OUT;
3501       }
3502     close(IN);
3503     close(OUT);
3504     }
3505   }
3506
3507 # Set a user's shell, distinguishable from /bin/sh
3508
3509 symlink('/bin/sh' => 'aux-var/sh');
3510 $ENV{SHELL} = $parm_shell = "$parm_cwd/aux-var/sh";
3511
3512 ##################################################
3513 #     Create fake DNS zones for this host        #
3514 ##################################################
3515
3516 # There are fixed zone files for 127.0.0.1 and ::1, but we also want to be
3517 # sure that there are forward and reverse registrations for this host, using
3518 # its real IP addresses. Dynamically created zone files achieve this.
3519
3520 if ($have_ipv4 || $have_ipv6)
3521   {
3522   my($shortname,$domain) = $parm_hostname =~ /^([^.]+)(.*)/;
3523   open(OUT, ">$parm_cwd/dnszones/db$domain") ||
3524     tests_exit(-1, "Failed to open $parm_cwd/dnszones/db$domain: $!");
3525   print OUT "; This is a dynamically constructed fake zone file.\n" .
3526     "; The following line causes fakens to return PASS_ON\n" .
3527     "; for queries that it cannot answer\n\n" .
3528     "PASS ON NOT FOUND\n\n";
3529   print OUT "$shortname  A     $parm_ipv4\n" if $have_ipv4;
3530   print OUT "$shortname  AAAA  $parm_ipv6\n" if $have_ipv6;
3531   print OUT "\n; End\n";
3532   close(OUT);
3533   }
3534
3535 if ($have_ipv4 && $parm_ipv4 ne "127.0.0.1")
3536   {
3537   my(@components) = $parm_ipv4 =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)/;
3538   open(OUT, ">$parm_cwd/dnszones/db.ip4.$components[0]") ||
3539     tests_exit(-1,
3540       "Failed  to open $parm_cwd/dnszones/db.ip4.$components[0]: $!");
3541   print OUT "; This is a dynamically constructed fake zone file.\n" .
3542     "; The zone is $components[0].in-addr.arpa.\n\n" .
3543     "$components[3].$components[2].$components[1]  PTR  $parm_hostname.\n\n" .
3544     "; End\n";
3545   close(OUT);
3546   }
3547
3548 if ($have_ipv6 && $parm_ipv6 ne "::1")
3549   {
3550   my($exp_v6) = $parm_ipv6;
3551   $exp_v6 =~ s/[^:]//g;
3552   if ( $parm_ipv6 =~ /^([^:].+)::$/ ) {
3553     $exp_v6 = $1 . ':0' x (9-length($exp_v6));
3554   } elsif ( $parm_ipv6 =~ /^(.+)::(.+)$/ ) {
3555     $exp_v6 = $1 . ':0' x (8-length($exp_v6)) . ':' . $2;
3556   } elsif ( $parm_ipv6 =~ /^::(.+[^:])$/ ) {
3557     $exp_v6 = '0:' x (9-length($exp_v6)) . $1;
3558   } else {
3559     $exp_v6 = $parm_ipv6;
3560   }
3561   my(@components) = split /:/, $exp_v6;
3562   my(@nibbles) = reverse (split /\s*/, shift @components);
3563   my($sep) =  '';
3564
3565   $" = ".";
3566   open(OUT, ">$parm_cwd/dnszones/db.ip6.@nibbles") ||
3567     tests_exit(-1,
3568       "Failed  to open $parm_cwd/dnszones/db.ip6.@nibbles: $!");
3569   print OUT "; This is a dynamically constructed fake zone file.\n" .
3570     "; The zone is @nibbles.ip6.arpa.\n\n";
3571
3572   @components = reverse @components;
3573   foreach $c (@components)
3574     {
3575     $c = "0$c" until $c =~ /^..../;
3576     @nibbles = reverse(split /\s*/, $c);
3577     print OUT "$sep@nibbles";
3578     $sep = ".";
3579     }
3580
3581   print OUT "  PTR  $parm_hostname.\n\n; End\n";
3582   close(OUT);
3583   $" = " ";
3584   }
3585
3586
3587
3588 ##################################################
3589 #    Create lists of mailboxes and message logs  #
3590 ##################################################
3591
3592 # We use these lists to check that a test has created the expected files. It
3593 # should be faster than looking for the file each time. For mailboxes, we have
3594 # to scan a complete subtree, in order to handle maildirs. For msglogs, there
3595 # is just a flat list of files.
3596
3597 @oldmails = list_files_below("mail");
3598 opendir(DIR, "msglog") || tests_exit(-1, "Failed to opendir msglog: $!");
3599 @oldmsglogs = readdir(DIR);
3600 closedir(DIR);
3601
3602
3603
3604 ##################################################
3605 #         Run the required tests                 #
3606 ##################################################
3607
3608 # Each test script contains a number of tests, separated by a line that
3609 # contains ****. We open input from the terminal so that we can read responses
3610 # to prompts.
3611
3612 if (not $force_continue) {
3613   # runtest needs to interact if we're not in continue
3614   # mode. It does so by communicate to /dev/tty
3615   open(T, "/dev/tty") or tests_exit(-1, "Failed to open /dev/tty: $!");
3616 }
3617
3618
3619 print "\nPress RETURN to run the tests: ";
3620 $_ = $force_continue ? "c" : <T>;
3621 print "\n";
3622
3623 $lasttestdir = '';
3624
3625 foreach $test (@test_list)
3626   {
3627   local($lineno) = 0;
3628   local($commandno) = 0;
3629   local($subtestno) = 0;
3630   (local $testno = $test) =~ s|.*/||;
3631   local($sortlog) = 0;
3632
3633   my($gnutls) = 0;
3634   my($docheck) = 1;
3635   my($thistestdir) = substr($test, 0, -5);
3636
3637   $dynamic_socket->close() if $dynamic_socket;
3638
3639   if ($lasttestdir ne $thistestdir)
3640     {
3641     $gnutls = 0;
3642     if (-s "scripts/$thistestdir/REQUIRES")
3643       {
3644       my($indent) = '';
3645       print "\n>>> The following tests require: ";
3646       open(IN, "scripts/$thistestdir/REQUIRES") ||
3647         tests_exit(-1, "Failed to open scripts/$thistestdir/REQUIRES: $1");
3648       while (<IN>)
3649         {
3650         $gnutls = 1 if /^support GnuTLS/;
3651         print $indent, $_;
3652         $indent = ">>>                              ";
3653         }
3654       close(IN);
3655       }
3656     }
3657   $lasttestdir = $thistestdir;
3658
3659   # Remove any debris in the spool directory and the test-mail directory
3660   # and also the files for collecting stdout and stderr. Then put back
3661   # the test-mail directory for appendfile deliveries.
3662
3663   system "sudo /bin/rm -rf spool test-*";
3664   system "mkdir test-mail 2>/dev/null";
3665
3666   # A privileged Exim will normally make its own spool directory, but some of
3667   # the tests run in unprivileged modes that don't always work if the spool
3668   # directory isn't already there. What is more, we want anybody to be able
3669   # to read it in order to find the daemon's pid.
3670
3671   system "mkdir spool; " .
3672          "sudo chown $parm_eximuser:$parm_eximgroup spool; " .
3673          "sudo chmod 0755 spool";
3674
3675   # Empty the cache that keeps track of things like message id mappings, and
3676   # set up the initial sequence strings.
3677
3678   undef %cache;
3679   $next_msgid = "aX";
3680   $next_pid = 1234;
3681   $next_port = 1111;
3682   $message_skip = 0;
3683   $msglog_skip = 0;
3684   $stderr_skip = 0;
3685   $stdout_skip = 0;
3686   $rmfiltertest = 0;
3687   $is_ipv6test = 0;
3688   $TEST_STATE->{munge} = '';
3689
3690   # Remove the associative arrays used to hold checked mail files and msglogs
3691
3692   undef %expected_mails;
3693   undef %expected_msglogs;
3694
3695   # Open the test's script
3696   open(SCRIPT, "scripts/$test") ||
3697     tests_exit(-1, "Failed to open \"scripts/$test\": $!");
3698   # Run through the script once to set variables which should be global
3699   while (<SCRIPT>)
3700     {
3701     if (/^no_message_check/) { $message_skip = 1; next; }
3702     if (/^no_msglog_check/)  { $msglog_skip = 1; next; }
3703     if (/^no_stderr_check/)  { $stderr_skip = 1; next; }
3704     if (/^no_stdout_check/)  { $stdout_skip = 1; next; }
3705     if (/^rmfiltertest/)     { $rmfiltertest = 1; next; }
3706     if (/^sortlog/)          { $sortlog = 1; next; }
3707     if (/\bPORT_DYNAMIC\b/)  { $dynamic_socket = Exim::Runtest::dynamic_socket(); next; }
3708     }
3709   # Reset to beginning of file for per test interpreting/processing
3710   seek(SCRIPT, 0, 0);
3711
3712   # The first line in the script must be a comment that is used to identify
3713   # the set of tests as a whole.
3714
3715   $_ = <SCRIPT>;
3716   $lineno++;
3717   tests_exit(-1, "Missing identifying comment at start of $test") if (!/^#/);
3718   printf("%s %s", (substr $test, 5), (substr $_, 2));
3719
3720   # Loop for each of the subtests within the script. The variable $server_pid
3721   # is used to remember the pid of a "server" process, for which we do not
3722   # wait until we have waited for a subsequent command.
3723
3724   local($server_pid) = 0;
3725   for ($commandno = 1; !eof SCRIPT; $commandno++)
3726     {
3727     # Skip further leading comments and blank lines, handle the flag setting
3728     # commands, and deal with tests for IP support.
3729
3730     while (<SCRIPT>)
3731       {
3732       $lineno++;
3733       # Could remove these variable settings because they are already
3734       # set above, but doesn't hurt to leave them here.
3735       if (/^no_message_check/) { $message_skip = 1; next; }
3736       if (/^no_msglog_check/)  { $msglog_skip = 1; next; }
3737       if (/^no_stderr_check/)  { $stderr_skip = 1; next; }
3738       if (/^no_stdout_check/)  { $stdout_skip = 1; next; }
3739       if (/^rmfiltertest/)     { $rmfiltertest = 1; next; }
3740       if (/^sortlog/)          { $sortlog = 1; next; }
3741
3742       if (/^need_largefiles/)
3743         {
3744         next if $have_largefiles;
3745         print ">>> Large file support is needed for test $testno, but is not available: skipping\n";
3746         $docheck = 0;      # don't check output
3747         undef $_;          # pretend EOF
3748         last;
3749         }
3750
3751       if (/^need_ipv4/)
3752         {
3753         next if $have_ipv4;
3754         print ">>> IPv4 is needed for test $testno, but is not available: skipping\n";
3755         $docheck = 0;      # don't check output
3756         undef $_;          # pretend EOF
3757         last;
3758         }
3759
3760       if (/^need_ipv6/)
3761         {
3762         if ($have_ipv6)
3763           {
3764           $is_ipv6test = 1;
3765           next;
3766           }
3767         print ">>> IPv6 is needed for test $testno, but is not available: skipping\n";
3768         $docheck = 0;      # don't check output
3769         undef $_;          # pretend EOF
3770         last;
3771         }
3772
3773       if (/^need_move_frozen_messages/)
3774         {
3775         next if defined $parm_support{move_frozen_messages};
3776         print ">>> move frozen message support is needed for test $testno, " .
3777           "but is not\n>>> available: skipping\n";
3778         $docheck = 0;      # don't check output
3779         undef $_;          # pretend EOF
3780         last;
3781         }
3782
3783       last unless /^(?:#(?!##\s)|\s*$)/;
3784       }
3785     last if !defined $_;  # Hit EOF
3786
3787     my($subtest_startline) = $lineno;
3788
3789     # Now run the command. The function returns 0 for an inline command,
3790     # 1 if a non-exim command was run and waited for, 2 if an exim
3791     # command was run and waited for, and 3 if a command
3792     # was run and not waited for (usually a daemon or server startup).
3793
3794     my($commandname) = '';
3795     my($expectrc) = 0;
3796     my($rc, $run_extra) = run_command($testno, \$subtestno, \$expectrc, \$commandname, $TEST_STATE);
3797     my($cmdrc) = $?;
3798
3799     $0 = "[runtest $testno]";
3800
3801     if ($debug) {
3802       print ">> rc=$rc cmdrc=$cmdrc\n";
3803       if (defined $run_extra) {
3804         foreach my $k (keys %$run_extra) {
3805           my $v = defined $run_extra->{$k} ? qq!"$run_extra->{$k}"! : '<undef>';
3806           print ">>   $k -> $v\n";
3807         }
3808       }
3809     }
3810     $run_extra = {} unless defined $run_extra;
3811     foreach my $k (keys %$run_extra) {
3812       if (exists $TEST_STATE->{$k}) {
3813         my $nv = defined $run_extra->{$k} ? qq!"$run_extra->{$k}"! : 'removed';
3814         print ">> override of $k; was $TEST_STATE->{$k}, now $nv\n" if $debug;
3815       }
3816       if (defined $run_extra->{$k}) {
3817         $TEST_STATE->{$k} = $run_extra->{$k};
3818       } elsif (exists $TEST_STATE->{$k}) {
3819         delete $TEST_STATE->{$k};
3820       }
3821     }
3822
3823     # Hit EOF after an initial return code number
3824
3825     tests_exit(-1, "Unexpected EOF in script") if ($rc == 4);
3826
3827     # Carry on with the next command if we did not wait for this one. $rc == 0
3828     # if no subprocess was run; $rc == 3 if we started a process but did not
3829     # wait for it.
3830
3831     next if ($rc == 0 || $rc == 3);
3832
3833     # We ran and waited for a command. Check for the expected result unless
3834     # it died.
3835
3836     if ($cmdrc != $expectrc && !$sigpipehappened)
3837       {
3838       printf("** Command $commandno (\"$commandname\", starting at line $subtest_startline)\n");
3839       if (($cmdrc & 0xff) == 0)
3840         {
3841         printf("** Return code %d (expected %d)", $cmdrc/256, $expectrc/256);
3842         }
3843       elsif (($cmdrc & 0xff00) == 0)
3844         { printf("** Killed by signal %d", $cmdrc & 255); }
3845       else
3846         { printf("** Status %x", $cmdrc); }
3847
3848       for (;;)
3849         {
3850         print "\nshow stdErr, show stdOut, Retry, Continue (without file comparison), or Quit? [Q] ";
3851         $_ = $force_continue ? "c" : <T>;
3852         tests_exit(1) if /^q?$/i;
3853         log_failure($log_failed_filename, $testno, "exit code unexpected") if (/^c$/i && $force_continue);
3854         if ($force_continue)
3855           {
3856           print "\nstderr tail:\n";
3857           print "===================\n";
3858           system("tail -20 test-stderr");
3859           print "===================\n";
3860           print "... continue forced\n";
3861           }
3862
3863         last if /^[rc]$/i;
3864         if (/^e$/i)
3865           {
3866           system("$more test-stderr");
3867           }
3868         elsif (/^o$/i)
3869           {
3870           system("$more test-stdout");
3871           }
3872         }
3873
3874       $retry = 1 if /^r$/i;
3875       $docheck = 0;
3876       }
3877
3878     # If the command was exim, and a listening server is running, we can now
3879     # close its input, which causes us to wait for it to finish, which is why
3880     # we didn't close it earlier.
3881
3882     if ($rc == 2 && $server_pid != 0)
3883       {
3884       close SERVERCMD;
3885       $server_pid = 0;
3886       if ($? != 0)
3887         {
3888         if (($? & 0xff) == 0)
3889           { printf("Server return code %d", $?/256); }
3890         elsif (($? & 0xff00) == 0)
3891           { printf("Server killed by signal %d", $? & 255); }
3892         else
3893           { printf("Server status %x", $?); }
3894
3895         for (;;)
3896           {
3897           print "\nShow server stdout, Retry, Continue, or Quit? [Q] ";
3898           $_ = $force_continue ? "c" : <T>;
3899           tests_exit(1) if /^q?$/i;
3900           log_failure($log_failed_filename, $testno, "exit code unexpected") if (/^c$/i && $force_continue);
3901           print "... continue forced\n" if $force_continue;
3902           last if /^[rc]$/i;
3903
3904           if (/^s$/i)
3905             {
3906             open(S, "test-stdout-server") ||
3907               tests_exit(-1, "Failed to open test-stdout-server: $!");
3908             print while <S>;
3909             close(S);
3910             }
3911           }
3912         $retry = 1 if /^r$/i;
3913         }
3914       }
3915     }
3916
3917   close SCRIPT;
3918
3919   # The script has finished. Check the all the output that was generated. The
3920   # function returns 0 if all is well, 1 if we should rerun the test (the files
3921   # have been updated). It does not return if the user responds Q to a prompt.
3922
3923   if ($retry)
3924     {
3925     $retry = '0';
3926     print (("#" x 79) . "\n");
3927     redo;
3928     }
3929
3930   if ($docheck)
3931     {
3932     if (check_output($TEST_STATE->{munge}) != 0)
3933       {
3934       print (("#" x 79) . "\n");
3935       redo;
3936       }
3937     else
3938       {
3939       print ("  Script completed\n");
3940       }
3941     }
3942   }
3943
3944
3945 ##################################################
3946 #         Exit from the test script              #
3947 ##################################################
3948
3949 tests_exit(-1, "No runnable tests selected") if @test_list == 0;
3950 tests_exit(0);
3951
3952 # End of runtest script