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