test/runtest

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