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