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