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