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