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