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