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