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