test/runtest

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