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