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