test/runtest

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