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