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