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