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