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