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