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