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