test/runtest

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