test/runtest

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