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