test/runtest

   1 #! /usr/bin/env perl
   2 # We use env, because in some environments of our build farm
   3 # the Perl 5.010 interpreter is only reachable via $PATH
   4
   5 ###############################################################################
   6 # This is the controlling script for the "new" test suite for Exim. It should #
   7 # be possible to export this suite for running on a wide variety of hosts, in #
   8 # contrast to the old suite, which was very dependent on the environment of   #
   9 # Philip Hazel's desktop computer. This implementation inspects the version   #
  10 # of Exim that it finds, and tests only those features that are included. The #
  11 # surrounding environment is also tested to discover what is available. See   #
  12 # the README file for details of how it all works.                            #
  13 #                                                                             #
  14 # Implementation started: 03 August 2005 by Philip Hazel                      #
  15 # Placed in the Exim CVS: 06 February 2006                                    #
  16 ###############################################################################
  17
  18 #use strict;
  19 use 5.010;
  20 use feature 'state';    # included in 5.010
  21 use warnings;
  22
  23 use Errno;
  24 use FileHandle;
  25 use Socket;
  26 use Time::Local;
  27 use Cwd;
  28 use File::Basename;
  29 use FindBin qw'$RealBin';
  30
  31 use lib "$RealBin/lib";
  32 use Exim::Runtest;
  33
  34 use if $ENV{DEBUG} && $ENV{DEBUG} =~ /\bruntest\b/ => ('Smart::Comments' => '####');
  35
  36
  37 # Start by initializing some global variables
  38
  39 chomp(my $testversion = `git describe --always --dirty 2>&1` || '<unknown>');
  40
  41 # This gets embedded in the D-H params filename, and the value comes
  42 # from asking GnuTLS for "normal", but there appears to be no way to
  43 # use certtool/... to ask what that value currently is.  *sigh*
  44 # We also clamp it because of NSS interop, see addition of tls_dh_max_bits.
  45 # This value is correct as of GnuTLS 2.12.18 as clamped by tls_dh_max_bits.
  46 # normal = 2432   tls_dh_max_bits = 2236
  47 my $gnutls_dh_bits_normal = 2236;
  48
  49 my $cf = 'bin/cf -exact';
  50 my $cr = "\r";
  51 my $debug = 0;
  52 my $flavour = do {
  53   my $f = Exim::Runtest::flavour() // '';
  54   (grep { $f eq $_ } Exim::Runtest::flavours()) ? $f : 'FOO';
  55 };
  56 my $force_continue = 0;
  57 my $force_update = 0;
  58 my $log_failed_filename = 'failed-summary.log';
  59 my $log_summary_filename = 'run-summary.log';
  60 my $more = 'less -XF';
  61 my $optargs = '';
  62 my $save_output = 0;
  63 my $server_opts = '';
  64 my $valgrind = 0;
  65
  66 my $have_ipv4 = 1;
  67 my $have_ipv6 = 1;
  68 my $have_largefiles = 0;
  69
  70 my $test_start = 1;
  71 my $test_end = $test_top = 8999;
  72 my $test_special_top = 9999;
  73 my @test_list = ();
  74 my @test_dirs = ();
  75
  76
  77 # Networks to use for DNS tests. We need to choose some networks that will
  78 # never be used so that there is no chance that the host on which we are
  79 # running is actually in one of the test networks. Private networks such as
  80 # the IPv4 10.0.0.0/8 network are no good because hosts may well use them.
  81 # Rather than use some unassigned numbers (that might become assigned later),
  82 # I have chosen some multicast networks, in the belief that such addresses
  83 # won't ever be assigned to hosts. This is the only place where these numbers
  84 # are defined, so it is trivially possible to change them should that ever
  85 # become necessary.
  86
  87 my $parm_ipv4_test_net = 224;
  88 my $parm_ipv6_test_net = 'ff00';
  89
  90 # Port numbers are currently hard-wired
  91
  92 my $parm_port_n = 1223;         # Nothing listening on this port
  93 my $parm_port_s = 1224;         # Used for the "server" command
  94 my $parm_port_d = 1225;         # Used for the Exim daemon
  95 my $parm_port_d2 = 1226;        # Additional for daemon
  96 my $parm_port_d3 = 1227;        # Additional for daemon
  97 my $parm_port_d4 = 1228;        # Additional for daemon
  98 my $dynamic_socket;          # allocated later for PORT_DYNAMIC
  99
 100 # Find a suiteable group name for test (currently only 0001
 101 # uses a group name. A numeric group id would do
 102 my $parm_mailgroup = Exim::Runtest::mailgroup('mail');
 103
 104 # Manually set locale
 105 $ENV{LC_ALL} = 'C';
 106
 107 # In some environments USER does not exist, but we need it for some test(s)
 108 $ENV{USER} = getpwuid($>) if not exists $ENV{USER};
 109
 110 my ($parm_configure_owner, $parm_configure_group);
 111 my ($parm_ipv4, $parm_ipv6);
 112 my $parm_hostname;
 113
 114 ###############################################################################
 115 ###############################################################################
 116
 117 # Define a number of subroutines
 118
 119 ###############################################################################
 120 ###############################################################################
 121
 122
 123 ##################################################
 124 #              Handle signals                    #
 125 ##################################################
 126
 127 sub pipehandler { $sigpipehappened = 1; }
 128
 129 sub inthandler { print "\n"; tests_exit(-1, "Caught SIGINT"); }
 130
 131
 132 ##################################################
 133 #       Do global macro substitutions            #
 134 ##################################################
 135
 136 # This function is applied to configurations, command lines and data lines in
 137 # scripts, and to lines in the files of the aux-var-src and the dnszones-src
 138 # directory. It takes one argument: the current test number, or zero when
 139 # setting up files before running any tests.
 140
 141 sub do_substitute{
 142 s?\bCALLER\b?$parm_caller?g;
 143 s?\bCALLERGROUP\b?$parm_caller_group?g;
 144 s?\bCALLER_UID\b?$parm_caller_uid?g;
 145 s?\bCALLER_GID\b?$parm_caller_gid?g;
 146 s?\bCLAMSOCKET\b?$parm_clamsocket?g;
 147 s?\bDIR/?$parm_cwd/?g;
 148 s?\bEXIMGROUP\b?$parm_eximgroup?g;
 149 s?\bEXIMUSER\b?$parm_eximuser?g;
 150 s?\bHOSTIPV4\b?$parm_ipv4?g;
 151 s?\bHOSTIPV6\b?$parm_ipv6?g;
 152 s?\bHOSTNAME\b?$parm_hostname?g;
 153 s?\bPORT_D\b?$parm_port_d?g;
 154 s?\bPORT_D2\b?$parm_port_d2?g;
 155 s?\bPORT_D3\b?$parm_port_d3?g;
 156 s?\bPORT_D4\b?$parm_port_d4?g;
 157 s?\bPORT_N\b?$parm_port_n?g;
 158 s?\bPORT_S\b?$parm_port_s?g;
 159 s?\bTESTNUM\b?$_[0]?g;
 160 s?(\b|_)V4NET([\._])?$1$parm_ipv4_test_net$2?g;
 161 s?\bV6NET:?$parm_ipv6_test_net:?g;
 162 s?\bPORT_DYNAMIC\b?$dynamic_socket->sockport()?eg;
 163 s?\bMAILGROUP\b?$parm_mailgroup?g;
 164 }
 165
 166
 167 ##################################################
 168 #     Any state to be preserved across tests     #
 169 ##################################################
 170
 171 my $TEST_STATE = {};
 172
 173
 174 ##################################################
 175 #        Subroutine to tidy up and exit          #
 176 ##################################################
 177
 178 # In all cases, we check for any Exim daemons that have been left running, and
 179 # kill them. Then remove all the spool data, test output, and the modified Exim
 180 # binary if we are ending normally.
 181
 182 # Arguments:
 183 #    $_[0] = 0 for a normal exit; full cleanup done
 184 #    $_[0] > 0 for an error exit; no files cleaned up
 185 #    $_[0] < 0 for a "die" exit; $_[1] contains a message
 186
 187 sub tests_exit{
 188 my($rc) = $_[0];
 189 my($spool);
 190
 191 # Search for daemon pid files and kill the daemons. We kill with SIGINT rather
 192 # than SIGTERM to stop it outputting "Terminated" to the terminal when not in
 193 # the background.
 194
 195 if (exists $TEST_STATE->{exim_pid})
 196   {
 197   $pid = $TEST_STATE->{exim_pid};
 198   print "Tidyup: killing wait-mode daemon pid=$pid\n";
 199   system("sudo kill -INT $pid");
 200   }
 201
 202 if (opendir(DIR, "spool"))
 203   {
 204   my(@spools) = sort readdir(DIR);
 205   closedir(DIR);
 206   foreach $spool (@spools)
 207     {
 208     next if $spool !~ /^exim-daemon./;
 209     open(PID, "spool/$spool") || die "** Failed to open \"spool/$spool\": $!\n";
 210     chomp($pid = <PID>);
 211     close(PID);
 212     print "Tidyup: killing daemon pid=$pid\n";
 213     system("sudo rm -f spool/$spool; sudo kill -INT $pid");
 214     }
 215   }
 216 else
 217   { die "** Failed to opendir(\"spool\"): $!\n" unless $!{ENOENT}; }
 218
 219 # Close the terminal input and remove the test files if all went well, unless
 220 # the option to save them is set. Always remove the patched Exim binary. Then
 221 # exit normally, or die.
 222
 223 close(T);
 224 system("sudo /bin/rm -rf ./spool test-* ./dnszones/*")
 225   if ($rc == 0 && !$save_output);
 226
 227 system("sudo /bin/rm -rf ./eximdir/*")
 228   if (!$save_output);
 229
 230 print "\nYou were in test $test at the end there.\n\n" if defined $test;
 231 exit $rc if ($rc >= 0);
 232 die "** runtest error: $_[1]\n";
 233 }
 234
 235
 236
 237 ##################################################
 238 #   Subroutines used by the munging subroutine   #
 239 ##################################################
 240
 241 # This function is used for things like message ids, where we want to generate
 242 # more than one value, but keep a consistent mapping throughout.
 243 #
 244 # Arguments:
 245 #   $oldid        the value from the file
 246 #   $base         a base string into which we insert a sequence
 247 #   $sequence     the address of the current sequence counter
 248
 249 sub new_value {
 250 my($oldid, $base, $sequence) = @_;
 251 my($newid) = $cache{$oldid};
 252 if (! defined $newid)
 253   {
 254   $newid = sprintf($base, $$sequence++);
 255   $cache{$oldid} = $newid;
 256   }
 257 return $newid;
 258 }
 259
 260
 261 # This is used while munging the output from exim_dumpdb.
 262 # May go wrong across DST changes.
 263
 264 sub date_seconds {
 265 my($day,$month,$year,$hour,$min,$sec) =
 266   $_[0] =~ /^(\d\d)-(\w\w\w)-(\d{4})\s(\d\d):(\d\d):(\d\d)/;
 267 my($mon);
 268 if   ($month =~ /Jan/) {$mon = 0;}
 269 elsif($month =~ /Feb/) {$mon = 1;}
 270 elsif($month =~ /Mar/) {$mon = 2;}
 271 elsif($month =~ /Apr/) {$mon = 3;}
 272 elsif($month =~ /May/) {$mon = 4;}
 273 elsif($month =~ /Jun/) {$mon = 5;}
 274 elsif($month =~ /Jul/) {$mon = 6;}
 275 elsif($month =~ /Aug/) {$mon = 7;}
 276 elsif($month =~ /Sep/) {$mon = 8;}
 277 elsif($month =~ /Oct/) {$mon = 9;}
 278 elsif($month =~ /Nov/) {$mon = 10;}
 279 elsif($month =~ /Dec/) {$mon = 11;}
 280 return timelocal($sec,$min,$hour,$day,$mon,$year);
 281 }
 282
 283
 284 # This is a subroutine to sort maildir files into time-order. The second field
 285 # is the microsecond field, and may vary in length, so must be compared
 286 # numerically.
 287
 288 sub maildirsort {
 289 return $a cmp $b if ($a !~ /^\d+\.H\d/ || $b !~ /^\d+\.H\d/);
 290 my($x1,$y1) = $a =~ /^(\d+)\.H(\d+)/;
 291 my($x2,$y2) = $b =~ /^(\d+)\.H(\d+)/;
 292 return ($x1 != $x2)? ($x1 <=> $x2) : ($y1 <=> $y2);
 293 }
 294
 295
 296
 297 ##################################################
 298 #   Subroutine list files below a directory      #
 299 ##################################################
 300
 301 # This is used to build up a list of expected mail files below a certain path
 302 # in the directory tree. It has to be recursive in order to deal with multiple
 303 # maildir mailboxes.
 304
 305 sub list_files_below {
 306 my($dir) = $_[0];
 307 my(@yield) = ();
 308 my(@sublist, $file);
 309
 310 opendir(DIR, $dir) || tests_exit(-1, "Failed to open $dir: $!");
 311 @sublist = sort maildirsort readdir(DIR);
 312 closedir(DIR);
 313
 314 foreach $file (@sublist)
 315   {
 316   next if $file eq "." || $file eq ".." || $file eq "CVS";
 317   if (-d "$dir/$file")
 318     { @yield = (@yield, list_files_below("$dir/$file")); }
 319   else
 320     { push @yield, "$dir/$file"; }
 321   }
 322
 323 return @yield;
 324 }
 325
 326
 327
 328 ##################################################
 329 #         Munge a file before comparing          #
 330 ##################################################
 331
 332 # The pre-processing turns all dates, times, Exim versions, message ids, and so
 333 # on into standard values, so that the compare works. Perl's substitution with
 334 # an expression provides a neat way to do some of these changes.
 335
 336 # We keep a global associative array for repeatedly turning the same values
 337 # into the same standard values throughout the data from a single test.
 338 # Message ids get this treatment (can't be made reliable for times), and
 339 # times in dumped retry databases are also handled in a special way, as are
 340 # incoming port numbers.
 341
 342 # On entry to the subroutine, the file to write to is already opened with the
 343 # name MUNGED. The input file name is the only argument to the subroutine.
 344 # Certain actions are taken only when the name contains "stderr", "stdout",
 345 # or "log". The yield of the function is 1 if a line matching "*** truncated
 346 # ***" is encountered; otherwise it is 0.
 347
 348 sub munge {
 349 my($file) = $_[0];
 350 my($extra) = $_[1];
 351 my($yield) = 0;
 352 my(@saved) = ();
 353
 354 local $_;
 355
 356 open(IN, "$file") || tests_exit(-1, "Failed to open $file: $!");
 357
 358 my($is_log) = $file =~ /log/;
 359 my($is_stdout) = $file =~ /stdout/;
 360 my($is_stderr) = $file =~ /stderr/;
 361 my($is_mail) = $file =~ /mail/;
 362
 363 # Date pattern
 364
 365 $date = "\\d{2}-\\w{3}-\\d{4}\\s\\d{2}:\\d{2}:\\d{2}";
 366
 367 # Pattern for matching pids at start of stderr lines; initially something
 368 # that won't match.
 369
 370 $spid = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
 371
 372 # Scan the file and make the changes. Near the bottom there are some changes
 373 # that are specific to certain file types, though there are also some of those
 374 # inline too.
 375
 376 LINE: while(<IN>)
 377   {
 378 RESET_AFTER_EXTRA_LINE_READ:
 379   # Custom munges
 380   if ($extra)
 381     {
 382     next if $extra =~ m%^/%  &&  eval $extra;
 383     eval $extra if $extra =~ m/^s/;
 384     }
 385
 386   # Check for "*** truncated ***"
 387   $yield = 1 if /\*\*\* truncated \*\*\*/;
 388
 389   # Replace the name of this host
 390   s/\Q$parm_hostname\E/the.local.host.name/g;
 391
 392   # But convert "name=the.local.host address=127.0.0.1" to use "localhost"
 393   s/name=the\.local\.host address=127\.0\.0\.1/name=localhost address=127.0.0.1/g;
 394
 395   # The name of the shell may vary
 396   s/\s\Q$parm_shell\E\b/ ENV_SHELL/;
 397
 398   # Replace the path to the testsuite directory
 399   s?\Q$parm_cwd\E?TESTSUITE?g;
 400
 401   # Replace the Exim version number (may appear in various places)
 402   # patchexim should have fixed this for us
 403   #s/(Exim) \d+\.\d+[\w_-]*/$1 x.yz/i;
 404
 405   # Replace Exim message ids by a unique series
 406   s/((?:[^\W_]{6}-){2}[^\W_]{2})
 407     /new_value($1, "10Hm%s-0005vi-00", \$next_msgid)/egx;
 408
 409   # The names of lock files appear in some error and debug messages
 410   s/\.lock(\.[-\w]+)+(\.[\da-f]+){2}/.lock.test.ex.dddddddd.pppppppp/;
 411
 412   # Unless we are in an IPv6 test, replace IPv4 and/or IPv6 in "listening on
 413   # port" message, because it is not always the same.
 414   s/port (\d+) \([^)]+\)/port $1/g
 415     if !$is_ipv6test && m/listening for SMTP(S?) on port/;
 416
 417   # Challenges in SPA authentication
 418   s/TlRMTVNTUAACAAAAAAAAAAAoAAABgg[\w+\/]+/TlRMTVNTUAACAAAAAAAAAAAoAAABggAAAEbBRwqFwwIAAAAAAAAAAAAt1sgAAAAA/;
 419
 420   # PRVS values
 421   s?prvs=([^/]+)/[\da-f]{10}@?prvs=$1/xxxxxxxxxx@?g;    # Old form
 422   s?prvs=[\da-f]{10}=([^@]+)@?prvs=xxxxxxxxxx=$1@?g;    # New form
 423
 424   # There are differences in error messages between OpenSSL versions
 425   s/SSL_CTX_set_cipher_list/SSL_connect/;
 426
 427   # One error test in expansions mentions base 62 or 36
 428   s/is not a base (36|62) number/is not a base 36\/62 number/;
 429
 430   # This message sometimes has a different number of seconds
 431   s/forced fail after \d seconds/forced fail after d seconds/;
 432
 433   # This message may contain a different DBM library name
 434   s/Failed to open \S+( \([^\)]+\))? file/Failed to open DBM file/;
 435
 436   # The message for a non-listening FIFO varies
 437   s/:[^:]+: while opening named pipe/: Error: while opening named pipe/;
 438
 439   # Debugging output of lists of hosts may have different sort keys
 440   s/sort=\S+/sort=xx/ if /^\S+ (?:\d+\.){3}\d+ mx=\S+ sort=\S+/;
 441
 442   # Random local part in callout cache testing
 443   s/myhost.test.ex-\d+-testing/myhost.test.ex-dddddddd-testing/;
 444   s/the.local.host.name-\d+-testing/the.local.host.name-dddddddd-testing/;
 445
 446   # File descriptor numbers may vary
 447   s/^writing data block fd=\d+/writing data block fd=dddd/;
 448   s/(running as transport filter:) fd_write=\d+ fd_read=\d+/$1 fd_write=dddd fd_read=dddd/;
 449
 450
 451   # ======== Dumpdb output ========
 452   # This must be before the general date/date munging.
 453   # Time data lines, which look like this:
 454   # 25-Aug-2000 12:11:37  25-Aug-2000 12:11:37  26-Aug-2000 12:11:37
 455   if (/^($date)\s+($date)\s+($date)(\s+\*)?\s*$/)
 456     {
 457     my($date1,$date2,$date3,$expired) = ($1,$2,$3,$4);
 458     $expired = '' if !defined $expired;
 459     my($increment) = date_seconds($date3) - date_seconds($date2);
 460
 461     # We used to use globally unique replacement values, but timing
 462     # differences make this impossible. Just show the increment on the
 463     # last one.
 464
 465     printf MUNGED ("first failed = time last try = time2 next try = time2 + %s%s\n",
 466       $increment, $expired);
 467     next;
 468     }
 469
 470   # more_errno values in exim_dumpdb output which are times
 471   s/T:(\S+)\s-22\s(\S+)\s/T:$1 -22 xxxx /;
 472
 473
 474   # ======== Dates and times ========
 475
 476   # Dates and times are all turned into the same value - trying to turn
 477   # them into different ones cannot be done repeatedly because they are
 478   # real time stamps generated while running the test. The actual date and
 479   # time used was fixed when I first started running automatic Exim tests.
 480
 481   # Date/time in header lines and SMTP responses
 482   s/[A-Z][a-z]{2},\s\d\d?\s[A-Z][a-z]{2}\s\d\d\d\d\s\d\d\:\d\d:\d\d\s[-+]\d{4}
 483     /Tue, 2 Mar 1999 09:44:33 +0000/gx;
 484
 485   # Date/time in logs and in one instance of a filter test
 486   s/^\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d(\s[+-]\d\d\d\d)?/1999-03-02 09:44:33/gx;
 487   s/^Logwrite\s"\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d/Logwrite "1999-03-02 09:44:33/gx;
 488
 489   # Date/time in message separators
 490   s/(?:[A-Z][a-z]{2}\s){2}\d\d\s\d\d:\d\d:\d\d\s\d\d\d\d
 491     /Tue Mar 02 09:44:33 1999/gx;
 492
 493   # Date of message arrival in spool file as shown by -Mvh
 494   s/^\d{9,10}\s0$/ddddddddd 0/;
 495
 496   # Date/time in mbx mailbox files
 497   s/\d\d-\w\w\w-\d\d\d\d\s\d\d:\d\d:\d\d\s[-+]\d\d\d\d,/06-Sep-1999 15:52:48 +0100,/gx;
 498
 499   # Dates/times in debugging output for writing retry records
 500   if (/^  first failed=(\d+) last try=(\d+) next try=(\d+) (.*)$/)
 501     {
 502     my($next) = $3 - $2;
 503     $_ = "  first failed=dddd last try=dddd next try=+$next $4\n";
 504     }
 505   s/^(\s*)now=\d+ first_failed=\d+ next_try=\d+ expired=(\d)/$1now=tttt first_failed=tttt next_try=tttt expired=$2/;
 506   s/^(\s*)received_time=\d+ diff=\d+ timeout=(\d+)/$1received_time=tttt diff=tttt timeout=$2/;
 507
 508   # Time to retry may vary
 509   s/time to retry = \S+/time to retry = tttt/;
 510   s/retry record exists: age=\S+/retry record exists: age=ttt/;
 511   s/failing_interval=\S+ message_age=\S+/failing_interval=ttt message_age=ttt/;
 512
 513   # Date/time in exim -bV output
 514   s/\d\d-[A-Z][a-z]{2}-\d{4}\s\d\d:\d\d:\d\d/07-Mar-2000 12:21:52/g;
 515
 516   # Time on queue tolerance
 517   s/(QT|D)=1s/$1=0s/;
 518
 519   # Eximstats heading
 520   s/Exim\sstatistics\sfrom\s\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d\sto\s
 521     \d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d/Exim statistics from <time> to <time>/x;
 522
 523   # Treat ECONNRESET the same as ECONNREFUSED.  At least some systems give
 524   # us the former on a new connection.
 525   s/(could not connect to .*: Connection) reset by peer$/$1 refused/;
 526
 527   # ======== TLS certificate algorithms ========
 528   # Test machines might have various different TLS library versions supporting
 529   # different protocols; can't rely upon TLS 1.2's AES256-GCM-SHA384, so we
 530   # treat the standard algorithms the same.
 531   # So far, have seen:
 532   #   TLSv1:AES128-GCM-SHA256:128
 533   #   TLSv1:AES256-SHA:256
 534   #   TLSv1.1:AES256-SHA:256
 535   #   TLSv1.2:AES256-GCM-SHA384:256
 536   #   TLSv1.2:DHE-RSA-AES256-SHA:256
 537   #   TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128
 538   # We also need to handle the ciphersuite without the TLS part present, for
 539   # client-ssl's output.  We also see some older forced ciphersuites, but
 540   # negotiating TLS 1.2 instead of 1.0.
 541   # Mail headers (...), log-lines X=..., client-ssl output ...
 542   # (and \b doesn't match between ' ' and '(' )
 543
 544   s/( (?: (?:\b|\s) [\(=] ) | \s )TLSv1\.[12]:/$1TLSv1:/xg;
 545   s/\bAES128-GCM-SHA256:128\b/AES256-SHA:256/g;
 546   s/\bAES128-GCM-SHA256\b/AES256-SHA/g;
 547   s/\bAES256-GCM-SHA384\b/AES256-SHA/g;
 548   s/\bDHE-RSA-AES256-SHA\b/AES256-SHA/g;
 549
 550   # LibreSSL
 551   # TLSv1:ECDHE-RSA-CHACHA20-POLY1305:256
 552   s/\bECDHE-RSA-CHACHA20-POLY1305\b/AES256-SHA/g;
 553
 554   # GnuTLS have seen:
 555   #   TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256
 556   #   TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128
 557   #   TLS1.2:RSA_AES_256_CBC_SHA1:256 (canonical)
 558   #   TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128
 559   #
 560   #   X=TLS1.2:DHE_RSA_AES_256_CBC_SHA256:256
 561   #   X=TLS1.2:RSA_AES_256_CBC_SHA1:256
 562   #   X=TLS1.1:RSA_AES_256_CBC_SHA1:256
 563   #   X=TLS1.0:DHE_RSA_AES_256_CBC_SHA1:256
 564   # and as stand-alone cipher:
 565   #   ECDHE-RSA-AES256-SHA
 566   #   DHE-RSA-AES256-SHA256
 567   #   DHE-RSA-AES256-SHA
 568   # picking latter as canonical simply because regex easier that way.
 569   s/\bDHE_RSA_AES_128_CBC_SHA1:128/RSA_AES_256_CBC_SHA1:256/g;
 570   s/TLS1.[012]:((EC)?DHE_)?RSA_AES_(256|128)_(CBC|GCM)_SHA(1|256|384):(256|128)/TLS1.x:xxxxRSA_AES_256_CBC_SHAnnn:256/g;
 571   s/\b(ECDHE-RSA-AES256-SHA|DHE-RSA-AES256-SHA256)\b/AES256-SHA/g;
 572
 573   # GnuTLS library error message changes
 574   s/No certificate was found/The peer did not send any certificate/g;
 575 #(dodgy test?)  s/\(certificate verification failed\): invalid/\(gnutls_handshake\): The peer did not send any certificate./g;
 576   s/\(gnutls_priority_set\): No or insufficient priorities were set/\(gnutls_handshake\): Could not negotiate a supported cipher suite/g;
 577
 578   # (this new one is a generic channel-read error, but the testsuite
 579   # only hits it in one place)
 580   s/TLS error on connection \(gnutls_handshake\): Error in the pull function\./a TLS session is required but an attempt to start TLS failed/g;
 581
 582   # (replace old with new, hoping that old only happens in one situation)
 583   s/TLS error on connection to \d{1,3}(.\d{1,3}){3} \[\d{1,3}(.\d{1,3}){3}\] \(gnutls_handshake\): A TLS packet with unexpected length was received./a TLS session is required for ip4.ip4.ip4.ip4 [ip4.ip4.ip4.ip4], but an attempt to start TLS failed/g;
 584   s/TLS error on connection from \[127.0.0.1\] \(recv\): A TLS packet with unexpected length was received./TLS error on connection from [127.0.0.1] (recv): The TLS connection was non-properly terminated./g;
 585
 586   # signature algorithm names
 587   s/RSA-SHA1/RSA-SHA/;
 588
 589
 590   # ======== Caller's login, uid, gid, home, gecos ========
 591
 592   s/\Q$parm_caller_home\E/CALLER_HOME/g;   # NOTE: these must be done
 593   s/\b\Q$parm_caller\E\b/CALLER/g;         #       in this order!
 594   s/\b\Q$parm_caller_group\E\b/CALLER/g;   # In case group name different
 595
 596   s/\beuid=$parm_caller_uid\b/euid=CALLER_UID/g;
 597   s/\begid=$parm_caller_gid\b/egid=CALLER_GID/g;
 598
 599   s/\buid=$parm_caller_uid\b/uid=CALLER_UID/g;
 600   s/\bgid=$parm_caller_gid\b/gid=CALLER_GID/g;
 601
 602   s/\bname="?$parm_caller_gecos"?/name=CALLER_GECOS/g;
 603
 604   # When looking at spool files with -Mvh, we will find not only the caller
 605   # login, but also the uid and gid. It seems that $) in some Perls gives all
 606   # the auxiliary gids as well, so don't bother checking for that.
 607
 608   s/^CALLER $> \d+$/CALLER UID GID/;
 609
 610   # There is one case where the caller's login is forced to something else,
 611   # in order to test the processing of logins that contain spaces. Weird what
 612   # some people do, isn't it?
 613
 614   s/^spaced user $> \d+$/CALLER UID GID/;
 615
 616
 617   # ======== Exim's login ========
 618   # For messages received by the daemon, this is in the -H file, which some
 619   # tests inspect. For bounce messages, this will appear on the U= lines in
 620   # logs and also after Received: and in addresses. In one pipe test it appears
 621   # after "Running as:". It also appears in addresses, and in the names of lock
 622   # files.
 623
 624   s/U=$parm_eximuser/U=EXIMUSER/;
 625   s/user=$parm_eximuser/user=EXIMUSER/;
 626   s/login=$parm_eximuser/login=EXIMUSER/;
 627   s/Received: from $parm_eximuser /Received: from EXIMUSER /;
 628   s/Running as: $parm_eximuser/Running as: EXIMUSER/;
 629   s/\b$parm_eximuser@/EXIMUSER@/;
 630   s/\b$parm_eximuser\.lock\./EXIMUSER.lock./;
 631
 632   s/\beuid=$parm_exim_uid\b/euid=EXIM_UID/g;
 633   s/\begid=$parm_exim_gid\b/egid=EXIM_GID/g;
 634
 635   s/\buid=$parm_exim_uid\b/uid=EXIM_UID/g;
 636   s/\bgid=$parm_exim_gid\b/gid=EXIM_GID/g;
 637
 638   s/^$parm_eximuser $parm_exim_uid $parm_exim_gid/EXIMUSER EXIM_UID EXIM_GID/;
 639
 640
 641   # ======== General uids, gids, and pids ========
 642   # Note: this must come after munges for caller's and exim's uid/gid
 643
 644   # These are for systems where long int is 64
 645   s/\buid=4294967295/uid=-1/;
 646   s/\beuid=4294967295/euid=-1/;
 647   s/\bgid=4294967295/gid=-1/;
 648   s/\begid=4294967295/egid=-1/;
 649
 650   s/\bgid=\d+/gid=gggg/;
 651   s/\begid=\d+/egid=gggg/;
 652   s/\bpid=\d+/pid=pppp/;
 653   s/\buid=\d+/uid=uuuu/;
 654   s/\beuid=\d+/euid=uuuu/;
 655   s/set_process_info:\s+\d+/set_process_info: pppp/;
 656   s/queue run pid \d+/queue run pid ppppp/;
 657   s/process \d+ running as transport filter/process pppp running as transport filter/;
 658   s/process \d+ writing to transport filter/process pppp writing to transport filter/;
 659   s/reading pipe for subprocess \d+/reading pipe for subprocess pppp/;
 660   s/remote delivery process \d+ ended/remote delivery process pppp ended/;
 661
 662   # Pid in temp file in appendfile transport
 663   s"test-mail/temp\.\d+\."test-mail/temp.pppp.";
 664
 665   # Optional pid in log lines
 666   s/^(\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d)(\s[+-]\d\d\d\d|)(\s\[\d+\])/
 667     "$1$2 [" . new_value($3, "%s", \$next_pid) . "]"/gxe;
 668
 669   # Detect a daemon stderr line with a pid and save the pid for subsequent
 670   # removal from following lines.
 671   $spid = $1 if /^(\s*\d+) (?:listening|LOG: MAIN|(?:daemon_smtp_port|local_interfaces) overridden by)/;
 672   s/^$spid //;
 673
 674   # Queue runner waiting messages
 675   s/waiting for children of \d+/waiting for children of pppp/;
 676   s/waiting for (\S+) \(\d+\)/waiting for $1 (pppp)/;
 677
 678   # The spool header file name varies with PID
 679   s%^(Writing spool header file: .*/hdr).[0-9]{1,5}%$1.pppp%;
 680
 681   # ======== Port numbers ========
 682   # Incoming port numbers may vary, but not in daemon startup line.
 683
 684   s/^Port: (\d+)/"Port: " . new_value($1, "%s", \$next_port)/e;
 685   s/\(port=(\d+)/"(port=" . new_value($1, "%s", \$next_port)/e;
 686
 687   # This handles "connection from" and the like, when the port is given
 688   if (!/listening for SMTP on/ && !/Connecting to/ && !/=>/ && !/->/
 689       && !/\*>/ && !/Connection refused/)
 690     {
 691     s/\[([a-z\d:]+|\d+(?:\.\d+){3})\]:(\d+)/"[".$1."]:".new_value($2,"%s",\$next_port)/ie;
 692     }
 693
 694   # Port in host address in spool file output from -Mvh
 695   s/^-host_address (.*)\.\d+/-host_address $1.9999/;
 696
 697   if ($dynamic_socket and $dynamic_socket->opened and my $port = $dynamic_socket->sockport) {
 698     s/^Connecting to 127\.0\.0\.1 port \K$port/<dynamic port>/;
 699   }
 700
 701
 702   # ======== Local IP addresses ========
 703   # The amount of space between "host" and the address in verification output
 704   # depends on the length of the host name. We therefore reduce it to one space
 705   # for all of them.
 706   # Also, the length of space at the end of the host line is dependent
 707   # on the length of the longest line, so strip it also on otherwise
 708   # un-rewritten lines like localhost
 709
 710   s/^\s+host\s(\S+)\s+(\S+)/  host $1 $2/;
 711   s/^\s+(host\s\S+\s\S+)\s+(port=.*)/  host $1 $2/;
 712   s/^\s+(host\s\S+\s\S+)\s+(?=MX=)/  $1 /;
 713   s/host\s\Q$parm_ipv4\E\s\[\Q$parm_ipv4\E\]/host ipv4.ipv4.ipv4.ipv4 [ipv4.ipv4.ipv4.ipv4]/;
 714   s/host\s\Q$parm_ipv6\E\s\[\Q$parm_ipv6\E\]/host ip6:ip6:ip6:ip6:ip6:ip6:ip6:ip6 [ip6:ip6:ip6:ip6:ip6:ip6:ip6:ip6]/;
 715   s/\b\Q$parm_ipv4\E\b/ip4.ip4.ip4.ip4/g;
 716   s/(^|\W)\K\Q$parm_ipv6\E/ip6:ip6:ip6:ip6:ip6:ip6:ip6:ip6/g;
 717   s/\b\Q$parm_ipv4r\E\b/ip4-reverse/g;
 718   s/(^|\W)\K\Q$parm_ipv6r\E/ip6-reverse/g;
 719   s/^(\s+host\s\S+\s+\[\S+\]) +$/$1 /;
 720
 721
 722   # ======== Test network IP addresses ========
 723   s/(\b|_)\Q$parm_ipv4_test_net\E(?=\.\d+\.\d+\.\d+\b|_|\.rbl|\.in-addr|\.test\.again\.dns)/$1V4NET/g;
 724   s/\b\Q$parm_ipv6_test_net\E(?=:[\da-f]+:[\da-f]+:[\da-f]+)/V6NET/gi;
 725
 726
 727   # ======== IP error numbers and messages ========
 728   # These vary between operating systems
 729   s/Can't assign requested address/Network Error/;
 730   s/Cannot assign requested address/Network Error/;
 731   s/Operation timed out/Connection timed out/;
 732   s/Address family not supported by protocol family/Network Error/;
 733   s/Network is unreachable/Network Error/;
 734   s/Invalid argument/Network Error/;
 735
 736   s/\(\d+\): Network/(dd): Network/;
 737   s/\(\d+\): Connection refused/(dd): Connection refused/;
 738   s/\(\d+\): Connection timed out/(dd): Connection timed out/;
 739   s/\d+ 65 Connection refused/dd 65 Connection refused/;
 740   s/\d+ 321 Connection timed out/dd 321 Connection timed out/;
 741
 742
 743   # ======== Other error numbers ========
 744   s/errno=\d+/errno=dd/g;
 745
 746   # ======== System Error Messages ======
 747   # depending on the underlaying file system the error message seems to differ
 748   s/(?: is not a regular file)|(?: has too many links \(\d+\))/ not a regular file or too many links/;
 749
 750   # ======== Output from ls ========
 751   # Different operating systems use different spacing on long output
 752   #s/ +/ /g if /^[-rwd]{10} /;
 753   # (Bug 1226) SUSv3 allows a trailing printable char for modified access method control.
 754   # Handle only the Gnu and MacOS space, dot, plus and at-sign.  A full [[:graph:]]
 755   # unfortunately matches a non-ls linefull of dashes.
 756   # Allow the case where we've already picked out the file protection bits.
 757   if (s/^([-d](?:[-r][-w][-SsTtx]){3})[.+@]?( +|$)/$1$2/) {
 758     s/ +/ /g;
 759   }
 760
 761
 762   # ======== Message sizes =========
 763   # Message sizes vary, owing to different logins and host names that get
 764   # automatically inserted. I can't think of any way of even approximately
 765   # comparing these.
 766
 767   s/([\s,])S=\d+\b/$1S=sss/;
 768   s/:S\d+\b/:Ssss/;
 769   s/^(\s*\d+m\s+)\d+(\s+[a-z0-9-]{16} <)/$1sss$2/i if $is_stdout;
 770   s/\sSIZE=\d+\b/ SIZE=ssss/;
 771   s/\ssize=\d+\b/ size=sss/ if $is_stderr;
 772   s/old size = \d+\b/old size = sssss/;
 773   s/message size = \d+\b/message size = sss/;
 774   s/this message = \d+\b/this message = sss/;
 775   s/Size of headers = \d+/Size of headers = sss/;
 776   s/sum=(?!0)\d+/sum=dddd/;
 777   s/(?<=sum=dddd )count=\d+\b/count=dd/;
 778   s/(?<=sum=0 )count=\d+\b/count=dd/;
 779   s/,S is \d+\b/,S is ddddd/;
 780   s/\+0100,\d+;/+0100,ddd;/;
 781   s/\(\d+ bytes written\)/(ddd bytes written)/;
 782   s/added '\d+ 1'/added 'ddd 1'/;
 783   s/Received\s+\d+/Received               nnn/;
 784   s/Delivered\s+\d+/Delivered              nnn/;
 785
 786
 787   # ======== Values in spool space failure message ========
 788   s/space=\d+ inodes=[+-]?\d+/space=xxxxx inodes=xxxxx/;
 789
 790
 791   # ======== Filter sizes ========
 792   # The sizes of filter files may vary because of the substitution of local
 793   # filenames, logins, etc.
 794
 795   s/^\d+(?= bytes read from )/ssss/;
 796
 797
 798   # ======== OpenSSL error messages ========
 799   # Different releases of the OpenSSL libraries seem to give different error
 800   # numbers, or handle specific bad conditions in different ways, leading to
 801   # different wording in the error messages, so we cannot compare them.
 802
 803   s/(TLS error on connection (?:from .* )?\(SSL_\w+\): error:)(.*)/$1 <<detail omitted>>/;
 804   next if /SSL verify error: depth=0 error=certificate not trusted/;
 805
 806   # ======== Maildir things ========
 807   # timestamp output in maildir processing
 808   s/(timestamp=|\(timestamp_only\): )\d+/$1ddddddd/g;
 809
 810   # maildir delivery files appearing in log lines (in cases of error)
 811   s/writing to(?: file)? tmp\/\d+\.[^.]+\.(\S+)/writing to tmp\/MAILDIR.$1/;
 812
 813   s/renamed tmp\/\d+\.[^.]+\.(\S+) as new\/\d+\.[^.]+\.(\S+)/renamed tmp\/MAILDIR.$1 as new\/MAILDIR.$1/;
 814
 815   # Maildir file names in general
 816   s/\b\d+\.H\d+P\d+\b/dddddddddd.HddddddPddddd/;
 817
 818   # Maildirsize data
 819   while (/^\d+S,\d+C\s*$/)
 820     {
 821     print MUNGED;
 822     while (<IN>)
 823       {
 824       last if !/^\d+ \d+\s*$/;
 825       print MUNGED "ddd d\n";
 826       }
 827     last if !defined $_;
 828     }
 829   last if !defined $_;
 830
 831
 832   # ======== Output from the "fd" program about open descriptors ========
 833   # The statuses seem to be different on different operating systems, but
 834   # at least we'll still be checking the number of open fd's.
 835
 836   s/max fd = \d+/max fd = dddd/;
 837   s/status=0 RDONLY/STATUS/g;
 838   s/status=1 WRONLY/STATUS/g;
 839   s/status=2 RDWR/STATUS/g;
 840
 841
 842   # ======== Contents of spool files ========
 843   # A couple of tests dump the contents of the -H file. The length fields
 844   # will be wrong because of different user names, etc.
 845   s/^\d\d\d(?=[PFS*])/ddd/;
 846
 847
 848   # ========= Exim lookups ==================
 849   # Lookups have a char which depends on the number of lookup types compiled in,
 850   # in stderr output.  Replace with a "0".  Recognising this while avoiding
 851   # other output is fragile; perhaps the debug output should be revised instead.
 852   s%(?<!sqlite)(?<!lsearch\*@)(?<!lsearch\*)(?<!lsearch)[0-?]TESTSUITE/aux-fixed/%0TESTSUITE/aux-fixed/%g;
 853
 854   # ==========================================================
 855   # MIME boundaries in RFC3461 DSN messages
 856   s/\d{8,10}-eximdsn-\d+/NNNNNNNNNN-eximdsn-MMMMMMMMMM/;
 857
 858   # ==========================================================
 859   # Some munging is specific to the specific file types
 860
 861   # ======== stdout ========
 862
 863   if ($is_stdout)
 864     {
 865     # Skip translate_ip_address and use_classresources in -bP output because
 866     # they aren't always there.
 867
 868     next if /translate_ip_address =/;
 869     next if /use_classresources/;
 870
 871     # In certain filter tests, remove initial filter lines because they just
 872     # clog up by repetition.
 873
 874     if ($rmfiltertest)
 875       {
 876       next if /^(Sender\staken\sfrom|
 877                  Return-path\scopied\sfrom|
 878                  Sender\s+=|
 879                  Recipient\s+=)/x;
 880       if (/^Testing \S+ filter/)
 881         {
 882         $_ = <IN>;    # remove blank line
 883         next;
 884         }
 885       }
 886
 887     # remote IPv6 addrs vary
 888     s/^(Connection request from) \[.*:.*:.*\]$/$1 \[ipv6\]/;
 889
 890     # openssl version variances
 891   # Error lines on stdout from SSL contain process id values and file names.
 892   # They also contain a source file name and line number, which may vary from
 893   # release to release.
 894
 895     next if /^SSL info:/;
 896     next if /SSL verify error: depth=0 error=certificate not trusted/;
 897     s/SSL3_READ_BYTES/ssl3_read_bytes/i;
 898     s/^\d+:error:\d+(:SSL routines:ssl3_read_bytes:[^:]+:).*(:SSL alert number \d\d)$/pppp:error:dddddddd$1\[...\]$2/;
 899
 900     # gnutls version variances
 901     next if /^Error in the pull function./;
 902
 903     # optional IDN2 variant conversions.  Accept either IDN1 or IDN2
 904     s/conversion  strasse.de/conversion  xn--strae-oqa.de/;
 905     s/conversion: german.xn--strae-oqa.de/conversion: german.straße.de/;
 906     }
 907
 908   # ======== stderr ========
 909
 910   elsif ($is_stderr)
 911     {
 912     # The very first line of debugging output will vary
 913
 914     s/^Exim version .*/Exim version x.yz ..../;
 915
 916     # Debugging lines for Exim terminations
 917
 918     s/(?<=^>>>>>>>>>>>>>>>> Exim pid=)\d+(?= terminating)/pppp/;
 919
 920     # IP address lookups use gethostbyname() when IPv6 is not supported,
 921     # and gethostbyname2() or getipnodebyname() when it is.
 922
 923     s/\b(gethostbyname2?|\bgetipnodebyname)(\(af=inet\))?/get[host|ipnode]byname[2]/;
 924
 925     # drop gnutls version strings
 926     next if /GnuTLS compile-time version: \d+[\.\d]+$/;
 927     next if /GnuTLS runtime version: \d+[\.\d]+$/;
 928
 929     # drop openssl version strings
 930     next if /OpenSSL compile-time version: OpenSSL \d+[\.\da-z]+/;
 931     next if /OpenSSL runtime version: OpenSSL \d+[\.\da-z]+/;
 932
 933     # drop lookups
 934     next if /^Lookups \(built-in\):/;
 935     next if /^Loading lookup modules from/;
 936     next if /^Loaded \d+ lookup modules/;
 937     next if /^Total \d+ lookups/;
 938
 939     # drop compiler information
 940     next if /^Compiler:/;
 941
 942     # and the ugly bit
 943     # different libraries will have different numbers (possibly 0) of follow-up
 944     # lines, indenting with more data
 945     if (/^Library version:/) {
 946       while (1) {
 947         $_ = <IN>;
 948         next if /^\s/;
 949         goto RESET_AFTER_EXTRA_LINE_READ;
 950       }
 951     }
 952
 953     # drop other build-time controls emitted for debugging
 954     next if /^WHITELIST_D_MACROS:/;
 955     next if /^TRUSTED_CONFIG_LIST:/;
 956
 957     # As of Exim 4.74, we log when a setgid fails; because we invoke Exim
 958     # with -be, privileges will have been dropped, so this will always
 959     # be the case
 960     next if /^changing group to \d+ failed: (Operation not permitted|Not owner)/;
 961
 962     # We might not keep this check; rather than change all the tests, just
 963     # ignore it as long as it succeeds; then we only need to change the
 964     # TLS tests where tls_require_ciphers has been set.
 965     if (m{^changed uid/gid: calling tls_validate_require_cipher}) {
 966       my $discard = <IN>;
 967       next;
 968     }
 969     next if /^tls_validate_require_cipher child \d+ ended: status=0x0/;
 970
 971     # We invoke Exim with -D, so we hit this new message as of Exim 4.73:
 972     next if /^macros_trusted overridden to true by whitelisting/;
 973
 974     # We have to omit the localhost ::1 address so that all is well in
 975     # the IPv4-only case.
 976
 977     print MUNGED "MUNGED: ::1 will be omitted in what follows\n"
 978       if (/looked up these IP addresses/);
 979     next if /name=localhost address=::1/;
 980
 981     # drop pdkim debugging header
 982     next if /^PDKIM <<<<<<<<<<<<<<<<<<<<<<<<<<<<<+$/;
 983
 984     # Various other IPv6 lines must be omitted too
 985
 986     next if /using host_fake_gethostbyname for \S+ \(IPv6\)/;
 987     next if /get\[host\|ipnode\]byname\[2\]\(af=inet6\)/;
 988     next if /DNS lookup of \S+ \(AAAA\) using fakens/;
 989     next if / in dns_ipv4_lookup?/;
 990
 991     if (/DNS lookup of \S+ \(AAAA\) gave NO_DATA/)
 992       {
 993       $_= <IN>;     # Gets "returning DNS_NODATA"
 994       next;
 995       }
 996
 997     # Skip tls_advertise_hosts and hosts_require_tls checks when the options
 998     # are unset, because tls ain't always there.
 999
1000     next if /in\s(?:tls_advertise_hosts\?|hosts_require_tls\?)
1001                 \sno\s\((option\sunset|end\sof\slist)\)/x;
1002
1003     # Skip auxiliary group lists because they will vary.
1004
1005     next if /auxiliary group list:/;
1006
1007     # Skip "extracted from gecos field" because the gecos field varies
1008
1009     next if /extracted from gecos field/;
1010
1011     # Skip "waiting for data on socket" and "read response data: size=" lines
1012     # because some systems pack more stuff into packets than others.
1013
1014     next if /waiting for data on socket/;
1015     next if /read response data: size=/;
1016
1017     # If Exim is compiled with readline support but it can't find the library
1018     # to load, there will be an extra debug line. Omit it.
1019
1020     next if /failed to load readline:/;
1021
1022     # Some DBM libraries seem to make DBM files on opening with O_RDWR without
1023     # O_CREAT; other's don't. In the latter case there is some debugging output
1024     # which is not present in the former. Skip the relevant lines (there are
1025     # two of them).
1026
1027     if (/TESTSUITE\/spool\/db\/\S+ appears not to exist: trying to create/)
1028       {
1029       $_ = <IN>;
1030       next;
1031       }
1032
1033     # Some tests turn on +expand debugging to check on expansions.
1034     # Unfortunately, the Received: expansion varies, depending on whether TLS
1035     # is compiled or not. So we must remove the relevant debugging if it is.
1036
1037     if (/^condition: def:tls_cipher/)
1038       {
1039       while (<IN>) { last if /^condition: def:sender_address/; }
1040       }
1041     elsif (/^expanding: Received: /)
1042       {
1043       while (<IN>) { last if !/^\s/; }
1044       }
1045
1046     # remote port numbers vary
1047     s/(Connection request from 127.0.0.1 port) \d{1,5}/$1 sssss/;
1048
1049     # Skip hosts_require_dane checks when the options
1050     # are unset, because dane ain't always there.
1051
1052     next if /in\shosts_require_dane\?\sno\s\(option\sunset\)/x;
1053
1054     # SUPPORT_PROXY
1055     next if /host in hosts_proxy\?/;
1056
1057     # Experimental_International
1058     next if / in smtputf8_advertise_hosts\? no \(option unset\)/;
1059
1060     # Environment cleaning
1061     next if /\w+ in keep_environment\? (yes|no)/;
1062
1063     # Sizes vary with test hostname
1064     s/^cmd buf flush \d+ bytes$/cmd buf flush ddd bytes/;
1065
1066     # Spool filesystem free space changes on different systems.
1067     s/^((?:spool|log) directory space =) -?\d+K (inodes =)\s*-?\d+/$1 nnnnnK $2 nnnnn/;
1068
1069     # Non-TLS builds have different expansions for received_header_text
1070     if (s/(with \$received_protocol)\}\} \$\{if def:tls_cipher \{\(\$tls_cipher\)\n$/$1/)
1071       {
1072       $_ .= <IN>;
1073       s/\s+\}\}(?=\(Exim )/\}\} /;
1074       }
1075     if (/^  condition: def:tls_cipher$/)
1076       {
1077       <IN>; <IN>; <IN>; <IN>; <IN>; <IN>;
1078       <IN>; <IN>; <IN>; <IN>; <IN>; next;
1079       }
1080
1081     # Not all platforms build with DKIM enabled
1082     next if /^PDKIM >> Body data for hash, canonicalized/;
1083
1084     #  Parts of DKIM-specific debug output depend on the time/date
1085     next if /^date:\w+,\{SP\}/;
1086     next if /^PDKIM \[[^[]+\] (Header hash|b) computed:/;
1087
1088     # Not all platforms support TCP Fast Open, and the compile omits the check
1089     if (s/\S+ in hosts_try_fastopen\? no \(option unset\)\n$//)
1090       {
1091       $_ .= <IN>;
1092       s/ \.\.\. >>> / ... /;
1093       s/Address family not supported by protocol family/Network Error/;
1094       s/Network is unreachable/Network Error/;
1095       }
1096
1097     next if /^(ppppp )?setsockopt FASTOPEN: Protocol not available$/;
1098
1099     # Specific pointer values reported for DB operations change from run to run
1100     s/^(returned from EXIM_DBOPEN: 0x)[0-9a-f]+/$1AAAAAAAA/;
1101     s/^(EXIM_DBCLOSE.0x)[0-9a-f]+/$1AAAAAAAA/;
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 "-VALGRIND")   { $valgrind = 1; next; }
2555     if ($arg =~ /^-FLAVOU?R$/) { $flavour = shift; next; }
2556     }
2557   $optargs .= " $arg";
2558   }
2559
2560 # Any subsequent arguments are a range of test numbers.
2561
2562 if (@ARGV > 0)
2563   {
2564   $test_end = $test_start = $ARGV[0];
2565   $test_end = $ARGV[1] if (@ARGV > 1);
2566   $test_end = ($test_start >= 9000)? $test_special_top : $test_top
2567     if $test_end eq "+";
2568   die "** Test numbers out of order\n" if ($test_end < $test_start);
2569   }
2570
2571
2572 ##################################################
2573 #      Make the command's directory current      #
2574 ##################################################
2575
2576 # After doing so, we find its absolute path name.
2577
2578 $cwd = $0;
2579 $cwd = '.' if ($cwd !~ s|/[^/]+$||);
2580 chdir($cwd) || die "** Failed to chdir to \"$cwd\": $!\n";
2581 $parm_cwd = Cwd::getcwd();
2582
2583
2584 ##################################################
2585 #     Search for an Exim binary to test          #
2586 ##################################################
2587
2588 # If an Exim binary hasn't been provided, try to find one. We can handle the
2589 # case where exim-testsuite is installed alongside Exim source directories. For
2590 # PH's private convenience, if there's a directory just called "exim4", that
2591 # takes precedence; otherwise exim-snapshot takes precedence over any numbered
2592 # releases.
2593
2594 # If $parm_exim is still empty, ask the caller
2595
2596 if ($parm_exim eq '')
2597   {
2598   print "** Did not find an Exim binary to test\n";
2599   for ($i = 0; $i < 5; $i++)
2600     {
2601     my($trybin);
2602     print "** Enter pathname for Exim binary: ";
2603     chomp($trybin = <STDIN>);
2604     if (-e $trybin)
2605       {
2606       $parm_exim = $trybin;
2607       last;
2608       }
2609     else
2610       {
2611       print "** $trybin does not exist\n";
2612       }
2613     }
2614   die "** Too many tries\n" if $parm_exim eq '';
2615   }
2616
2617
2618
2619 ##################################################
2620 #          Find what is in the binary            #
2621 ##################################################
2622
2623 # deal with TRUSTED_CONFIG_LIST restrictions
2624 unlink("$parm_cwd/test-config") if -e "$parm_cwd/test-config";
2625 open (IN, "$parm_cwd/confs/0000") ||
2626   tests_exit(-1, "Couldn't open $parm_cwd/confs/0000: $!\n");
2627 open (OUT, ">test-config") ||
2628   tests_exit(-1, "Couldn't open test-config: $!\n");
2629 while (<IN>) { print OUT; }
2630 close(IN);
2631 close(OUT);
2632
2633 print("Probing with config file: $parm_cwd/test-config\n");
2634
2635 my $eximinfo = "$parm_exim -d -C $parm_cwd/test-config -DDIR=$parm_cwd -bP exim_user exim_group";
2636 chomp(my @eximinfo = `$eximinfo 2>&1`);
2637 die "$0: Can't run $eximinfo\n" if $? == -1;
2638
2639 warn 'Got ' . $?>>8 . " from $eximinfo\n" if $?;
2640 foreach (@eximinfo)
2641   {
2642   if (my ($version) = /^Exim version (\S+)/) {
2643     my $git = `git describe --dirty=-XX --match 'exim-4*'`;
2644     if (defined $git and $? == 0) {
2645       chomp $git;
2646       $version =~ s/^\d+\K\./_/;
2647       $git =~ s/^exim-//i;
2648       $git =~ s/.*-\Kg([[:xdigit:]]+(?:-XX)?)/$1/;
2649       print <<___
2650
2651 *** Version mismatch
2652 *** Exim binary: $version
2653 *** Git        : $git
2654
2655 ___
2656         if not $version eq $git;
2657     }
2658   }
2659   $parm_eximuser = $1 if /^exim_user = (.*)$/;
2660   $parm_eximgroup = $1 if /^exim_group = (.*)$/;
2661   $parm_trusted_config_list = $1 if /^TRUSTED_CONFIG_LIST:.*?"(.*?)"$/;
2662   ($parm_configure_owner, $parm_configure_group) = ($1, $2)
2663         if /^Configure owner:\s*(\d+):(\d+)/;
2664   print if /wrong owner/;
2665   }
2666
2667 if (not defined $parm_eximuser) {
2668   die <<XXX, map { "|$_\n" } @eximinfo;
2669 Unable to extract exim_user from binary.
2670 Check if Exim refused to run; if so, consider:
2671   TRUSTED_CONFIG_LIST ALT_CONFIG_PREFIX WHITELIST_D_MACROS
2672 If debug permission denied, are you in the exim group?
2673 Failing to get information from binary.
2674 Output from $eximinfo:
2675 XXX
2676
2677 }
2678
2679 if ($parm_eximuser =~ /^\d+$/) { $parm_exim_uid = $parm_eximuser; }
2680 else { $parm_exim_uid = getpwnam($parm_eximuser); }
2681
2682 if (defined $parm_eximgroup)
2683   {
2684   if ($parm_eximgroup =~ /^\d+$/) { $parm_exim_gid = $parm_eximgroup; }
2685     else { $parm_exim_gid = getgrnam($parm_eximgroup); }
2686   }
2687
2688 # check the permissions on the TRUSTED_CONFIG_LIST
2689 if (defined $parm_trusted_config_list)
2690   {
2691   die "TRUSTED_CONFIG_LIST: $parm_trusted_config_list: $!\n"
2692     if not -f $parm_trusted_config_list;
2693
2694   die "TRUSTED_CONFIG_LIST $parm_trusted_config_list must not be world writable!\n"
2695     if 02 & (stat _)[2];
2696
2697   die sprintf "TRUSTED_CONFIG_LIST: $parm_trusted_config_list %d is group writable, but not owned by group '%s' or '%s'.\n",
2698   (stat _)[1],
2699     scalar(getgrgid 0), scalar(getgrgid $>)
2700     if (020 & (stat _)[2]) and not ((stat _)[5] == $> or (stat _)[5] == 0);
2701
2702   die sprintf "TRUSTED_CONFIG_LIST: $parm_trusted_config_list is not owned by user '%s' or '%s'.\n",
2703   scalar(getpwuid 0), scalar(getpwuid $>)
2704      if (not (-o _ or (stat _)[4] == 0));
2705
2706   open(TCL, $parm_trusted_config_list) or die "Can't open $parm_trusted_config_list: $!\n";
2707   my $test_config = getcwd() . '/test-config';
2708   die "Can't find '$test_config' in TRUSTED_CONFIG_LIST $parm_trusted_config_list."
2709   if not grep { /^\Q$test_config\E$/ } <TCL>;
2710   }
2711 else
2712   {
2713   die "Unable to check the TRUSTED_CONFIG_LIST, seems to be empty?\n";
2714   }
2715
2716 die "CONFIGURE_OWNER ($parm_configure_owner) does not match the user invoking $0 ($>)\n"
2717         if $parm_configure_owner != $>;
2718
2719 die "CONFIGURE_GROUP ($parm_configure_group) does not match the group invoking $0 ($))\n"
2720         if 0020 & (stat "$parm_cwd/test-config")[2]
2721         and $parm_configure_group != $);
2722
2723
2724 open(EXIMINFO, "$parm_exim -d-all+transport -bV -C $parm_cwd/test-config -DDIR=$parm_cwd |") ||
2725   die "** Cannot run $parm_exim: $!\n";
2726
2727 print "-" x 78, "\n";
2728
2729 while (<EXIMINFO>)
2730   {
2731   my(@temp);
2732
2733   if (/^(Exim|Library) version/) { print; }
2734
2735   elsif (/^Size of off_t: (\d+)/)
2736     {
2737     print;
2738     $have_largefiles = 1 if $1 > 4;
2739     die "** Size of off_t > 32 which seems improbable, not running tests\n"
2740         if ($1 > 32);
2741     }
2742
2743   elsif (/^Support for: (.*)/)
2744     {
2745     print;
2746     @temp = split /(\s+)/, $1;
2747     push(@temp, ' ');
2748     %parm_support = @temp;
2749     }
2750
2751   elsif (/^Lookups \(built-in\): (.*)/)
2752     {
2753     print;
2754     @temp = split /(\s+)/, $1;
2755     push(@temp, ' ');
2756     %parm_lookups = @temp;
2757     }
2758
2759   elsif (/^Authenticators: (.*)/)
2760     {
2761     print;
2762     @temp = split /(\s+)/, $1;
2763     push(@temp, ' ');
2764     %parm_authenticators = @temp;
2765     }
2766
2767   elsif (/^Routers: (.*)/)
2768     {
2769     print;
2770     @temp = split /(\s+)/, $1;
2771     push(@temp, ' ');
2772     %parm_routers = @temp;
2773     }
2774
2775   # Some transports have options, e.g. appendfile/maildir. For those, ensure
2776   # that the basic transport name is set, and then the name with each of the
2777   # options.
2778
2779   elsif (/^Transports: (.*)/)
2780     {
2781     print;
2782     @temp = split /(\s+)/, $1;
2783     my($i,$k);
2784     push(@temp, ' ');
2785     %parm_transports = @temp;
2786     foreach $k (keys %parm_transports)
2787       {
2788       if ($k =~ "/")
2789         {
2790         @temp = split /\//, $k;
2791         $parm_transports{$temp[0]} = " ";
2792         for ($i = 1; $i < @temp; $i++)
2793           { $parm_transports{"$temp[0]/$temp[$i]"} = " "; }
2794         }
2795       }
2796     }
2797   }
2798 close(EXIMINFO);
2799 print "-" x 78, "\n";
2800
2801 unlink("$parm_cwd/test-config");
2802
2803 ##################################################
2804 #    Check for SpamAssassin and ClamAV           #
2805 ##################################################
2806
2807 # These are crude tests. If they aren't good enough, we'll have to improve
2808 # them, for example by actually passing a message through spamc or clamscan.
2809
2810 if (defined $parm_support{Content_Scanning})
2811   {
2812   my $sock = new FileHandle;
2813
2814   if (system("spamc -h 2>/dev/null >/dev/null") == 0)
2815     {
2816     print "The spamc command works:\n";
2817
2818     # This test for an active SpamAssassin is courtesy of John Jetmore.
2819     # The tests are hard coded to localhost:783, so no point in making
2820     # this test flexible like the clamav test until the test scripts are
2821     # changed.  spamd doesn't have the nice PING/PONG protocol that
2822     # clamd does, but it does respond to errors in an informative manner,
2823     # so use that.
2824
2825     my($sint,$sport) = ('127.0.0.1',783);
2826     eval
2827       {
2828       my $sin = sockaddr_in($sport, inet_aton($sint))
2829           or die "** Failed packing $sint:$sport\n";
2830       socket($sock, PF_INET, SOCK_STREAM, getprotobyname('tcp'))
2831           or die "** Unable to open socket $sint:$sport\n";
2832
2833       local $SIG{ALRM} =
2834           sub { die "** Timeout while connecting to socket $sint:$sport\n"; };
2835       alarm(5);
2836       connect($sock, $sin)
2837           or die "** Unable to connect to socket $sint:$sport\n";
2838       alarm(0);
2839
2840       select((select($sock), $| = 1)[0]);
2841       print $sock "bad command\r\n";
2842
2843       $SIG{ALRM} =
2844           sub { die "** Timeout while reading from socket $sint:$sport\n"; };
2845       alarm(10);
2846       my $res = <$sock>;
2847       alarm(0);
2848
2849       $res =~ m|^SPAMD/|
2850           or die "** Did not get SPAMD from socket $sint:$sport. "
2851                 ."It said: $res\n";
2852       };
2853     alarm(0);
2854     if($@)
2855       {
2856       print "  $@";
2857       print "  Assume SpamAssassin (spamd) is not running\n";
2858       }
2859     else
2860       {
2861       $parm_running{SpamAssassin} = ' ';
2862       print "  SpamAssassin (spamd) seems to be running\n";
2863       }
2864     }
2865   else
2866     {
2867     print "The spamc command failed: assume SpamAssassin (spamd) is not running\n";
2868     }
2869
2870   # For ClamAV, we need to find the clamd socket for use in the Exim
2871   # configuration. Search for the clamd configuration file.
2872
2873   if (system("clamscan -h 2>/dev/null >/dev/null") == 0)
2874     {
2875     my($f, $clamconf, $test_prefix);
2876
2877     print "The clamscan command works";
2878
2879     $test_prefix = $ENV{EXIM_TEST_PREFIX};
2880     $test_prefix = '' if !defined $test_prefix;
2881
2882     foreach $f ("$test_prefix/etc/clamd.conf",
2883                 "$test_prefix/usr/local/etc/clamd.conf",
2884                 "$test_prefix/etc/clamav/clamd.conf", '')
2885       {
2886       if (-e $f)
2887         {
2888         $clamconf = $f;
2889         last;
2890         }
2891       }
2892
2893     # Read the ClamAV configuration file and find the socket interface.
2894
2895     if ($clamconf ne '')
2896       {
2897       my $socket_domain;
2898       open(IN, "$clamconf") || die "\n** Unable to open $clamconf: $!\n";
2899       while (<IN>)
2900         {
2901         if (/^LocalSocket\s+(.*)/)
2902           {
2903           $parm_clamsocket = $1;
2904           $socket_domain = AF_UNIX;
2905           last;
2906           }
2907         if (/^TCPSocket\s+(\d+)/)
2908           {
2909           if (defined $parm_clamsocket)
2910             {
2911             $parm_clamsocket .= " $1";
2912             $socket_domain = AF_INET;
2913             last;
2914             }
2915           else
2916             {
2917             $parm_clamsocket = " $1";
2918             }
2919           }
2920         elsif (/^TCPAddr\s+(\S+)/)
2921           {
2922           if (defined $parm_clamsocket)
2923             {
2924             $parm_clamsocket = $1 . $parm_clamsocket;
2925             $socket_domain = AF_INET;
2926             last;
2927             }
2928           else
2929             {
2930             $parm_clamsocket = $1;
2931             }
2932           }
2933         }
2934       close(IN);
2935
2936       if (defined $socket_domain)
2937         {
2938         print ":\n  The clamd socket is $parm_clamsocket\n";
2939         # This test for an active ClamAV is courtesy of Daniel Tiefnig.
2940         eval
2941           {
2942           my $socket;
2943           if ($socket_domain == AF_UNIX)
2944             {
2945             $socket = sockaddr_un($parm_clamsocket) or die "** Failed packing '$parm_clamsocket'\n";
2946             }
2947           elsif ($socket_domain == AF_INET)
2948             {
2949             my ($ca_host, $ca_port) = split(/\s+/,$parm_clamsocket);
2950             my $ca_hostent = gethostbyname($ca_host) or die "** Failed to get raw address for host '$ca_host'\n";
2951             $socket = sockaddr_in($ca_port, $ca_hostent) or die "** Failed packing '$parm_clamsocket'\n";
2952             }
2953           else
2954             {
2955             die "** Unknown socket domain '$socket_domain' (should not happen)\n";
2956             }
2957           socket($sock, $socket_domain, SOCK_STREAM, 0) or die "** Unable to open socket '$parm_clamsocket'\n";
2958           local $SIG{ALRM} = sub { die "** Timeout while connecting to socket '$parm_clamsocket'\n"; };
2959           alarm(5);
2960           connect($sock, $socket) or die "** Unable to connect to socket '$parm_clamsocket'\n";
2961           alarm(0);
2962
2963           my $ofh = select $sock; $| = 1; select $ofh;
2964           print $sock "PING\n";
2965
2966           $SIG{ALRM} = sub { die "** Timeout while reading from socket '$parm_clamsocket'\n"; };
2967           alarm(10);
2968           my $res = <$sock>;
2969           alarm(0);
2970
2971           $res =~ /PONG/ or die "** Did not get PONG from socket '$parm_clamsocket'. It said: $res\n";
2972           };
2973         alarm(0);
2974
2975         if($@)
2976           {
2977           print "  $@";
2978           print "  Assume ClamAV is not running\n";
2979           }
2980         else
2981           {
2982           $parm_running{ClamAV} = ' ';
2983           print "  ClamAV seems to be running\n";
2984           }
2985         }
2986       else
2987         {
2988         print ", but the socket for clamd could not be determined\n";
2989         print "Assume ClamAV is not running\n";
2990         }
2991       }
2992
2993     else
2994       {
2995       print ", but I can't find a configuration for clamd\n";
2996       print "Assume ClamAV is not running\n";
2997       }
2998     }
2999   }
3000
3001
3002 ##################################################
3003 #       Check for redis                          #
3004 ##################################################
3005 if (defined $parm_lookups{redis})
3006   {
3007   if (system("redis-server -v 2>/dev/null >/dev/null") == 0)
3008     {
3009     print "The redis-server command works\n";
3010     $parm_running{redis} = ' ';
3011     }
3012   else
3013     {
3014     print "The redis-server command failed: assume Redis not installed\n";
3015     }
3016   }
3017
3018 ##################################################
3019 #         Test for the basic requirements        #
3020 ##################################################
3021
3022 # This test suite assumes that Exim has been built with at least the "usual"
3023 # set of routers, transports, and lookups. Ensure that this is so.
3024
3025 $missing = '';
3026
3027 $missing .= "     Lookup: lsearch\n" if (!defined $parm_lookups{lsearch});
3028
3029 $missing .= "     Router: accept\n" if (!defined $parm_routers{accept});
3030 $missing .= "     Router: dnslookup\n" if (!defined $parm_routers{dnslookup});
3031 $missing .= "     Router: manualroute\n" if (!defined $parm_routers{manualroute});
3032 $missing .= "     Router: redirect\n" if (!defined $parm_routers{redirect});
3033
3034 $missing .= "     Transport: appendfile\n" if (!defined $parm_transports{appendfile});
3035 $missing .= "     Transport: autoreply\n" if (!defined $parm_transports{autoreply});
3036 $missing .= "     Transport: pipe\n" if (!defined $parm_transports{pipe});
3037 $missing .= "     Transport: smtp\n" if (!defined $parm_transports{smtp});
3038
3039 if ($missing ne '')
3040   {
3041   print "\n";
3042   print "** Many features can be included or excluded from Exim binaries.\n";
3043   print "** This test suite requires that Exim is built to contain a certain\n";
3044   print "** set of basic facilities. It seems that some of these are missing\n";
3045   print "** from the binary that is under test, so the test cannot proceed.\n";
3046   print "** The missing facilities are:\n";
3047   print "$missing";
3048   die "** Test script abandoned\n";
3049   }
3050
3051
3052 ##################################################
3053 #      Check for the auxiliary programs          #
3054 ##################################################
3055
3056 # These are always required:
3057
3058 for $prog ("cf", "checkaccess", "client", "client-ssl", "client-gnutls",
3059            "fakens", "iefbr14", "server")
3060   {
3061   next if ($prog eq "client-ssl" && !defined $parm_support{OpenSSL});
3062   next if ($prog eq "client-gnutls" && !defined $parm_support{GnuTLS});
3063   if (!-e "bin/$prog")
3064     {
3065     print "\n";
3066     print "** bin/$prog does not exist. Have you run ./configure and make?\n";
3067     die "** Test script abandoned\n";
3068     }
3069   }
3070
3071 # If the "loaded" binary is missing, we cut out tests for ${dlfunc. It isn't
3072 # compiled on systems where we don't know how to. However, if Exim does not
3073 # have that functionality compiled, we needn't bother.
3074
3075 $dlfunc_deleted = 0;
3076 if (defined $parm_support{Expand_dlfunc} && !-e 'bin/loaded')
3077   {
3078   delete $parm_support{Expand_dlfunc};
3079   $dlfunc_deleted = 1;
3080   }
3081
3082
3083 ##################################################
3084 #          Find environmental details            #
3085 ##################################################
3086
3087 # Find the caller of this program.
3088
3089 ($parm_caller,$pwpw,$parm_caller_uid,$parm_caller_gid,$pwquota,$pwcomm,
3090  $parm_caller_gecos, $parm_caller_home) = getpwuid($>);
3091
3092 $pwpw = $pwpw;       # Kill Perl warnings
3093 $pwquota = $pwquota;
3094 $pwcomm = $pwcomm;
3095
3096 $parm_caller_group = getgrgid($parm_caller_gid);
3097
3098 print "Program caller is $parm_caller ($parm_caller_uid), whose group is $parm_caller_group ($parm_caller_gid)\n";
3099 print "Home directory is $parm_caller_home\n";
3100
3101 unless (defined $parm_eximgroup)
3102   {
3103   print "Unable to derive \$parm_eximgroup.\n";
3104   die "** ABANDONING.\n";
3105   }
3106
3107 print "You need to be in the Exim group to run these tests. Checking ...";
3108
3109 if (`groups` =~ /\b\Q$parm_eximgroup\E\b/)
3110   {
3111   print " OK\n";
3112   }
3113 else
3114   {
3115   print "\nOh dear, you are not in the Exim group.\n";
3116   die "** Testing abandoned.\n";
3117   }
3118
3119 # Find this host's IP addresses - there may be many, of course, but we keep
3120 # one of each type (IPv4 and IPv6).
3121
3122 open(IFCONFIG, '-|', (grep { -x "$_/ip" } split /:/, $ENV{PATH}) ? 'ip address' : 'ifconfig -a')
3123   or die "** Cannot run 'ip address' or 'ifconfig -a'\n";
3124 while (not ($parm_ipv4 and $parm_ipv6) and defined($_ = <IFCONFIG>))
3125   {
3126   if (not $parm_ipv4 and /^\s*inet(?:\saddr)?:?\s?(\d+\.\d+\.\d+\.\d+)(?:\/\d+)?\s/i)
3127     {
3128     next if $1 =~ /^(?:127|10)\./;
3129     $parm_ipv4 = $1;
3130     }
3131
3132   if (not $parm_ipv6 and /^\s*inet6(?:\saddr)?:?\s?([abcdef\d:]+)(?:\/\d+)/i)
3133     {
3134     next if $1 eq '::1' or $1 =~ /^fe80/i;
3135     $parm_ipv6 = $1;
3136     }
3137   }
3138 close(IFCONFIG);
3139
3140 # Use private IP addresses if there are no public ones.
3141
3142 # If either type of IP address is missing, we need to set the value to
3143 # something other than empty, because that wrecks the substitutions. The value
3144 # is reflected, so use a meaningful string. Set appropriate options for the
3145 # "server" command. In practice, however, many tests assume 127.0.0.1 is
3146 # available, so things will go wrong if there is no IPv4 address. The lack
3147 # of IPV4 or IPv6 can be simulated by command options, which force $have_ipv4
3148 # and $have_ipv6 false.
3149
3150 if (not $parm_ipv4)
3151   {
3152   $have_ipv4 = 0;
3153   $parm_ipv4 = "<no IPv4 address found>";
3154   $server_opts .= " -noipv4";
3155   }
3156 elsif ($have_ipv4 == 0)
3157   {
3158   $parm_ipv4 = "<IPv4 testing disabled>";
3159   $server_opts .= " -noipv4";
3160   }
3161 else
3162   {
3163   $parm_running{IPv4} = " ";
3164   }
3165
3166 if (not $parm_ipv6)
3167   {
3168   $have_ipv6 = 0;
3169   $parm_ipv6 = "<no IPv6 address found>";
3170   $server_opts .= " -noipv6";
3171   delete($parm_support{IPv6});
3172   }
3173 elsif ($have_ipv6 == 0)
3174   {
3175   $parm_ipv6 = "<IPv6 testing disabled>";
3176   $server_opts .= " -noipv6";
3177   delete($parm_support{IPv6});
3178   }
3179 elsif (!defined $parm_support{IPv6})
3180   {
3181   $have_ipv6 = 0;
3182   $parm_ipv6 = "<no IPv6 support in Exim binary>";
3183   $server_opts .= " -noipv6";
3184   }
3185 else
3186   {
3187   $parm_running{IPv6} = " ";
3188   }
3189
3190 print "IPv4 address is $parm_ipv4\n";
3191 print "IPv6 address is $parm_ipv6\n";
3192
3193 # For munging test output, we need the reversed IP addresses.
3194
3195 $parm_ipv4r = ($parm_ipv4 !~ /^\d/)? '' :
3196   join(".", reverse(split /\./, $parm_ipv4));
3197
3198 $parm_ipv6r = $parm_ipv6;             # Appropriate if not in use
3199 if ($parm_ipv6 =~ /^[\da-f]/)
3200   {
3201   my(@comps) = split /:/, $parm_ipv6;
3202   my(@nibbles);
3203   foreach $comp (@comps)
3204     {
3205     push @nibbles, sprintf("%lx", hex($comp) >> 8);
3206     push @nibbles, sprintf("%lx", hex($comp) & 0xff);
3207     }
3208   $parm_ipv6r = join(".", reverse(@nibbles));
3209   }
3210
3211 # Find the host name, fully qualified.
3212
3213 chomp($temp = `hostname`);
3214 die "'hostname' didn't return anything\n" unless defined $temp and length $temp;
3215 if ($temp =~ /\./)
3216   {
3217   $parm_hostname = $temp;
3218   }
3219 else
3220   {
3221   $parm_hostname = (gethostbyname($temp))[0];
3222   $parm_hostname = "no.host.name.found" unless defined $parm_hostname and length $parm_hostname;
3223   }
3224 print "Hostname is $parm_hostname\n";
3225
3226 if ($parm_hostname !~ /\./)
3227   {
3228   print "\n*** Host name is not fully qualified: this may cause problems ***\n\n";
3229   }
3230
3231 if ($parm_hostname =~ /[[:upper:]]/)
3232   {
3233   print "\n*** Host name has upper case characters: this may cause problems ***\n\n";
3234   }
3235
3236
3237
3238 ##################################################
3239 #     Create a testing version of Exim           #
3240 ##################################################
3241
3242 # We want to be able to run Exim with a variety of configurations. Normally,
3243 # the use of -C to change configuration causes Exim to give up its root
3244 # privilege (unless the caller is exim or root). For these tests, we do not
3245 # want this to happen. Also, we want Exim to know that it is running in its
3246 # test harness.
3247
3248 # We achieve this by copying the binary and patching it as we go. The new
3249 # binary knows it is a testing copy, and it allows -C and -D without loss of
3250 # privilege. Clearly, this file is dangerous to have lying around on systems
3251 # where there are general users with login accounts. To protect against this,
3252 # we put the new binary in a special directory that is accessible only to the
3253 # caller of this script, who is known to have sudo root privilege from the test
3254 # that was done above. Furthermore, we ensure that the binary is deleted at the
3255 # end of the test. First ensure the directory exists.
3256
3257 if (-d "eximdir")
3258   { unlink "eximdir/exim"; }     # Just in case
3259 else
3260   {
3261   mkdir("eximdir", 0710) || die "** Unable to mkdir $parm_cwd/eximdir: $!\n";
3262   system("sudo chgrp $parm_eximgroup eximdir");
3263   }
3264
3265 # The construction of the patched binary must be done as root, so we use
3266 # a separate script. As well as indicating that this is a test-harness binary,
3267 # the version number is patched to "x.yz" so that its length is always the
3268 # same. Otherwise, when it appears in Received: headers, it affects the length
3269 # of the message, which breaks certain comparisons.
3270
3271 die "** Unable to make patched exim: $!\n"
3272   if (system("sudo ./patchexim $parm_exim") != 0);
3273
3274 # From this point on, exits from the program must go via the subroutine
3275 # tests_exit(), so that suitable cleaning up can be done when required.
3276 # Arrange to catch interrupting signals, to assist with this.
3277
3278 $SIG{INT} = \&inthandler;
3279 $SIG{PIPE} = \&pipehandler;
3280
3281 # For some tests, we need another copy of the binary that is setuid exim rather
3282 # than root.
3283
3284 system("sudo cp eximdir/exim eximdir/exim_exim;" .
3285        "sudo chown $parm_eximuser eximdir/exim_exim;" .
3286        "sudo chgrp $parm_eximgroup eximdir/exim_exim;" .
3287        "sudo chmod 06755 eximdir/exim_exim");
3288
3289
3290 ##################################################
3291 #     Make copies of utilities we might need     #
3292 ##################################################
3293
3294 # Certain of the tests make use of some of Exim's utilities. We do not need
3295 # to be root to copy these.
3296
3297 ($parm_exim_dir) = $parm_exim =~ m?^(.*)/exim?;
3298
3299 $dbm_build_deleted = 0;
3300 if (defined $parm_lookups{dbm} &&
3301     system("cp $parm_exim_dir/exim_dbmbuild eximdir") != 0)
3302   {
3303   delete $parm_lookups{dbm};
3304   $dbm_build_deleted = 1;
3305   }
3306
3307 if (system("cp $parm_exim_dir/exim_dumpdb eximdir") != 0)
3308   {
3309   tests_exit(-1, "Failed to make a copy of exim_dumpdb: $!");
3310   }
3311
3312 if (system("cp $parm_exim_dir/exim_lock eximdir") != 0)
3313   {
3314   tests_exit(-1, "Failed to make a copy of exim_lock: $!");
3315   }
3316
3317 if (system("cp $parm_exim_dir/exinext eximdir") != 0)
3318   {
3319   tests_exit(-1, "Failed to make a copy of exinext: $!");
3320   }
3321
3322 if (system("cp $parm_exim_dir/exigrep eximdir") != 0)
3323   {
3324   tests_exit(-1, "Failed to make a copy of exigrep: $!");
3325   }
3326
3327 if (system("cp $parm_exim_dir/eximstats eximdir") != 0)
3328   {
3329   tests_exit(-1, "Failed to make a copy of eximstats: $!");
3330   }
3331
3332
3333 ##################################################
3334 #    Check that the Exim user can access stuff   #
3335 ##################################################
3336
3337 # We delay this test till here so that we can check access to the actual test
3338 # binary. This will be needed when Exim re-exec's itself to do deliveries.
3339
3340 print "Exim user is $parm_eximuser ($parm_exim_uid)\n";
3341 print "Exim group is $parm_eximgroup ($parm_exim_gid)\n";
3342
3343 if ($parm_caller_uid eq $parm_exim_uid) {
3344   tests_exit(-1, "Exim user ($parm_eximuser,$parm_exim_uid) cannot be "
3345                 ."the same as caller ($parm_caller,$parm_caller_uid)");
3346 }
3347 if ($parm_caller_gid eq $parm_exim_gid) {
3348   tests_exit(-1, "Exim group ($parm_eximgroup,$parm_exim_gid) cannot be "
3349                 ."the same as caller's ($parm_caller) group as it confuses "
3350                 ."results analysis");
3351 }
3352
3353 print "The Exim user needs access to the test suite directory. Checking ...";
3354
3355 if (($rc = system("sudo bin/checkaccess $parm_cwd/eximdir/exim $parm_eximuser $parm_eximgroup")) != 0)
3356   {
3357   my($why) = "unknown failure $rc";
3358   $rc >>= 8;
3359   $why = "Couldn't find user \"$parm_eximuser\"" if $rc == 1;
3360   $why = "Couldn't find group \"$parm_eximgroup\"" if $rc == 2;
3361   $why = "Couldn't read auxiliary group list" if $rc == 3;
3362   $why = "Couldn't get rid of auxiliary groups" if $rc == 4;
3363   $why = "Couldn't set gid" if $rc == 5;
3364   $why = "Couldn't set uid" if $rc == 6;
3365   $why = "Couldn't open \"$parm_cwd/eximdir/exim\"" if $rc == 7;
3366   print "\n** $why\n";
3367   tests_exit(-1, "$parm_eximuser cannot access the test suite directory");
3368   }
3369 else
3370   {
3371   print " OK\n";
3372   }
3373
3374
3375 ##################################################
3376 #        Create a list of available tests        #
3377 ##################################################
3378
3379 # The scripts directory contains a number of subdirectories whose names are
3380 # of the form 0000-xxxx, 1100-xxxx, 2000-xxxx, etc. Each set of tests apart
3381 # from the first requires certain optional features to be included in the Exim
3382 # binary. These requirements are contained in a file called "REQUIRES" within
3383 # the directory. We scan all these tests, discarding those that cannot be run
3384 # because the current binary does not support the right facilities, and also
3385 # those that are outside the numerical range selected.
3386
3387 print "\nTest range is $test_start to $test_end (flavour $flavour)\n";
3388 print "Omitting \${dlfunc expansion tests (loadable module not present)\n"
3389   if $dlfunc_deleted;
3390 print "Omitting dbm tests (unable to copy exim_dbmbuild)\n"
3391   if $dbm_build_deleted;
3392
3393 opendir(DIR, "scripts") || tests_exit(-1, "Failed to opendir(\"scripts\"): $!");
3394 @test_dirs = sort readdir(DIR);
3395 closedir(DIR);
3396
3397 # Remove . and .. and CVS from the list.
3398
3399 for ($i = 0; $i < @test_dirs; $i++)
3400   {
3401   my($d) = $test_dirs[$i];
3402   if ($d eq "." || $d eq ".." || $d eq "CVS")
3403     {
3404     splice @test_dirs, $i, 1;
3405     $i--;
3406     }
3407   }
3408
3409 # Scan for relevant tests
3410
3411 tests_exit(-1, "Failed to unlink $log_summary_filename")
3412   if (-e $log_summary_filename && !unlink($log_summary_filename));
3413 for ($i = 0; $i < @test_dirs; $i++)
3414   {
3415   my($testdir) = $test_dirs[$i];
3416   my($wantthis) = 1;
3417
3418   print ">>Checking $testdir\n" if $debug;
3419
3420   # Skip this directory if the first test is equal or greater than the first
3421   # test in the next directory.
3422
3423   next if ($i < @test_dirs - 1) &&
3424           ($test_start >= substr($test_dirs[$i+1], 0, 4));
3425
3426   # No need to carry on if the end test is less than the first test in this
3427   # subdirectory.
3428
3429   last if $test_end < substr($testdir, 0, 4);
3430
3431   # Check requirements, if any.
3432
3433   if (open(REQUIRES, "scripts/$testdir/REQUIRES"))
3434     {
3435     while (<REQUIRES>)
3436       {
3437       next if /^\s*$/;
3438       s/\s+$//;
3439       if (/^support (.*)$/)
3440         {
3441         if (!defined $parm_support{$1}) { $wantthis = 0; last; }
3442         }
3443       elsif (/^running (.*)$/)
3444         {
3445         if (!defined $parm_running{$1}) { $wantthis = 0; last; }
3446         }
3447       elsif (/^lookup (.*)$/)
3448         {
3449         if (!defined $parm_lookups{$1}) { $wantthis = 0; last; }
3450         }
3451       elsif (/^authenticators? (.*)$/)
3452         {
3453         if (!defined $parm_authenticators{$1}) { $wantthis = 0; last; }
3454         }
3455       elsif (/^router (.*)$/)
3456         {
3457         if (!defined $parm_routers{$1}) { $wantthis = 0; last; }
3458         }
3459       elsif (/^transport (.*)$/)
3460         {
3461         if (!defined $parm_transports{$1}) { $wantthis = 0; last; }
3462         }
3463       else
3464         {
3465         tests_exit(-1, "Unknown line in \"scripts/$testdir/REQUIRES\": \"$_\"");
3466         }
3467       }
3468     close(REQUIRES);
3469     }
3470   else
3471     {
3472     tests_exit(-1, "Failed to open \"scripts/$testdir/REQUIRES\": $!")
3473       unless $!{ENOENT};
3474     }
3475
3476   # Loop if we do not want the tests in this subdirectory.
3477
3478   if (!$wantthis)
3479     {
3480     chomp;
3481     print "Omitting tests in $testdir (missing $_)\n";
3482     }
3483
3484   # We want the tests from this subdirectory, provided they are in the
3485   # range that was selected.
3486
3487   opendir(SUBDIR, "scripts/$testdir") ||
3488     tests_exit(-1, "Failed to opendir(\"scripts/$testdir\"): $!");
3489   @testlist = sort readdir(SUBDIR);
3490   close(SUBDIR);
3491
3492   foreach $test (@testlist)
3493     {
3494     next if ($test !~ /^\d{4}(?:\.\d+)?$/);
3495     if (!$wantthis || $test < $test_start || $test > $test_end)
3496       {
3497       log_test($log_summary_filename, $test, '.');
3498       }
3499     else
3500       {
3501       push @test_list, "$testdir/$test";
3502       }
3503     }
3504   }
3505
3506 print ">>Test List: @test_list\n", if $debug;
3507
3508
3509 ##################################################
3510 #         Munge variable auxiliary data          #
3511 ##################################################
3512
3513 # Some of the auxiliary data files have to refer to the current testing
3514 # directory and other parameter data. The generic versions of these files are
3515 # stored in the aux-var-src directory. At this point, we copy each of them
3516 # to the aux-var directory, making appropriate substitutions. There aren't very
3517 # many of them, so it's easiest just to do this every time. Ensure the mode
3518 # is standardized, as this path is used as a test for the ${stat: expansion.
3519
3520 # A similar job has to be done for the files in the dnszones-src directory, to
3521 # make the fake DNS zones for testing. Most of the zone files are copied to
3522 # files of the same name, but db.ipv4.V4NET and db.ipv6.V6NET use the testing
3523 # networks that are defined by parameter.
3524
3525 foreach $basedir ("aux-var", "dnszones")
3526   {
3527   system("sudo rm -rf $parm_cwd/$basedir");
3528   mkdir("$parm_cwd/$basedir", 0777);
3529   chmod(0755, "$parm_cwd/$basedir");
3530
3531   opendir(AUX, "$parm_cwd/$basedir-src") ||
3532     tests_exit(-1, "Failed to opendir $parm_cwd/$basedir-src: $!");
3533   my(@filelist) = readdir(AUX);
3534   close(AUX);
3535
3536   foreach $file (@filelist)
3537     {
3538     my($outfile) = $file;
3539     next if $file =~ /^\./;
3540
3541     if ($file eq "db.ip4.V4NET")
3542       {
3543       $outfile = "db.ip4.$parm_ipv4_test_net";
3544       }
3545     elsif ($file eq "db.ip6.V6NET")
3546       {
3547       my(@nibbles) = reverse(split /\s*/, $parm_ipv6_test_net);
3548       $" = '.';
3549       $outfile = "db.ip6.@nibbles";
3550       $" = ' ';
3551       }
3552
3553     print ">>Copying $basedir-src/$file to $basedir/$outfile\n" if $debug;
3554     open(IN, "$parm_cwd/$basedir-src/$file") ||
3555       tests_exit(-1, "Failed to open $parm_cwd/$basedir-src/$file: $!");
3556     open(OUT, ">$parm_cwd/$basedir/$outfile") ||
3557       tests_exit(-1, "Failed to open $parm_cwd/$basedir/$outfile: $!");
3558     while (<IN>)
3559       {
3560       do_substitute(0);
3561       print OUT;
3562       }
3563     close(IN);
3564     close(OUT);
3565     }
3566   }
3567
3568 # Set a user's shell, distinguishable from /bin/sh
3569
3570 symlink('/bin/sh' => 'aux-var/sh');
3571 $ENV{SHELL} = $parm_shell = "$parm_cwd/aux-var/sh";
3572
3573 ##################################################
3574 #     Create fake DNS zones for this host        #
3575 ##################################################
3576
3577 # There are fixed zone files for 127.0.0.1 and ::1, but we also want to be
3578 # sure that there are forward and reverse registrations for this host, using
3579 # its real IP addresses. Dynamically created zone files achieve this.
3580
3581 if ($have_ipv4 || $have_ipv6)
3582   {
3583   my($shortname,$domain) = $parm_hostname =~ /^([^.]+)(.*)/;
3584   open(OUT, ">$parm_cwd/dnszones/db$domain") ||
3585     tests_exit(-1, "Failed to open $parm_cwd/dnszones/db$domain: $!");
3586   print OUT "; This is a dynamically constructed fake zone file.\n" .
3587     "; The following line causes fakens to return PASS_ON\n" .
3588     "; for queries that it cannot answer\n\n" .
3589     "PASS ON NOT FOUND\n\n";
3590   print OUT "$shortname  A     $parm_ipv4\n" if $have_ipv4;
3591   print OUT "$shortname  AAAA  $parm_ipv6\n" if $have_ipv6;
3592   print OUT "\n; End\n";
3593   close(OUT);
3594   }
3595
3596 if ($have_ipv4 && $parm_ipv4 ne "127.0.0.1")
3597   {
3598   my(@components) = $parm_ipv4 =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)/;
3599   open(OUT, ">$parm_cwd/dnszones/db.ip4.$components[0]") ||
3600     tests_exit(-1,
3601       "Failed  to open $parm_cwd/dnszones/db.ip4.$components[0]: $!");
3602   print OUT "; This is a dynamically constructed fake zone file.\n" .
3603     "; The zone is $components[0].in-addr.arpa.\n\n" .
3604     "$components[3].$components[2].$components[1]  PTR  $parm_hostname.\n\n" .
3605     "; End\n";
3606   close(OUT);
3607   }
3608
3609 if ($have_ipv6 && $parm_ipv6 ne "::1")
3610   {
3611   my($exp_v6) = $parm_ipv6;
3612   $exp_v6 =~ s/[^:]//g;
3613   if ( $parm_ipv6 =~ /^([^:].+)::$/ ) {
3614     $exp_v6 = $1 . ':0' x (9-length($exp_v6));
3615   } elsif ( $parm_ipv6 =~ /^(.+)::(.+)$/ ) {
3616     $exp_v6 = $1 . ':0' x (8-length($exp_v6)) . ':' . $2;
3617   } elsif ( $parm_ipv6 =~ /^::(.+[^:])$/ ) {
3618     $exp_v6 = '0:' x (9-length($exp_v6)) . $1;
3619   } else {
3620     $exp_v6 = $parm_ipv6;
3621   }
3622   my(@components) = split /:/, $exp_v6;
3623   my(@nibbles) = reverse (split /\s*/, shift @components);
3624   my($sep) =  '';
3625
3626   $" = ".";
3627   open(OUT, ">$parm_cwd/dnszones/db.ip6.@nibbles") ||
3628     tests_exit(-1,
3629       "Failed  to open $parm_cwd/dnszones/db.ip6.@nibbles: $!");
3630   print OUT "; This is a dynamically constructed fake zone file.\n" .
3631     "; The zone is @nibbles.ip6.arpa.\n\n";
3632
3633   @components = reverse @components;
3634   foreach $c (@components)
3635     {
3636     $c = "0$c" until $c =~ /^..../;
3637     @nibbles = reverse(split /\s*/, $c);
3638     print OUT "$sep@nibbles";
3639     $sep = ".";
3640     }
3641
3642   print OUT "  PTR  $parm_hostname.\n\n; End\n";
3643   close(OUT);
3644   $" = " ";
3645   }
3646
3647
3648
3649 ##################################################
3650 #    Create lists of mailboxes and message logs  #
3651 ##################################################
3652
3653 # We use these lists to check that a test has created the expected files. It
3654 # should be faster than looking for the file each time. For mailboxes, we have
3655 # to scan a complete subtree, in order to handle maildirs. For msglogs, there
3656 # is just a flat list of files.
3657
3658 @oldmails = list_files_below("mail");
3659 opendir(DIR, "msglog") || tests_exit(-1, "Failed to opendir msglog: $!");
3660 @oldmsglogs = readdir(DIR);
3661 closedir(DIR);
3662
3663
3664
3665 ##################################################
3666 #         Run the required tests                 #
3667 ##################################################
3668
3669 # Each test script contains a number of tests, separated by a line that
3670 # contains ****. We open input from the terminal so that we can read responses
3671 # to prompts.
3672
3673 if (not $force_continue) {
3674   # runtest needs to interact if we're not in continue
3675   # mode. It does so by communicate to /dev/tty
3676   open(T, "/dev/tty") or tests_exit(-1, "Failed to open /dev/tty: $!");
3677 }
3678
3679
3680 print "\nPress RETURN to run the tests: ";
3681 $_ = $force_continue ? "c" : <T>;
3682 print "\n";
3683
3684 $lasttestdir = '';
3685
3686 foreach $test (@test_list)
3687   {
3688   local($lineno) = 0;
3689   local($commandno) = 0;
3690   local($subtestno) = 0;
3691   (local $testno = $test) =~ s|.*/||;
3692   local($sortlog) = 0;
3693
3694   my($gnutls) = 0;
3695   my($docheck) = 1;
3696   my($thistestdir) = substr($test, 0, -5);
3697
3698   $dynamic_socket->close() if $dynamic_socket;
3699
3700   if ($lasttestdir ne $thistestdir)
3701     {
3702     $gnutls = 0;
3703     if (-s "scripts/$thistestdir/REQUIRES")
3704       {
3705       my($indent) = '';
3706       print "\n>>> The following tests require: ";
3707       open(IN, "scripts/$thistestdir/REQUIRES") ||
3708         tests_exit(-1, "Failed to open scripts/$thistestdir/REQUIRES: $1");
3709       while (<IN>)
3710         {
3711         $gnutls = 1 if /^support GnuTLS/;
3712         print $indent, $_;
3713         $indent = ">>>                              ";
3714         }
3715       close(IN);
3716       }
3717     }
3718   $lasttestdir = $thistestdir;
3719
3720   # Remove any debris in the spool directory and the test-mail directory
3721   # and also the files for collecting stdout and stderr. Then put back
3722   # the test-mail directory for appendfile deliveries.
3723
3724   system "sudo /bin/rm -rf spool test-*";
3725   system "mkdir test-mail 2>/dev/null";
3726
3727   # A privileged Exim will normally make its own spool directory, but some of
3728   # the tests run in unprivileged modes that don't always work if the spool
3729   # directory isn't already there. What is more, we want anybody to be able
3730   # to read it in order to find the daemon's pid.
3731
3732   system "mkdir spool; " .
3733          "sudo chown $parm_eximuser:$parm_eximgroup spool; " .
3734          "sudo chmod 0755 spool";
3735
3736   # Empty the cache that keeps track of things like message id mappings, and
3737   # set up the initial sequence strings.
3738
3739   undef %cache;
3740   $next_msgid = "aX";
3741   $next_pid = 1234;
3742   $next_port = 1111;
3743   $message_skip = 0;
3744   $msglog_skip = 0;
3745   $stderr_skip = 0;
3746   $stdout_skip = 0;
3747   $rmfiltertest = 0;
3748   $is_ipv6test = 0;
3749   $TEST_STATE->{munge} = '';
3750
3751   # Remove the associative arrays used to hold checked mail files and msglogs
3752
3753   undef %expected_mails;
3754   undef %expected_msglogs;
3755
3756   # Open the test's script
3757   open(SCRIPT, "scripts/$test") ||
3758     tests_exit(-1, "Failed to open \"scripts/$test\": $!");
3759   # Run through the script once to set variables which should be global
3760   while (<SCRIPT>)
3761     {
3762     if (/^no_message_check/) { $message_skip = 1; next; }
3763     if (/^no_msglog_check/)  { $msglog_skip = 1; next; }
3764     if (/^no_stderr_check/)  { $stderr_skip = 1; next; }
3765     if (/^no_stdout_check/)  { $stdout_skip = 1; next; }
3766     if (/^rmfiltertest/)     { $rmfiltertest = 1; next; }
3767     if (/^sortlog/)          { $sortlog = 1; next; }
3768     if (/\bPORT_DYNAMIC\b/)  { $dynamic_socket = Exim::Runtest::dynamic_socket(); next; }
3769     }
3770   # Reset to beginning of file for per test interpreting/processing
3771   seek(SCRIPT, 0, 0);
3772
3773   # The first line in the script must be a comment that is used to identify
3774   # the set of tests as a whole.
3775
3776   $_ = <SCRIPT>;
3777   $lineno++;
3778   tests_exit(-1, "Missing identifying comment at start of $test") if (!/^#/);
3779   printf("%s %s", (substr $test, 5), (substr $_, 2));
3780
3781   # Loop for each of the subtests within the script. The variable $server_pid
3782   # is used to remember the pid of a "server" process, for which we do not
3783   # wait until we have waited for a subsequent command.
3784
3785   local($server_pid) = 0;
3786   for ($commandno = 1; !eof SCRIPT; $commandno++)
3787     {
3788     # Skip further leading comments and blank lines, handle the flag setting
3789     # commands, and deal with tests for IP support.
3790
3791     while (<SCRIPT>)
3792       {
3793       $lineno++;
3794       # Could remove these variable settings because they are already
3795       # set above, but doesn't hurt to leave them here.
3796       if (/^no_message_check/) { $message_skip = 1; next; }
3797       if (/^no_msglog_check/)  { $msglog_skip = 1; next; }
3798       if (/^no_stderr_check/)  { $stderr_skip = 1; next; }
3799       if (/^no_stdout_check/)  { $stdout_skip = 1; next; }
3800       if (/^rmfiltertest/)     { $rmfiltertest = 1; next; }
3801       if (/^sortlog/)          { $sortlog = 1; next; }
3802
3803       if (/^need_largefiles/)
3804         {
3805         next if $have_largefiles;
3806         print ">>> Large file support is needed for test $testno, but is not available: skipping\n";
3807         $docheck = 0;      # don't check output
3808         undef $_;          # pretend EOF
3809         last;
3810         }
3811
3812       if (/^need_ipv4/)
3813         {
3814         next if $have_ipv4;
3815         print ">>> IPv4 is needed for test $testno, but is not available: skipping\n";
3816         $docheck = 0;      # don't check output
3817         undef $_;          # pretend EOF
3818         last;
3819         }
3820
3821       if (/^need_ipv6/)
3822         {
3823         if ($have_ipv6)
3824           {
3825           $is_ipv6test = 1;
3826           next;
3827           }
3828         print ">>> IPv6 is needed for test $testno, but is not available: skipping\n";
3829         $docheck = 0;      # don't check output
3830         undef $_;          # pretend EOF
3831         last;
3832         }
3833
3834       if (/^need_move_frozen_messages/)
3835         {
3836         next if defined $parm_support{move_frozen_messages};
3837         print ">>> move frozen message support is needed for test $testno, " .
3838           "but is not\n>>> available: skipping\n";
3839         $docheck = 0;      # don't check output
3840         undef $_;          # pretend EOF
3841         last;
3842         }
3843
3844       last unless /^(?:#(?!##\s)|\s*$)/;
3845       }
3846     last if !defined $_;  # Hit EOF
3847
3848     my($subtest_startline) = $lineno;
3849
3850     # Now run the command. The function returns 0 for an inline command,
3851     # 1 if a non-exim command was run and waited for, 2 if an exim
3852     # command was run and waited for, and 3 if a command
3853     # was run and not waited for (usually a daemon or server startup).
3854
3855     my($commandname) = '';
3856     my($expectrc) = 0;
3857     my($rc, $run_extra) = run_command($testno, \$subtestno, \$expectrc, \$commandname, $TEST_STATE);
3858     my($cmdrc) = $?;
3859
3860     $0 = "[runtest $testno]";
3861
3862     if ($debug) {
3863       print ">> rc=$rc cmdrc=$cmdrc\n";
3864       if (defined $run_extra) {
3865         foreach my $k (keys %$run_extra) {
3866           my $v = defined $run_extra->{$k} ? qq!"$run_extra->{$k}"! : '<undef>';
3867           print ">>   $k -> $v\n";
3868         }
3869       }
3870     }
3871     $run_extra = {} unless defined $run_extra;
3872     foreach my $k (keys %$run_extra) {
3873       if (exists $TEST_STATE->{$k}) {
3874         my $nv = defined $run_extra->{$k} ? qq!"$run_extra->{$k}"! : 'removed';
3875         print ">> override of $k; was $TEST_STATE->{$k}, now $nv\n" if $debug;
3876       }
3877       if (defined $run_extra->{$k}) {
3878         $TEST_STATE->{$k} = $run_extra->{$k};
3879       } elsif (exists $TEST_STATE->{$k}) {
3880         delete $TEST_STATE->{$k};
3881       }
3882     }
3883
3884     # Hit EOF after an initial return code number
3885
3886     tests_exit(-1, "Unexpected EOF in script") if ($rc == 4);
3887
3888     # Carry on with the next command if we did not wait for this one. $rc == 0
3889     # if no subprocess was run; $rc == 3 if we started a process but did not
3890     # wait for it.
3891
3892     next if ($rc == 0 || $rc == 3);
3893
3894     # We ran and waited for a command. Check for the expected result unless
3895     # it died.
3896
3897     if ($cmdrc != $expectrc && !$sigpipehappened)
3898       {
3899       printf("** Command $commandno (\"$commandname\", starting at line $subtest_startline)\n");
3900       if (($cmdrc & 0xff) == 0)
3901         {
3902         printf("** Return code %d (expected %d)", $cmdrc/256, $expectrc/256);
3903         }
3904       elsif (($cmdrc & 0xff00) == 0)
3905         { printf("** Killed by signal %d", $cmdrc & 255); }
3906       else
3907         { printf("** Status %x", $cmdrc); }
3908
3909       for (;;)
3910         {
3911         print "\nshow stdErr, show stdOut, Retry, Continue (without file comparison), or Quit? [Q] ";
3912         $_ = $force_continue ? "c" : <T>;
3913         tests_exit(1) if /^q?$/i;
3914         if (/^c$/ && $force_continue) {
3915           log_failure($log_failed_filename, $testno, "exit code unexpected");
3916           log_test($log_summary_filename, $testno, 'F')
3917         }
3918         if ($force_continue)
3919           {
3920           print "\nstderr tail:\n";
3921           print "===================\n";
3922           system("tail -20 test-stderr");
3923           print "===================\n";
3924           print "... continue forced\n";
3925           }
3926
3927         last if /^[rc]$/i;
3928         if (/^e$/i)
3929           {
3930           system("$more test-stderr");
3931           }
3932         elsif (/^o$/i)
3933           {
3934           system("$more test-stdout");
3935           }
3936         }
3937
3938       $retry = 1 if /^r$/i;
3939       $docheck = 0;
3940       }
3941
3942     # If the command was exim, and a listening server is running, we can now
3943     # close its input, which causes us to wait for it to finish, which is why
3944     # we didn't close it earlier.
3945
3946     if ($rc == 2 && $server_pid != 0)
3947       {
3948       close SERVERCMD;
3949       $server_pid = 0;
3950       if ($? != 0)
3951         {
3952         if (($? & 0xff) == 0)
3953           { printf("Server return code %d for test %d starting line %d", $?/256,
3954                 $testno, $subtest_startline); }
3955         elsif (($? & 0xff00) == 0)
3956           { printf("Server killed by signal %d", $? & 255); }
3957         else
3958           { printf("Server status %x", $?); }
3959
3960         for (;;)
3961           {
3962           print "\nShow server stdout, Retry, Continue, or Quit? [Q] ";
3963           $_ = $force_continue ? "c" : <T>;
3964           tests_exit(1) if /^q?$/i;
3965           if (/^c$/ && $force_continue) {
3966             log_failure($log_failed_filename, $testno, "exit code unexpected");
3967             log_test($log_summary_filename, $testno, 'F')
3968           }
3969           print "... continue forced\n" if $force_continue;
3970           last if /^[rc]$/i;
3971
3972           if (/^s$/i)
3973             {
3974             open(S, "test-stdout-server") ||
3975               tests_exit(-1, "Failed to open test-stdout-server: $!");
3976             print while <S>;
3977             close(S);
3978             }
3979           }
3980         $retry = 1 if /^r$/i;
3981         }
3982       }
3983     }
3984
3985   close SCRIPT;
3986
3987   # The script has finished. Check the all the output that was generated. The
3988   # function returns 0 for a perfect pass, 1 if imperfect but ok, 2 if we should
3989   # rerun the test (the files # have been updated).
3990   # It does not return if the user responds Q to a prompt.
3991
3992   if ($retry)
3993     {
3994     $retry = '0';
3995     print (("#" x 79) . "\n");
3996     redo;
3997     }
3998
3999   if ($docheck)
4000     {
4001     my $rc = check_output($TEST_STATE->{munge});
4002     log_test($log_summary_filename, $testno, 'P') if ($rc == 0);
4003     if ($rc < 2)
4004       {
4005       print ("  Script completed\n");
4006       }
4007     else
4008       {
4009       print (("#" x 79) . "\n");
4010       redo;
4011       }
4012     }
4013   }
4014
4015
4016 ##################################################
4017 #         Exit from the test script              #
4018 ##################################################
4019
4020 tests_exit(-1, "No runnable tests selected") if @test_list == 0;
4021 tests_exit(0);
4022
4023 # End of runtest script