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/(^|\W)\K\Q$parm_ipv6\E/ip6:ip6:ip6:ip6:ip6:ip6:ip6:ip6/g;
 564   s/\b\Q$parm_ipv4r\E\b/ip4-reverse/g;
 565   s/(^|\W)\K\Q$parm_ipv6r\E/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   # ========= Exim lookups ==================
 691   # Lookups have a char which depends on the number of lookup types compiled in,
 692   # in stderr output.  Replace with a "0".  Recognising this while avoiding
 693   # other output is fragile; perhaps the debug output should be revised instead.
 694   s%(?<!sqlite)(?<!lsearch\*@)(?<!lsearch\*)(?<!lsearch)[0-?]TESTSUITE/aux-fixed/%0TESTSUITE/aux-fixed/%g;
 695
 696   # ==========================================================
 697   # Some munging is specific to the specific file types
 698
 699   # ======== stdout ========
 700
 701   if ($is_stdout)
 702     {
 703     # Skip translate_ip_address and use_classresources in -bP output because
 704     # they aren't always there.
 705
 706     next if /translate_ip_address =/;
 707     next if /use_classresources/;
 708
 709     # In certain filter tests, remove initial filter lines because they just
 710     # clog up by repetition.
 711
 712     if ($rmfiltertest)
 713       {
 714       next if /^(Sender\staken\sfrom|
 715                  Return-path\scopied\sfrom|
 716                  Sender\s+=|
 717                  Recipient\s+=)/x;
 718       if (/^Testing \S+ filter/)
 719         {
 720         $_ = <IN>;    # remove blank line
 721         next;
 722         }
 723       }
 724     }
 725
 726   # ======== stderr ========
 727
 728   elsif ($is_stderr)
 729     {
 730     # The very first line of debugging output will vary
 731
 732     s/^Exim version .*/Exim version x.yz ..../;
 733
 734     # Debugging lines for Exim terminations
 735
 736     s/(?<=^>>>>>>>>>>>>>>>> Exim pid=)\d+(?= terminating)/pppp/;
 737
 738     # IP address lookups use gethostbyname() when IPv6 is not supported,
 739     # and gethostbyname2() or getipnodebyname() when it is.
 740
 741     s/\bgethostbyname2?|\bgetipnodebyname/get[host|ipnode]byname[2]/;
 742
 743     # drop gnutls version strings
 744     next if /GnuTLS compile-time version: \d+[\.\d]+$/;
 745     next if /GnuTLS runtime version: \d+[\.\d]+$/;
 746
 747     # drop openssl version strings
 748     next if /OpenSSL compile-time version: OpenSSL \d+[\.\da-z]+/;
 749     next if /OpenSSL runtime version: OpenSSL \d+[\.\da-z]+/;
 750
 751     # drop lookups
 752     next if /^Lookups \(built-in\):/;
 753     next if /^Loading lookup modules from/;
 754     next if /^Loaded \d+ lookup modules/;
 755     next if /^Total \d+ lookups/;
 756
 757     # drop compiler information
 758     next if /^Compiler:/;
 759
 760     # and the ugly bit
 761     # different libraries will have different numbers (possibly 0) of follow-up
 762     # lines, indenting with more data
 763     if (/^Library version:/) {
 764       while (1) {
 765         $_ = <IN>;
 766         next if /^\s/;
 767         goto RESET_AFTER_EXTRA_LINE_READ;
 768       }
 769     }
 770
 771     # drop other build-time controls emitted for debugging
 772     next if /^WHITELIST_D_MACROS:/;
 773     next if /^TRUSTED_CONFIG_LIST:/;
 774
 775     # As of Exim 4.74, we log when a setgid fails; because we invoke Exim
 776     # with -be, privileges will have been dropped, so this will always
 777     # be the case
 778     next if /^changing group to \d+ failed: Operation not permitted/;
 779
 780     # We invoke Exim with -D, so we hit this new messag as of Exim 4.73:
 781     next if /^macros_trusted overridden to true by whitelisting/;
 782
 783     # We have to omit the localhost ::1 address so that all is well in
 784     # the IPv4-only case.
 785
 786     print MUNGED "MUNGED: ::1 will be omitted in what follows\n"
 787       if (/looked up these IP addresses/);
 788     next if /name=localhost address=::1/;
 789
 790     # drop pdkim debugging header
 791     next if /^PDKIM <<<<<<<<<<<<<<<<<<<<<<<<<<<<<+$/;
 792
 793     # Various other IPv6 lines must be omitted too
 794
 795     next if /using host_fake_gethostbyname for \S+ \(IPv6\)/;
 796     next if /get\[host\|ipnode\]byname\[2\]\(af=inet6\)/;
 797     next if /DNS lookup of \S+ \(AAAA\) using fakens/;
 798     next if / in dns_ipv4_lookup?/;
 799
 800     if (/DNS lookup of \S+ \(AAAA\) gave NO_DATA/)
 801       {
 802       $_= <IN>;     # Gets "returning DNS_NODATA"
 803       next;
 804       }
 805
 806     # Skip tls_advertise_hosts and hosts_require_tls checks when the options
 807     # are unset, because tls ain't always there.
 808
 809     next if /in\s(?:tls_advertise_hosts\?|hosts_require_tls\?)
 810                 \sno\s\(option\sunset\)/x;
 811
 812     # Skip auxiliary group lists because they will vary.
 813
 814     next if /auxiliary group list:/;
 815
 816     # Skip "extracted from gecos field" because the gecos field varies
 817
 818     next if /extracted from gecos field/;
 819
 820     # Skip "waiting for data on socket" and "read response data: size=" lines
 821     # because some systems pack more stuff into packets than others.
 822
 823     next if /waiting for data on socket/;
 824     next if /read response data: size=/;
 825
 826     # If Exim is compiled with readline support but it can't find the library
 827     # to load, there will be an extra debug line. Omit it.
 828
 829     next if /failed to load readline:/;
 830
 831     # Some DBM libraries seem to make DBM files on opening with O_RDWR without
 832     # O_CREAT; other's don't. In the latter case there is some debugging output
 833     # which is not present in the former. Skip the relevant lines (there are
 834     # two of them).
 835
 836     if (/TESTSUITE\/spool\/db\/\S+ appears not to exist: trying to create/)
 837       {
 838       $_ = <IN>;
 839       next;
 840       }
 841
 842     # Some tests turn on +expand debugging to check on expansions.
 843     # Unfortunately, the Received: expansion varies, depending on whether TLS
 844     # is compiled or not. So we must remove the relevant debugging if it is.
 845
 846     if (/^condition: def:tls_cipher/)
 847       {
 848       while (<IN>) { last if /^condition: def:sender_address/; }
 849       }
 850     elsif (/^expanding: Received: /)
 851       {
 852       while (<IN>) { last if !/^\s/; }
 853       }
 854
 855     # When Exim is checking the size of directories for maildir, it uses
 856     # the check_dir_size() function to scan directories. Of course, the order
 857     # of the files that are obtained using readdir() varies from system to
 858     # system. We therefore buffer up debugging lines from check_dir_size()
 859     # and sort them before outputting them.
 860
 861     if (/^check_dir_size:/ || /^skipping TESTSUITE\/test-mail\//)
 862       {
 863       push @saved, $_;
 864       }
 865     else
 866       {
 867       if (@saved > 0)
 868         {
 869         print MUNGED "MUNGED: the check_dir_size lines have been sorted " .
 870           "to ensure consistency\n";
 871         @saved = sort(@saved);
 872         print MUNGED @saved;
 873         @saved = ();
 874         }
 875
 876       # Skip some lines that Exim puts out at the start of debugging output
 877       # because they will be different in different binaries.
 878
 879       print MUNGED
 880         unless (/^Berkeley DB: / ||
 881                 /^Probably (?:Berkeley DB|ndbm|GDBM)/ ||
 882                 /^Authenticators:/ ||
 883                 /^Lookups:/ ||
 884                 /^Support for:/ ||
 885                 /^Routers:/ ||
 886                 /^Transports:/ ||
 887                 /^log selectors =/ ||
 888                 /^cwd=/ ||
 889                 /^Fixed never_users:/ ||
 890                 /^Size of off_t:/
 891                 );
 892       }
 893
 894     next;
 895     }
 896
 897   # ======== All files other than stderr ========
 898
 899   print MUNGED;
 900   }
 901
 902 close(IN);
 903 return $yield;
 904 }
 905
 906
 907
 908
 909 ##################################################
 910 #        Subroutine to interact with caller      #
 911 ##################################################
 912
 913 # Arguments: [0] the prompt string
 914 #            [1] if there is a U in the prompt and $force_update is true
 915 # Returns:   nothing (it sets $_)
 916
 917 sub interact{
 918 print $_[0];
 919 if ($_[1]) { $_ = "u"; print "... update forced\n"; }
 920   else { $_ = <T>; }
 921 }
 922
 923
 924
 925
 926 ##################################################
 927 #    Subroutine to compare one output file       #
 928 ##################################################
 929
 930 # When an Exim server is part of the test, its output is in separate files from
 931 # an Exim client. The server data is concatenated with the client data as part
 932 # of the munging operation.
 933 #
 934 # Arguments:  [0] the name of the main raw output file
 935 #             [1] the name of the server raw output file or undef
 936 #             [2] where to put the munged copy
 937 #             [3] the name of the saved file
 938 #             [4] TRUE if this is a log file whose deliveries must be sorted
 939 #
 940 # Returns:    0 comparison succeeded or differences to be ignored
 941 #             1 comparison failed; files were updated (=> re-compare)
 942 #
 943 # Does not return if the user replies "Q" to a prompt.
 944
 945 sub check_file{
 946 my($rf,$rsf,$mf,$sf,$sortfile) = @_;
 947
 948 # If there is no saved file, the raw files must either not exist, or be
 949 # empty. The test ! -s is TRUE if the file does not exist or is empty.
 950
 951 if (! -e $sf)
 952   {
 953   return 0 if (! -s $rf && (! defined $rsf || ! -s $rsf));
 954
 955   print "\n";
 956   print "** $rf is not empty\n" if (-s $rf);
 957   print "** $rsf is not empty\n" if (defined $rsf && -s $rsf);
 958
 959   for (;;)
 960     {
 961     print "Continue, Show, or Quit? [Q] ";
 962     $_ = <T>;
 963     tests_exit(1) if /^q?$/i;
 964     return 0 if /^c$/i;
 965     last if (/^s$/);
 966     }
 967
 968   foreach $f ($rf, $rsf)
 969     {
 970     if (defined $f && -s $f)
 971       {
 972       print "\n";
 973       print "------------ $f -----------\n"
 974         if (defined $rf && -s $rf && defined $rsf && -s $rsf);
 975       system("$more '$f'");
 976       }
 977     }
 978
 979   print "\n";
 980   for (;;)
 981     {
 982     interact("Continue, Update & retry, Quit? [Q] ", $force_update);
 983     tests_exit(1) if /^q?$/i;
 984     return 0 if /^c$/i;
 985     last if (/^u$/i);
 986     }
 987   }
 988
 989 # Control reaches here if either (a) there is a saved file ($sf), or (b) there
 990 # was a request to create a saved file. First, create the munged file from any
 991 # data that does exist.
 992
 993 open(MUNGED, ">$mf") || tests_exit(-1, "Failed to open $mf: $!");
 994 my($truncated) = munge($rf) if -e $rf;
 995 if (defined $rsf && -e $rsf)
 996   {
 997   print MUNGED "\n******** SERVER ********\n";
 998   $truncated |= munge($rsf);
 999   }
1000 close(MUNGED);
1001
1002 # If a saved file exists, do the comparison. There are two awkward cases:
1003 #
1004 # If "*** truncated ***" was found in the new file, it means that a log line
1005 # was overlong, and truncated. The problem is that it may be truncated at
1006 # different points on different systems, because of different user name
1007 # lengths. We reload the file and the saved file, and remove lines from the new
1008 # file that precede "*** truncated ***" until we reach one that matches the
1009 # line that precedes it in the saved file.
1010 #
1011 # If $sortfile is set, we are dealing with a mainlog file where the deliveries
1012 # for an individual message might vary in their order from system to system, as
1013 # a result of parallel deliveries. We load the munged file and sort sequences
1014 # of delivery lines.
1015
1016 if (-e $sf)
1017   {
1018   # Deal with truncated text items
1019
1020   if ($truncated)
1021     {
1022     my(@munged, @saved, $i, $j, $k);
1023
1024     open(MUNGED, "$mf") || tests_exit(-1, "Failed to open $mf: $!");
1025     @munged = <MUNGED>;
1026     close(MUNGED);
1027     open(SAVED, "$sf") || tests_exit(-1, "Failed to open $sf: $!");
1028     @saved = <SAVED>;
1029     close(SAVED);
1030
1031     $j = 0;
1032     for ($i = 0; $i < @munged; $i++)
1033       {
1034       if ($munged[$i] =~ /\*\*\* truncated \*\*\*/)
1035         {
1036         for (; $j < @saved; $j++)
1037           { last if $saved[$j] =~ /\*\*\* truncated \*\*\*/; }
1038         last if $j >= @saved;     # not found in saved
1039
1040         for ($k = $i - 1; $k >= 0; $k--)
1041           { last if $munged[$k] eq $saved[$j - 1]; }
1042
1043         last if $k <= 0;          # failed to find previous match
1044         splice @munged, $k + 1, $i - $k - 1;
1045         $i = $k + 1;
1046         }
1047       }
1048
1049     open(MUNGED, ">$mf") || tests_exit(-1, "Failed to open $mf: $!");
1050     for ($i = 0; $i < @munged; $i++)
1051       { print MUNGED $munged[$i]; }
1052     close(MUNGED);
1053     }
1054
1055   # Deal with log sorting
1056
1057   if ($sortfile)
1058     {
1059     my(@munged, $i, $j);
1060
1061     open(MUNGED, "$mf") || tests_exit(-1, "Failed to open $mf: $!");
1062     @munged = <MUNGED>;
1063     close(MUNGED);
1064
1065     for ($i = 0; $i < @munged; $i++)
1066       {
1067       if ($munged[$i] =~ /^[-\d]{10}\s[:\d]{8}\s[-A-Za-z\d]{16}\s[-=*]>/)
1068         {
1069         for ($j = $i + 1; $j < @munged; $j++)
1070           {
1071           last if $munged[$j] !~
1072             /^[-\d]{10}\s[:\d]{8}\s[-A-Za-z\d]{16}\s[-=*]>/;
1073           }
1074         @temp = splice(@munged, $i, $j - $i);
1075         @temp = sort(@temp);
1076         splice(@munged, $i, 0, @temp);
1077         }
1078       }
1079
1080     open(MUNGED, ">$mf") || tests_exit(-1, "Failed to open $mf: $!");
1081     print MUNGED "**NOTE: The delivery lines in this file have been sorted.\n";
1082     for ($i = 0; $i < @munged; $i++)
1083       { print MUNGED $munged[$i]; }
1084     close(MUNGED);
1085     }
1086
1087   # Do the comparison
1088
1089   return 0 if (system("$cf '$mf' '$sf' >test-cf") == 0);
1090
1091   # Handle comparison failure
1092
1093   print "** Comparison of $mf with $sf failed";
1094   system("$more test-cf");
1095
1096   print "\n";
1097   for (;;)
1098     {
1099     interact("Continue, Update & retry, Quit? [Q] ", $force_update);
1100     tests_exit(1) if /^q?$/i;
1101     return 0 if /^c$/i;
1102     last if (/^u$/i);
1103     }
1104   }
1105
1106 # Update or delete the saved file, and give the appropriate return code.
1107
1108 if (-s $mf)
1109   { tests_exit(-1, "Failed to cp $mf $sf") if system("cp '$mf' '$sf'") != 0; }
1110 else
1111   { tests_exit(-1, "Failed to unlink $sf") if !unlink($sf); }
1112
1113 return 1;
1114 }
1115
1116
1117
1118 ##################################################
1119 #    Subroutine to check the output of a test    #
1120 ##################################################
1121
1122 # This function is called when the series of subtests is complete. It makes
1123 # use of check() file, whose arguments are:
1124 #
1125 #  [0] the name of the main raw output file
1126 #  [1] the name of the server raw output file or undef
1127 #  [2] where to put the munged copy
1128 #  [3] the name of the saved file
1129 #  [4] TRUE if this is a log file whose deliveries must be sorted
1130 #
1131 # Arguments: none
1132 # Returns:   0 if the output compared equal
1133 #            1 if files were updated and the test must be re-run
1134
1135 sub check_output{
1136 my($yield) = 0;
1137
1138 $yield = 1 if check_file("spool/log/paniclog",
1139                        "spool/log/serverpaniclog",
1140                        "test-paniclog-munged",
1141                        "paniclog/$testno", 0);
1142
1143 $yield = 1 if check_file("spool/log/rejectlog",
1144                        "spool/log/serverrejectlog",
1145                        "test-rejectlog-munged",
1146                        "rejectlog/$testno", 0);
1147
1148 $yield = 1 if check_file("spool/log/mainlog",
1149                        "spool/log/servermainlog",
1150                        "test-mainlog-munged",
1151                        "log/$testno", $sortlog);
1152
1153 if (!$stdout_skip)
1154   {
1155   $yield = 1 if check_file("test-stdout",
1156                        "test-stdout-server",
1157                        "test-stdout-munged",
1158                        "stdout/$testno", 0);
1159   }
1160
1161 if (!$stderr_skip)
1162   {
1163   $yield = 1 if check_file("test-stderr",
1164                        "test-stderr-server",
1165                        "test-stderr-munged",
1166                        "stderr/$testno", 0);
1167   }
1168
1169 # Compare any delivered messages, unless this test is skipped.
1170
1171 if (! $message_skip)
1172   {
1173   my($msgno) = 0;
1174
1175   # Get a list of expected mailbox files for this script. We don't bother with
1176   # directories, just the files within them.
1177
1178   foreach $oldmail (@oldmails)
1179     {
1180     next unless $oldmail =~ /^mail\/$testno\./;
1181     print ">> EXPECT $oldmail\n" if $debug;
1182     $expected_mails{$oldmail} = 1;
1183     }
1184
1185   # If there are any files in test-mail, compare them. Note that "." and
1186   # ".." are automatically omitted by list_files_below().
1187
1188   @mails = list_files_below("test-mail");
1189
1190   foreach $mail (@mails)
1191     {
1192     next if $mail eq "test-mail/oncelog";
1193
1194     $saved_mail = substr($mail, 10);               # Remove "test-mail/"
1195     $saved_mail =~ s/^$parm_caller(\/|$)/CALLER/;  # Convert caller name
1196
1197     if ($saved_mail =~ /(\d+\.[^.]+\.)/)
1198       {
1199       $msgno++;
1200       $saved_mail =~ s/(\d+\.[^.]+\.)/$msgno./gx;
1201       }
1202
1203     print ">> COMPARE $mail mail/$testno.$saved_mail\n" if $debug;
1204     $yield = 1 if check_file($mail, undef, "test-mail-munged",
1205       "mail/$testno.$saved_mail", 0);
1206     delete $expected_mails{"mail/$testno.$saved_mail"};
1207     }
1208
1209   # Complain if not all expected mails have been found
1210
1211   if (scalar(keys %expected_mails) != 0)
1212     {
1213     foreach $key (keys %expected_mails)
1214       { print "** no test file found for $key\n"; }
1215
1216     for (;;)
1217       {
1218       interact("Continue, Update & retry, or Quit? [Q] ", $force_update);
1219       tests_exit(1) if /^q?$/i;
1220       last if /^c$/i;
1221
1222       # For update, we not only have to unlink the file, but we must also
1223       # remove it from the @oldmails vector, as otherwise it will still be
1224       # checked for when we re-run the test.
1225
1226       if (/^u$/i)
1227         {
1228         foreach $key (keys %expected_mails)
1229           {
1230           my($i);
1231           tests_exit(-1, "Failed to unlink $key") if !unlink("$key");
1232           for ($i = 0; $i < @oldmails; $i++)
1233             {
1234             if ($oldmails[$i] eq $key)
1235               {
1236               splice @oldmails, $i, 1;
1237               last;
1238               }
1239             }
1240           }
1241         last;
1242         }
1243       }
1244     }
1245   }
1246
1247 # Compare any remaining message logs, unless this test is skipped.
1248
1249 if (! $msglog_skip)
1250   {
1251   # Get a list of expected msglog files for this test
1252
1253   foreach $oldmsglog (@oldmsglogs)
1254     {
1255     next unless $oldmsglog =~ /^$testno\./;
1256     $expected_msglogs{$oldmsglog} = 1;
1257     }
1258
1259   # If there are any files in spool/msglog, compare them. However, we have
1260   # to munge the file names because they are message ids, which are
1261   # time dependent.
1262
1263   if (opendir(DIR, "spool/msglog"))
1264     {
1265     @msglogs = sort readdir(DIR);
1266     closedir(DIR);
1267
1268     foreach $msglog (@msglogs)
1269       {
1270       next if ($msglog eq "." || $msglog eq ".." || $msglog eq "CVS");
1271       ($munged_msglog = $msglog) =~
1272         s/((?:[^\W_]{6}-){2}[^\W_]{2})
1273           /new_value($1, "10Hm%s-0005vi-00", \$next_msgid)/egx;
1274       $yield = 1 if check_file("spool/msglog/$msglog", undef,
1275         "test-msglog-munged", "msglog/$testno.$munged_msglog", 0);
1276       delete $expected_msglogs{"$testno.$munged_msglog"};
1277       }
1278     }
1279
1280   # Complain if not all expected msglogs have been found
1281
1282   if (scalar(keys %expected_msglogs) != 0)
1283     {
1284     foreach $key (keys %expected_msglogs)
1285       {
1286       print "** no test msglog found for msglog/$key\n";
1287       ($msgid) = $key =~ /^\d+\.(.*)$/;
1288       foreach $cachekey (keys %cache)
1289         {
1290         if ($cache{$cachekey} eq $msgid)
1291           {
1292           print "** original msgid $cachekey\n";
1293           last;
1294           }
1295         }
1296       }
1297
1298     for (;;)
1299       {
1300       interact("Continue, Update, or Quit? [Q] ", $force_update);
1301       tests_exit(1) if /^q?$/i;
1302       last if /^c$/i;
1303       if (/^u$/i)
1304         {
1305         foreach $key (keys %expected_msglogs)
1306           {
1307           tests_exit(-1, "Failed to unlink msglog/$key")
1308             if !unlink("msglog/$key");
1309           }
1310         last;
1311         }
1312       }
1313     }
1314   }
1315
1316 return $yield;
1317 }
1318
1319
1320
1321 ##################################################
1322 #     Subroutine to run one "system" command     #
1323 ##################################################
1324
1325 # We put this in a subroutine so that the command can be reflected when
1326 # debugging.
1327 #
1328 # Argument: the command to be run
1329 # Returns:  nothing
1330
1331 sub run_system {
1332 my($cmd) = $_[0];
1333 if ($debug)
1334   {
1335   my($prcmd) = $cmd;
1336   $prcmd =~ s/; /;\n>> /;
1337   print ">> $prcmd\n";
1338   }
1339 system("$cmd");
1340 }
1341
1342
1343
1344 ##################################################
1345 #      Subroutine to run one script command      #
1346 ##################################################
1347
1348 # The <SCRIPT> file is open for us to read an optional return code line,
1349 # followed by the command line and any following data lines for stdin. The
1350 # command line can be continued by the use of \. Data lines are not continued
1351 # in this way. In all lines, the following substutions are made:
1352 #
1353 # DIR    => the current directory
1354 # CALLER => the caller of this script
1355 #
1356 # Arguments: the current test number
1357 #            reference to the subtest number, holding previous value
1358 #            reference to the expected return code value
1359 #            reference to where to put the command name (for messages)
1360 #
1361 # Returns:   0 the commmand was executed inline, no subprocess was run
1362 #            1 a non-exim command was run and waited for
1363 #            2 an exim command was run and waited for
1364 #            3 a command was run and not waited for (daemon, server, exim_lock)
1365 #            4 EOF was encountered after an initial return code line
1366
1367 sub run_command{
1368 my($testno) = $_[0];
1369 my($subtestref) = $_[1];
1370 my($commandnameref) = $_[3];
1371 my($yield) = 1;
1372
1373 if (/^(\d+)\s*$/)                # Handle unusual return code
1374   {
1375   my($r) = $_[2];
1376   $$r = $1 << 8;
1377   $_ = <SCRIPT>;
1378   return 4 if !defined $_;       # Missing command
1379   $lineno++;
1380   }
1381
1382 chomp;
1383 $wait_time = 0;
1384
1385 # Handle concatenated command lines
1386
1387 s/\s+$//;
1388 while (substr($_, -1) eq"\\")
1389   {
1390   my($temp);
1391   $_ = substr($_, 0, -1);
1392   chomp($temp = <SCRIPT>);
1393   if (defined $temp)
1394     {
1395     $lineno++;
1396     $temp =~ s/\s+$//;
1397     $temp =~ s/^\s+//;
1398     $_ .= $temp;
1399     }
1400   }
1401
1402 # Do substitutions
1403
1404 do_substitute($testno);
1405 if ($debug) { printf ">> $_\n"; }
1406
1407 # Pass back the command name (for messages)
1408
1409 ($$commandnameref) = /^(\S+)/;
1410
1411 # Here follows code for handling the various different commands that are
1412 # supported by this script. The first group of commands are all freestanding
1413 # in that they share no common code and are not followed by any data lines.
1414
1415
1416 ###################
1417 ###################
1418
1419 # The "dbmbuild" command runs exim_dbmbuild. This is used both to test the
1420 # utility and to make DBM files for testing DBM lookups.
1421
1422 if (/^dbmbuild\s+(\S+)\s+(\S+)/)
1423   {
1424   run_system("(./eximdir/exim_dbmbuild $parm_cwd/$1 $parm_cwd/$2;" .
1425          "echo exim_dbmbuild exit code = \$?)" .
1426          ">>test-stdout");
1427   return 1;
1428   }
1429
1430
1431 # The "dump" command runs exim_dumpdb. On different systems, the output for
1432 # some types of dump may appear in a different order because it's just hauled
1433 # out of the DBM file. We can solve this by sorting. Ignore the leading
1434 # date/time, as it will be flattened later during munging.
1435
1436 if (/^dump\s+(\S+)/)
1437   {
1438   my($which) = $1;
1439   my(@temp);
1440   print ">> ./eximdir/exim_dumpdb $parm_cwd/spool $which\n" if $debug;
1441   open(IN, "./eximdir/exim_dumpdb $parm_cwd/spool $which |");
1442   @temp = <IN>;
1443   close(IN);
1444   if ($which eq "callout")
1445     {
1446     @temp = sort {
1447                  my($aa) = substr $a, 21;
1448                  my($bb) = substr $b, 21;
1449                  return $aa cmp $bb;
1450                  } @temp;
1451     }
1452   open(OUT, ">>test-stdout");
1453   print OUT "+++++++++++++++++++++++++++\n";
1454   print OUT @temp;
1455   close(OUT);
1456   return 1;
1457   }
1458
1459
1460 # The "echo" command is a way of writing comments to the screen.
1461
1462 if (/^echo\s+(.*)$/)
1463   {
1464   print "$1\n";
1465   return 0;
1466   }
1467
1468
1469 # The "exim_lock" command runs exim_lock in the same manner as "server",
1470 # but it doesn't use any input.
1471
1472 if (/^exim_lock\s+(.*)$/)
1473   {
1474   $cmd = "./eximdir/exim_lock $1 >>test-stdout";
1475   $server_pid = open SERVERCMD, "|$cmd" ||
1476     tests_exit(-1, "Failed to run $cmd\n");
1477
1478   # This gives the process time to get started; otherwise the next
1479   # process may not find it there when it expects it.
1480
1481   select(undef, undef, undef, 0.1);
1482   return 3;
1483   }
1484
1485
1486 # The "exinext" command runs exinext
1487
1488 if (/^exinext\s+(.*)/)
1489   {
1490   run_system("(./eximdir/exinext " .
1491     "-DEXIM_PATH=$parm_cwd/eximdir/exim " .
1492     "-C $parm_cwd/test-config $1;" .
1493     "echo exinext exit code = \$?)" .
1494     ">>test-stdout");
1495   return 1;
1496   }
1497
1498
1499 # The "exigrep" command runs exigrep on the current mainlog
1500
1501 if (/^exigrep\s+(.*)/)
1502   {
1503   run_system("(./eximdir/exigrep " .
1504     "$1 $parm_cwd/spool/log/mainlog;" .
1505     "echo exigrep exit code = \$?)" .
1506     ">>test-stdout");
1507   return 1;
1508   }
1509
1510
1511 # The "eximstats" command runs eximstats on the current mainlog
1512
1513 if (/^eximstats\s+(.*)/)
1514   {
1515   run_system("(./eximdir/eximstats " .
1516     "$1 $parm_cwd/spool/log/mainlog;" .
1517     "echo eximstats exit code = \$?)" .
1518     ">>test-stdout");
1519   return 1;
1520   }
1521
1522
1523 # The "gnutls" command makes a copy of saved GnuTLS parameter data in the
1524 # spool directory, to save Exim from re-creating it each time.
1525
1526 if (/^gnutls/)
1527   {
1528   run_system "sudo cp -p aux-fixed/gnutls-params spool/gnutls-params;" .
1529          "sudo chown $parm_eximuser:$parm_eximgroup spool/gnutls-params;" .
1530          "sudo chmod 0400 spool/gnutls-params";
1531   return 1;
1532   }
1533
1534
1535 # The "killdaemon" command should ultimately follow the starting of any Exim
1536 # daemon with the -bd option. We kill with SIGINT rather than SIGTERM to stop
1537 # it outputting "Terminated" to the terminal when not in the background.
1538
1539 if (/^killdaemon/)
1540   {
1541   $pid = `cat $parm_cwd/spool/exim-daemon.*`;
1542   run_system("sudo /bin/kill -SIGINT $pid");
1543   close DAEMONCMD;                                   # Waits for process
1544   run_system("sudo /bin/rm -f spool/exim-daemon.*");
1545   return 1;
1546   }
1547
1548
1549 # The "millisleep" command is like "sleep" except that its argument is in
1550 # milliseconds, thus allowing for a subsecond sleep, which is, in fact, all it
1551 # is used for.
1552
1553 elsif (/^millisleep\s+(.*)$/)
1554   {
1555   select(undef, undef, undef, $1/1000);
1556   return 0;
1557   }
1558
1559
1560 # The "sleep" command does just that. For sleeps longer than 1 second we
1561 # tell the user what's going on.
1562
1563 if (/^sleep\s+(.*)$/)
1564   {
1565   if ($1 == 1)
1566     {
1567     sleep(1);
1568     }
1569   else
1570     {
1571     printf("  Test %d sleep $1 ", $$subtestref);
1572     for (1..$1)
1573       {
1574       print ".";
1575       sleep(1);
1576       }
1577     printf("\r  Test %d                            $cr", $$subtestref);
1578     }
1579   return 0;
1580   }
1581
1582
1583 # Various Unix management commands are recognized
1584
1585 if (/^(ln|ls|du|mkdir|mkfifo|touch|cp|cat)\s/ ||
1586     /^sudo (rmdir|rm|chown|chmod)\s/)
1587   {
1588   run_system("$_ >>test-stdout 2>>test-stderr");
1589   return 1;
1590   }
1591
1592
1593
1594 ###################
1595 ###################
1596
1597 # The next group of commands are also freestanding, but they are all followed
1598 # by data lines.
1599
1600
1601 # The "server" command starts up a script-driven server that runs in parallel
1602 # with the following exim command. Therefore, we want to run a subprocess and
1603 # not yet wait for it to complete. The waiting happens after the next exim
1604 # command, triggered by $server_pid being non-zero. The server sends its output
1605 # to a different file. The variable $server_opts, if not empty, contains
1606 # options to disable IPv4 or IPv6 if necessary.
1607
1608 if (/^server\s+(.*)$/)
1609   {
1610   $cmd = "./bin/server $server_opts $1 >>test-stdout-server";
1611   print ">> $cmd\n" if ($debug);
1612   $server_pid = open SERVERCMD, "|$cmd" || tests_exit(-1, "Failed to run $cmd");
1613   SERVERCMD->autoflush(1);
1614   print ">> Server pid is $server_pid\n" if $debug;
1615   while (<SCRIPT>)
1616     {
1617     $lineno++;
1618     last if /^\*{4}\s*$/;
1619     print SERVERCMD;
1620     }
1621   print SERVERCMD "++++\n"; # Send end to server; can't send EOF yet
1622                             # because close() waits for the process.
1623
1624   # This gives the server time to get started; otherwise the next
1625   # process may not find it there when it expects it.
1626
1627   select(undef, undef, undef, 0.5);
1628   return 3;
1629   }
1630
1631
1632 # The "write" command is a way of creating files of specific sizes for
1633 # buffering tests, or containing specific data lines from within the script
1634 # (rather than hold lots of little files). The "catwrite" command does the
1635 # same, but it also copies the lines to test-stdout.
1636
1637 if (/^(cat)?write\s+(\S+)(?:\s+(.*))?\s*$/)
1638   {
1639   my($cat) = defined $1;
1640   @sizes = ();
1641   @sizes = split /\s+/, $3 if defined $3;
1642   open FILE, ">$2" || tests_exit(-1, "Failed to open \"$2\": $!");
1643
1644   if ($cat)
1645     {
1646     open CAT, ">>test-stdout" ||
1647       tests_exit(-1, "Failed to open test-stdout: $!");
1648     print CAT "==========\n";
1649     }
1650
1651   if (scalar @sizes > 0)
1652     {
1653     # Pre-data
1654
1655     while (<SCRIPT>)
1656       {
1657       $lineno++;
1658       last if /^\+{4}\s*$/;
1659       print FILE;
1660       print CAT if $cat;
1661       }
1662
1663     # Sized data
1664
1665     while (scalar @sizes > 0)
1666       {
1667       ($count,$len,$leadin) = (shift @sizes) =~ /(\d+)x(\d+)(?:=(.*))?/;
1668       $leadin = "" if !defined $leadin;
1669       $leadin =~ s/_/ /g;
1670       $len -= length($leadin) + 1;
1671       while ($count-- > 0)
1672         {
1673         print FILE $leadin, "a" x $len, "\n";
1674         print CAT $leadin, "a" x $len, "\n" if $cat;
1675         }
1676       }
1677     }
1678
1679   # Post data, or only data if no sized data
1680
1681   while (<SCRIPT>)
1682     {
1683     $lineno++;
1684     last if /^\*{4}\s*$/;
1685     print FILE;
1686     print CAT if $cat;
1687     }
1688   close FILE;
1689
1690   if ($cat)
1691     {
1692     print CAT "==========\n";
1693     close CAT;
1694     }
1695
1696   return 0;
1697   }
1698
1699
1700 ###################
1701 ###################
1702
1703 # From this point on, script commands are implemented by setting up a shell
1704 # command in the variable $cmd. Shared code to run this command and handle its
1705 # input and output follows.
1706
1707 # The "client", "client-gnutls", and "client-ssl" commands run a script-driven
1708 # program that plays the part of an email client. We also have the availability
1709 # of running Perl for doing one-off special things. Note that all these
1710 # commands expect stdin data to be supplied.
1711
1712 if (/^client/ || /^(sudo\s+)?perl\b/)
1713   {
1714   s"client"./bin/client";
1715   $cmd = "$_ >>test-stdout 2>>test-stderr";
1716   }
1717
1718 # For the "exim" command, replace the text "exim" with the path for the test
1719 # binary, plus -D options to pass over various parameters, and a -C option for
1720 # the testing configuration file. When running in the test harness, Exim does
1721 # not drop privilege when -C and -D options are present. To run the exim
1722 # command as root, we use sudo.
1723
1724 elsif (/^([A-Z_]+=\S+\s+)?(\d+)?\s*(sudo\s+)?exim(_\S+)?\s+(.*)$/)
1725   {
1726   $args = $5;
1727   my($envset) = (defined $1)? $1      : "";
1728   my($sudo)   = (defined $3)? "sudo " : "";
1729   my($special)= (defined $4)? $4      : "";
1730   $wait_time  = (defined $2)? $2      : 0;
1731
1732   # Return 2 rather than 1 afterwards
1733
1734   $yield = 2;
1735
1736   # Update the test number
1737
1738   $$subtestref = $$subtestref + 1;
1739   printf("  Test %d       $cr", $$subtestref);
1740
1741   # Copy the configuration file, making the usual substitutions.
1742
1743   open (IN, "$parm_cwd/confs/$testno") ||
1744     tests_exit(-1, "Couldn't open $parm_cwd/confs/$testno: $!\n");
1745   open (OUT, ">test-config") ||
1746     tests_exit(-1, "Couldn't open test-config: $!\n");
1747   while (<IN>)
1748     {
1749     do_substitute($testno);
1750     print OUT;
1751     }
1752   close(IN);
1753   close(OUT);
1754
1755   # The string $msg1 in args substitutes the message id of the first
1756   # message on the queue, and so on. */
1757
1758   if ($args =~ /\$msg/)
1759     {
1760     my($listcmd) = "$parm_cwd/eximdir/exim -bp " .
1761                    "-DEXIM_PATH=$parm_cwd/eximdir/exim " .
1762                    "-C $parm_cwd/test-config |";
1763     print ">> Getting queue list from:\n>>    $listcmd\n" if ($debug);
1764     open (QLIST, $listcmd) || tests_exit(-1, "Couldn't run \"exim -bp\": $!\n");
1765     my(@msglist) = ();
1766     while (<QLIST>) { push (@msglist, $1) if /^\s*\d+[smhdw]\s+\S+\s+(\S+)/; }
1767     close(QLIST);
1768
1769     # Done backwards just in case there are more than 9
1770
1771     my($i);
1772     for ($i = @msglist; $i > 0; $i--) { $args =~ s/\$msg$i/$msglist[$i-1]/g; }
1773     }
1774
1775   # If -d is specified in $optargs, remove it from $args; i.e. let
1776   # the command line for runtest override. Then run Exim.
1777
1778   $args =~ s/(?:^|\s)-d\S*// if $optargs =~ /(?:^|\s)-d/;
1779
1780   $cmd = "$envset$sudo$parm_cwd/eximdir/exim$special$optargs " .
1781          "-DEXIM_PATH=$parm_cwd/eximdir/exim$special " .
1782          "-C $parm_cwd/test-config $args " .
1783          ">>test-stdout 2>>test-stderr";
1784
1785   # If the command is starting an Exim daemon, we run it in the same
1786   # way as the "server" command above, that is, we don't want to wait
1787   # for the process to finish. That happens when "killdaemon" is obeyed later
1788   # in the script. We also send the stderr output to test-stderr-server. The
1789   # daemon has its log files put in a different place too (by configuring with
1790   # log_file_path). This requires the  directory to be set up in advance.
1791   #
1792   # There are also times when we want to run a non-daemon version of Exim
1793   # (e.g. a queue runner) with the server configuration. In this case,
1794   # we also define -DNOTDAEMON.
1795
1796   if ($cmd =~ /\s-DSERVER=server\s/ && $cmd !~ /\s-DNOTDAEMON\s/)
1797     {
1798     if ($debug) { printf ">> daemon: $cmd\n"; }
1799     run_system("sudo mkdir spool/log 2>/dev/null");
1800     run_system("sudo chown $parm_eximuser:$parm_eximgroup spool/log");
1801
1802     # Before running the command, convert the -bd option into -bdf so that an
1803     # Exim daemon doesn't double fork. This means that when we wait close
1804     # DAEMONCMD, it waits for the correct process. Also, ensure that the pid
1805     # file is written to the spool directory, in case the Exim binary was
1806     # built with PID_FILE_PATH pointing somewhere else.
1807
1808     $cmd =~ s!\s-bd\s! -bdf -oP $parm_cwd/spool/exim-daemon.pid !;
1809     print ">> |${cmd}-server\n" if ($debug);
1810     open DAEMONCMD, "|${cmd}-server" || tests_exit(-1, "Failed to run $cmd");
1811     DAEMONCMD->autoflush(1);
1812     while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; }   # Ignore any input
1813     select(undef, undef, undef, 0.3);             # Let the daemon get going
1814     return 3;                                     # Don't wait
1815     }
1816   }
1817
1818
1819 # Unknown command
1820
1821 else { tests_exit(-1, "Command unrecognized in line $lineno: $_"); }
1822
1823
1824 # Run the command, with stdin connected to a pipe, and write the stdin data
1825 # to it, with appropriate substitutions. If a line ends with \NONL\, chop off
1826 # the terminating newline (and the \NONL\). If the command contains
1827 # -DSERVER=server add "-server" to the command, where it will adjoin the name
1828 # for the stderr file. See comment above about the use of -DSERVER.
1829
1830 $stderrsuffix = ($cmd =~ /\s-DSERVER=server\s/)? "-server" : "";
1831 print ">> |${cmd}${stderrsuffix}\n" if ($debug);
1832 open CMD, "|${cmd}${stderrsuffix}" || tests_exit(1, "Failed to run $cmd");
1833
1834 CMD->autoflush(1);
1835 while (<SCRIPT>)
1836   {
1837   $lineno++;
1838   last if /^\*{4}\s*$/;
1839   do_substitute($testno);
1840   if (/^(.*)\\NONL\\\s*$/) { print CMD $1; } else { print CMD; }
1841   }
1842
1843 # For timeout tests, wait before closing the pipe; we expect a
1844 # SIGPIPE error in this case.
1845
1846 if ($wait_time > 0)
1847   {
1848   printf("  Test %d sleep $wait_time ", $$subtestref);
1849   while ($wait_time-- > 0)
1850     {
1851     print ".";
1852     sleep(1);
1853     }
1854   printf("\r  Test %d                                       $cr", $$subtestref);
1855   }
1856
1857 $sigpipehappened = 0;
1858 close CMD;                # Waits for command to finish
1859 return $yield;            # Ran command and waited
1860 }
1861
1862
1863
1864
1865 ###############################################################################
1866 ###############################################################################
1867
1868 # Here beginneth the Main Program ...
1869
1870 ###############################################################################
1871 ###############################################################################
1872
1873
1874 autoflush STDOUT 1;
1875 print "Exim tester $testversion\n";
1876
1877
1878 ##################################################
1879 #      Some tests check created file modes       #
1880 ##################################################
1881
1882 umask 022;
1883
1884
1885 ##################################################
1886 #       Check for the "less" command             #
1887 ##################################################
1888
1889 $more = "more" if system("which less >/dev/null 2>&1") != 0;
1890
1891
1892
1893 ##################################################
1894 #        Check for sudo access to root           #
1895 ##################################################
1896
1897 print "You need to have sudo access to root to run these tests. Checking ...\n";
1898 if (system("sudo date >/dev/null") != 0)
1899   {
1900   die "** Test for sudo failed: testing abandoned.\n";
1901   }
1902 else
1903   {
1904   print "Test for sudo OK\n";
1905   }
1906
1907
1908
1909 ##################################################
1910 #      See if an Exim binary has been given      #
1911 ##################################################
1912
1913 # If the first character of the first argument is '/', the argument is taken
1914 # as the path to the binary.
1915
1916 $parm_exim = (@ARGV > 0 && $ARGV[0] =~ ?^/?)? shift @ARGV : "";
1917 print "Exim binary is $parm_exim\n" if $parm_exim ne "";
1918
1919
1920
1921 ##################################################
1922 # Sort out options and which tests are to be run #
1923 ##################################################
1924
1925 # There are a few possible options for the test script itself; after these, any
1926 # options are passed on to Exim calls within the tests. Typically, this is used
1927 # to turn on Exim debugging while setting up a test.
1928
1929 while (@ARGV > 0 && $ARGV[0] =~ /^-/)
1930   {
1931   my($arg) = shift @ARGV;
1932   if ($optargs eq "")
1933     {
1934     if ($arg eq "-DEBUG")  { $debug = 1; $cr = "\n"; next; }
1935     if ($arg eq "-DIFF")   { $cf = "diff -u"; next; }
1936     if ($arg eq "-UPDATE") { $force_update = 1; next; }
1937     if ($arg eq "-NOIPV4") { $have_ipv4 = 0; next; }
1938     if ($arg eq "-NOIPV6") { $have_ipv6 = 0; next; }
1939     if ($arg eq "-KEEP")   { $save_output = 1; next; }
1940     }
1941   $optargs .= " $arg";
1942   }
1943
1944 # Any subsequent arguments are a range of test numbers.
1945
1946 if (@ARGV > 0)
1947   {
1948   $test_end = $test_start = $ARGV[0];
1949   $test_end = $ARGV[1] if (@ARGV > 1);
1950   $test_end = ($test_start >= 9000)? $test_special_top : $test_top
1951     if $test_end eq "+";
1952   die "** Test numbers out of order\n" if ($test_end < $test_start);
1953   }
1954
1955
1956 ##################################################
1957 #      Make the command's directory current      #
1958 ##################################################
1959
1960 # After doing so, we find its absolute path name.
1961
1962 $cwd = $0;
1963 $cwd = '.' if ($cwd !~ s|/[^/]+$||);
1964 chdir($cwd) || die "** Failed to chdir to \"$cwd\": $!\n";
1965 $parm_cwd = Cwd::getcwd();
1966
1967
1968 ##################################################
1969 #     Search for an Exim binary to test          #
1970 ##################################################
1971
1972 # If an Exim binary hasn't been provided, try to find one. We can handle the
1973 # case where exim-testsuite is installed alongside Exim source directories. For
1974 # PH's private convenience, if there's a directory just called "exim4", that
1975 # takes precedence; otherwise exim-snapshot takes precedence over any numbered
1976 # releases.
1977
1978 if ($parm_exim eq "")
1979   {
1980   my($use_srcdir) = "";
1981
1982   opendir DIR, ".." || die "** Failed to opendir \"..\": $!\n";
1983   while ($f = readdir(DIR))
1984     {
1985     my($srcdir);
1986
1987     # Try this directory if it is "exim4" or if it is exim-snapshot or exim-n.m
1988     # possibly followed by -RCx where n.m is greater than any previously tried
1989     # directory. Thus, we should choose the highest version of Exim that has
1990     # been compiled.
1991
1992     if ($f eq "exim4" || $f eq "exim-snapshot")
1993       { $srcdir = $f; }
1994     else
1995       { $srcdir = $f
1996         if ($f =~ /^exim-\d+\.\d+(-RC\d+)?$/ && $f gt $use_srcdir); }
1997
1998     # Look for a build directory with a binary in it. If we find a binary,
1999     # accept this source directory.
2000
2001     if ($srcdir)
2002       {
2003       opendir SRCDIR, "../$srcdir" ||
2004         die "** Failed to opendir \"$cwd/../$srcdir\": $!\n";
2005       while ($f = readdir(SRCDIR))
2006         {
2007         if ($f =~ /^build-/ && -e "../$srcdir/$f/exim")
2008           {
2009           $use_srcdir = $srcdir;
2010           $parm_exim = "$cwd/../$srcdir/$f/exim";
2011           $parm_exim =~ s'/[^/]+/\.\./'/';
2012           last;
2013           }
2014         }
2015       closedir(SRCDIR);
2016       }
2017
2018     # If we have found "exim4" or "exim-snapshot", that takes precedence.
2019     # Otherwise, continue to see if there's a later version.
2020
2021     last if $use_srcdir eq "exim4" || $use_srcdir eq "exim-snapshot";
2022     }
2023   closedir(DIR);
2024   print "Exim binary found in $parm_exim\n" if $parm_exim ne "";
2025   }
2026
2027 # If $parm_exim is still empty, ask the caller
2028
2029 if ($parm_exim eq "")
2030   {
2031   print "** Did not find an Exim binary to test\n";
2032   for ($i = 0; $i < 5; $i++)
2033     {
2034     my($trybin);
2035     print "** Enter pathname for Exim binary: ";
2036     chomp($trybin = <STDIN>);
2037     if (-e $trybin)
2038       {
2039       $parm_exim = $trybin;
2040       last;
2041       }
2042     else
2043       {
2044       print "** $trybin does not exist\n";
2045       }
2046     }
2047   die "** Too many tries\n" if $parm_exim eq "";
2048   }
2049
2050
2051
2052 ##################################################
2053 #          Find what is in the binary            #
2054 ##################################################
2055
2056 # deal with TRUSTED_CONFIG_LIST restrictions
2057 unlink("$parm_cwd/test-config") if -e "$parm_cwd/test-config";
2058 symlink("$parm_cwd/confs/0000", "$parm_cwd/test-config")
2059   or die "Unable to link initial config into place: $!\n";
2060
2061 print("Probing with config file: $parm_cwd/test-config\n");
2062 open(EXIMINFO, "$parm_exim -d -C $parm_cwd/test-config -DDIR=$parm_cwd " .
2063                "-bP exim_user exim_group|") ||
2064   die "** Cannot run $parm_exim: $!\n";
2065 while(<EXIMINFO>)
2066   {
2067   $parm_eximuser = $1 if /^exim_user = (.*)$/;
2068   $parm_eximgroup = $1 if /^exim_group = (.*)$/;
2069   }
2070 close(EXIMINFO);
2071
2072 if (defined $parm_eximuser)
2073   {
2074   if ($parm_eximuser =~ /^\d+$/) { $parm_exim_uid = $parm_eximuser; }
2075     else { $parm_exim_uid = getpwnam($parm_eximuser); }
2076   }
2077 else
2078   {
2079   print "Unable to extract exim_user from binary.\n";
2080   print "Check if Exim refused to run; if so, consider:\n";
2081   print "  TRUSTED_CONFIG_LIST ALT_CONFIG_PREFIX WHITELIST_D_MACROS\n";
2082   die "Failing to get information from binary.\n";
2083   }
2084
2085 if (defined $parm_eximgroup)
2086   {
2087   if ($parm_eximgroup =~ /^\d+$/) { $parm_exim_gid = $parm_eximgroup; }
2088     else { $parm_exim_gid = getgrnam($parm_eximgroup); }
2089   }
2090
2091 open(EXIMINFO, "$parm_exim -bV -C $parm_cwd/test-config -DDIR=$parm_cwd |") ||
2092   die "** Cannot run $parm_exim: $!\n";
2093
2094 print "-" x 78, "\n";
2095
2096 while (<EXIMINFO>)
2097   {
2098   my(@temp);
2099
2100   if (/^Exim version/) { print; }
2101
2102   elsif (/^Size of off_t: (\d+)/)
2103     {
2104     print;
2105     $have_largefiles = 1 if $1 > 4;
2106     die "** Size of off_t > 32 which seems improbable, not running tests\n"
2107         if ($1 > 32);
2108     }
2109
2110   elsif (/^Support for: (.*)/)
2111     {
2112     print;
2113     @temp = split /(\s+)/, $1;
2114     push(@temp, ' ');
2115     %parm_support = @temp;
2116     }
2117
2118   elsif (/^Lookups \(built-in\): (.*)/)
2119     {
2120     print;
2121     @temp = split /(\s+)/, $1;
2122     push(@temp, ' ');
2123     %parm_lookups = @temp;
2124     }
2125
2126   elsif (/^Authenticators: (.*)/)
2127     {
2128     print;
2129     @temp = split /(\s+)/, $1;
2130     push(@temp, ' ');
2131     %parm_authenticators = @temp;
2132     }
2133
2134   elsif (/^Routers: (.*)/)
2135     {
2136     print;
2137     @temp = split /(\s+)/, $1;
2138     push(@temp, ' ');
2139     %parm_routers = @temp;
2140     }
2141
2142   # Some transports have options, e.g. appendfile/maildir. For those, ensure
2143   # that the basic transport name is set, and then the name with each of the
2144   # options.
2145
2146   elsif (/^Transports: (.*)/)
2147     {
2148     print;
2149     @temp = split /(\s+)/, $1;
2150     my($i,$k);
2151     push(@temp, ' ');
2152     %parm_transports = @temp;
2153     foreach $k (keys %parm_transports)
2154       {
2155       if ($k =~ "/")
2156         {
2157         @temp = split /\//, $k;
2158         $parm_transports{"$temp[0]"} = " ";
2159         for ($i = 1; $i < @temp; $i++)
2160           { $parm_transports{"$temp[0]/$temp[$i]"} = " "; }
2161         }
2162       }
2163     }
2164   }
2165 close(EXIMINFO);
2166 print "-" x 78, "\n";
2167
2168 unlink("$parm_cwd/test-config");
2169
2170 ##################################################
2171 #    Check for SpamAssassin and ClamAV           #
2172 ##################################################
2173
2174 # These are crude tests. If they aren't good enough, we'll have to improve
2175 # them, for example by actually passing a message through spamc or clamscan.
2176
2177 if (defined $parm_support{'Content_Scanning'})
2178   {
2179   if (system("spamc -h 2>/dev/null >/dev/null") == 0)
2180     {
2181     print "The spamc command works:\n";
2182
2183     # This test for an active SpamAssassin is courtesy of John Jetmore.
2184     # The tests are hard coded to localhost:783, so no point in making
2185     # this test flexible like the clamav test until the test scripts are
2186     # changed.  spamd doesn't have the nice PING/PONG protoccol that
2187     # clamd does, but it does respond to errors in an informative manner,
2188     # so use that.
2189
2190     my($sint,$sport) = ('127.0.0.1',783);
2191     eval
2192       {
2193       my $sin = sockaddr_in($sport, inet_aton($sint))
2194           or die "** Failed packing $sint:$sport\n";
2195       socket(SOCK, PF_INET, SOCK_STREAM, getprotobyname('tcp'))
2196           or die "** Unable to open socket $sint:$sport\n";
2197
2198       local $SIG{ALRM} =
2199           sub { die "** Timeout while connecting to socket $sint:$sport\n"; };
2200       alarm(5);
2201       connect(SOCK, $sin)
2202           or die "** Unable to connect to socket $sint:$sport\n";
2203       alarm(0);
2204
2205       select((select(SOCK), $| = 1)[0]);
2206       print SOCK "bad command\r\n";
2207
2208       $SIG{ALRM} =
2209           sub { die "** Timeout while reading from socket $sint:$sport\n"; };
2210       alarm(10);
2211       my $res = <SOCK>;
2212       alarm(0);
2213
2214       $res =~ m|^SPAMD/|
2215           or die "** Did not get SPAMD from socket $sint:$sport. "
2216                 ."It said: $res\n";
2217       };
2218     alarm(0);
2219     if($@)
2220       {
2221       print "  $@";
2222       print "  Assume SpamAssassin (spamd) is not running\n";
2223       }
2224     else
2225       {
2226       $parm_running{'SpamAssassin'} = ' ';
2227       print "  SpamAssassin (spamd) seems to be running\n";
2228       }
2229     }
2230   else
2231     {
2232     print "The spamc command failed: assume SpamAssassin (spamd) is not running\n";
2233     }
2234
2235   # For ClamAV, we need to find the clamd socket for use in the Exim
2236   # configuration. Search for the clamd configuration file.
2237
2238   if (system("clamscan -h 2>/dev/null >/dev/null") == 0)
2239     {
2240     my($f, $clamconf, $test_prefix);
2241
2242     print "The clamscan command works";
2243
2244     $test_prefix = $ENV{EXIM_TEST_PREFIX};
2245     $test_prefix = "" if !defined $test_prefix;
2246
2247     foreach $f ("$test_prefix/etc/clamd.conf",
2248                 "$test_prefix/usr/local/etc/clamd.conf",
2249                 "$test_prefix/etc/clamav/clamd.conf", "")
2250       {
2251       if (-e $f)
2252         {
2253         $clamconf = $f;
2254         last;
2255         }
2256       }
2257
2258     # Read the ClamAV configuration file and find the socket interface.
2259
2260     if ($clamconf ne "")
2261       {
2262       my $socket_domain;
2263       open(IN, "$clamconf") || die "\n** Unable to open $clamconf: $!\n";
2264       while (<IN>)
2265         {
2266         if (/^LocalSocket\s+(.*)/)
2267           {
2268           $parm_clamsocket = $1;
2269           $socket_domain = AF_UNIX;
2270           last;
2271           }
2272         if (/^TCPSocket\s+(\d+)/)
2273           {
2274           if (defined $parm_clamsocket)
2275             {
2276             $parm_clamsocket .= " $1";
2277             $socket_domain = AF_INET;
2278             last;
2279             }
2280           else
2281             {
2282             $parm_clamsocket = " $1";
2283             }
2284           }
2285         elsif (/^TCPAddr\s+(\S+)/)
2286           {
2287           if (defined $parm_clamsocket)
2288             {
2289             $parm_clamsocket = $1 . $parm_clamsocket;
2290             $socket_domain = AF_INET;
2291             last;
2292             }
2293           else
2294             {
2295             $parm_clamsocket = $1;
2296             }
2297           }
2298         }
2299       close(IN);
2300
2301       if (defined $socket_domain)
2302         {
2303         print ":\n  The clamd socket is $parm_clamsocket\n";
2304         # This test for an active ClamAV is courtesy of Daniel Tiefnig.
2305         eval
2306           {
2307           my $socket;
2308           if ($socket_domain == AF_UNIX)
2309             {
2310             $socket = sockaddr_un($parm_clamsocket) or die "** Failed packing '$parm_clamsocket'\n";
2311             }
2312           elsif ($socket_domain == AF_INET)
2313             {
2314             my ($ca_host, $ca_port) = split(/\s+/,$parm_clamsocket);
2315             my $ca_hostent = gethostbyname($ca_host) or die "** Failed to get raw address for host '$ca_host'\n";
2316             $socket = sockaddr_in($ca_port, $ca_hostent) or die "** Failed packing '$parm_clamsocket'\n";
2317             }
2318           else
2319             {
2320             die "** Unknown socket domain '$socket_domain' (should not happen)\n";
2321             }
2322           socket(SOCK, $socket_domain, SOCK_STREAM, 0) or die "** Unable to open socket '$parm_clamsocket'\n";
2323           local $SIG{ALRM} = sub { die "** Timeout while connecting to socket '$parm_clamsocket'\n"; };
2324           alarm(5);
2325           connect(SOCK, $socket) or die "** Unable to connect to socket '$parm_clamsocket'\n";
2326           alarm(0);
2327
2328           my $ofh = select SOCK; $| = 1; select $ofh;
2329           print SOCK "PING\n";
2330
2331           $SIG{ALRM} = sub { die "** Timeout while reading from socket '$parm_clamsocket'\n"; };
2332           alarm(10);
2333           my $res = <SOCK>;
2334           alarm(0);
2335
2336           $res =~ /PONG/ or die "** Did not get PONG from socket '$parm_clamsocket'. It said: $res\n";
2337           };
2338         alarm(0);
2339
2340         if($@)
2341           {
2342           print "  $@";
2343           print "  Assume ClamAV is not running\n";
2344           }
2345         else
2346           {
2347           $parm_running{'ClamAV'} = ' ';
2348           print "  ClamAV seems to be running\n";
2349           }
2350         }
2351       else
2352         {
2353         print ", but the socket for clamd could not be determined\n";
2354         print "Assume ClamAV is not running\n";
2355         }
2356       }
2357
2358     else
2359       {
2360       print ", but I can't find a configuration for clamd\n";
2361       print "Assume ClamAV is not running\n";
2362       }
2363     }
2364   }
2365
2366
2367 ##################################################
2368 #         Test for the basic requirements        #
2369 ##################################################
2370
2371 # This test suite assumes that Exim has been built with at least the "usual"
2372 # set of routers, transports, and lookups. Ensure that this is so.
2373
2374 $missing = "";
2375
2376 $missing .= "     Lookup: lsearch\n" if (!defined $parm_lookups{'lsearch'});
2377
2378 $missing .= "     Router: accept\n" if (!defined $parm_routers{'accept'});
2379 $missing .= "     Router: dnslookup\n" if (!defined $parm_routers{'dnslookup'});
2380 $missing .= "     Router: manualroute\n" if (!defined $parm_routers{'manualroute'});
2381 $missing .= "     Router: redirect\n" if (!defined $parm_routers{'redirect'});
2382
2383 $missing .= "     Transport: appendfile\n" if (!defined $parm_transports{'appendfile'});
2384 $missing .= "     Transport: autoreply\n" if (!defined $parm_transports{'autoreply'});
2385 $missing .= "     Transport: pipe\n" if (!defined $parm_transports{'pipe'});
2386 $missing .= "     Transport: smtp\n" if (!defined $parm_transports{'smtp'});
2387
2388 if ($missing ne "")
2389   {
2390   print "\n";
2391   print "** Many features can be included or excluded from Exim binaries.\n";
2392   print "** This test suite requires that Exim is built to contain a certain\n";
2393   print "** set of basic facilities. It seems that some of these are missing\n";
2394   print "** from the binary that is under test, so the test cannot proceed.\n";
2395   print "** The missing facilities are:\n";
2396   print "$missing";
2397   die "** Test script abandoned\n";
2398   }
2399
2400
2401 ##################################################
2402 #      Check for the auxiliary programs          #
2403 ##################################################
2404
2405 # These are always required:
2406
2407 for $prog ("cf", "checkaccess", "client", "client-ssl", "client-gnutls",
2408            "fakens", "iefbr14", "server")
2409   {
2410   next if ($prog eq "client-ssl" && !defined $parm_support{'OpenSSL'});
2411   next if ($prog eq "client-gnutls" && !defined $parm_support{'GnuTLS'});
2412   if (!-e "bin/$prog")
2413     {
2414     print "\n";
2415     print "** bin/$prog does not exist. Have you run ./configure and make?\n";
2416     die "** Test script abandoned\n";
2417     }
2418   }
2419
2420 # If the "loaded" binary is missing, we cut out tests for ${dlfunc. It isn't
2421 # compiled on systems where we don't know how to. However, if Exim does not
2422 # have that functionality compiled, we needn't bother.
2423
2424 $dlfunc_deleted = 0;
2425 if (defined $parm_support{'Expand_dlfunc'} && !-e "bin/loaded")
2426   {
2427   delete $parm_support{'Expand_dlfunc'};
2428   $dlfunc_deleted = 1;
2429   }
2430
2431
2432 ##################################################
2433 #          Find environmental details            #
2434 ##################################################
2435
2436 # Find the caller of this program.
2437
2438 ($parm_caller,$pwpw,$parm_caller_uid,$parm_caller_gid,$pwquota,$pwcomm,
2439  $parm_caller_gecos, $parm_caller_home) = getpwuid($>);
2440
2441 $pwpw = $pwpw;       # Kill Perl warnings
2442 $pwquota = $pwquota;
2443 $pwcomm = $pwcomm;
2444
2445 $parm_caller_group = getgrgid($parm_caller_gid);
2446
2447 print "Program caller is $parm_caller, whose group is $parm_caller_group\n";
2448 print "Home directory is $parm_caller_home\n";
2449
2450 unless (defined $parm_eximgroup)
2451   {
2452   print "Unable to derive \$parm_eximgroup.\n";
2453   die "** ABANDONING.\n";
2454   }
2455
2456 print "You need to be in the Exim group to run these tests. Checking ...";
2457
2458 if (`groups` =~ /\b\Q$parm_eximgroup\E\b/)
2459   {
2460   print " OK\n";
2461   }
2462 else
2463   {
2464   print "\nOh dear, you are not in the Exim group.\n";
2465   die "** Testing abandoned.\n";
2466   }
2467
2468 # Find this host's IP addresses - there may be many, of course, but we keep
2469 # one of each type (IPv4 and IPv6).
2470
2471 $parm_ipv4 = "";
2472 $parm_ipv6 = "";
2473
2474 $local_ipv4 = "";
2475 $local_ipv6 = "";
2476
2477 open(IFCONFIG, "ifconfig -a|") || die "** Cannot run \"ifconfig\": $!\n";
2478 while (($parm_ipv4 eq "" || $parm_ipv6 eq "") && ($_ = <IFCONFIG>))
2479   {
2480   my($ip);
2481   if ($parm_ipv4 eq "" &&
2482       $_ =~ /^\s*inet(?:\saddr)?:?\s?(\d+\.\d+\.\d+\.\d+)\s/i)
2483     {
2484     $ip = $1;
2485     next if ($ip eq "127.0.0.1");
2486     $parm_ipv4 = $ip;
2487     }
2488
2489   if ($parm_ipv6 eq "" &&
2490       $_ =~ /^\s*inet6(?:\saddr)?:?\s?([abcdef\d:]+)/i)
2491     {
2492     $ip = $1;
2493     next if ($ip eq "::1" || $ip =~ /^fe80/i);
2494     $parm_ipv6 = $ip;
2495     }
2496   }
2497 close(IFCONFIG);
2498
2499 # Use private IP addresses if there are no public ones.
2500
2501 $parm_ipv4 = $local_ipv4 if ($parm_ipv4 eq "");
2502 $parm_ipv6 = $local_ipv6 if ($parm_ipv6 eq "");
2503
2504 # If either type of IP address is missing, we need to set the value to
2505 # something other than empty, because that wrecks the substitutions. The value
2506 # is reflected, so use a meaningful string. Set appropriate options for the
2507 # "server" command. In practice, however, many tests assume 127.0.0.1 is
2508 # available, so things will go wrong if there is no IPv4 address. The lack
2509 # of IPV4 or IPv6 can be simulated by command options, which force $have_ipv4
2510 # and $have_ipv6 false.
2511
2512 if ($parm_ipv4 eq "")
2513   {
2514   $have_ipv4 = 0;
2515   $parm_ipv4 = "<no IPv4 address found>";
2516   $server_opts .= " -noipv4";
2517   }
2518 elsif ($have_ipv4 == 0)
2519   {
2520   $parm_ipv4 = "<IPv4 testing disabled>";
2521   $server_opts .= " -noipv4";
2522   }
2523 else
2524   {
2525   $parm_running{"IPv4"} = " ";
2526   }
2527
2528 if ($parm_ipv6 eq "")
2529   {
2530   $have_ipv6 = 0;
2531   $parm_ipv6 = "<no IPv6 address found>";
2532   $server_opts .= " -noipv6";
2533   delete($parm_support{"IPv6"});
2534   }
2535 elsif ($have_ipv6 == 0)
2536   {
2537   $parm_ipv6 = "<IPv6 testing disabled>";
2538   $server_opts .= " -noipv6";
2539   delete($parm_support{"IPv6"});
2540   }
2541 elsif (!defined $parm_support{'IPv6'})
2542   {
2543   $have_ipv6 = 0;
2544   $parm_ipv6 = "<no IPv6 support in Exim binary>";
2545   $server_opts .= " -noipv6";
2546   }
2547 else
2548   {
2549   $parm_running{"IPv6"} = " ";
2550   }
2551
2552 print "IPv4 address is $parm_ipv4\n";
2553 print "IPv6 address is $parm_ipv6\n";
2554
2555 # For munging test output, we need the reversed IP addresses.
2556
2557 $parm_ipv4r = ($parm_ipv4 !~ /^\d/)? "" :
2558   join(".", reverse(split /\./, $parm_ipv4));
2559
2560 $parm_ipv6r = $parm_ipv6;             # Appropriate if not in use
2561 if ($parm_ipv6 =~ /^[\da-f]/)
2562   {
2563   my(@comps) = split /:/, $parm_ipv6;
2564   my(@nibbles);
2565   foreach $comp (@comps)
2566     {
2567     push @nibbles, sprintf("%lx", hex($comp) >> 8);
2568     push @nibbles, sprintf("%lx", hex($comp) & 0xff);
2569     }
2570   $parm_ipv6r = join(".", reverse(@nibbles));
2571   }
2572
2573 # Find the host name, fully qualified.
2574
2575 chomp($temp = `hostname`);
2576 $parm_hostname = (gethostbyname($temp))[0];
2577 $parm_hostname = "no.host.name.found" if $parm_hostname eq "";
2578 print "Hostname is $parm_hostname\n";
2579
2580 if ($parm_hostname !~ /\./)
2581   {
2582   print "\n*** Host name is not fully qualified: this may cause problems ***\n\n";
2583   }
2584
2585 # Find the user's shell
2586
2587 $parm_shell = $ENV{'SHELL'};
2588
2589
2590 ##################################################
2591 #     Create a testing version of Exim           #
2592 ##################################################
2593
2594 # We want to be able to run Exim with a variety of configurations. Normally,
2595 # the use of -C to change configuration causes Exim to give up its root
2596 # privilege (unless the caller is exim or root). For these tests, we do not
2597 # want this to happen. Also, we want Exim to know that it is running in its
2598 # test harness.
2599
2600 # We achieve this by copying the binary and patching it as we go. The new
2601 # binary knows it is a testing copy, and it allows -C and -D without loss of
2602 # privilege. Clearly, this file is dangerous to have lying around on systems
2603 # where there are general users with login accounts. To protect against this,
2604 # we put the new binary in a special directory that is accessible only to the
2605 # caller of this script, who is known to have sudo root privilege from the test
2606 # that was done above. Furthermore, we ensure that the binary is deleted at the
2607 # end of the test. First ensure the directory exists.
2608
2609 if (-d "eximdir")
2610   { unlink "eximdir/exim"; }     # Just in case
2611 else
2612   {
2613   mkdir("eximdir", 0710) || die "** Unable to mkdir $parm_cwd/eximdir: $!\n";
2614   system("sudo chgrp $parm_eximgroup eximdir");
2615   }
2616
2617 # The construction of the patched binary must be done as root, so we use
2618 # a separate script. As well as indicating that this is a test-harness binary,
2619 # the version number is patched to "x.yz" so that its length is always the
2620 # same. Otherwise, when it appears in Received: headers, it affects the length
2621 # of the message, which breaks certain comparisons.
2622
2623 die "** Unable to make patched exim: $!\n"
2624   if (system("sudo ./patchexim $parm_exim") != 0);
2625
2626 # From this point on, exits from the program must go via the subroutine
2627 # tests_exit(), so that suitable cleaning up can be done when required.
2628 # Arrange to catch interrupting signals, to assist with this.
2629
2630 $SIG{'INT'} = \&inthandler;
2631 $SIG{'PIPE'} = \&pipehandler;
2632
2633 # For some tests, we need another copy of the binary that is setuid exim rather
2634 # than root.
2635
2636 system("sudo cp eximdir/exim eximdir/exim_exim;" .
2637        "sudo chown $parm_eximuser eximdir/exim_exim;" .
2638        "sudo chgrp $parm_eximgroup eximdir/exim_exim;" .
2639        "sudo chmod 06755 eximdir/exim_exim");
2640
2641
2642 ##################################################
2643 #     Make copies of utilities we might need     #
2644 ##################################################
2645
2646 # Certain of the tests make use of some of Exim's utilities. We do not need
2647 # to be root to copy these.
2648
2649 ($parm_exim_dir) = $parm_exim =~ ?^(.*)/exim?;
2650
2651 $dbm_build_deleted = 0;
2652 if (defined $parm_lookups{'dbm'} &&
2653     system("cp $parm_exim_dir/exim_dbmbuild eximdir") != 0)
2654   {
2655   delete $parm_lookups{'dbm'};
2656   $dbm_build_deleted = 1;
2657   }
2658
2659 if (system("cp $parm_exim_dir/exim_dumpdb eximdir") != 0)
2660   {
2661   tests_exit(-1, "Failed to make a copy of exim_dumpdb: $!");
2662   }
2663
2664 if (system("cp $parm_exim_dir/exim_lock eximdir") != 0)
2665   {
2666   tests_exit(-1, "Failed to make a copy of exim_lock: $!");
2667   }
2668
2669 if (system("cp $parm_exim_dir/exinext eximdir") != 0)
2670   {
2671   tests_exit(-1, "Failed to make a copy of exinext: $!");
2672   }
2673
2674 if (system("cp $parm_exim_dir/exigrep eximdir") != 0)
2675   {
2676   tests_exit(-1, "Failed to make a copy of exigrep: $!");
2677   }
2678
2679 if (system("cp $parm_exim_dir/eximstats eximdir") != 0)
2680   {
2681   tests_exit(-1, "Failed to make a copy of eximstats: $!");
2682   }
2683
2684
2685 ##################################################
2686 #    Check that the Exim user can access stuff   #
2687 ##################################################
2688
2689 # We delay this test till here so that we can check access to the actual test
2690 # binary. This will be needed when Exim re-exec's itself to do deliveries.
2691
2692 print "Exim user is $parm_eximuser ($parm_exim_uid)\n";
2693 print "Exim group is $parm_eximgroup ($parm_exim_gid)\n";
2694
2695 if ($parm_caller_uid eq $parm_exim_uid) {
2696   tests_exit(-1, "Exim user ($parm_eximuser,$parm_exim_uid) cannot be "
2697                 ."the same as caller ($parm_caller,$parm_caller_uid)");
2698 }
2699
2700 print "The Exim user needs access to the test suite directory. Checking ...";
2701
2702 if (($rc = system("sudo bin/checkaccess $parm_cwd/eximdir/exim $parm_eximuser $parm_eximgroup")) != 0)
2703   {
2704   my($why) = "unknown failure $rc";
2705   $rc >>= 8;
2706   $why = "Couldn't find user \"$parm_eximuser\"" if $rc == 1;
2707   $why = "Couldn't find group \"$parm_eximgroup\"" if $rc == 2;
2708   $why = "Couldn't read auxiliary group list" if $rc == 3;
2709   $why = "Couldn't get rid of auxiliary groups" if $rc == 4;
2710   $why = "Couldn't set gid" if $rc == 5;
2711   $why = "Couldn't set uid" if $rc == 6;
2712   $why = "Couldn't open \"$parm_cwd/eximdir/exim\"" if $rc == 7;
2713   print "\n** $why\n";
2714   tests_exit(-1, "$parm_eximuser cannot access the test suite directory");
2715   }
2716 else
2717   {
2718   print " OK\n";
2719   }
2720
2721
2722 ##################################################
2723 #        Create a list of available tests        #
2724 ##################################################
2725
2726 # The scripts directory contains a number of subdirectories whose names are
2727 # of the form 0000-xxxx, 1100-xxxx, 2000-xxxx, etc. Each set of tests apart
2728 # from the first requires certain optional features to be included in the Exim
2729 # binary. These requirements are contained in a file called "REQUIRES" within
2730 # the directory. We scan all these tests, discarding those that cannot be run
2731 # because the current binary does not support the right facilities, and also
2732 # those that are outside the numerical range selected.
2733
2734 print "\nTest range is $test_start to $test_end\n";
2735 print "Omitting \${dlfunc expansion tests (loadable module not present)\n"
2736   if $dlfunc_deleted;
2737 print "Omitting dbm tests (unable to copy exim_dbmbuild)\n"
2738   if $dbm_build_deleted;
2739
2740 opendir(DIR, "scripts") || tests_exit(-1, "Failed to opendir(\"scripts\"): $!");
2741 @test_dirs = sort readdir(DIR);
2742 closedir(DIR);
2743
2744 # Remove . and .. and CVS from the list.
2745
2746 for ($i = 0; $i < @test_dirs; $i++)
2747   {
2748   my($d) = $test_dirs[$i];
2749   if ($d eq "." || $d eq ".." || $d eq "CVS")
2750     {
2751     splice @test_dirs, $i, 1;
2752     $i--;
2753     }
2754   }
2755
2756 # Scan for relevant tests
2757
2758 for ($i = 0; $i < @test_dirs; $i++)
2759   {
2760   my($testdir) = $test_dirs[$i];
2761   my($wantthis) = 1;
2762
2763   print ">>Checking $testdir\n" if $debug;
2764
2765   # Skip this directory if the first test is equal or greater than the first
2766   # test in the next directory.
2767
2768   next if ($i < @test_dirs - 1) &&
2769           ($test_start >= substr($test_dirs[$i+1], 0, 4));
2770
2771   # No need to carry on if the end test is less than the first test in this
2772   # subdirectory.
2773
2774   last if $test_end < substr($testdir, 0, 4);
2775
2776   # Check requirements, if any.
2777
2778   if (open(REQUIRES, "scripts/$testdir/REQUIRES"))
2779     {
2780     while (<REQUIRES>)
2781       {
2782       next if /^\s*$/;
2783       s/\s+$//;
2784       if (/^support (.*)$/)
2785         {
2786         if (!defined $parm_support{$1}) { $wantthis = 0; last; }
2787         }
2788       elsif (/^running (.*)$/)
2789         {
2790         if (!defined $parm_running{$1}) { $wantthis = 0; last; }
2791         }
2792       elsif (/^lookup (.*)$/)
2793         {
2794         if (!defined $parm_lookups{$1}) { $wantthis = 0; last; }
2795         }
2796       elsif (/^authenticators? (.*)$/)
2797         {
2798         if (!defined $parm_authenticators{$1}) { $wantthis = 0; last; }
2799         }
2800       elsif (/^router (.*)$/)
2801         {
2802         if (!defined $parm_routers{$1}) { $wantthis = 0; last; }
2803         }
2804       elsif (/^transport (.*)$/)
2805         {
2806         if (!defined $parm_transports{$1}) { $wantthis = 0; last; }
2807         }
2808       else
2809         {
2810         tests_exit(-1, "Unknown line in \"scripts/$testdir/REQUIRES\": \"$_\"");
2811         }
2812       }
2813     close(REQUIRES);
2814     }
2815   else
2816     {
2817     tests_exit(-1, "Failed to open \"scripts/$testdir/REQUIRES\": $!")
2818       unless $!{ENOENT};
2819     }
2820
2821   # Loop if we do not want the tests in this subdirectory.
2822
2823   if (!$wantthis)
2824     {
2825     chomp;
2826     print "Omitting tests in $testdir (missing $_)\n";
2827     next;
2828     }
2829
2830   # We want the tests from this subdirectory, provided they are in the
2831   # range that was selected.
2832
2833   opendir(SUBDIR, "scripts/$testdir") ||
2834     tests_exit(-1, "Failed to opendir(\"scripts/$testdir\"): $!");
2835   @testlist = sort readdir(SUBDIR);
2836   close(SUBDIR);
2837
2838   foreach $test (@testlist)
2839     {
2840     next if $test !~ /^\d{4}$/;
2841     next if $test < $test_start || $test > $test_end;
2842     push @test_list, "$testdir/$test";
2843     }
2844   }
2845
2846 print ">>Test List: @test_list\n", if $debug;
2847
2848
2849 ##################################################
2850 #         Munge variable auxiliary data          #
2851 ##################################################
2852
2853 # Some of the auxiliary data files have to refer to the current testing
2854 # directory and other parameter data. The generic versions of these files are
2855 # stored in the aux-var-src directory. At this point, we copy each of them
2856 # to the aux-var directory, making appropriate substitutions. There aren't very
2857 # many of them, so it's easiest just to do this every time. Ensure the mode
2858 # is standardized, as this path is used as a test for the ${stat: expansion.
2859
2860 # A similar job has to be done for the files in the dnszones-src directory, to
2861 # make the fake DNS zones for testing. Most of the zone files are copied to
2862 # files of the same name, but db.ipv4.V4NET and db.ipv6.V6NET use the testing
2863 # networks that are defined by parameter.
2864
2865 foreach $basedir ("aux-var", "dnszones")
2866   {
2867   system("sudo rm -rf $parm_cwd/$basedir");
2868   mkdir("$parm_cwd/$basedir", 0777);
2869   chmod(0755, "$parm_cwd/$basedir");
2870
2871   opendir(AUX, "$parm_cwd/$basedir-src") ||
2872     tests_exit(-1, "Failed to opendir $parm_cwd/$basedir-src: $!");
2873   my(@filelist) = readdir(AUX);
2874   close(AUX);
2875
2876   foreach $file (@filelist)
2877     {
2878     my($outfile) = $file;
2879     next if $file =~ /^\./;
2880
2881     if ($file eq "db.ip4.V4NET")
2882       {
2883       $outfile = "db.ip4.$parm_ipv4_test_net";
2884       }
2885     elsif ($file eq "db.ip6.V6NET")
2886       {
2887       my(@nibbles) = reverse(split /\s*/, $parm_ipv6_test_net);
2888       $" = '.';
2889       $outfile = "db.ip6.@nibbles";
2890       $" = ' ';
2891       }
2892
2893     print ">>Copying $basedir-src/$file to $basedir/$outfile\n" if $debug;
2894     open(IN, "$parm_cwd/$basedir-src/$file") ||
2895       tests_exit(-1, "Failed to open $parm_cwd/$basedir-src/$file: $!");
2896     open(OUT, ">$parm_cwd/$basedir/$outfile") ||
2897       tests_exit(-1, "Failed to open $parm_cwd/$basedir/$outfile: $!");
2898     while (<IN>)
2899       {
2900       do_substitute(0);
2901       print OUT;
2902       }
2903     close(IN);
2904     close(OUT);
2905     }
2906   }
2907
2908
2909 ##################################################
2910 #     Create fake DNS zones for this host        #
2911 ##################################################
2912
2913 # There are fixed zone files for 127.0.0.1 and ::1, but we also want to be
2914 # sure that there are forward and reverse registrations for this host, using
2915 # its real IP addresses. Dynamically created zone files achieve this.
2916
2917 if ($have_ipv4 || $have_ipv6)
2918   {
2919   my($shortname,$domain) = $parm_hostname =~ /^([^.]+)(.*)/;
2920   open(OUT, ">$parm_cwd/dnszones/db$domain") ||
2921     tests_exit(-1, "Failed to open $parm_cwd/dnszones/db$domain: $!");
2922   print OUT "; This is a dynamically constructed fake zone file.\n" .
2923     "; The following line causes fakens to return PASS_ON\n" .
2924     "; for queries that it cannot answer\n\n" .
2925     "PASS ON NOT FOUND\n\n";
2926   print OUT "$shortname  A     $parm_ipv4\n" if $have_ipv4;
2927   print OUT "$shortname  AAAA  $parm_ipv6\n" if $have_ipv6;
2928   print OUT "\n; End\n";
2929   close(OUT);
2930   }
2931
2932 if ($have_ipv4 && $parm_ipv4 ne "127.0.0.1")
2933   {
2934   my(@components) = $parm_ipv4 =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)/;
2935   open(OUT, ">$parm_cwd/dnszones/db.ip4.$components[0]") ||
2936     tests_exit(-1,
2937       "Failed  to open $parm_cwd/dnszones/db.ip4.$components[0]: $!");
2938   print OUT "; This is a dynamically constructed fake zone file.\n" .
2939     "; The zone is $components[0].in-addr.arpa.\n\n" .
2940     "$components[3].$components[2].$components[1]  PTR  $parm_hostname.\n\n" .
2941     "; End\n";
2942   close(OUT);
2943   }
2944
2945 if ($have_ipv6 && $parm_ipv6 ne "::1")
2946   {
2947   my(@components) = split /:/, $parm_ipv6;
2948   my(@nibbles) = reverse (split /\s*/, shift @components);
2949   my($sep) =  "";
2950
2951   $" = ".";
2952   open(OUT, ">$parm_cwd/dnszones/db.ip6.@nibbles") ||
2953     tests_exit(-1,
2954       "Failed  to open $parm_cwd/dnszones/db.ip6.@nibbles: $!");
2955   print OUT "; This is a dynamically constructed fake zone file.\n" .
2956     "; The zone is @nibbles.ip6.arpa.\n\n";
2957
2958   @components = reverse @components;
2959   foreach $c (@components)
2960     {
2961     $c = "0$c" until $c =~ /^..../;
2962     @nibbles = reverse(split /\s*/, $c);
2963     print OUT "$sep@nibbles";
2964     $sep = ".";
2965     }
2966
2967   print OUT "  PTR  $parm_hostname.\n\n; End\n";
2968   close(OUT);
2969   $" = " ";
2970   }
2971
2972
2973
2974 ##################################################
2975 #    Create lists of mailboxes and message logs  #
2976 ##################################################
2977
2978 # We use these lists to check that a test has created the expected files. It
2979 # should be faster than looking for the file each time. For mailboxes, we have
2980 # to scan a complete subtree, in order to handle maildirs. For msglogs, there
2981 # is just a flat list of files.
2982
2983 @oldmails = list_files_below("mail");
2984 opendir(DIR, "msglog") || tests_exit(-1, "Failed to opendir msglog: $!");
2985 @oldmsglogs = readdir(DIR);
2986 closedir(DIR);
2987
2988
2989
2990 ##################################################
2991 #         Run the required tests                 #
2992 ##################################################
2993
2994 # Each test script contains a number of tests, separated by a line that
2995 # contains ****. We open input from the terminal so that we can read responses
2996 # to prompts.
2997
2998 open(T, "/dev/tty") || tests_exit(-1, "Failed to open /dev/tty: $!");
2999
3000 print "\nPress RETURN to run the tests: ";
3001 $_ = <T>;
3002 print "\n";
3003
3004 $lasttestdir = "";
3005
3006 foreach $test (@test_list)
3007   {
3008   local($lineno) = 0;
3009   local($commandno) = 0;
3010   local($subtestno) = 0;
3011   local($testno) = substr($test, -4);
3012   local($sortlog) = 0;
3013
3014   my($gnutls) = 0;
3015   my($docheck) = 1;
3016   my($thistestdir) = substr($test, 0, -5);
3017
3018   if ($lasttestdir ne $thistestdir)
3019     {
3020     $gnutls = 0;
3021     if (-s "scripts/$thistestdir/REQUIRES")
3022       {
3023       my($indent) = "";
3024       print "\n>>> The following tests require: ";
3025       open(IN, "scripts/$thistestdir/REQUIRES") ||
3026         tests_exit(-1, "Failed to open scripts/$thistestdir/REQUIRES: $1");
3027       while (<IN>)
3028         {
3029         $gnutls = 1 if /^support GnuTLS/;
3030         print $indent, $_;
3031         $indent = ">>>                              ";
3032         }
3033       close(IN);
3034       }
3035     }
3036   $lasttestdir = $thistestdir;
3037
3038   # Remove any debris in the spool directory and the test-mail directory
3039   # and also the files for collecting stdout and stderr. Then put back
3040   # the test-mail directory for appendfile deliveries.
3041
3042   system "sudo /bin/rm -rf spool test-*";
3043   system "mkdir test-mail 2>/dev/null";
3044
3045   # A privileged Exim will normally make its own spool directory, but some of
3046   # the tests run in unprivileged modes that don't always work if the spool
3047   # directory isn't already there. What is more, we want anybody to be able
3048   # to read it in order to find the daemon's pid.
3049
3050   system "mkdir spool; " .
3051          "sudo chown $parm_eximuser:$parm_eximgroup spool; " .
3052          "sudo chmod 0755 spool";
3053
3054   # Empty the cache that keeps track of things like message id mappings, and
3055   # set up the initial sequence strings.
3056
3057   undef %cache;
3058   $next_msgid = "aX";
3059   $next_pid = 1234;
3060   $next_port = 1111;
3061   $message_skip = 0;
3062   $msglog_skip = 0;
3063   $stderr_skip = 0;
3064   $stdout_skip = 0;
3065   $rmfiltertest = 0;
3066   $is_ipv6test = 0;
3067
3068   # Remove the associative arrays used to hold checked mail files and msglogs
3069
3070   undef %expected_mails;
3071   undef %expected_msglogs;
3072
3073   # Open the test's script
3074
3075   open(SCRIPT, "scripts/$test") ||
3076     tests_exit(-1, "Failed to open \"scripts/$test\": $!");
3077
3078   # The first line in the script must be a comment that is used to identify
3079   # the set of tests as a whole.
3080
3081   $_ = <SCRIPT>;
3082   $lineno++;
3083   tests_exit(-1, "Missing identifying comment at start of $test") if (!/^#/);
3084   printf("%s %s", (substr $test, 5), (substr $_, 2));
3085
3086   # Loop for each of the subtests within the script. The variable $server_pid
3087   # is used to remember the pid of a "server" process, for which we do not
3088   # wait until we have waited for a subsequent command.
3089
3090   local($server_pid) = 0;
3091   for ($commandno = 1; !eof SCRIPT; $commandno++)
3092     {
3093     # Skip further leading comments and blank lines, handle the flag setting
3094     # commands, and deal with tests for IP support.
3095
3096     while (<SCRIPT>)
3097       {
3098       $lineno++;
3099       if (/^no_message_check/) { $message_skip = 1; next; }
3100       if (/^no_msglog_check/)  { $msglog_skip = 1; next; }
3101       if (/^no_stderr_check/)  { $stderr_skip = 1; next; }
3102       if (/^no_stdout_check/)  { $stdout_skip = 1; next; }
3103       if (/^rmfiltertest/)     { $rmfiltertest = 1; next; }
3104       if (/^sortlog/)          { $sortlog = 1; next; }
3105
3106       if (/^need_largefiles/)
3107         {
3108         next if $have_largefiles;
3109         print ">>> Large file support is needed for test $testno, but is not available: skipping\n";
3110         $docheck = 0;      # don't check output
3111         undef $_;          # pretend EOF
3112         last;
3113         }
3114
3115       if (/^need_ipv4/)
3116         {
3117         next if $have_ipv4;
3118         print ">>> IPv4 is needed for test $testno, but is not available: skipping\n";
3119         $docheck = 0;      # don't check output
3120         undef $_;          # pretend EOF
3121         last;
3122         }
3123
3124       if (/^need_ipv6/)
3125         {
3126         if ($have_ipv6)
3127           {
3128           $is_ipv6test = 1;
3129           next;
3130           }
3131         print ">>> IPv6 is needed for test $testno, but is not available: skipping\n";
3132         $docheck = 0;      # don't check output
3133         undef $_;          # pretend EOF
3134         last;
3135         }
3136
3137       if (/^need_move_frozen_messages/)
3138         {
3139         next if defined $parm_support{"move_frozen_messages"};
3140         print ">>> move frozen message support is needed for test $testno, " .
3141           "but is not\n>>> available: skipping\n";
3142         $docheck = 0;      # don't check output
3143         undef $_;          # pretend EOF
3144         last;
3145         }
3146
3147       last unless /^(#|\s*$)/;
3148       }
3149     last if !defined $_;  # Hit EOF
3150
3151     my($subtest_startline) = $lineno;
3152
3153     # Now run the command. The function returns 0 if exim was run and waited
3154     # for, 1 if any other command was run and waited for, and 2 if a command
3155     # was run and not waited for (usually a daemon or server startup).
3156
3157     my($commandname) = "";
3158     my($expectrc) = 0;
3159     my($rc) = run_command($testno, \$subtestno, \$expectrc, \$commandname);
3160     my($cmdrc) = $?;
3161
3162     print ">> rc=$rc cmdrc=$cmdrc\n" if $debug;
3163
3164     # Hit EOF after an initial return code number
3165
3166     tests_exit(-1, "Unexpected EOF in script") if ($rc == 4);
3167
3168     # Carry on with the next command if we did not wait for this one. $rc == 0
3169     # if no subprocess was run; $rc == 3 if we started a process but did not
3170     # wait for it.
3171
3172     next if ($rc == 0 || $rc == 3);
3173
3174     # We ran and waited for a command. Check for the expected result unless
3175     # it died.
3176
3177     if ($cmdrc != $expectrc && !$sigpipehappened)
3178       {
3179       printf("** Command $commandno (\"$commandname\", starting at line $subtest_startline)\n");
3180       if (($cmdrc & 0xff) == 0)
3181         {
3182         printf("** Return code %d (expected %d)", $cmdrc/256, $expectrc/256);
3183         }
3184       elsif (($cmdrc & 0xff00) == 0)
3185         { printf("** Killed by signal %d", $cmdrc & 255); }
3186       else
3187         { printf("** Status %x", $cmdrc); }
3188
3189       for (;;)
3190         {
3191         print "\nshow stdErr, show stdOut, Continue (without file comparison), or Quit? [Q] ";
3192         $_ = <T>;
3193         tests_exit(1) if /^q?$/i;
3194         last if /^c$/i;
3195         if (/^e$/i)
3196           {
3197           system("$more test-stderr");
3198           }
3199         elsif (/^o$/i)
3200           {
3201           system("$more test-stdout");
3202           }
3203         }
3204
3205       $docheck = 0;
3206       }
3207
3208     # If the command was exim, and a listening server is running, we can now
3209     # close its input, which causes us to wait for it to finish, which is why
3210     # we didn't close it earlier.
3211
3212     if ($rc == 2 && $server_pid != 0)
3213       {
3214       close SERVERCMD;
3215       $server_pid = 0;
3216       if ($? != 0)
3217         {
3218         if (($? & 0xff) == 0)
3219           { printf("Server return code %d", $?/256); }
3220         elsif (($? & 0xff00) == 0)
3221           { printf("Server killed by signal %d", $? & 255); }
3222         else
3223           { printf("Server status %x", $?); }
3224
3225         for (;;)
3226           {
3227           print "\nShow server stdout, Continue, or Quit? [Q] ";
3228           $_ = <T>;
3229           tests_exit(1) if /^q?$/i;
3230           last if /^c$/i;
3231
3232           if (/^s$/i)
3233             {
3234             open(S, "test-stdout-server") ||
3235               tests_exit(-1, "Failed to open test-stdout-server: $!");
3236             print while <S>;
3237             close(S);
3238             }
3239           }
3240         }
3241       }
3242     }
3243
3244   close SCRIPT;
3245
3246   # The script has finished. Check the all the output that was generated. The
3247   # function returns 0 if all is well, 1 if we should rerun the test (the files
3248   # have been updated). It does not return if the user responds Q to a prompt.
3249
3250   if ($docheck)
3251     {
3252     if (check_output() != 0)
3253       {
3254       print (("#" x 79) . "\n");
3255       redo;
3256       }
3257     else
3258       {
3259       print ("  Script completed\n");
3260       }
3261     }
3262   }
3263
3264
3265 ##################################################
3266 #         Exit from the test script              #
3267 ##################################################
3268
3269 tests_exit(-1, "No runnable tests selected") if @test_list == 0;
3270 tests_exit(0);
3271
3272 # End of runtest script
3273 # vim: set sw=2 :