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