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