test/runtest

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