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