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