test/runtest

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