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