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