test/runtest

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