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