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