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