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