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