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