test/runtest

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