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