test/runtest

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