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