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