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