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