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