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