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