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