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