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