test/runtest

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