test/runtest

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