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