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