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