test/runtest

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