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