set umask
[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 314 # patchexim should have fixed this for us
026d45f5 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##################################################
650ececb
PP
1868# Some tests check created file modes #
1869##################################################
1870
1871umask 022;
1872
1873
1874##################################################
151b83f8
PH
1875# Check for the "less" command #
1876##################################################
1877
1878$more = "more" if system("which less >/dev/null 2>&1") != 0;
1879
1880
1881
1882##################################################
1883# Check for sudo access to root #
1884##################################################
1885
1886print "You need to have sudo access to root to run these tests. Checking ...\n";
1887if (system("sudo date >/dev/null") != 0)
1888 {
1889 die "** Test for sudo failed: testing abandoned.\n";
1890 }
1891else
1892 {
1893 print "Test for sudo OK\n";
1894 }
1895
1896
1897
1898##################################################
1899# See if an Exim binary has been given #
1900##################################################
1901
1902# If the first character of the first argument is '/', the argument is taken
1903# as the path to the binary.
1904
1905$parm_exim = (@ARGV > 0 && $ARGV[0] =~ ?^/?)? shift @ARGV : "";
1906print "Exim binary is $parm_exim\n" if $parm_exim ne "";
1907
1908
1909
1910##################################################
1911# Sort out options and which tests are to be run #
1912##################################################
1913
1914# There are a few possible options for the test script itself; after these, any
1915# options are passed on to Exim calls within the tests. Typically, this is used
1916# to turn on Exim debugging while setting up a test.
1917
1918while (@ARGV > 0 && $ARGV[0] =~ /^-/)
1919 {
1920 my($arg) = shift @ARGV;
1921 if ($optargs eq "")
1922 {
1923 if ($arg eq "-DEBUG") { $debug = 1; $cr = "\n"; next; }
1924 if ($arg eq "-DIFF") { $cf = "diff -u"; next; }
1925 if ($arg eq "-UPDATE") { $force_update = 1; next; }
1926 if ($arg eq "-NOIPV4") { $have_ipv4 = 0; next; }
1927 if ($arg eq "-NOIPV6") { $have_ipv6 = 0; next; }
1928 if ($arg eq "-KEEP") { $save_output = 1; next; }
1929 }
1930 $optargs .= " $arg";
1931 }
1932
1933# Any subsequent arguments are a range of test numbers.
1934
1935if (@ARGV > 0)
1936 {
1937 $test_end = $test_start = $ARGV[0];
1938 $test_end = $ARGV[1] if (@ARGV > 1);
1939 $test_end = ($test_start >= 9000)? $test_special_top : $test_top
1940 if $test_end eq "+";
1941 die "** Test numbers out of order\n" if ($test_end < $test_start);
1942 }
1943
1944
1945##################################################
1946# Make the command's directory current #
1947##################################################
1948
1949# After doing so, we find its absolute path name.
1950
1951$cwd = $0;
1952$cwd = '.' if ($cwd !~ s|/[^/]+$||);
1953chdir($cwd) || die "** Failed to chdir to \"$cwd\": $!\n";
1954$parm_cwd = Cwd::getcwd();
1955
1956
1957##################################################
1958# Search for an Exim binary to test #
1959##################################################
1960
1961# If an Exim binary hasn't been provided, try to find one. We can handle the
1962# case where exim-testsuite is installed alongside Exim source directories. For
1963# PH's private convenience, if there's a directory just called "exim4", that
1964# takes precedence; otherwise exim-snapshot takes precedence over any numbered
1965# releases.
1966
1967if ($parm_exim eq "")
1968 {
1969 my($use_srcdir) = "";
1970
1971 opendir DIR, ".." || die "** Failed to opendir \"..\": $!\n";
1972 while ($f = readdir(DIR))
1973 {
1974 my($srcdir);
1975
1976 # Try this directory if it is "exim4" or if it is exim-snapshot or exim-n.m
1977 # possibly followed by -RCx where n.m is greater than any previously tried
1978 # directory. Thus, we should choose the highest version of Exim that has
1979 # been compiled.
1980
1981 if ($f eq "exim4" || $f eq "exim-snapshot")
1982 { $srcdir = $f; }
1983 else
1984 { $srcdir = $f
1985 if ($f =~ /^exim-\d+\.\d+(-RC\d+)?$/ && $f gt $use_srcdir); }
1986
1987 # Look for a build directory with a binary in it. If we find a binary,
1988 # accept this source directory.
1989
1990 if ($srcdir)
1991 {
1992 opendir SRCDIR, "../$srcdir" ||
1993 die "** Failed to opendir \"$cwd/../$srcdir\": $!\n";
1994 while ($f = readdir(SRCDIR))
1995 {
1996 if ($f =~ /^build-/ && -e "../$srcdir/$f/exim")
1997 {
1998 $use_srcdir = $srcdir;
1999 $parm_exim = "$cwd/../$srcdir/$f/exim";
2000 $parm_exim =~ s'/[^/]+/\.\./'/';
2001 last;
2002 }
2003 }
2004 closedir(SRCDIR);
2005 }
2006
2007 # If we have found "exim4" or "exim-snapshot", that takes precedence.
2008 # Otherwise, continue to see if there's a later version.
2009
2010 last if $use_srcdir eq "exim4" || $use_srcdir eq "exim-snapshot";
2011 }
2012 closedir(DIR);
2013 print "Exim binary found in $parm_exim\n" if $parm_exim ne "";
2014 }
2015
2016# If $parm_exim is still empty, ask the caller
2017
2018if ($parm_exim eq "")
2019 {
2020 print "** Did not find an Exim binary to test\n";
2021 for ($i = 0; $i < 5; $i++)
2022 {
2023 my($trybin);
2024 print "** Enter pathname for Exim binary: ";
2025 chomp($trybin = <STDIN>);
2026 if (-e $trybin)
2027 {
2028 $parm_exim = $trybin;
2029 last;
2030 }
2031 else
2032 {
2033 print "** $trybin does not exist\n";
2034 }
2035 }
2036 die "** Too many tries\n" if $parm_exim eq "";
2037 }
2038
2039
2040
2041##################################################
2042# Find what is in the binary #
2043##################################################
2044
5f122889
PP
2045# deal with TRUSTED_CONFIG_LIST restrictions
2046unlink("$parm_cwd/test-config") if -e "$parm_cwd/test-config";
2047symlink("$parm_cwd/confs/0000", "$parm_cwd/test-config")
2048 or die "Unable to link initial config into place: $!\n";
2049
2050print("Probing with config file: $parm_cwd/test-config\n");
2051open(EXIMINFO, "$parm_exim -d -C $parm_cwd/test-config -DDIR=$parm_cwd " .
151b83f8
PH
2052 "-bP exim_user exim_group|") ||
2053 die "** Cannot run $parm_exim: $!\n";
2054while(<EXIMINFO>)
2055 {
2056 $parm_eximuser = $1 if /^exim_user = (.*)$/;
2057 $parm_eximgroup = $1 if /^exim_group = (.*)$/;
2058 }
2059close(EXIMINFO);
2060
2061if (defined $parm_eximuser)
2062 {
2063 if ($parm_eximuser =~ /^\d+$/) { $parm_exim_uid = $parm_eximuser; }
2064 else { $parm_exim_uid = getpwnam($parm_eximuser); }
2065 }
5f122889
PP
2066else
2067 {
2068 print "Unable to extract exim_user from binary.\n";
2069 print "Check if Exim refused to run; if so, consider:\n";
2070 print " TRUSTED_CONFIG_LIST ALT_CONFIG_PREFIX WHITELIST_D_MACROS\n";
2071 die "Failing to get information from binary.\n";
2072 }
151b83f8
PH
2073
2074if (defined $parm_eximgroup)
2075 {
2076 if ($parm_eximgroup =~ /^\d+$/) { $parm_exim_gid = $parm_eximgroup; }
2077 else { $parm_exim_gid = getgrnam($parm_eximgroup); }
2078 }
2079
5f122889 2080open(EXIMINFO, "$parm_exim -bV -C $parm_cwd/test-config -DDIR=$parm_cwd |") ||
151b83f8
PH
2081 die "** Cannot run $parm_exim: $!\n";
2082
2083print "-" x 78, "\n";
2084
2085while (<EXIMINFO>)
2086 {
2087 my(@temp);
2088
21c28500 2089 if (/^Exim version/) { print; }
151b83f8 2090
21c28500
PH
2091 elsif (/^Size of off_t: (\d+)/)
2092 {
e1b3d58d 2093 print;
21c28500 2094 $have_largefiles = 1 if $1 > 4;
e1b3d58d
JJ
2095 die "** Size of off_t > 32 which seems improbable, not running tests\n"
2096 if ($1 > 32);
21c28500
PH
2097 }
2098
2099 elsif (/^Support for: (.*)/)
151b83f8
PH
2100 {
2101 print;
2102 @temp = split /(\s+)/, $1;
2103 push(@temp, ' ');
2104 %parm_support = @temp;
2105 }
2106
33191679 2107 elsif (/^Lookups \(built-in\): (.*)/)
151b83f8
PH
2108 {
2109 print;
2110 @temp = split /(\s+)/, $1;
2111 push(@temp, ' ');
2112 %parm_lookups = @temp;
2113 }
2114
21c28500 2115 elsif (/^Authenticators: (.*)/)
151b83f8
PH
2116 {
2117 print;
2118 @temp = split /(\s+)/, $1;
2119 push(@temp, ' ');
2120 %parm_authenticators = @temp;
2121 }
2122
21c28500 2123 elsif (/^Routers: (.*)/)
151b83f8
PH
2124 {
2125 print;
2126 @temp = split /(\s+)/, $1;
2127 push(@temp, ' ');
2128 %parm_routers = @temp;
2129 }
2130
2131 # Some transports have options, e.g. appendfile/maildir. For those, ensure
2132 # that the basic transport name is set, and then the name with each of the
2133 # options.
2134
21c28500 2135 elsif (/^Transports: (.*)/)
151b83f8
PH
2136 {
2137 print;
2138 @temp = split /(\s+)/, $1;
2139 my($i,$k);
2140 push(@temp, ' ');
2141 %parm_transports = @temp;
2142 foreach $k (keys %parm_transports)
2143 {
2144 if ($k =~ "/")
2145 {
2146 @temp = split /\//, $k;
2147 $parm_transports{"$temp[0]"} = " ";
2148 for ($i = 1; $i < @temp; $i++)
2149 { $parm_transports{"$temp[0]/$temp[$i]"} = " "; }
2150 }
2151 }
2152 }
2153 }
2154close(EXIMINFO);
2155print "-" x 78, "\n";
2156
5f122889 2157unlink("$parm_cwd/test-config");
151b83f8
PH
2158
2159##################################################
2160# Check for SpamAssassin and ClamAV #
2161##################################################
2162
2163# These are crude tests. If they aren't good enough, we'll have to improve
2164# them, for example by actually passing a message through spamc or clamscan.
2165
2166if (defined $parm_support{'Content_Scanning'})
2167 {
2168 if (system("spamc -h 2>/dev/null >/dev/null") == 0)
2169 {
151b83f8
PH
2170 print "The spamc command works:\n";
2171
2172 # This test for an active SpamAssassin is courtesy of John Jetmore.
2173 # The tests are hard coded to localhost:783, so no point in making
2174 # this test flexible like the clamav test until the test scripts are
2175 # changed. spamd doesn't have the nice PING/PONG protoccol that
2176 # clamd does, but it does respond to errors in an informative manner,
2177 # so use that.
2178
2179 my($sint,$sport) = ('127.0.0.1',783);
2180 eval
2181 {
2182 my $sin = sockaddr_in($sport, inet_aton($sint))
2183 or die "** Failed packing $sint:$sport\n";
2184 socket(SOCK, PF_INET, SOCK_STREAM, getprotobyname('tcp'))
2185 or die "** Unable to open socket $sint:$sport\n";
2186
2187 local $SIG{ALRM} =
2188 sub { die "** Timeout while connecting to socket $sint:$sport\n"; };
2189 alarm(5);
2190 connect(SOCK, $sin)
2191 or die "** Unable to connect to socket $sint:$sport\n";
2192 alarm(0);
2193
2194 select((select(SOCK), $| = 1)[0]);
2195 print SOCK "bad command\r\n";
2196
2197 $SIG{ALRM} =
2198 sub { die "** Timeout while reading from socket $sint:$sport\n"; };
2199 alarm(10);
2200 my $res = <SOCK>;
2201 alarm(0);
2202
2203 $res =~ m|^SPAMD/|
2204 or die "** Did not get SPAMD from socket $sint:$sport. "
2205 ."It said: $res\n";
2206 };
2207 alarm(0);
2208 if($@)
2209 {
2210 print " $@";
2211 print " Assume SpamAssassin (spamd) is not running\n";
2212 }
2213 else
2214 {
2215 $parm_running{'SpamAssassin'} = ' ';
2216 print " SpamAssassin (spamd) seems to be running\n";
2217 }
2218 }
2219 else
2220 {
2221 print "The spamc command failed: assume SpamAssassin (spamd) is not running\n";
2222 }
2223
2224 # For ClamAV, we need to find the clamd socket for use in the Exim
2225 # configuration. Search for the clamd configuration file.
2226
2227 if (system("clamscan -h 2>/dev/null >/dev/null") == 0)
2228 {
2229 my($f, $clamconf, $test_prefix);
2230
2231 print "The clamscan command works";
2232
2233 $test_prefix = $ENV{EXIM_TEST_PREFIX};
2234 $test_prefix = "" if !defined $test_prefix;
2235
2236 foreach $f ("$test_prefix/etc/clamd.conf",
2237 "$test_prefix/usr/local/etc/clamd.conf",
2238 "$test_prefix/etc/clamav/clamd.conf", "")
2239 {
2240 if (-e $f)
2241 {
2242 $clamconf = $f;
2243 last;
2244 }
2245 }
2246
11b3bc4d
PH
2247 # Read the ClamAV configuration file and find the socket interface.
2248
151b83f8
PH
2249 if ($clamconf ne "")
2250 {
11b3bc4d 2251 my $socket_domain;
151b83f8
PH
2252 open(IN, "$clamconf") || die "\n** Unable to open $clamconf: $!\n";
2253 while (<IN>)
2254 {
2255 if (/^LocalSocket\s+(.*)/)
2256 {
2257 $parm_clamsocket = $1;
11b3bc4d 2258 $socket_domain = AF_UNIX;
151b83f8
PH
2259 last;
2260 }
11b3bc4d
PH
2261 if (/^TCPSocket\s+(\d+)/)
2262 {
2263 if (defined $parm_clamsocket)
2264 {
2265 $parm_clamsocket .= " $1";
2266 $socket_domain = AF_INET;
2267 last;
2268 }
2269 else
2270 {
2271 $parm_clamsocket = " $1";
2272 }
2273 }
2274 elsif (/^TCPAddr\s+(\S+)/)
2275 {
2276 if (defined $parm_clamsocket)
2277 {
2278 $parm_clamsocket = $1 . $parm_clamsocket;
2279 $socket_domain = AF_INET;
2280 last;
2281 }
2282 else
2283 {
2284 $parm_clamsocket = $1;
2285 }
2286 }
151b83f8
PH
2287 }
2288 close(IN);
11b3bc4d
PH
2289
2290 if (defined $socket_domain)
151b83f8
PH
2291 {
2292 print ":\n The clamd socket is $parm_clamsocket\n";
2293 # This test for an active ClamAV is courtesy of Daniel Tiefnig.
2294 eval
2295 {
11b3bc4d
PH
2296 my $socket;
2297 if ($socket_domain == AF_UNIX)
2298 {
2299 $socket = sockaddr_un($parm_clamsocket) or die "** Failed packing '$parm_clamsocket'\n";
2300 }
2301 elsif ($socket_domain == AF_INET)
2302 {
2303 my ($ca_host, $ca_port) = split(/\s+/,$parm_clamsocket);
2304 my $ca_hostent = gethostbyname($ca_host) or die "** Failed to get raw address for host '$ca_host'\n";
2305 $socket = sockaddr_in($ca_port, $ca_hostent) or die "** Failed packing '$parm_clamsocket'\n";
2306 }
2307 else
2308 {
2309 die "** Unknown socket domain '$socket_domain' (should not happen)\n";
2310 }
2311 socket(SOCK, $socket_domain, SOCK_STREAM, 0) or die "** Unable to open socket '$parm_clamsocket'\n";
151b83f8
PH
2312 local $SIG{ALRM} = sub { die "** Timeout while connecting to socket '$parm_clamsocket'\n"; };
2313 alarm(5);
11b3bc4d 2314 connect(SOCK, $socket) or die "** Unable to connect to socket '$parm_clamsocket'\n";
151b83f8
PH
2315 alarm(0);
2316
2317 my $ofh = select SOCK; $| = 1; select $ofh;
2318 print SOCK "PING\n";
2319
2320 $SIG{ALRM} = sub { die "** Timeout while reading from socket '$parm_clamsocket'\n"; };
2321 alarm(10);
2322 my $res = <SOCK>;
2323 alarm(0);
2324
2325 $res =~ /PONG/ or die "** Did not get PONG from socket '$parm_clamsocket'. It said: $res\n";
2326 };
2327 alarm(0);
2328
2329 if($@)
2330 {
520de300 2331 print " $@";
151b83f8
PH
2332 print " Assume ClamAV is not running\n";
2333 }
2334 else
2335 {
2336 $parm_running{'ClamAV'} = ' ';
2337 print " ClamAV seems to be running\n";
2338 }
2339 }
2340 else
2341 {
11b3bc4d 2342 print ", but the socket for clamd could not be determined\n";
151b83f8
PH
2343 print "Assume ClamAV is not running\n";
2344 }
2345 }
2346
2347 else
2348 {
2349 print ", but I can't find a configuration for clamd\n";
2350 print "Assume ClamAV is not running\n";
2351 }
2352 }
2353 }
2354
2355
2356##################################################
2357# Test for the basic requirements #
2358##################################################
2359
2360# This test suite assumes that Exim has been built with at least the "usual"
2361# set of routers, transports, and lookups. Ensure that this is so.
2362
2363$missing = "";
2364
2365$missing .= " Lookup: lsearch\n" if (!defined $parm_lookups{'lsearch'});
2366
2367$missing .= " Router: accept\n" if (!defined $parm_routers{'accept'});
2368$missing .= " Router: dnslookup\n" if (!defined $parm_routers{'dnslookup'});
2369$missing .= " Router: manualroute\n" if (!defined $parm_routers{'manualroute'});
2370$missing .= " Router: redirect\n" if (!defined $parm_routers{'redirect'});
2371
2372$missing .= " Transport: appendfile\n" if (!defined $parm_transports{'appendfile'});
2373$missing .= " Transport: autoreply\n" if (!defined $parm_transports{'autoreply'});
2374$missing .= " Transport: pipe\n" if (!defined $parm_transports{'pipe'});
2375$missing .= " Transport: smtp\n" if (!defined $parm_transports{'smtp'});
2376
2377if ($missing ne "")
2378 {
2379 print "\n";
2380 print "** Many features can be included or excluded from Exim binaries.\n";
2381 print "** This test suite requires that Exim is built to contain a certain\n";
2382 print "** set of basic facilities. It seems that some of these are missing\n";
2383 print "** from the binary that is under test, so the test cannot proceed.\n";
2384 print "** The missing facilities are:\n";
2385 print "$missing";
2386 die "** Test script abandoned\n";
2387 }
2388
2389
2390##################################################
2391# Check for the auxiliary programs #
2392##################################################
2393
2394# These are always required:
2395
2396for $prog ("cf", "checkaccess", "client", "client-ssl", "client-gnutls",
2397 "fakens", "iefbr14", "server")
2398 {
2399 next if ($prog eq "client-ssl" && !defined $parm_support{'OpenSSL'});
2400 next if ($prog eq "client-gnutls" && !defined $parm_support{'GnuTLS'});
2401 if (!-e "bin/$prog")
2402 {
2403 print "\n";
2404 print "** bin/$prog does not exist. Have you run ./configure and make?\n";
2405 die "** Test script abandoned\n";
2406 }
2407 }
2408
2409# If the "loaded" binary is missing, we cut out tests for ${dlfunc. It isn't
2410# compiled on systems where we don't know how to. However, if Exim does not
2411# have that functionality compiled, we needn't bother.
2412
2413$dlfunc_deleted = 0;
2414if (defined $parm_support{'Expand_dlfunc'} && !-e "bin/loaded")
2415 {
2416 delete $parm_support{'Expand_dlfunc'};
2417 $dlfunc_deleted = 1;
2418 }
2419
2420
2421##################################################
2422# Find environmental details #
2423##################################################
2424
2425# Find the caller of this program.
2426
2427($parm_caller,$pwpw,$parm_caller_uid,$parm_caller_gid,$pwquota,$pwcomm,
eeeda78a 2428 $parm_caller_gecos, $parm_caller_home) = getpwuid($>);
151b83f8
PH
2429
2430$pwpw = $pwpw; # Kill Perl warnings
2431$pwquota = $pwquota;
2432$pwcomm = $pwcomm;
151b83f8
PH
2433
2434$parm_caller_group = getgrgid($parm_caller_gid);
2435
2436print "Program caller is $parm_caller, whose group is $parm_caller_group\n";
2437print "Home directory is $parm_caller_home\n";
2438
5f122889
PP
2439unless (defined $parm_eximgroup)
2440 {
2441 print "Unable to derive \$parm_eximgroup.\n";
2442 die "** ABANDONING.\n";
2443 }
2444
151b83f8
PH
2445print "You need to be in the Exim group to run these tests. Checking ...";
2446
2447if (`groups` =~ /\b\Q$parm_eximgroup\E\b/)
2448 {
2449 print " OK\n";
2450 }
2451else
2452 {
2453 print "\nOh dear, you are not in the Exim group.\n";
2454 die "** Testing abandoned.\n";
2455 }
2456
2457# Find this host's IP addresses - there may be many, of course, but we keep
2458# one of each type (IPv4 and IPv6).
2459
2460$parm_ipv4 = "";
2461$parm_ipv6 = "";
2462
2463$local_ipv4 = "";
2464$local_ipv6 = "";
2465
2466open(IFCONFIG, "ifconfig -a|") || die "** Cannot run \"ifconfig\": $!\n";
2467while (($parm_ipv4 eq "" || $parm_ipv6 eq "") && ($_ = <IFCONFIG>))
2468 {
2469 my($ip);
2470 if ($parm_ipv4 eq "" &&
2471 $_ =~ /^\s*inet(?:\saddr)?:?\s?(\d+\.\d+\.\d+\.\d+)\s/i)
2472 {
2473 $ip = $1;
2474 next if ($ip eq "127.0.0.1");
2475 $parm_ipv4 = $ip;
2476 }
2477
2478 if ($parm_ipv6 eq "" &&
2479 $_ =~ /^\s*inet6(?:\saddr)?:?\s?([abcdef\d:]+)/i)
2480 {
2481 $ip = $1;
2482 next if ($ip eq "::1" || $ip =~ /^fe80/i);
2483 $parm_ipv6 = $ip;
2484 }
2485 }
2486close(IFCONFIG);
2487
2488# Use private IP addresses if there are no public ones.
2489
2490$parm_ipv4 = $local_ipv4 if ($parm_ipv4 eq "");
2491$parm_ipv6 = $local_ipv6 if ($parm_ipv6 eq "");
2492
2493# If either type of IP address is missing, we need to set the value to
2494# something other than empty, because that wrecks the substitutions. The value
2495# is reflected, so use a meaningful string. Set appropriate options for the
2496# "server" command. In practice, however, many tests assume 127.0.0.1 is
2497# available, so things will go wrong if there is no IPv4 address. The lack
2498# of IPV4 or IPv6 can be simulated by command options, which force $have_ipv4
2499# and $have_ipv6 false.
2500
2501if ($parm_ipv4 eq "")
2502 {
2503 $have_ipv4 = 0;
2504 $parm_ipv4 = "<no IPv4 address found>";
2505 $server_opts .= " -noipv4";
2506 }
2507elsif ($have_ipv4 == 0)
2508 {
2509 $parm_ipv4 = "<IPv4 testing disabled>";
2510 $server_opts .= " -noipv4";
2511 }
2512else
2513 {
2514 $parm_running{"IPv4"} = " ";
2515 }
2516
2517if ($parm_ipv6 eq "")
2518 {
2519 $have_ipv6 = 0;
2520 $parm_ipv6 = "<no IPv6 address found>";
2521 $server_opts .= " -noipv6";
2522 delete($parm_support{"IPv6"});
2523 }
2524elsif ($have_ipv6 == 0)
2525 {
2526 $parm_ipv6 = "<IPv6 testing disabled>";
2527 $server_opts .= " -noipv6";
2528 delete($parm_support{"IPv6"});
2529 }
2530elsif (!defined $parm_support{'IPv6'})
2531 {
2532 $have_ipv6 = 0;
2533 $parm_ipv6 = "<no IPv6 support in Exim binary>";
2534 $server_opts .= " -noipv6";
2535 }
2536else
2537 {
2538 $parm_running{"IPv6"} = " ";
2539 }
2540
2541print "IPv4 address is $parm_ipv4\n";
2542print "IPv6 address is $parm_ipv6\n";
2543
75758eeb
PH
2544# For munging test output, we need the reversed IP addresses.
2545
2546$parm_ipv4r = ($parm_ipv4 !~ /^\d/)? "" :
2547 join(".", reverse(split /\./, $parm_ipv4));
2548
1b781f48 2549$parm_ipv6r = $parm_ipv6; # Appropriate if not in use
75758eeb
PH
2550if ($parm_ipv6 =~ /^[\da-f]/)
2551 {
2552 my(@comps) = split /:/, $parm_ipv6;
2553 my(@nibbles);
2554 foreach $comp (@comps)
2555 {
2556 push @nibbles, sprintf("%lx", hex($comp) >> 8);
2557 push @nibbles, sprintf("%lx", hex($comp) & 0xff);
2558 }
2559 $parm_ipv6r = join(".", reverse(@nibbles));
2560 }
2561
151b83f8
PH
2562# Find the host name, fully qualified.
2563
2564chomp($temp = `hostname`);
2565$parm_hostname = (gethostbyname($temp))[0];
2566$parm_hostname = "no.host.name.found" if $parm_hostname eq "";
2567print "Hostname is $parm_hostname\n";
2568
2569if ($parm_hostname !~ /\./)
2570 {
2571 print "\n*** Host name is not fully qualified: this may cause problems ***\n\n";
2572 }
2573
2574# Find the user's shell
2575
2576$parm_shell = $ENV{'SHELL'};
2577
2578
2579##################################################
2580# Create a testing version of Exim #
2581##################################################
2582
2583# We want to be able to run Exim with a variety of configurations. Normally,
2584# the use of -C to change configuration causes Exim to give up its root
2585# privilege (unless the caller is exim or root). For these tests, we do not
2586# want this to happen. Also, we want Exim to know that it is running in its
2587# test harness.
2588
2589# We achieve this by copying the binary and patching it as we go. The new
2590# binary knows it is a testing copy, and it allows -C and -D without loss of
2591# privilege. Clearly, this file is dangerous to have lying around on systems
2592# where there are general users with login accounts. To protect against this,
2593# we put the new binary in a special directory that is accessible only to the
2594# caller of this script, who is known to have sudo root privilege from the test
2595# that was done above. Furthermore, we ensure that the binary is deleted at the
2596# end of the test. First ensure the directory exists.
2597
2598if (-d "eximdir")
2599 { unlink "eximdir/exim"; } # Just in case
2600else
2601 {
2602 mkdir("eximdir", 0710) || die "** Unable to mkdir $parm_cwd/eximdir: $!\n";
2603 system("sudo chgrp $parm_eximgroup eximdir");
2604 }
2605
2606# The construction of the patched binary must be done as root, so we use
2607# a separate script. As well as indicating that this is a test-harness binary,
2608# the version number is patched to "x.yz" so that its length is always the
2609# same. Otherwise, when it appears in Received: headers, it affects the length
2610# of the message, which breaks certain comparisons.
2611
2612die "** Unable to make patched exim: $!\n"
2613 if (system("sudo ./patchexim $parm_exim") != 0);
2614
2615# From this point on, exits from the program must go via the subroutine
2616# tests_exit(), so that suitable cleaning up can be done when required.
2617# Arrange to catch interrupting signals, to assist with this.
2618
2619$SIG{'INT'} = \&inthandler;
2620$SIG{'PIPE'} = \&pipehandler;
2621
2622# For some tests, we need another copy of the binary that is setuid exim rather
2623# than root.
2624
2625system("sudo cp eximdir/exim eximdir/exim_exim;" .
2626 "sudo chown $parm_eximuser eximdir/exim_exim;" .
2627 "sudo chgrp $parm_eximgroup eximdir/exim_exim;" .
2628 "sudo chmod 06755 eximdir/exim_exim");
2629
2630
2631##################################################
2632# Make copies of utilities we might need #
2633##################################################
2634
2635# Certain of the tests make use of some of Exim's utilities. We do not need
2636# to be root to copy these.
2637
2638($parm_exim_dir) = $parm_exim =~ ?^(.*)/exim?;
2639
2640$dbm_build_deleted = 0;
2641if (defined $parm_lookups{'dbm'} &&
2642 system("cp $parm_exim_dir/exim_dbmbuild eximdir") != 0)
2643 {
2644 delete $parm_lookups{'dbm'};
2645 $dbm_build_deleted = 1;
2646 }
2647
2648if (system("cp $parm_exim_dir/exim_dumpdb eximdir") != 0)
2649 {
2650 tests_exit(-1, "Failed to make a copy of exim_dumpdb: $!");
2651 }
2652
2653if (system("cp $parm_exim_dir/exim_lock eximdir") != 0)
2654 {
2655 tests_exit(-1, "Failed to make a copy of exim_lock: $!");
2656 }
2657
2658if (system("cp $parm_exim_dir/exinext eximdir") != 0)
2659 {
2660 tests_exit(-1, "Failed to make a copy of exinext: $!");
2661 }
2662
f3f065bb
PH
2663if (system("cp $parm_exim_dir/exigrep eximdir") != 0)
2664 {
2665 tests_exit(-1, "Failed to make a copy of exigrep: $!");
2666 }
2667
2668if (system("cp $parm_exim_dir/eximstats eximdir") != 0)
2669 {
2670 tests_exit(-1, "Failed to make a copy of eximstats: $!");
2671 }
2672
151b83f8
PH
2673
2674##################################################
2675# Check that the Exim user can access stuff #
2676##################################################
2677
2678# We delay this test till here so that we can check access to the actual test
2679# binary. This will be needed when Exim re-exec's itself to do deliveries.
2680
2681print "Exim user is $parm_eximuser ($parm_exim_uid)\n";
2682print "Exim group is $parm_eximgroup ($parm_exim_gid)\n";
a56f166d
JJ
2683
2684if ($parm_caller_uid eq $parm_exim_uid) {
2685 tests_exit(-1, "Exim user ($parm_eximuser,$parm_exim_uid) cannot be "
2686 ."the same as caller ($parm_caller,$parm_caller_uid)");
2687}
2688
151b83f8
PH
2689print "The Exim user needs access to the test suite directory. Checking ...";
2690
2691if (($rc = system("sudo bin/checkaccess $parm_cwd/eximdir/exim $parm_eximuser $parm_eximgroup")) != 0)
2692 {
2693 my($why) = "unknown failure $rc";
2694 $rc >>= 8;
2695 $why = "Couldn't find user \"$parm_eximuser\"" if $rc == 1;
2696 $why = "Couldn't find group \"$parm_eximgroup\"" if $rc == 2;
2697 $why = "Couldn't read auxiliary group list" if $rc == 3;
2698 $why = "Couldn't get rid of auxiliary groups" if $rc == 4;
2699 $why = "Couldn't set gid" if $rc == 5;
2700 $why = "Couldn't set uid" if $rc == 6;
2701 $why = "Couldn't open \"$parm_cwd/eximdir/exim\"" if $rc == 7;
2702 print "\n** $why\n";
2703 tests_exit(-1, "$parm_eximuser cannot access the test suite directory");
2704 }
2705else
2706 {
2707 print " OK\n";
2708 }
2709
2710
2711##################################################
2712# Create a list of available tests #
2713##################################################
2714
2715# The scripts directory contains a number of subdirectories whose names are
2716# of the form 0000-xxxx, 1100-xxxx, 2000-xxxx, etc. Each set of tests apart
2717# from the first requires certain optional features to be included in the Exim
2718# binary. These requirements are contained in a file called "REQUIRES" within
2719# the directory. We scan all these tests, discarding those that cannot be run
2720# because the current binary does not support the right facilities, and also
2721# those that are outside the numerical range selected.
2722
2723print "\nTest range is $test_start to $test_end\n";
2724print "Omitting \${dlfunc expansion tests (loadable module not present)\n"
2725 if $dlfunc_deleted;
2726print "Omitting dbm tests (unable to copy exim_dbmbuild)\n"
2727 if $dbm_build_deleted;
2728
2729opendir(DIR, "scripts") || tests_exit(-1, "Failed to opendir(\"scripts\"): $!");
2730@test_dirs = sort readdir(DIR);
2731closedir(DIR);
2732
9e146c9f
PH
2733# Remove . and .. and CVS from the list.
2734
2735for ($i = 0; $i < @test_dirs; $i++)
2736 {
2737 my($d) = $test_dirs[$i];
2738 if ($d eq "." || $d eq ".." || $d eq "CVS")
2739 {
2740 splice @test_dirs, $i, 1;
2741 $i--;
2742 }
2743 }
2744
2745# Scan for relevant tests
2746
151b83f8
PH
2747for ($i = 0; $i < @test_dirs; $i++)
2748 {
2749 my($testdir) = $test_dirs[$i];
2750 my($wantthis) = 1;
2751
151b83f8
PH
2752 print ">>Checking $testdir\n" if $debug;
2753
2754 # Skip this directory if the first test is equal or greater than the first
2755 # test in the next directory.
2756
2757 next if ($i < @test_dirs - 1) &&
2758 ($test_start >= substr($test_dirs[$i+1], 0, 4));
2759
2760 # No need to carry on if the end test is less than the first test in this
2761 # subdirectory.
2762
2763 last if $test_end < substr($testdir, 0, 4);
2764
2765 # Check requirements, if any.
2766
2767 if (open(REQUIRES, "scripts/$testdir/REQUIRES"))
2768 {
2769 while (<REQUIRES>)
2770 {
2771 next if /^\s*$/;
2772 s/\s+$//;
2773 if (/^support (.*)$/)
2774 {
2775 if (!defined $parm_support{$1}) { $wantthis = 0; last; }
2776 }
2777 elsif (/^running (.*)$/)
2778 {
2779 if (!defined $parm_running{$1}) { $wantthis = 0; last; }
2780 }
2781 elsif (/^lookup (.*)$/)
2782 {
2783 if (!defined $parm_lookups{$1}) { $wantthis = 0; last; }
2784 }
2785 elsif (/^authenticators? (.*)$/)
2786 {
2787 if (!defined $parm_authenticators{$1}) { $wantthis = 0; last; }
2788 }
2789 elsif (/^router (.*)$/)
2790 {
2791 if (!defined $parm_routers{$1}) { $wantthis = 0; last; }
2792 }
2793 elsif (/^transport (.*)$/)
2794 {
2795 if (!defined $parm_transports{$1}) { $wantthis = 0; last; }
2796 }
2797 else
2798 {
2799 tests_exit(-1, "Unknown line in \"scripts/$testdir/REQUIRES\": \"$_\"");
2800 }
2801 }
2802 close(REQUIRES);
2803 }
2804 else
2805 {
2806 tests_exit(-1, "Failed to open \"scripts/$testdir/REQUIRES\": $!")
2807 unless $!{ENOENT};
2808 }
2809
2810 # Loop if we do not want the tests in this subdirectory.
2811
2812 if (!$wantthis)
2813 {
2814 chomp;
2815 print "Omitting tests in $testdir (missing $_)\n";
2816 next;
2817 }
2818
2819 # We want the tests from this subdirectory, provided they are in the
2820 # range that was selected.
2821
2822 opendir(SUBDIR, "scripts/$testdir") ||
2823 tests_exit(-1, "Failed to opendir(\"scripts/$testdir\"): $!");
2824 @testlist = sort readdir(SUBDIR);
2825 close(SUBDIR);
2826
2827 foreach $test (@testlist)
2828 {
2829 next if $test !~ /^\d{4}$/;
2830 next if $test < $test_start || $test > $test_end;
2831 push @test_list, "$testdir/$test";
2832 }
2833 }
2834
2835print ">>Test List: @test_list\n", if $debug;
2836
2837
2838##################################################
2839# Munge variable auxiliary data #
2840##################################################
2841
2842# Some of the auxiliary data files have to refer to the current testing
2843# directory and other parameter data. The generic versions of these files are
2844# stored in the aux-var-src directory. At this point, we copy each of them
2845# to the aux-var directory, making appropriate substitutions. There aren't very
2846# many of them, so it's easiest just to do this every time. Ensure the mode
2847# is standardized, as this path is used as a test for the ${stat: expansion.
2848
2849# A similar job has to be done for the files in the dnszones-src directory, to
2850# make the fake DNS zones for testing. Most of the zone files are copied to
2851# files of the same name, but db.ipv4.V4NET and db.ipv6.V6NET use the testing
2852# networks that are defined by parameter.
2853
2854foreach $basedir ("aux-var", "dnszones")
2855 {
2856 system("sudo rm -rf $parm_cwd/$basedir");
2857 mkdir("$parm_cwd/$basedir", 0777);
2858 chmod(0755, "$parm_cwd/$basedir");
2859
2860 opendir(AUX, "$parm_cwd/$basedir-src") ||
2861 tests_exit(-1, "Failed to opendir $parm_cwd/$basedir-src: $!");
2862 my(@filelist) = readdir(AUX);
2863 close(AUX);
2864
2865 foreach $file (@filelist)
2866 {
2867 my($outfile) = $file;
2868 next if $file =~ /^\./;
2869
2870 if ($file eq "db.ip4.V4NET")
2871 {
2872 $outfile = "db.ip4.$parm_ipv4_test_net";
2873 }
2874 elsif ($file eq "db.ip6.V6NET")
2875 {
2876 my(@nibbles) = reverse(split /\s*/, $parm_ipv6_test_net);
2877 $" = '.';
2878 $outfile = "db.ip6.@nibbles";
2879 $" = ' ';
2880 }
2881
2882 print ">>Copying $basedir-src/$file to $basedir/$outfile\n" if $debug;
2883 open(IN, "$parm_cwd/$basedir-src/$file") ||
2884 tests_exit(-1, "Failed to open $parm_cwd/$basedir-src/$file: $!");
2885 open(OUT, ">$parm_cwd/$basedir/$outfile") ||
2886 tests_exit(-1, "Failed to open $parm_cwd/$basedir/$outfile: $!");
2887 while (<IN>)
2888 {
2889 do_substitute(0);
2890 print OUT;
2891 }
2892 close(IN);
2893 close(OUT);
2894 }
2895 }
2896
2897
2898##################################################
2899# Create fake DNS zones for this host #
2900##################################################
2901
2902# There are fixed zone files for 127.0.0.1 and ::1, but we also want to be
2903# sure that there are forward and reverse registrations for this host, using
2904# its real IP addresses. Dynamically created zone files achieve this.
2905
2906if ($have_ipv4 || $have_ipv6)
2907 {
2908 my($shortname,$domain) = $parm_hostname =~ /^([^.]+)(.*)/;
2909 open(OUT, ">$parm_cwd/dnszones/db$domain") ||
2910 tests_exit(-1, "Failed to open $parm_cwd/dnszones/db$domain: $!");
2911 print OUT "; This is a dynamically constructed fake zone file.\n" .
2912 "; The following line causes fakens to return PASS_ON\n" .
2913 "; for queries that it cannot answer\n\n" .
2914 "PASS ON NOT FOUND\n\n";
2915 print OUT "$shortname A $parm_ipv4\n" if $have_ipv4;
2916 print OUT "$shortname AAAA $parm_ipv6\n" if $have_ipv6;
2917 print OUT "\n; End\n";
2918 close(OUT);
2919 }
2920
2921if ($have_ipv4 && $parm_ipv4 ne "127.0.0.1")
2922 {
2923 my(@components) = $parm_ipv4 =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)/;
2924 open(OUT, ">$parm_cwd/dnszones/db.ip4.$components[0]") ||
2925 tests_exit(-1,
2926 "Failed to open $parm_cwd/dnszones/db.ip4.$components[0]: $!");
2927 print OUT "; This is a dynamically constructed fake zone file.\n" .
2928 "; The zone is $components[0].in-addr.arpa.\n\n" .
2929 "$components[3].$components[2].$components[1] PTR $parm_hostname.\n\n" .
2930 "; End\n";
2931 close(OUT);
2932 }
2933
2934if ($have_ipv6 && $parm_ipv6 ne "::1")
2935 {
2936 my(@components) = split /:/, $parm_ipv6;
2937 my(@nibbles) = reverse (split /\s*/, shift @components);
2938 my($sep) = "";
2939
2940 $" = ".";
2941 open(OUT, ">$parm_cwd/dnszones/db.ip6.@nibbles") ||
2942 tests_exit(-1,
2943 "Failed to open $parm_cwd/dnszones/db.ip6.@nibbles: $!");
2944 print OUT "; This is a dynamically constructed fake zone file.\n" .
2945 "; The zone is @nibbles.ip6.arpa.\n\n";
2946
2947 @components = reverse @components;
2948 foreach $c (@components)
2949 {
2950 $c = "0$c" until $c =~ /^..../;
2951 @nibbles = reverse(split /\s*/, $c);
2952 print OUT "$sep@nibbles";
2953 $sep = ".";
2954 }
2955
2956 print OUT " PTR $parm_hostname.\n\n; End\n";
2957 close(OUT);
2958 $" = " ";
2959 }
2960
2961
2962
2963##################################################
2964# Create lists of mailboxes and message logs #
2965##################################################
2966
2967# We use these lists to check that a test has created the expected files. It
2968# should be faster than looking for the file each time. For mailboxes, we have
2969# to scan a complete subtree, in order to handle maildirs. For msglogs, there
2970# is just a flat list of files.
2971
2972@oldmails = list_files_below("mail");
2973opendir(DIR, "msglog") || tests_exit(-1, "Failed to opendir msglog: $!");
2974@oldmsglogs = readdir(DIR);
2975closedir(DIR);
2976
2977
2978
2979##################################################
2980# Run the required tests #
2981##################################################
2982
2983# Each test script contains a number of tests, separated by a line that
2984# contains ****. We open input from the terminal so that we can read responses
2985# to prompts.
2986
2987open(T, "/dev/tty") || tests_exit(-1, "Failed to open /dev/tty: $!");
2988
2989print "\nPress RETURN to run the tests: ";
2990$_ = <T>;
2991print "\n";
2992
2993$lasttestdir = "";
2994
2995foreach $test (@test_list)
2996 {
2997 local($lineno) = 0;
2998 local($commandno) = 0;
2999 local($subtestno) = 0;
3000 local($testno) = substr($test, -4);
3001 local($sortlog) = 0;
3002
3003 my($gnutls) = 0;
3004 my($docheck) = 1;
3005 my($thistestdir) = substr($test, 0, -5);
3006
3007 if ($lasttestdir ne $thistestdir)
3008 {
3009 $gnutls = 0;
3010 if (-s "scripts/$thistestdir/REQUIRES")
3011 {
3012 my($indent) = "";
3013 print "\n>>> The following tests require: ";
3014 open(IN, "scripts/$thistestdir/REQUIRES") ||
3015 tests_exit(-1, "Failed to open scripts/$thistestdir/REQUIRES: $1");
3016 while (<IN>)
3017 {
3018 $gnutls = 1 if /^support GnuTLS/;
3019 print $indent, $_;
3020 $indent = ">>> ";
3021 }
3022 close(IN);
3023 }
3024 }
3025 $lasttestdir = $thistestdir;
3026
3027 # Remove any debris in the spool directory and the test-mail directory
3028 # and also the files for collecting stdout and stderr. Then put back
3029 # the test-mail directory for appendfile deliveries.
3030
3031 system "sudo /bin/rm -rf spool test-*";
3032 system "mkdir test-mail 2>/dev/null";
3033
3034 # A privileged Exim will normally make its own spool directory, but some of
3035 # the tests run in unprivileged modes that don't always work if the spool
3036 # directory isn't already there. What is more, we want anybody to be able
3037 # to read it in order to find the daemon's pid.
3038
3039 system "mkdir spool; " .
3040 "sudo chown $parm_eximuser:$parm_eximgroup spool; " .
3041 "sudo chmod 0755 spool";
3042
3043 # Empty the cache that keeps track of things like message id mappings, and
3044 # set up the initial sequence strings.
3045
3046 undef %cache;
3047 $next_msgid = "aX";
f3f065bb 3048 $next_pid = 1234;
151b83f8
PH
3049 $next_port = 1111;
3050 $message_skip = 0;
3051 $msglog_skip = 0;
3052 $stderr_skip = 0;
3053 $stdout_skip = 0;
3054 $rmfiltertest = 0;
3055 $is_ipv6test = 0;
3056
3057 # Remove the associative arrays used to hold checked mail files and msglogs
3058
3059 undef %expected_mails;
3060 undef %expected_msglogs;
3061
3062 # Open the test's script
3063
3064 open(SCRIPT, "scripts/$test") ||
3065 tests_exit(-1, "Failed to open \"scripts/$test\": $!");
3066
3067 # The first line in the script must be a comment that is used to identify
3068 # the set of tests as a whole.
3069
3070 $_ = <SCRIPT>;
3071 $lineno++;
3072 tests_exit(-1, "Missing identifying comment at start of $test") if (!/^#/);
3073 printf("%s %s", (substr $test, 5), (substr $_, 2));
3074
3075 # Loop for each of the subtests within the script. The variable $server_pid
3076 # is used to remember the pid of a "server" process, for which we do not
3077 # wait until we have waited for a subsequent command.
3078
3079 local($server_pid) = 0;
3080 for ($commandno = 1; !eof SCRIPT; $commandno++)
3081 {
3082 # Skip further leading comments and blank lines, handle the flag setting
3083 # commands, and deal with tests for IP support.
3084
3085 while (<SCRIPT>)
3086 {
3087 $lineno++;
3088 if (/^no_message_check/) { $message_skip = 1; next; }
3089 if (/^no_msglog_check/) { $msglog_skip = 1; next; }
3090 if (/^no_stderr_check/) { $stderr_skip = 1; next; }
3091 if (/^no_stdout_check/) { $stdout_skip = 1; next; }
3092 if (/^rmfiltertest/) { $rmfiltertest = 1; next; }
3093 if (/^sortlog/) { $sortlog = 1; next; }
3094
21c28500
PH
3095 if (/^need_largefiles/)
3096 {
3097 next if $have_largefiles;
3098 print ">>> Large file support is needed for test $testno, but is not available: skipping\n";
3099 $docheck = 0; # don't check output
3100 undef $_; # pretend EOF
3101 last;
3102 }
3103
151b83f8
PH
3104 if (/^need_ipv4/)
3105 {
3106 next if $have_ipv4;
3107 print ">>> IPv4 is needed for test $testno, but is not available: skipping\n";
3108 $docheck = 0; # don't check output
3109 undef $_; # pretend EOF
3110 last;
3111 }
3112
3113 if (/^need_ipv6/)
3114 {
3115 if ($have_ipv6)
3116 {
3117 $is_ipv6test = 1;
3118 next;
3119 }
3120 print ">>> IPv6 is needed for test $testno, but is not available: skipping\n";
3121 $docheck = 0; # don't check output
3122 undef $_; # pretend EOF
3123 last;
3124 }
3125
3126 if (/^need_move_frozen_messages/)
3127 {
3128 next if defined $parm_support{"move_frozen_messages"};
3129 print ">>> move frozen message support is needed for test $testno, " .
3130 "but is not\n>>> available: skipping\n";
3131 $docheck = 0; # don't check output
3132 undef $_; # pretend EOF
3133 last;
3134 }
3135
3136 last unless /^(#|\s*$)/;
3137 }
3138 last if !defined $_; # Hit EOF
3139
3140 my($subtest_startline) = $lineno;
3141
3142 # Now run the command. The function returns 0 if exim was run and waited
3143 # for, 1 if any other command was run and waited for, and 2 if a command
3144 # was run and not waited for (usually a daemon or server startup).
3145
3146 my($commandname) = "";
3147 my($expectrc) = 0;
3148 my($rc) = run_command($testno, \$subtestno, \$expectrc, \$commandname);
3149 my($cmdrc) = $?;
3150
3151 print ">> rc=$rc cmdrc=$cmdrc\n" if $debug;
3152
3153 # Hit EOF after an initial return code number
3154
3155 tests_exit(-1, "Unexpected EOF in script") if ($rc == 4);
3156
3157 # Carry on with the next command if we did not wait for this one. $rc == 0
3158 # if no subprocess was run; $rc == 3 if we started a process but did not
3159 # wait for it.
3160
3161 next if ($rc == 0 || $rc == 3);
3162
3163 # We ran and waited for a command. Check for the expected result unless
3164 # it died.
3165
3166 if ($cmdrc != $expectrc && !$sigpipehappened)
3167 {
3168 printf("** Command $commandno (\"$commandname\", starting at line $subtest_startline)\n");
3169 if (($cmdrc & 0xff) == 0)
3170 {
3171 printf("** Return code %d (expected %d)", $cmdrc/256, $expectrc/256);
3172 }
3173 elsif (($cmdrc & 0xff00) == 0)
3174 { printf("** Killed by signal %d", $cmdrc & 255); }
3175 else
3176 { printf("** Status %x", $cmdrc); }
3177
3178 for (;;)
3179 {
3180 print "\nshow stdErr, show stdOut, Continue (without file comparison), or Quit? [Q] ";
3181 $_ = <T>;
3182 tests_exit(1) if /^q?$/i;
3183 last if /^c$/i;
3184 if (/^e$/i)
3185 {
3186 system("$more test-stderr");
3187 }
3188 elsif (/^o$/i)
3189 {
3190 system("$more test-stdout");
3191 }
3192 }
3193
3194 $docheck = 0;
3195 }
3196
3197 # If the command was exim, and a listening server is running, we can now
3198 # close its input, which causes us to wait for it to finish, which is why
3199 # we didn't close it earlier.
3200
3201 if ($rc == 2 && $server_pid != 0)
3202 {
3203 close SERVERCMD;
3204 $server_pid = 0;
3205 if ($? != 0)
3206 {
3207 if (($? & 0xff) == 0)
3208 { printf("Server return code %d", $?/256); }
3209 elsif (($? & 0xff00) == 0)
3210 { printf("Server killed by signal %d", $? & 255); }
3211 else
3212 { printf("Server status %x", $?); }
3213
3214 for (;;)
3215 {
3216 print "\nShow server stdout, Continue, or Quit? [Q] ";
3217 $_ = <T>;
3218 tests_exit(1) if /^q?$/i;
3219 last if /^c$/i;
3220
3221 if (/^s$/i)
3222 {
3223 open(S, "test-stdout-server") ||
3224 tests_exit(-1, "Failed to open test-stdout-server: $!");
3225 print while <S>;
3226 close(S);
3227 }
3228 }
3229 }
3230 }
3231 }
3232
3233 close SCRIPT;
3234
3235 # The script has finished. Check the all the output that was generated. The
3236 # function returns 0 if all is well, 1 if we should rerun the test (the files
3237 # have been updated). It does not return if the user responds Q to a prompt.
3238
3239 if ($docheck)
3240 {
3241 if (check_output() != 0)
3242 {
3243 print (("#" x 79) . "\n");
3244 redo;
3245 }
3246 else
3247 {
3248 print (" Script completed\n");
3249 }
3250 }
3251 }
3252
3253
3254##################################################
3255# Exit from the test script #
3256##################################################
3257
3258tests_exit(-1, "No runnable tests selected") if @test_list == 0;
3259tests_exit(0);
3260
3261# End of runtest script
5f122889 3262# vim: set sw=2 :