test/runtest

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