test/runtest

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