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