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