test/runtest

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