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