test/runtest

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