test/runtest

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