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