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