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