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