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