test/runtest

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