test/runtest

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