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