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