test/runtest

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