test/runtest

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