test/runtest

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