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