test/runtest

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