test/runtest

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