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