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