test/runtest

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