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