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