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