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