test/runtest

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