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