test/runtest

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