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