test/runtest

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