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