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