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