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