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