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