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