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