test/runtest

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