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