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