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