test/runtest

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