test/runtest

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