Testsuite: ignore optional-config output
[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/CONNECT_CR_FINISHED/ssl3_read_bytes/i;
907 s/^\d+:error:\d+(?:E\d+)?(:SSL routines:ssl3_read_bytes:[^:]+:).*(:SSL alert number \d\d)$/pppp:error:dddddddd$1\[...\]$2/;
908
909 # gnutls version variances
910 next if /^Error in the pull function./;
911
912 # optional IDN2 variant conversions. Accept either IDN1 or IDN2
913 s/conversion strasse.de/conversion xn--strae-oqa.de/;
914 s/conversion: german.xn--strae-oqa.de/conversion: german.straße.de/;
915
916 # subsecond timstamp info in reported header-files
917 s/^(-received_time_usec \.)\d{6}$/$1uuuuuu/;
918 }
919
920 # ======== stderr ========
921
922 elsif ($is_stderr)
923 {
924 # The very first line of debugging output will vary
925
926 s/^Exim version .*/Exim version x.yz ..../;
927
928 # Debugging lines for Exim terminations
929
930 s/(?<=^>>>>>>>>>>>>>>>> Exim pid=)\d+(?= terminating)/pppp/;
931
932 # IP address lookups use gethostbyname() when IPv6 is not supported,
933 # and gethostbyname2() or getipnodebyname() when it is.
934
935 s/\b(gethostbyname2?|\bgetipnodebyname)(\(af=inet\))?/get[host|ipnode]byname[2]/;
936
937 # drop gnutls version strings
938 next if /GnuTLS compile-time version: \d+[\.\d]+$/;
939 next if /GnuTLS runtime version: \d+[\.\d]+$/;
940
941 # drop openssl version strings
942 next if /OpenSSL compile-time version: OpenSSL \d+[\.\da-z]+/;
943 next if /OpenSSL runtime version: OpenSSL \d+[\.\da-z]+/;
944
945 # drop lookups
946 next if /^Lookups \(built-in\):/;
947 next if /^Loading lookup modules from/;
948 next if /^Loaded \d+ lookup modules/;
949 next if /^Total \d+ lookups/;
950
951 # drop compiler information
952 next if /^Compiler:/;
953
954 # and the ugly bit
955 # different libraries will have different numbers (possibly 0) of follow-up
956 # lines, indenting with more data
957 if (/^Library version:/) {
958 while (1) {
959 $_ = <IN>;
960 next if /^\s/;
961 goto RESET_AFTER_EXTRA_LINE_READ;
962 }
963 }
964
965 # drop other build-time controls emitted for debugging
966 next if /^WHITELIST_D_MACROS:/;
967 next if /^TRUSTED_CONFIG_LIST:/;
968
969 # As of Exim 4.74, we log when a setgid fails; because we invoke Exim
970 # with -be, privileges will have been dropped, so this will always
971 # be the case
972 next if /^changing group to \d+ failed: (Operation not permitted|Not owner)/;
973
974 # We might not keep this check; rather than change all the tests, just
975 # ignore it as long as it succeeds; then we only need to change the
976 # TLS tests where tls_require_ciphers has been set.
977 if (m{^changed uid/gid: calling tls_validate_require_cipher}) {
978 my $discard = <IN>;
979 next;
980 }
981 next if /^tls_validate_require_cipher child \d+ ended: status=0x0/;
982
983 # We invoke Exim with -D, so we hit this new message as of Exim 4.73:
984 next if /^macros_trusted overridden to true by whitelisting/;
985
986 # We have to omit the localhost ::1 address so that all is well in
987 # the IPv4-only case.
988
989 print MUNGED "MUNGED: ::1 will be omitted in what follows\n"
990 if (/looked up these IP addresses/);
991 next if /name=localhost address=::1/;
992
993 # drop pdkim debugging header
994 next if /^PDKIM <<<<<<<<<<<<<<<<<<<<<<<<<<<<<+$/;
995
996 # Various other IPv6 lines must be omitted too
997
998 next if /using host_fake_gethostbyname for \S+ \(IPv6\)/;
999 next if /get\[host\|ipnode\]byname\[2\]\(af=inet6\)/;
1000 next if /DNS lookup of \S+ \(AAAA\) using fakens/;
1001 next if / in dns_ipv4_lookup?/;
1002
1003 if (/DNS lookup of \S+ \(AAAA\) gave NO_DATA/)
1004 {
1005 $_= <IN>; # Gets "returning DNS_NODATA"
1006 next;
1007 }
1008
1009 # Skip tls_advertise_hosts and hosts_require_tls checks when the options
1010 # are unset, because tls ain't always there.
1011
1012 next if /in\s(?:tls_advertise_hosts\?|hosts_require_tls\?)
1013 \sno\s\((option\sunset|end\sof\slist)\)/x;
1014
1015 # Skip auxiliary group lists because they will vary.
1016
1017 next if /auxiliary group list:/;
1018
1019 # Skip "extracted from gecos field" because the gecos field varies
1020
1021 next if /extracted from gecos field/;
1022
1023 # Skip "waiting for data on socket" and "read response data: size=" lines
1024 # because some systems pack more stuff into packets than others.
1025
1026 next if /waiting for data on socket/;
1027 next if /read response data: size=/;
1028
1029 # If Exim is compiled with readline support but it can't find the library
1030 # to load, there will be an extra debug line. Omit it.
1031
1032 next if /failed to load readline:/;
1033
1034 # Some DBM libraries seem to make DBM files on opening with O_RDWR without
1035 # O_CREAT; other's don't. In the latter case there is some debugging output
1036 # which is not present in the former. Skip the relevant lines (there are
1037 # two of them).
1038
1039 if (/TESTSUITE\/spool\/db\/\S+ appears not to exist: trying to create/)
1040 {
1041 $_ = <IN>;
1042 next;
1043 }
1044
1045 # Some tests turn on +expand debugging to check on expansions.
1046 # Unfortunately, the Received: expansion varies, depending on whether TLS
1047 # is compiled or not. So we must remove the relevant debugging if it is.
1048
1049 if (/^condition: def:tls_cipher/)
1050 {
1051 while (<IN>) { last if /^condition: def:sender_address/; }
1052 }
1053 elsif (/^expanding: Received: /)
1054 {
1055 while (<IN>) { last if !/^\s/; }
1056 }
1057
1058 # remote port numbers vary
1059 s/(Connection request from 127.0.0.1 port) \d{1,5}/$1 sssss/;
1060
1061 # Skip hosts_require_dane checks when the options
1062 # are unset, because dane ain't always there.
1063
1064 next if /in\shosts_require_dane\?\sno\s\(option\sunset\)/x;
1065
1066 # SUPPORT_PROXY
1067 next if /host in hosts_proxy\?/;
1068
1069 # Experimental_International
1070 next if / in smtputf8_advertise_hosts\? no \(option unset\)/;
1071
1072 # Environment cleaning
1073 next if /\w+ in keep_environment\? (yes|no)/;
1074
1075 # Sizes vary with test hostname
1076 s/^cmd buf flush \d+ bytes$/cmd buf flush ddd bytes/;
1077
1078 # Spool filesystem free space changes on different systems.
1079 s/^((?:spool|log) directory space =) -?\d+K (inodes =)\s*-?\d+/$1 nnnnnK $2 nnnnn/;
1080
1081 # Non-TLS builds have different expansions for received_header_text
1082 if (s/(with \$received_protocol)\}\} \$\{if def:tls_cipher \{\(\$tls_cipher\)\n$/$1/)
1083 {
1084 $_ .= <IN>;
1085 s/[ â•Ž]+\}\}(?=\(Exim )/\}\} /;
1086 }
1087 if (/^ condition: def:tls_cipher$/)
1088 {
1089 <IN>; <IN>; <IN>; <IN>; <IN>; <IN>;
1090 <IN>; <IN>; <IN>; <IN>; <IN>; next;
1091 }
1092
1093 # Not all platforms build with DKIM enabled
1094 next if /^PDKIM >> Body data for hash, canonicalized/;
1095
1096 # Not all platforms have sendfile support
1097 next if /^cannot use sendfile for body: no support$/;
1098
1099 # Parts of DKIM-specific debug output depend on the time/date
1100 next if /^date:\w+,\{SP\}/;
1101 next if /^PDKIM \[[^[]+\] (Header hash|b) computed:/;
1102
1103 # Not all platforms support TCP Fast Open, and the compile omits the check
1104 if (s/\S+ in hosts_try_fastopen\? no \(option unset\)\n$//)
1105 {
1106 $_ .= <IN>;
1107 s/ \.\.\. >>> / ... /;
1108 s/Address family not supported by protocol family/Network Error/;
1109 s/Network is unreachable/Network Error/;
1110 }
1111
1112 next if /^(ppppp )?setsockopt FASTOPEN: Protocol not available$/;
1113
1114 # Specific pointer values reported for DB operations change from run to run
1115 s/^(returned from EXIM_DBOPEN: 0x)[0-9a-f]+/$1AAAAAAAA/;
1116 s/^(EXIM_DBCLOSE.0x)[0-9a-f]+/$1AAAAAAAA/;
1117
1118 # When Exim is checking the size of directories for maildir, it uses
1119 # the check_dir_size() function to scan directories. Of course, the order
1120 # of the files that are obtained using readdir() varies from system to
1121 # system. We therefore buffer up debugging lines from check_dir_size()
1122 # and sort them before outputting them.
1123
1124 if (/^check_dir_size:/ || /^skipping TESTSUITE\/test-mail\//)
1125 {
1126 push @saved, $_;
1127 }
1128 else
1129 {
1130 if (@saved > 0)
1131 {
1132 print MUNGED "MUNGED: the check_dir_size lines have been sorted " .
1133 "to ensure consistency\n";
1134 @saved = sort(@saved);
1135 print MUNGED @saved;
1136 @saved = ();
1137 }
1138
1139 # Skip some lines that Exim puts out at the start of debugging output
1140 # because they will be different in different binaries.
1141
1142 print MUNGED
1143 unless (/^Berkeley DB: / ||
1144 /^Probably (?:Berkeley DB|ndbm|GDBM)/ ||
1145 /^Authenticators:/ ||
1146 /^Lookups:/ ||
1147 /^Support for:/ ||
1148 /^Routers:/ ||
1149 /^Transports:/ ||
1150 /^log selectors =/ ||
1151 /^cwd=/ ||
1152 /^Fixed never_users:/ ||
1153 /^Configure owner:/ ||
1154 /^Size of off_t:/
1155 );
1156
1157
1158 }
1159
1160 next;
1161 }
1162
1163 # ======== log ========
1164
1165 elsif ($is_log)
1166 {
1167 # Berkeley DB version differences
1168 next if / Berkeley DB error: /;
1169
1170 # CHUNKING: exact sizes depend on hostnames in headers
1171 s/(=>.* K C="250- \d)\d+ (byte chunk, total \d)\d+/$1nn $2nn/;
1172
1173 # openssl version variances
1174 s/(TLS error on connection .*: error:)[0-9A-F]{8}(:system library):func\(4095\):(No such file or
1175 directory)$/$1xxxxxxxx$2:fopen:$3/;
1176 }
1177
1178 # ======== All files other than stderr ========
1179
1180 print MUNGED;
1181 }
1182
1183 close(IN);
1184 return $yield;
1185 }
1186
1187
1188
1189
1190 ##################################################
1191 # Subroutine to interact with caller #
1192 ##################################################
1193
1194 # Arguments: [0] the prompt string
1195 # [1] if there is a U in the prompt and $force_update is true
1196 # [2] if there is a C in the prompt and $force_continue is true
1197 # Returns: returns the answer
1198
1199 sub interact {
1200 my ($prompt, $have_u, $have_c) = @_;
1201
1202 print $prompt;
1203
1204 if ($have_u) {
1205 print "... update forced\n";
1206 return 'u';
1207 }
1208
1209 if ($have_c) {
1210 print "... continue forced\n";
1211 return 'c';
1212 }
1213
1214 return lc <T>;
1215 }
1216
1217
1218
1219 ##################################################
1220 # Subroutine to log in force_continue mode #
1221 ##################################################
1222
1223 # In force_continue mode, we just want a terse output to a statically
1224 # named logfile. If multiple files in same batch (stdout, stderr, etc)
1225 # all have mismatches, it will log multiple times.
1226 #
1227 # Arguments: [0] the logfile to append to
1228 # [1] the testno that failed
1229 # Returns: nothing
1230
1231
1232
1233 sub log_failure {
1234 my ($logfile, $testno, $detail) = @_;
1235
1236 open(my $fh, '>>', $logfile) or return;
1237
1238 print $fh "Test $testno "
1239 . (defined $detail ? "$detail " : '')
1240 . "failed\n";
1241 }
1242
1243 # Computer-readable summary results logfile
1244
1245 sub log_test {
1246 my ($logfile, $testno, $resultchar) = @_;
1247
1248 open(my $fh, '>>', $logfile) or return;
1249 print $fh "$testno $resultchar\n";
1250 }
1251
1252
1253
1254 ##################################################
1255 # Subroutine to compare one output file #
1256 ##################################################
1257
1258 # When an Exim server is part of the test, its output is in separate files from
1259 # an Exim client. The server data is concatenated with the client data as part
1260 # of the munging operation.
1261 #
1262 # Arguments: [0] the name of the main raw output file
1263 # [1] the name of the server raw output file or undef
1264 # [2] where to put the munged copy
1265 # [3] the name of the saved file
1266 # [4] TRUE if this is a log file whose deliveries must be sorted
1267 # [5] optionally, a custom munge command
1268 #
1269 # Returns: 0 comparison succeeded
1270 # 1 comparison failed; differences to be ignored
1271 # 2 comparison failed; files may have been updated (=> re-compare)
1272 #
1273 # Does not return if the user replies "Q" to a prompt.
1274
1275 sub check_file{
1276 my($rf,$rsf,$mf,$sf,$sortfile,$extra) = @_;
1277
1278 # If there is no saved file, the raw files must either not exist, or be
1279 # empty. The test ! -s is TRUE if the file does not exist or is empty.
1280
1281 # we check if there is a flavour specific file, but we remember
1282 # the original file name as "generic"
1283 $sf_generic = $sf;
1284 $sf_flavour = "$sf_generic.$flavour";
1285 $sf_current = -e $sf_flavour ? $sf_flavour : $sf_generic;
1286
1287 if (! -e $sf_current)
1288 {
1289 return 0 if (! -s $rf && (! defined $rsf || ! -s $rsf));
1290
1291 print "\n";
1292 print "** $rf is not empty\n" if (-s $rf);
1293 print "** $rsf is not empty\n" if (defined $rsf && -s $rsf);
1294
1295 for (;;)
1296 {
1297 $_ = interact('Continue, Show, or Quit? [Q] ', undef, $force_continue);
1298 tests_exit(1) if /^q?$/;
1299 if (/^c$/ && $force_continue) {
1300 log_failure($log_failed_filename, $testno, $rf);
1301 log_test($log_summary_filename, $testno, 'F') if ($force_continue);
1302 }
1303 return 1 if /^c$/i && $rf !~ /paniclog/ && $rsf !~ /paniclog/;
1304 last if (/^[sc]$/);
1305 }
1306
1307 foreach $f ($rf, $rsf)
1308 {
1309 if (defined $f && -s $f)
1310 {
1311 print "\n";
1312 print "------------ $f -----------\n"
1313 if (defined $rf && -s $rf && defined $rsf && -s $rsf);
1314 system("$more '$f'");
1315 }
1316 }
1317
1318 print "\n";
1319 for (;;)
1320 {
1321 $_ = interact('Continue, Update & retry, Quit? [Q] ', $force_update, $force_continue);
1322 tests_exit(1) if /^q?$/;
1323 if (/^c$/ && $force_continue) {
1324 log_failure($log_failed_filename, $testno, $rf);
1325 log_test($log_summary_filename, $testno, 'F')
1326 }
1327 return 1 if /^c$/i;
1328 last if (/^u$/i);
1329 }
1330 }
1331
1332 #### $_
1333
1334 # Control reaches here if either (a) there is a saved file ($sf), or (b) there
1335 # was a request to create a saved file. First, create the munged file from any
1336 # data that does exist.
1337
1338 open(MUNGED, '>', $mf) || tests_exit(-1, "Failed to open $mf: $!");
1339 my($truncated) = munge($rf, $extra) if -e $rf;
1340
1341 # Append the raw server log, if it is non-empty
1342 if (defined $rsf && -e $rsf)
1343 {
1344 print MUNGED "\n******** SERVER ********\n";
1345 $truncated |= munge($rsf, $extra);
1346 }
1347 close(MUNGED);
1348
1349 # If a saved file exists, do the comparison. There are two awkward cases:
1350 #
1351 # If "*** truncated ***" was found in the new file, it means that a log line
1352 # was overlong, and truncated. The problem is that it may be truncated at
1353 # different points on different systems, because of different user name
1354 # lengths. We reload the file and the saved file, and remove lines from the new
1355 # file that precede "*** truncated ***" until we reach one that matches the
1356 # line that precedes it in the saved file.
1357 #
1358 # If $sortfile is set, we are dealing with a mainlog file where the deliveries
1359 # for an individual message might vary in their order from system to system, as
1360 # a result of parallel deliveries. We load the munged file and sort sequences
1361 # of delivery lines.
1362
1363 if (-e $sf_current)
1364 {
1365 # Deal with truncated text items
1366
1367 if ($truncated)
1368 {
1369 my(@munged, @saved, $i, $j, $k);
1370
1371 open(MUNGED, $mf) || tests_exit(-1, "Failed to open $mf: $!");
1372 @munged = <MUNGED>;
1373 close(MUNGED);
1374 open(SAVED, $sf_current) || tests_exit(-1, "Failed to open $sf_current: $!");
1375 @saved = <SAVED>;
1376 close(SAVED);
1377
1378 $j = 0;
1379 for ($i = 0; $i < @munged; $i++)
1380 {
1381 if ($munged[$i] =~ /\*\*\* truncated \*\*\*/)
1382 {
1383 for (; $j < @saved; $j++)
1384 { last if $saved[$j] =~ /\*\*\* truncated \*\*\*/; }
1385 last if $j >= @saved; # not found in saved
1386
1387 for ($k = $i - 1; $k >= 0; $k--)
1388 { last if $munged[$k] eq $saved[$j - 1]; }
1389
1390 last if $k <= 0; # failed to find previous match
1391 splice @munged, $k + 1, $i - $k - 1;
1392 $i = $k + 1;
1393 }
1394 }
1395
1396 open(MUNGED, '>', $mf) || tests_exit(-1, "Failed to open $mf: $!");
1397 for ($i = 0; $i < @munged; $i++)
1398 { print MUNGED $munged[$i]; }
1399 close(MUNGED);
1400 }
1401
1402 # Deal with log sorting
1403
1404 if ($sortfile)
1405 {
1406 my(@munged, $i, $j);
1407
1408 open(MUNGED, $mf) || tests_exit(-1, "Failed to open $mf: $!");
1409 @munged = <MUNGED>;
1410 close(MUNGED);
1411
1412 for ($i = 0; $i < @munged; $i++)
1413 {
1414 if ($munged[$i] =~ /^[-\d]{10}\s[:\d]{8}\s[-A-Za-z\d]{16}\s[-=*]>/)
1415 {
1416 for ($j = $i + 1; $j < @munged; $j++)
1417 {
1418 last if $munged[$j] !~
1419 /^[-\d]{10}\s[:\d]{8}\s[-A-Za-z\d]{16}\s[-=*]>/;
1420 }
1421 @temp = splice(@munged, $i, $j - $i);
1422 @temp = sort(@temp);
1423 splice(@munged, $i, 0, @temp);
1424 }
1425 }
1426
1427 open(MUNGED, ">$mf") || tests_exit(-1, "Failed to open $mf: $!");
1428 print MUNGED "**NOTE: The delivery lines in this file have been sorted.\n";
1429 for ($i = 0; $i < @munged; $i++)
1430 { print MUNGED $munged[$i]; }
1431 close(MUNGED);
1432 }
1433
1434 # Do the comparison
1435
1436 return 0 if (system("$cf '$mf' '$sf_current' >test-cf") == 0);
1437
1438 # Handle comparison failure
1439
1440 print "** Comparison of $mf with $sf_current failed";
1441 system("$more test-cf");
1442
1443 print "\n";
1444 for (;;)
1445 {
1446 $_ = interact('Continue, Retry, Update current'
1447 . ($sf_current ne $sf_flavour ? "/Save for flavour '$flavour'" : '')
1448 . ' & retry, Quit? [Q] ', $force_update, $force_continue);
1449 tests_exit(1) if /^q?$/;
1450 if (/^c$/ && $force_continue) {
1451 log_failure($log_failed_filename, $testno, $sf_current);
1452 log_test($log_summary_filename, $testno, 'F')
1453 }
1454 return 1 if /^c$/i;
1455 return 2 if /^r$/i;
1456 last if (/^[us]$/i);
1457 }
1458 }
1459
1460 # Update or delete the saved file, and give the appropriate return code.
1461
1462 if (-s $mf)
1463 {
1464 my $sf = /^u/i ? $sf_current : $sf_flavour;
1465 tests_exit(-1, "Failed to cp $mf $sf") if system("cp '$mf' '$sf'") != 0;
1466 }
1467 else
1468 {
1469 # if we deal with a flavour file, we can't delete it, because next time the generic
1470 # file would be used again
1471 if ($sf_current eq $sf_flavour) {
1472 open(FOO, ">$sf_current");
1473 close(FOO);
1474 }
1475 else {
1476 tests_exit(-1, "Failed to unlink $sf_current") if !unlink($sf_current);
1477 }
1478 }
1479
1480 return 2;
1481 }
1482
1483
1484
1485 ##################################################
1486 # Custom munges
1487 # keyed by name of munge; value is a ref to a hash
1488 # which is keyed by file, value a string to look for.
1489 # Usable files are:
1490 # paniclog, rejectlog, mainlog, stdout, stderr, msglog, mail
1491 # Search strings starting with 's' do substitutions;
1492 # with '/' do line-skips.
1493 # Triggered by a scriptfile line "munge <name>"
1494 ##################################################
1495 $munges =
1496 { 'dnssec' =>
1497 { 'stderr' => '/^Reverse DNS security status: unverified\n/' },
1498
1499 'gnutls_unexpected' =>
1500 { 'mainlog' => '/\(recv\): A TLS packet with unexpected length was received./' },
1501
1502 'gnutls_handshake' =>
1503 { 'mainlog' => 's/\(gnutls_handshake\): Error in the push function/\(gnutls_handshake\): A TLS packet with unexpected length was received/' },
1504
1505 'optional_events' =>
1506 { 'stdout' => '/event_action =/' },
1507
1508 'optional_ocsp' =>
1509 { 'stderr' => '/127.0.0.1 in hosts_requ(ire|est)_ocsp/' },
1510
1511 'optional_cert_hostnames' =>
1512 { 'stderr' => '/in tls_verify_cert_hostnames\? no/' },
1513
1514 'loopback' =>
1515 { 'stdout' => 's/[[](127\.0\.0\.1|::1)]/[IP_LOOPBACK_ADDR]/' },
1516
1517 'scanfile_size' =>
1518 { 'stdout' => 's/(Content-length:) \d\d\d/$1 ddd/' },
1519
1520 'delay_1500' =>
1521 { 'stderr' => 's/(1[5-9]|23\d)\d\d msec/ssss msec/' },
1522
1523 'tls_anycipher' =>
1524 { 'mainlog' => 's/ X=TLS\S+ / X=TLS_proto_and_cipher /' },
1525
1526 'debug_pid' =>
1527 { 'stderr' => 's/(^\s{0,4}|(?<=Process )|(?<=child ))\d{1,5}/ppppp/g' },
1528
1529 'optional_dsn_info' =>
1530 { 'mail' => '/^(X-(Remote-MTA-(smtp-greeting|helo-response)|Exim-Diagnostic|(body|message)-linecount):|Remote-MTA: X-ip;)/'
1531 },
1532
1533 'optional_config' =>
1534 { 'stdout' => '/^(
1535 dkim_(canon|domain|private_key|selector|sign_headers|strict|hash|identity)
1536 |gnutls_require_(kx|mac|protocols)
1537 |hosts_(requ(est|ire)|try)_(dane|ocsp)
1538 |hosts_(avoid|nopass|noproxy|require|verify_avoid)_tls
1539 |socks_proxy
1540 |tls_[^ ]*
1541 )($|[ ]=)/x'
1542 },
1543
1544 'sys_bindir' =>
1545 { 'mainlog' => 's%/(usr/(local/)?)?bin/%SYSBINDIR/%' },
1546
1547 'sync_check_data' =>
1548 { 'mainlog' => 's/^(.* SMTP protocol synchronization error .* next input=.{8}).*$/$1<suppressed>/',
1549 'rejectlog' => 's/^(.* SMTP protocol synchronization error .* next input=.{8}).*$/$1<suppressed>/'},
1550
1551 'debuglog_stdout' =>
1552 { 'stdout' => 's/^\d\d:\d\d:\d\d\s+\d+ //;
1553 s/Process \d+ is ready for new message/Process pppp is ready for new message/'
1554 },
1555
1556 'timeout_errno' => # actual errno differs Solaris vs. Linux
1557 { 'mainlog' => 's/(host deferral .* errno) <\d+> /$1 <EEE> /' },
1558
1559 'peer_terminated_conn' => # actual error differs FreedBSD vs. Linux
1560 { 'stderr' => 's/^( SMTP\()Connection reset by peer(\)<<)$/$1closed$2/' },
1561
1562 'perl_variants'
1563 };
1564
1565
1566 sub max {
1567 my ($a, $b) = @_;
1568 return $a if ($a > $b);
1569 return $b;
1570 }
1571
1572 ##################################################
1573 # Subroutine to check the output of a test #
1574 ##################################################
1575
1576 # This function is called when the series of subtests is complete. It makes
1577 # use of check_file(), whose arguments are:
1578 #
1579 # [0] the name of the main raw output file
1580 # [1] the name of the server raw output file or undef
1581 # [2] where to put the munged copy
1582 # [3] the name of the saved file
1583 # [4] TRUE if this is a log file whose deliveries must be sorted
1584 # [5] an optional custom munge command
1585 #
1586 # Arguments: Optionally, name of a single custom munge to run.
1587 # Returns: 0 if the output compared equal
1588 # 1 if comparison failed; differences to be ignored
1589 # 2 if re-run needed (files may have been updated)
1590
1591 sub check_output{
1592 my($mungename) = $_[0];
1593 my($yield) = 0;
1594 my($munge) = $munges->{$mungename} if defined $mungename;
1595
1596 $yield = max($yield, check_file("spool/log/paniclog",
1597 "spool/log/serverpaniclog",
1598 "test-paniclog-munged",
1599 "paniclog/$testno", 0,
1600 $munge->{paniclog}));
1601
1602 $yield = max($yield, check_file("spool/log/rejectlog",
1603 "spool/log/serverrejectlog",
1604 "test-rejectlog-munged",
1605 "rejectlog/$testno", 0,
1606 $munge->{rejectlog}));
1607
1608 $yield = max($yield, check_file("spool/log/mainlog",
1609 "spool/log/servermainlog",
1610 "test-mainlog-munged",
1611 "log/$testno", $sortlog,
1612 $munge->{mainlog}));
1613
1614 if (!$stdout_skip)
1615 {
1616 $yield = max($yield, check_file("test-stdout",
1617 "test-stdout-server",
1618 "test-stdout-munged",
1619 "stdout/$testno", 0,
1620 $munge->{stdout}));
1621 }
1622
1623 if (!$stderr_skip)
1624 {
1625 $yield = max($yield, check_file("test-stderr",
1626 "test-stderr-server",
1627 "test-stderr-munged",
1628 "stderr/$testno", 0,
1629 $munge->{stderr}));
1630 }
1631
1632 # Compare any delivered messages, unless this test is skipped.
1633
1634 if (! $message_skip)
1635 {
1636 my($msgno) = 0;
1637
1638 # Get a list of expected mailbox files for this script. We don't bother with
1639 # directories, just the files within them.
1640
1641 foreach $oldmail (@oldmails)
1642 {
1643 next unless $oldmail =~ /^mail\/$testno\./;
1644 print ">> EXPECT $oldmail\n" if $debug;
1645 $expected_mails{$oldmail} = 1;
1646 }
1647
1648 # If there are any files in test-mail, compare them. Note that "." and
1649 # ".." are automatically omitted by list_files_below().
1650
1651 @mails = list_files_below("test-mail");
1652
1653 foreach $mail (@mails)
1654 {
1655 next if $mail eq "test-mail/oncelog";
1656
1657 $saved_mail = substr($mail, 10); # Remove "test-mail/"
1658 $saved_mail =~ s/^$parm_caller(\/|$)/CALLER/; # Convert caller name
1659
1660 if ($saved_mail =~ /(\d+\.[^.]+\.)/)
1661 {
1662 $msgno++;
1663 $saved_mail =~ s/(\d+\.[^.]+\.)/$msgno./gx;
1664 }
1665
1666 print ">> COMPARE $mail mail/$testno.$saved_mail\n" if $debug;
1667 $yield = max($yield, check_file($mail, undef, "test-mail-munged",
1668 "mail/$testno.$saved_mail", 0,
1669 $munge->{mail}));
1670 delete $expected_mails{"mail/$testno.$saved_mail"};
1671 }
1672
1673 # Complain if not all expected mails have been found
1674
1675 if (scalar(keys %expected_mails) != 0)
1676 {
1677 foreach $key (keys %expected_mails)
1678 { print "** no test file found for $key\n"; }
1679
1680 for (;;)
1681 {
1682 $_ = interact('Continue, Update & retry, or Quit? [Q] ', $force_update, $force_continue);
1683 tests_exit(1) if /^q?$/;
1684 if (/^c$/ && $force_continue) {
1685 log_failure($log_failed_filename, $testno, "missing email");
1686 log_test($log_summary_filename, $testno, 'F')
1687 }
1688 last if /^c$/;
1689
1690 # For update, we not only have to unlink the file, but we must also
1691 # remove it from the @oldmails vector, as otherwise it will still be
1692 # checked for when we re-run the test.
1693
1694 if (/^u$/)
1695 {
1696 foreach $key (keys %expected_mails)
1697 {
1698 my($i);
1699 tests_exit(-1, "Failed to unlink $key") if !unlink("$key");
1700 for ($i = 0; $i < @oldmails; $i++)
1701 {
1702 if ($oldmails[$i] eq $key)
1703 {
1704 splice @oldmails, $i, 1;
1705 last;
1706 }
1707 }
1708 }
1709 last;
1710 }
1711 }
1712 }
1713 }
1714
1715 # Compare any remaining message logs, unless this test is skipped.
1716
1717 if (! $msglog_skip)
1718 {
1719 # Get a list of expected msglog files for this test
1720
1721 foreach $oldmsglog (@oldmsglogs)
1722 {
1723 next unless $oldmsglog =~ /^$testno\./;
1724 $expected_msglogs{$oldmsglog} = 1;
1725 }
1726
1727 # If there are any files in spool/msglog, compare them. However, we have
1728 # to munge the file names because they are message ids, which are
1729 # time dependent.
1730
1731 if (opendir(DIR, "spool/msglog"))
1732 {
1733 @msglogs = sort readdir(DIR);
1734 closedir(DIR);
1735
1736 foreach $msglog (@msglogs)
1737 {
1738 next if ($msglog eq "." || $msglog eq ".." || $msglog eq "CVS");
1739 ($munged_msglog = $msglog) =~
1740 s/((?:[^\W_]{6}-){2}[^\W_]{2})
1741 /new_value($1, "10Hm%s-0005vi-00", \$next_msgid)/egx;
1742 $yield = max($yield, check_file("spool/msglog/$msglog", undef,
1743 "test-msglog-munged", "msglog/$testno.$munged_msglog", 0,
1744 $munge->{msglog}));
1745 delete $expected_msglogs{"$testno.$munged_msglog"};
1746 }
1747 }
1748
1749 # Complain if not all expected msglogs have been found
1750
1751 if (scalar(keys %expected_msglogs) != 0)
1752 {
1753 foreach $key (keys %expected_msglogs)
1754 {
1755 print "** no test msglog found for msglog/$key\n";
1756 ($msgid) = $key =~ /^\d+\.(.*)$/;
1757 foreach $cachekey (keys %cache)
1758 {
1759 if ($cache{$cachekey} eq $msgid)
1760 {
1761 print "** original msgid $cachekey\n";
1762 last;
1763 }
1764 }
1765 }
1766
1767 for (;;)
1768 {
1769 $_ = interact('Continue, Update, or Quit? [Q] ', $force_update, $force_continue);
1770 tests_exit(1) if /^q?$/;
1771 if (/^c$/ && $force_continue) {
1772 log_failure($log_failed_filename, $testno, "missing msglog");
1773 log_test($log_summary_filename, $testno, 'F')
1774 }
1775 last if /^c$/;
1776 if (/^u$/)
1777 {
1778 foreach $key (keys %expected_msglogs)
1779 {
1780 tests_exit(-1, "Failed to unlink msglog/$key")
1781 if !unlink("msglog/$key");
1782 }
1783 last;
1784 }
1785 }
1786 }
1787 }
1788
1789 return $yield;
1790 }
1791
1792
1793
1794 ##################################################
1795 # Subroutine to run one "system" command #
1796 ##################################################
1797
1798 # We put this in a subroutine so that the command can be reflected when
1799 # debugging.
1800 #
1801 # Argument: the command to be run
1802 # Returns: nothing
1803
1804 sub run_system {
1805 my($cmd) = $_[0];
1806 if ($debug)
1807 {
1808 my($prcmd) = $cmd;
1809 $prcmd =~ s/; /;\n>> /;
1810 print ">> $prcmd\n";
1811 }
1812 system("$cmd");
1813 }
1814
1815
1816
1817 ##################################################
1818 # Subroutine to run one script command #
1819 ##################################################
1820
1821 # The <SCRIPT> file is open for us to read an optional return code line,
1822 # followed by the command line and any following data lines for stdin. The
1823 # command line can be continued by the use of \. Data lines are not continued
1824 # in this way. In all lines, the following substitutions are made:
1825 #
1826 # DIR => the current directory
1827 # CALLER => the caller of this script
1828 #
1829 # Arguments: the current test number
1830 # reference to the subtest number, holding previous value
1831 # reference to the expected return code value
1832 # reference to where to put the command name (for messages)
1833 # auxiliary information returned from a previous run
1834 #
1835 # Returns: 0 the command was executed inline, no subprocess was run
1836 # 1 a non-exim command was run and waited for
1837 # 2 an exim command was run and waited for
1838 # 3 a command was run and not waited for (daemon, server, exim_lock)
1839 # 4 EOF was encountered after an initial return code line
1840 # Optionally also a second parameter, a hash-ref, with auxiliary information:
1841 # exim_pid: pid of a run process
1842 # munge: name of a post-script results munger
1843
1844 sub run_command{
1845 my($testno) = $_[0];
1846 my($subtestref) = $_[1];
1847 my($commandnameref) = $_[3];
1848 my($aux_info) = $_[4];
1849 my($yield) = 1;
1850
1851 our %ENV = map { $_ => $ENV{$_} } grep { /^(?:USER|SHELL|PATH|TERM|EXIM_TEST_.*)$/ } keys %ENV;
1852
1853 if (/^(\d+)\s*$/) # Handle unusual return code
1854 {
1855 my($r) = $_[2];
1856 $$r = $1 << 8;
1857 $_ = <SCRIPT>;
1858 return 4 if !defined $_; # Missing command
1859 $lineno++;
1860 }
1861
1862 chomp;
1863 $wait_time = 0;
1864
1865 # Handle concatenated command lines
1866
1867 s/\s+$//;
1868 while (substr($_, -1) eq"\\")
1869 {
1870 my($temp);
1871 $_ = substr($_, 0, -1);
1872 chomp($temp = <SCRIPT>);
1873 if (defined $temp)
1874 {
1875 $lineno++;
1876 $temp =~ s/\s+$//;
1877 $temp =~ s/^\s+//;
1878 $_ .= $temp;
1879 }
1880 }
1881
1882 # Do substitutions
1883
1884 do_substitute($testno);
1885 if ($debug) { printf ">> $_\n"; }
1886
1887 # Pass back the command name (for messages)
1888
1889 ($$commandnameref) = /^(\S+)/;
1890
1891 # Here follows code for handling the various different commands that are
1892 # supported by this script. The first group of commands are all freestanding
1893 # in that they share no common code and are not followed by any data lines.
1894
1895
1896 ###################
1897 ###################
1898
1899 # The "dbmbuild" command runs exim_dbmbuild. This is used both to test the
1900 # utility and to make DBM files for testing DBM lookups.
1901
1902 if (/^dbmbuild\s+(\S+)\s+(\S+)/)
1903 {
1904 run_system("(./eximdir/exim_dbmbuild $parm_cwd/$1 $parm_cwd/$2;" .
1905 "echo exim_dbmbuild exit code = \$?)" .
1906 ">>test-stdout");
1907 return 1;
1908 }
1909
1910
1911 # The "dump" command runs exim_dumpdb. On different systems, the output for
1912 # some types of dump may appear in a different order because it's just hauled
1913 # out of the DBM file. We can solve this by sorting. Ignore the leading
1914 # date/time, as it will be flattened later during munging.
1915
1916 if (/^dump\s+(\S+)/)
1917 {
1918 my($which) = $1;
1919 my(@temp);
1920 print ">> ./eximdir/exim_dumpdb $parm_cwd/spool $which\n" if $debug;
1921 open(IN, "./eximdir/exim_dumpdb $parm_cwd/spool $which |");
1922 open(OUT, ">>test-stdout");
1923 print OUT "+++++++++++++++++++++++++++\n";
1924
1925 if ($which eq "retry")
1926 {
1927 $/ = "\n ";
1928 @temp = <IN>;
1929 $/ = "\n";
1930
1931 @temp = sort {
1932 my($aa) = split(' ', $a);
1933 my($bb) = split(' ', $b);
1934 return $aa cmp $bb;
1935 } @temp;
1936
1937 foreach $item (@temp)
1938 {
1939 $item =~ s/^\s*(.*)\n(.*)\n?\s*$/$1\n$2/m;
1940 print OUT " $item\n";
1941 }
1942 }
1943 else
1944 {
1945 @temp = <IN>;
1946 if ($which eq "callout")
1947 {
1948 @temp = sort {
1949 my($aa) = substr $a, 21;
1950 my($bb) = substr $b, 21;
1951 return $aa cmp $bb;
1952 } @temp;
1953 }
1954 print OUT @temp;
1955 }
1956
1957 close(IN);
1958 close(OUT);
1959 return 1;
1960 }
1961
1962
1963 # verbose comments start with ###
1964 if (/^###\s/) {
1965 for my $file (qw(test-stdout test-stderr test-stderr-server test-stdout-server)) {
1966 open my $fh, '>>', $file or die "Can't open >>$file: $!\n";
1967 say {$fh} $_;
1968 }
1969 return 0;
1970 }
1971
1972 # The "echo" command is a way of writing comments to the screen.
1973 if (/^echo\s+(.*)$/)
1974 {
1975 print "$1\n";
1976 return 0;
1977 }
1978
1979
1980 # The "exim_lock" command runs exim_lock in the same manner as "server",
1981 # but it doesn't use any input.
1982
1983 if (/^exim_lock\s+(.*)$/)
1984 {
1985 $cmd = "./eximdir/exim_lock $1 >>test-stdout";
1986 $server_pid = open SERVERCMD, "|$cmd" ||
1987 tests_exit(-1, "Failed to run $cmd\n");
1988
1989 # This gives the process time to get started; otherwise the next
1990 # process may not find it there when it expects it.
1991
1992 select(undef, undef, undef, 0.1);
1993 return 3;
1994 }
1995
1996
1997 # The "exinext" command runs exinext
1998
1999 if (/^exinext\s+(.*)/)
2000 {
2001 run_system("(./eximdir/exinext " .
2002 "-DEXIM_PATH=$parm_cwd/eximdir/exim " .
2003 "-C $parm_cwd/test-config $1;" .
2004 "echo exinext exit code = \$?)" .
2005 ">>test-stdout");
2006 return 1;
2007 }
2008
2009
2010 # The "exigrep" command runs exigrep on the current mainlog
2011
2012 if (/^exigrep\s+(.*)/)
2013 {
2014 run_system("(./eximdir/exigrep " .
2015 "$1 $parm_cwd/spool/log/mainlog;" .
2016 "echo exigrep exit code = \$?)" .
2017 ">>test-stdout");
2018 return 1;
2019 }
2020
2021
2022 # The "eximstats" command runs eximstats on the current mainlog
2023
2024 if (/^eximstats\s+(.*)/)
2025 {
2026 run_system("(./eximdir/eximstats " .
2027 "$1 $parm_cwd/spool/log/mainlog;" .
2028 "echo eximstats exit code = \$?)" .
2029 ">>test-stdout");
2030 return 1;
2031 }
2032
2033
2034 # The "gnutls" command makes a copy of saved GnuTLS parameter data in the
2035 # spool directory, to save Exim from re-creating it each time.
2036
2037 if (/^gnutls/)
2038 {
2039 my $gen_fn = "spool/gnutls-params-$gnutls_dh_bits_normal";
2040 run_system "sudo cp -p aux-fixed/gnutls-params $gen_fn;" .
2041 "sudo chown $parm_eximuser:$parm_eximgroup $gen_fn;" .
2042 "sudo chmod 0400 $gen_fn";
2043 return 1;
2044 }
2045
2046
2047 # The "killdaemon" command should ultimately follow the starting of any Exim
2048 # daemon with the -bd option. We kill with SIGINT rather than SIGTERM to stop
2049 # it outputting "Terminated" to the terminal when not in the background.
2050
2051 if (/^killdaemon/)
2052 {
2053 my $return_extra = {};
2054 if (exists $aux_info->{exim_pid})
2055 {
2056 $pid = $aux_info->{exim_pid};
2057 $return_extra->{exim_pid} = undef;
2058 print ">> killdaemon: recovered pid $pid\n" if $debug;
2059 if ($pid)
2060 {
2061 run_system("sudo /bin/kill -INT $pid");
2062 wait;
2063 }
2064 } else {
2065 $pid = `cat $parm_cwd/spool/exim-daemon.*`;
2066 if ($pid)
2067 {
2068 run_system("sudo /bin/kill -INT $pid");
2069 close DAEMONCMD; # Waits for process
2070 }
2071 }
2072 run_system("sudo /bin/rm -f spool/exim-daemon.*");
2073 return (1, $return_extra);
2074 }
2075
2076
2077 # The "millisleep" command is like "sleep" except that its argument is in
2078 # milliseconds, thus allowing for a subsecond sleep, which is, in fact, all it
2079 # is used for.
2080
2081 elsif (/^millisleep\s+(.*)$/)
2082 {
2083 select(undef, undef, undef, $1/1000);
2084 return 0;
2085 }
2086
2087
2088 # The "munge" command selects one of a hardwired set of test-result modifications
2089 # to be made before result compares are run agains the golden set. This lets
2090 # us account for test-system dependent things which only affect a few, but known,
2091 # test-cases.
2092 # Currently only the last munge takes effect.
2093
2094 if (/^munge\s+(.*)$/)
2095 {
2096 return (0, { munge => $1 });
2097 }
2098
2099
2100 # The "sleep" command does just that. For sleeps longer than 1 second we
2101 # tell the user what's going on.
2102
2103 if (/^sleep\s+(.*)$/)
2104 {
2105 if ($1 == 1)
2106 {
2107 sleep(1);
2108 }
2109 else
2110 {
2111 printf(" Test %d sleep $1 ", $$subtestref);
2112 for (1..$1)
2113 {
2114 print ".";
2115 sleep(1);
2116 }
2117 printf("\r Test %d $cr", $$subtestref);
2118 }
2119 return 0;
2120 }
2121
2122
2123 # Various Unix management commands are recognized
2124
2125 if (/^(ln|ls|du|mkdir|mkfifo|touch|cp|cat)\s/ ||
2126 /^sudo\s(rmdir|rm|mv|chown|chmod)\s/)
2127 {
2128 run_system("$_ >>test-stdout 2>>test-stderr");
2129 return 1;
2130 }
2131
2132
2133
2134 ###################
2135 ###################
2136
2137 # The next group of commands are also freestanding, but they are all followed
2138 # by data lines.
2139
2140
2141 # The "server" command starts up a script-driven server that runs in parallel
2142 # with the following exim command. Therefore, we want to run a subprocess and
2143 # not yet wait for it to complete. The waiting happens after the next exim
2144 # command, triggered by $server_pid being non-zero. The server sends its output
2145 # to a different file. The variable $server_opts, if not empty, contains
2146 # options to disable IPv4 or IPv6 if necessary.
2147 # This works because "server" swallows its stdin before waiting for a connection.
2148
2149 if (/^server\s+(.*)$/)
2150 {
2151 $pidfile = "$parm_cwd/aux-var/server-daemon.pid";
2152 $cmd = "./bin/server $server_opts -oP $pidfile $1 >>test-stdout-server";
2153 print ">> $cmd\n" if ($debug);
2154 $server_pid = open SERVERCMD, "|$cmd" || tests_exit(-1, "Failed to run $cmd");
2155 SERVERCMD->autoflush(1);
2156 print ">> Server pid is $server_pid\n" if $debug;
2157 while (<SCRIPT>)
2158 {
2159 $lineno++;
2160 last if /^\*{4}\s*$/;
2161 print SERVERCMD;
2162 }
2163 print SERVERCMD "++++\n"; # Send end to server; can't send EOF yet
2164 # because close() waits for the process.
2165
2166 # Interlock the server startup; otherwise the next
2167 # process may not find it there when it expects it.
2168 while (! stat("$pidfile") ) { select(undef, undef, undef, 0.3); }
2169 return 3;
2170 }
2171
2172
2173 # The "write" command is a way of creating files of specific sizes for
2174 # buffering tests, or containing specific data lines from within the script
2175 # (rather than hold lots of little files). The "catwrite" command does the
2176 # same, but it also copies the lines to test-stdout.
2177
2178 if (/^(cat)?write\s+(\S+)(?:\s+(.*))?\s*$/)
2179 {
2180 my($cat) = defined $1;
2181 @sizes = ();
2182 @sizes = split /\s+/, $3 if defined $3;
2183 open FILE, ">$2" || tests_exit(-1, "Failed to open \"$2\": $!");
2184
2185 if ($cat)
2186 {
2187 open CAT, ">>test-stdout" ||
2188 tests_exit(-1, "Failed to open test-stdout: $!");
2189 print CAT "==========\n";
2190 }
2191
2192 if (scalar @sizes > 0)
2193 {
2194 # Pre-data
2195
2196 while (<SCRIPT>)
2197 {
2198 $lineno++;
2199 last if /^\+{4}\s*$/;
2200 print FILE;
2201 print CAT if $cat;
2202 }
2203
2204 # Sized data
2205
2206 while (scalar @sizes > 0)
2207 {
2208 ($count,$len,$leadin) = (shift @sizes) =~ /(\d+)x(\d+)(?:=(.*))?/;
2209 $leadin = '' if !defined $leadin;
2210 $leadin =~ s/_/ /g;
2211 $len -= length($leadin) + 1;
2212 while ($count-- > 0)
2213 {
2214 print FILE $leadin, "a" x $len, "\n";
2215 print CAT $leadin, "a" x $len, "\n" if $cat;
2216 }
2217 }
2218 }
2219
2220 # Post data, or only data if no sized data
2221
2222 while (<SCRIPT>)
2223 {
2224 $lineno++;
2225 last if /^\*{4}\s*$/;
2226 print FILE;
2227 print CAT if $cat;
2228 }
2229 close FILE;
2230
2231 if ($cat)
2232 {
2233 print CAT "==========\n";
2234 close CAT;
2235 }
2236
2237 return 0;
2238 }
2239
2240
2241 ###################
2242 ###################
2243
2244 # From this point on, script commands are implemented by setting up a shell
2245 # command in the variable $cmd. Shared code to run this command and handle its
2246 # input and output follows.
2247
2248 # The "client", "client-gnutls", and "client-ssl" commands run a script-driven
2249 # program that plays the part of an email client. We also have the availability
2250 # of running Perl for doing one-off special things. Note that all these
2251 # commands expect stdin data to be supplied.
2252
2253 if (/^client/ || /^(sudo\s+)?perl\b/)
2254 {
2255 s"client"./bin/client";
2256 $cmd = "$_ >>test-stdout 2>>test-stderr";
2257 }
2258
2259 # For the "exim" command, replace the text "exim" with the path for the test
2260 # binary, plus -D options to pass over various parameters, and a -C option for
2261 # the testing configuration file. When running in the test harness, Exim does
2262 # not drop privilege when -C and -D options are present. To run the exim
2263 # command as root, we use sudo.
2264
2265 elsif (/^((?i:[A-Z\d_]+=\S+\s+)+)?(\d+)?\s*(sudo(?:\s+-u\s+(\w+))?\s+)?exim(_\S+)?\s+(.*)$/)
2266 {
2267 $args = $6;
2268 my($envset) = (defined $1)? $1 : '';
2269 my($sudo) = (defined $3)? "sudo " . (defined $4 ? "-u $4 ":'') : '';
2270 my($special)= (defined $5)? $5 : '';
2271 $wait_time = (defined $2)? $2 : 0;
2272
2273 # Return 2 rather than 1 afterwards
2274
2275 $yield = 2;
2276
2277 # Update the test number
2278
2279 $$subtestref = $$subtestref + 1;
2280 printf(" Test %d $cr", $$subtestref);
2281
2282 # Copy the configuration file, making the usual substitutions.
2283
2284 open (IN, "$parm_cwd/confs/$testno") ||
2285 tests_exit(-1, "Couldn't open $parm_cwd/confs/$testno: $!\n");
2286 open (OUT, ">test-config") ||
2287 tests_exit(-1, "Couldn't open test-config: $!\n");
2288 while (<IN>)
2289 {
2290 do_substitute($testno);
2291 print OUT;
2292 }
2293 close(IN);
2294 close(OUT);
2295
2296 # The string $msg1 in args substitutes the message id of the first
2297 # message on the queue, and so on. */
2298
2299 if ($args =~ /\$msg/)
2300 {
2301 my @listcmd = ("$parm_cwd/eximdir/exim", '-bp',
2302 "-DEXIM_PATH=$parm_cwd/eximdir/exim",
2303 -C => "$parm_cwd/test-config");
2304 print ">> Getting queue list from:\n>> @listcmd\n" if $debug;
2305 # We need the message ids sorted in ascending order.
2306 # Message id is: <timestamp>-<pid>-<fractional-time>. On some systems (*BSD) the
2307 # PIDs are randomized, so sorting just the whole PID doesn't work.
2308 # We do the Schartz' transformation here (sort on
2309 # <timestamp><fractional-time>). Thanks to Kirill Miazine
2310 my @msglist =
2311 map { $_->[1] } # extract the values
2312 sort { $a->[0] cmp $b->[0] } # sort by key
2313 map { [join('.' => (split /-/, $_)[0,2]) => $_] } # key (timestamp.fractional-time) => value(message_id)
2314 map { /^\s*\d+[smhdw]\s+\S+\s+(\S+)/ } `@listcmd` or tests_exit(-1, "No output from `exim -bp` (@listcmd)\n");
2315
2316 # Done backwards just in case there are more than 9
2317
2318 for (my $i = @msglist; $i > 0; $i--) { $args =~ s/\$msg$i/$msglist[$i-1]/g; }
2319 if ( $args =~ /\$msg\d/ )
2320 {
2321 tests_exit(-1, "Not enough messages in spool, for test $testno line $lineno\n")
2322 unless $force_continue;
2323 }
2324 }
2325
2326 # If -d is specified in $optargs, remove it from $args; i.e. let
2327 # the command line for runtest override. Then run Exim.
2328
2329 $args =~ s/(?:^|\s)-d\S*// if $optargs =~ /(?:^|\s)-d/;
2330
2331 my $opt_valgrind = $valgrind ? "valgrind --leak-check=yes --suppressions=$parm_cwd/aux-fixed/valgrind.supp " : '';
2332
2333 $cmd = "$envset$sudo$opt_valgrind" .
2334 "$parm_cwd/eximdir/exim$special$optargs " .
2335 "-DEXIM_PATH=$parm_cwd/eximdir/exim$special " .
2336 "-C $parm_cwd/test-config $args " .
2337 ">>test-stdout 2>>test-stderr";
2338 # If the command is starting an Exim daemon, we run it in the same
2339 # way as the "server" command above, that is, we don't want to wait
2340 # for the process to finish. That happens when "killdaemon" is obeyed later
2341 # in the script. We also send the stderr output to test-stderr-server. The
2342 # daemon has its log files put in a different place too (by configuring with
2343 # log_file_path). This requires the directory to be set up in advance.
2344 #
2345 # There are also times when we want to run a non-daemon version of Exim
2346 # (e.g. a queue runner) with the server configuration. In this case,
2347 # we also define -DNOTDAEMON.
2348
2349 if ($cmd =~ /\s-DSERVER=server\s/ && $cmd !~ /\s-DNOTDAEMON\s/)
2350 {
2351 if ($debug) { printf ">> daemon: $cmd\n"; }
2352 run_system("sudo mkdir spool/log 2>/dev/null");
2353 run_system("sudo chown $parm_eximuser:$parm_eximgroup spool/log");
2354
2355 # Before running the command, convert the -bd option into -bdf so that an
2356 # Exim daemon doesn't double fork. This means that when we wait close
2357 # DAEMONCMD, it waits for the correct process. Also, ensure that the pid
2358 # file is written to the spool directory, in case the Exim binary was
2359 # built with PID_FILE_PATH pointing somewhere else.
2360
2361 if ($cmd =~ /\s-oP\s/)
2362 {
2363 ($pidfile = $cmd) =~ s/^.*-oP ([^ ]+).*$/$1/;
2364 $cmd =~ s!\s-bd\s! -bdf !;
2365 }
2366 else
2367 {
2368 $pidfile = "$parm_cwd/spool/exim-daemon.pid";
2369 $cmd =~ s!\s-bd\s! -bdf -oP $pidfile !;
2370 }
2371 print ">> |${cmd}-server\n" if ($debug);
2372 open DAEMONCMD, "|${cmd}-server" || tests_exit(-1, "Failed to run $cmd");
2373 DAEMONCMD->autoflush(1);
2374 while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; } # Ignore any input
2375
2376 # Interlock with daemon startup
2377 for (my $count = 0; ! stat("$pidfile") && $count < 30; $count++ )
2378 { select(undef, undef, undef, 0.3); }
2379 return 3; # Don't wait
2380 }
2381 elsif ($cmd =~ /\s-DSERVER=wait:(\d+)\s/)
2382 {
2383
2384 # The port and the $dynamic_socket was already allocated while parsing the
2385 # script file, where -DSERVER=wait:PORT_DYNAMIC was encountered.
2386
2387 my $listen_port = $1;
2388 if ($debug) { printf ">> wait-mode daemon: $cmd\n"; }
2389 run_system("sudo mkdir spool/log 2>/dev/null");
2390 run_system("sudo chown $parm_eximuser:$parm_eximgroup spool/log");
2391
2392 my $pid = fork();
2393 if (not defined $pid) { die "** fork failed: $!\n" }
2394 if (not $pid) {
2395 close(STDIN);
2396 open(STDIN, '<&', $dynamic_socket) or die "** dup sock to stdin failed: $!\n";
2397 close($dynamic_socket);
2398 print "[$$]>> ${cmd}-server\n" if ($debug);
2399 exec "exec ${cmd}-server";
2400 die "Can't exec ${cmd}-server: $!\n";
2401 }
2402 while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; } # Ignore any input
2403 select(undef, undef, undef, 0.3); # Let the daemon get going
2404 return (3, { exim_pid => $pid }); # Don't wait
2405 }
2406 }
2407
2408 # The "background" command is run but not waited-for, like exim -DSERVER=server.
2409 # One script line is read and fork-exec'd. The PID is stored for a later
2410 # killdaemon.
2411
2412 elsif (/^background$/)
2413 {
2414 my $line;
2415 # $pidfile = "$parm_cwd/aux-var/server-daemon.pid";
2416
2417 $_ = <SCRIPT>; $lineno++;
2418 chomp;
2419 $line = $_;
2420 if ($debug) { printf ">> daemon: $line >>test-stdout 2>>test-stderr\n"; }
2421
2422 my $pid = fork();
2423 if (not defined $pid) { die "** fork failed: $!\n" }
2424 if (not $pid) {
2425 print "[$$]>> ${line}\n" if ($debug);
2426 close(STDIN);
2427 open(STDIN, "<", "test-stdout");
2428 close(STDOUT);
2429 open(STDOUT, ">>", "test-stdout");
2430 close(STDERR);
2431 open(STDERR, ">>", "test-stderr-server");
2432 exec "exec ${line}";
2433 exit(1);
2434 }
2435
2436 # open(my $fh, ">", $pidfile) ||
2437 # tests_exit(-1, "Failed to open $pidfile: $!");
2438 # printf($fh, "%d\n", $pid);
2439 # close($fh);
2440
2441 while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; } # Ignore any input
2442 select(undef, undef, undef, 0.3); # Let the daemon get going
2443 return (3, { exim_pid => $pid }); # Don't wait
2444 }
2445
2446
2447
2448 # Unknown command
2449
2450 else { tests_exit(-1, "Command unrecognized in line $lineno: $_"); }
2451
2452
2453 # Run the command, with stdin connected to a pipe, and write the stdin data
2454 # to it, with appropriate substitutions. If a line ends with \NONL\, chop off
2455 # the terminating newline (and the \NONL\). If the command contains
2456 # -DSERVER=server add "-server" to the command, where it will adjoin the name
2457 # for the stderr file. See comment above about the use of -DSERVER.
2458
2459 $stderrsuffix = ($cmd =~ /\s-DSERVER=server\s/)? "-server" : '';
2460 print ">> |${cmd}${stderrsuffix}\n" if ($debug);
2461 open CMD, "|${cmd}${stderrsuffix}" || tests_exit(1, "Failed to run $cmd");
2462
2463 CMD->autoflush(1);
2464 while (<SCRIPT>)
2465 {
2466 $lineno++;
2467 last if /^\*{4}\s*$/;
2468 do_substitute($testno);
2469 if (/^(.*)\\NONL\\\s*$/) { print CMD $1; } else { print CMD; }
2470 }
2471
2472 # For timeout tests, wait before closing the pipe; we expect a
2473 # SIGPIPE error in this case.
2474
2475 if ($wait_time > 0)
2476 {
2477 printf(" Test %d sleep $wait_time ", $$subtestref);
2478 while ($wait_time-- > 0)
2479 {
2480 print ".";
2481 sleep(1);
2482 }
2483 printf("\r Test %d $cr", $$subtestref);
2484 }
2485
2486 $sigpipehappened = 0;
2487 close CMD; # Waits for command to finish
2488 return $yield; # Ran command and waited
2489 }
2490
2491
2492
2493
2494 ###############################################################################
2495 ###############################################################################
2496
2497 # Here begins the Main Program ...
2498
2499 ###############################################################################
2500 ###############################################################################
2501
2502
2503 autoflush STDOUT 1;
2504 print "Exim tester $testversion\n";
2505
2506 # extend the PATH with .../sbin
2507 # we map all (.../bin) to (.../sbin:.../bin)
2508 $ENV{PATH} = do {
2509 my %seen = map { $_, 1 } split /:/, $ENV{PATH};
2510 join ':' => map { m{(.*)/bin$}
2511 ? ( $seen{"$1/sbin"} ? () : ("$1/sbin"), $_)
2512 : ($_) }
2513 split /:/, $ENV{PATH};
2514 };
2515
2516 ##################################################
2517 # Some tests check created file modes #
2518 ##################################################
2519
2520 umask 022;
2521
2522
2523 ##################################################
2524 # Check for the "less" command #
2525 ##################################################
2526
2527 $more = 'more' if system('which less >/dev/null 2>&1') != 0;
2528
2529
2530
2531 ##################################################
2532 # See if an Exim binary has been given #
2533 ##################################################
2534
2535 # If the first character of the first argument is '/', the argument is taken
2536 # as the path to the binary. If the first argument does not start with a
2537 # '/' but exists in the file system, it's assumed to be the Exim binary.
2538
2539
2540 ##################################################
2541 # Sort out options and which tests are to be run #
2542 ##################################################
2543
2544 # There are a few possible options for the test script itself; after these, any
2545 # options are passed on to Exim calls within the tests. Typically, this is used
2546 # to turn on Exim debugging while setting up a test.
2547
2548 Getopt::Long::Configure qw(no_getopt_compat);
2549 GetOptions(
2550 'debug' => sub { $debug = 1; $cr = "\n" },
2551 'diff' => sub { $cf = 'diff -u' },
2552 'continue' => sub { $force_continue = 1; $more = 'cat' },
2553 'update' => \$force_update,
2554 'ipv4!' => \$have_ipv4,
2555 'ipv6!' => \$have_ipv6,
2556 'keep' => \$save_output,
2557 'slow' => \$slow,
2558 'valgrind' => \$valgrind,
2559 'range=s{2}' => \my @range_wanted,
2560 'test=i@' => \my @tests_wanted,
2561 'flavor|flavour=s' => $flavour,
2562 'help' => sub { pod2usage(-exit => 0) },
2563 'man' => sub {
2564 pod2usage(
2565 -exit => 0,
2566 -verbose => 2,
2567 -noperldoc => system('perldoc -V 2>/dev/null 1>&2')
2568 );
2569 },
2570 ) or pod2usage;
2571
2572 ($parm_exim, @ARGV) = Exim::Runtest::exim_binary(@ARGV);
2573 print "Exim binary is `$parm_exim'\n" if defined $parm_exim;
2574
2575
2576 my @wanted = sort numerically uniq
2577 @tests_wanted ? @tests_wanted : (),
2578 @range_wanted ? $range_wanted[0] .. $range_wanted[1] : (),
2579 @ARGV ? @ARGV == 1 ? $ARGV[0] :
2580 $ARGV[1] eq '+' ? $ARGV[0]..($ARGV[0] >= 9000 ? TEST_SPECIAL_TOP : TEST_TOP) :
2581 0+$ARGV[0]..0+$ARGV[1] # add 0 to cope with test numbers starting with zero
2582 : ();
2583 @wanted = 1..TEST_TOP if not @wanted;
2584
2585 ##################################################
2586 # Check for sudo access to root #
2587 ##################################################
2588
2589 print "You need to have sudo access to root to run these tests. Checking ...\n";
2590 if (system('sudo true >/dev/null') != 0)
2591 {
2592 die "** Test for sudo failed: testing abandoned.\n";
2593 }
2594 else
2595 {
2596 print "Test for sudo OK\n";
2597 }
2598
2599
2600
2601
2602 ##################################################
2603 # Make the command's directory current #
2604 ##################################################
2605
2606 # After doing so, we find its absolute path name.
2607
2608 $cwd = $0;
2609 $cwd = '.' if ($cwd !~ s|/[^/]+$||);
2610 chdir($cwd) || die "** Failed to chdir to \"$cwd\": $!\n";
2611 $parm_cwd = Cwd::getcwd();
2612
2613
2614 ##################################################
2615 # Search for an Exim binary to test #
2616 ##################################################
2617
2618 # If an Exim binary hasn't been provided, try to find one. We can handle the
2619 # case where exim-testsuite is installed alongside Exim source directories. For
2620 # PH's private convenience, if there's a directory just called "exim4", that
2621 # takes precedence; otherwise exim-snapshot takes precedence over any numbered
2622 # releases.
2623
2624 # If $parm_exim is still empty, ask the caller
2625
2626 if (not $parm_exim)
2627 {
2628 print "** Did not find an Exim binary to test\n";
2629 for ($i = 0; $i < 5; $i++)
2630 {
2631 my($trybin);
2632 print "** Enter pathname for Exim binary: ";
2633 chomp($trybin = <STDIN>);
2634 if (-e $trybin)
2635 {
2636 $parm_exim = $trybin;
2637 last;
2638 }
2639 else
2640 {
2641 print "** $trybin does not exist\n";
2642 }
2643 }
2644 die "** Too many tries\n" if $parm_exim eq '';
2645 }
2646
2647
2648
2649 ##################################################
2650 # Find what is in the binary #
2651 ##################################################
2652
2653 # deal with TRUSTED_CONFIG_LIST restrictions
2654 unlink("$parm_cwd/test-config") if -e "$parm_cwd/test-config";
2655 open (IN, "$parm_cwd/confs/0000") ||
2656 tests_exit(-1, "Couldn't open $parm_cwd/confs/0000: $!\n");
2657 open (OUT, ">test-config") ||
2658 tests_exit(-1, "Couldn't open test-config: $!\n");
2659 while (<IN>) { print OUT; }
2660 close(IN);
2661 close(OUT);
2662
2663 print("Probing with config file: $parm_cwd/test-config\n");
2664
2665 my $eximinfo = "$parm_exim -d -C $parm_cwd/test-config -DDIR=$parm_cwd -bP exim_user exim_group";
2666 chomp(my @eximinfo = `$eximinfo 2>&1`);
2667 die "$0: Can't run $eximinfo\n" if $? == -1;
2668
2669 warn 'Got ' . $?>>8 . " from $eximinfo\n" if $?;
2670 foreach (@eximinfo)
2671 {
2672 if (my ($version) = /^Exim version (\S+)/) {
2673 my $git = `git describe --dirty=-XX --match 'exim-4*'`;
2674 if (defined $git and $? == 0) {
2675 chomp $git;
2676 $version =~ s/^\d+\K\./_/;
2677 $git =~ s/^exim-//i;
2678 $git =~ s/.*-\Kg([[:xdigit:]]+(?:-XX)?)/$1/;
2679 print <<___
2680
2681 *** Version mismatch
2682 *** Exim binary: $version
2683 *** Git : $git
2684
2685 ___
2686 if not $version eq $git;
2687 }
2688 }
2689 $parm_eximuser = $1 if /^exim_user = (.*)$/;
2690 $parm_eximgroup = $1 if /^exim_group = (.*)$/;
2691 $parm_trusted_config_list = $1 if /^TRUSTED_CONFIG_LIST:.*?"(.*?)"$/;
2692 ($parm_configure_owner, $parm_configure_group) = ($1, $2)
2693 if /^Configure owner:\s*(\d+):(\d+)/;
2694 print if /wrong owner/;
2695 }
2696
2697 if (not defined $parm_eximuser) {
2698 die <<XXX, map { "|$_\n" } @eximinfo;
2699 Unable to extract exim_user from binary.
2700 Check if Exim refused to run; if so, consider:
2701 TRUSTED_CONFIG_LIST ALT_CONFIG_PREFIX WHITELIST_D_MACROS
2702 If debug permission denied, are you in the exim group?
2703 Failing to get information from binary.
2704 Output from $eximinfo:
2705 XXX
2706
2707 }
2708
2709 if ($parm_eximuser =~ /^\d+$/) { $parm_exim_uid = $parm_eximuser; }
2710 else { $parm_exim_uid = getpwnam($parm_eximuser); }
2711
2712 if (defined $parm_eximgroup)
2713 {
2714 if ($parm_eximgroup =~ /^\d+$/) { $parm_exim_gid = $parm_eximgroup; }
2715 else { $parm_exim_gid = getgrnam($parm_eximgroup); }
2716 }
2717
2718 # check the permissions on the TRUSTED_CONFIG_LIST
2719 if (defined $parm_trusted_config_list)
2720 {
2721 die "TRUSTED_CONFIG_LIST: $parm_trusted_config_list: $!\n"
2722 if not -f $parm_trusted_config_list;
2723
2724 die "TRUSTED_CONFIG_LIST $parm_trusted_config_list must not be world writable!\n"
2725 if 02 & (stat _)[2];
2726
2727 die sprintf "TRUSTED_CONFIG_LIST: $parm_trusted_config_list %d is group writable, but not owned by group '%s' or '%s'.\n",
2728 (stat _)[1],
2729 scalar(getgrgid 0), scalar(getgrgid $>)
2730 if (020 & (stat _)[2]) and not ((stat _)[5] == $> or (stat _)[5] == 0);
2731
2732 die sprintf "TRUSTED_CONFIG_LIST: $parm_trusted_config_list is not owned by user '%s' or '%s'.\n",
2733 scalar(getpwuid 0), scalar(getpwuid $>)
2734 if (not (-o _ or (stat _)[4] == 0));
2735
2736 open(TCL, $parm_trusted_config_list) or die "Can't open $parm_trusted_config_list: $!\n";
2737 my $test_config = getcwd() . '/test-config';
2738 die "Can't find '$test_config' in TRUSTED_CONFIG_LIST $parm_trusted_config_list."
2739 if not grep { /^\Q$test_config\E$/ } <TCL>;
2740 }
2741 else
2742 {
2743 die "Unable to check the TRUSTED_CONFIG_LIST, seems to be empty?\n";
2744 }
2745
2746 die "CONFIGURE_OWNER ($parm_configure_owner) does not match the user invoking $0 ($>)\n"
2747 if $parm_configure_owner != $>;
2748
2749 die "CONFIGURE_GROUP ($parm_configure_group) does not match the group invoking $0 ($))\n"
2750 if 0020 & (stat "$parm_cwd/test-config")[2]
2751 and $parm_configure_group != $);
2752
2753
2754 open(EXIMINFO, "$parm_exim -d-all+transport -bV -C $parm_cwd/test-config -DDIR=$parm_cwd |") ||
2755 die "** Cannot run $parm_exim: $!\n";
2756
2757 print "-" x 78, "\n";
2758
2759 while (<EXIMINFO>)
2760 {
2761 my(@temp);
2762
2763 if (/^(Exim|Library) version/) { print; }
2764
2765 elsif (/^Size of off_t: (\d+)/)
2766 {
2767 print;
2768 $have_largefiles = 1 if $1 > 4;
2769 die "** Size of off_t > 32 which seems improbable, not running tests\n"
2770 if ($1 > 32);
2771 }
2772
2773 elsif (/^Support for: (.*)/)
2774 {
2775 print;
2776 @temp = split /(\s+)/, $1;
2777 push(@temp, ' ');
2778 %parm_support = @temp;
2779 }
2780
2781 elsif (/^Lookups \(built-in\): (.*)/)
2782 {
2783 print;
2784 @temp = split /(\s+)/, $1;
2785 push(@temp, ' ');
2786 %parm_lookups = @temp;
2787 }
2788
2789 elsif (/^Authenticators: (.*)/)
2790 {
2791 print;
2792 @temp = split /(\s+)/, $1;
2793 push(@temp, ' ');
2794 %parm_authenticators = @temp;
2795 }
2796
2797 elsif (/^Routers: (.*)/)
2798 {
2799 print;
2800 @temp = split /(\s+)/, $1;
2801 push(@temp, ' ');
2802 %parm_routers = @temp;
2803 }
2804
2805 # Some transports have options, e.g. appendfile/maildir. For those, ensure
2806 # that the basic transport name is set, and then the name with each of the
2807 # options.
2808
2809 elsif (/^Transports: (.*)/)
2810 {
2811 print;
2812 @temp = split /(\s+)/, $1;
2813 my($i,$k);
2814 push(@temp, ' ');
2815 %parm_transports = @temp;
2816 foreach $k (keys %parm_transports)
2817 {
2818 if ($k =~ "/")
2819 {
2820 @temp = split /\//, $k;
2821 $parm_transports{$temp[0]} = " ";
2822 for ($i = 1; $i < @temp; $i++)
2823 { $parm_transports{"$temp[0]/$temp[$i]"} = " "; }
2824 }
2825 }
2826 }
2827 }
2828 close(EXIMINFO);
2829 print "-" x 78, "\n";
2830
2831 unlink("$parm_cwd/test-config");
2832
2833 ##################################################
2834 # Check for SpamAssassin and ClamAV #
2835 ##################################################
2836
2837 # These are crude tests. If they aren't good enough, we'll have to improve
2838 # them, for example by actually passing a message through spamc or clamscan.
2839
2840 if (defined $parm_support{Content_Scanning})
2841 {
2842 my $sock = new FileHandle;
2843
2844 if (system("spamc -h 2>/dev/null >/dev/null") == 0)
2845 {
2846 print "The spamc command works:\n";
2847
2848 # This test for an active SpamAssassin is courtesy of John Jetmore.
2849 # The tests are hard coded to localhost:783, so no point in making
2850 # this test flexible like the clamav test until the test scripts are
2851 # changed. spamd doesn't have the nice PING/PONG protocol that
2852 # clamd does, but it does respond to errors in an informative manner,
2853 # so use that.
2854
2855 my($sint,$sport) = ('127.0.0.1',783);
2856 eval
2857 {
2858 my $sin = sockaddr_in($sport, inet_aton($sint))
2859 or die "** Failed packing $sint:$sport\n";
2860 socket($sock, PF_INET, SOCK_STREAM, getprotobyname('tcp'))
2861 or die "** Unable to open socket $sint:$sport\n";
2862
2863 local $SIG{ALRM} =
2864 sub { die "** Timeout while connecting to socket $sint:$sport\n"; };
2865 alarm(5);
2866 connect($sock, $sin)
2867 or die "** Unable to connect to socket $sint:$sport\n";
2868 alarm(0);
2869
2870 select((select($sock), $| = 1)[0]);
2871 print $sock "bad command\r\n";
2872
2873 $SIG{ALRM} =
2874 sub { die "** Timeout while reading from socket $sint:$sport\n"; };
2875 alarm(10);
2876 my $res = <$sock>;
2877 alarm(0);
2878
2879 $res =~ m|^SPAMD/|
2880 or die "** Did not get SPAMD from socket $sint:$sport. "
2881 ."It said: $res\n";
2882 };
2883 alarm(0);
2884 if($@)
2885 {
2886 print " $@";
2887 print " Assume SpamAssassin (spamd) is not running\n";
2888 }
2889 else
2890 {
2891 $parm_running{SpamAssassin} = ' ';
2892 print " SpamAssassin (spamd) seems to be running\n";
2893 }
2894 }
2895 else
2896 {
2897 print "The spamc command failed: assume SpamAssassin (spamd) is not running\n";
2898 }
2899
2900 # For ClamAV, we need to find the clamd socket for use in the Exim
2901 # configuration. Search for the clamd configuration file.
2902
2903 if (system("clamscan -h 2>/dev/null >/dev/null") == 0)
2904 {
2905 my($f, $clamconf, $test_prefix);
2906
2907 print "The clamscan command works";
2908
2909 $test_prefix = $ENV{EXIM_TEST_PREFIX};
2910 $test_prefix = '' if !defined $test_prefix;
2911
2912 foreach $f ("$test_prefix/etc/clamd.conf",
2913 "$test_prefix/usr/local/etc/clamd.conf",
2914 "$test_prefix/etc/clamav/clamd.conf", '')
2915 {
2916 if (-e $f)
2917 {
2918 $clamconf = $f;
2919 last;
2920 }
2921 }
2922
2923 # Read the ClamAV configuration file and find the socket interface.
2924
2925 if ($clamconf ne '')
2926 {
2927 my $socket_domain;
2928 open(IN, "$clamconf") || die "\n** Unable to open $clamconf: $!\n";
2929 while (<IN>)
2930 {
2931 if (/^LocalSocket\s+(.*)/)
2932 {
2933 $parm_clamsocket = $1;
2934 $socket_domain = AF_UNIX;
2935 last;
2936 }
2937 if (/^TCPSocket\s+(\d+)/)
2938 {
2939 if (defined $parm_clamsocket)
2940 {
2941 $parm_clamsocket .= " $1";
2942 $socket_domain = AF_INET;
2943 last;
2944 }
2945 else
2946 {
2947 $parm_clamsocket = " $1";
2948 }
2949 }
2950 elsif (/^TCPAddr\s+(\S+)/)
2951 {
2952 if (defined $parm_clamsocket)
2953 {
2954 $parm_clamsocket = $1 . $parm_clamsocket;
2955 $socket_domain = AF_INET;
2956 last;
2957 }
2958 else
2959 {
2960 $parm_clamsocket = $1;
2961 }
2962 }
2963 }
2964 close(IN);
2965
2966 if (defined $socket_domain)
2967 {
2968 print ":\n The clamd socket is $parm_clamsocket\n";
2969 # This test for an active ClamAV is courtesy of Daniel Tiefnig.
2970 eval
2971 {
2972 my $socket;
2973 if ($socket_domain == AF_UNIX)
2974 {
2975 $socket = sockaddr_un($parm_clamsocket) or die "** Failed packing '$parm_clamsocket'\n";
2976 }
2977 elsif ($socket_domain == AF_INET)
2978 {
2979 my ($ca_host, $ca_port) = split(/\s+/,$parm_clamsocket);
2980 my $ca_hostent = gethostbyname($ca_host) or die "** Failed to get raw address for host '$ca_host'\n";
2981 $socket = sockaddr_in($ca_port, $ca_hostent) or die "** Failed packing '$parm_clamsocket'\n";
2982 }
2983 else
2984 {
2985 die "** Unknown socket domain '$socket_domain' (should not happen)\n";
2986 }
2987 socket($sock, $socket_domain, SOCK_STREAM, 0) or die "** Unable to open socket '$parm_clamsocket'\n";
2988 local $SIG{ALRM} = sub { die "** Timeout while connecting to socket '$parm_clamsocket'\n"; };
2989 alarm(5);
2990 connect($sock, $socket) or die "** Unable to connect to socket '$parm_clamsocket'\n";
2991 alarm(0);
2992
2993 my $ofh = select $sock; $| = 1; select $ofh;
2994 print $sock "PING\n";
2995
2996 $SIG{ALRM} = sub { die "** Timeout while reading from socket '$parm_clamsocket'\n"; };
2997 alarm(10);
2998 my $res = <$sock>;
2999 alarm(0);
3000
3001 $res =~ /PONG/ or die "** Did not get PONG from socket '$parm_clamsocket'. It said: $res\n";
3002 };
3003 alarm(0);
3004
3005 if($@)
3006 {
3007 print " $@";
3008 print " Assume ClamAV is not running\n";
3009 }
3010 else
3011 {
3012 $parm_running{ClamAV} = ' ';
3013 print " ClamAV seems to be running\n";
3014 }
3015 }
3016 else
3017 {
3018 print ", but the socket for clamd could not be determined\n";
3019 print "Assume ClamAV is not running\n";
3020 }
3021 }
3022
3023 else
3024 {
3025 print ", but I can't find a configuration for clamd\n";
3026 print "Assume ClamAV is not running\n";
3027 }
3028 }
3029 }
3030
3031
3032 ##################################################
3033 # Check for redis #
3034 ##################################################
3035 if (defined $parm_lookups{redis})
3036 {
3037 if (system("redis-server -v 2>/dev/null >/dev/null") == 0)
3038 {
3039 print "The redis-server command works\n";
3040 $parm_running{redis} = ' ';
3041 }
3042 else
3043 {
3044 print "The redis-server command failed: assume Redis not installed\n";
3045 }
3046 }
3047
3048 ##################################################
3049 # Test for the basic requirements #
3050 ##################################################
3051
3052 # This test suite assumes that Exim has been built with at least the "usual"
3053 # set of routers, transports, and lookups. Ensure that this is so.
3054
3055 $missing = '';
3056
3057 $missing .= " Lookup: lsearch\n" if (!defined $parm_lookups{lsearch});
3058
3059 $missing .= " Router: accept\n" if (!defined $parm_routers{accept});
3060 $missing .= " Router: dnslookup\n" if (!defined $parm_routers{dnslookup});
3061 $missing .= " Router: manualroute\n" if (!defined $parm_routers{manualroute});
3062 $missing .= " Router: redirect\n" if (!defined $parm_routers{redirect});
3063
3064 $missing .= " Transport: appendfile\n" if (!defined $parm_transports{appendfile});
3065 $missing .= " Transport: autoreply\n" if (!defined $parm_transports{autoreply});
3066 $missing .= " Transport: pipe\n" if (!defined $parm_transports{pipe});
3067 $missing .= " Transport: smtp\n" if (!defined $parm_transports{smtp});
3068
3069 if ($missing ne '')
3070 {
3071 print "\n";
3072 print "** Many features can be included or excluded from Exim binaries.\n";
3073 print "** This test suite requires that Exim is built to contain a certain\n";
3074 print "** set of basic facilities. It seems that some of these are missing\n";
3075 print "** from the binary that is under test, so the test cannot proceed.\n";
3076 print "** The missing facilities are:\n";
3077 print "$missing";
3078 die "** Test script abandoned\n";
3079 }
3080
3081
3082 ##################################################
3083 # Check for the auxiliary programs #
3084 ##################################################
3085
3086 # These are always required:
3087
3088 for $prog ("cf", "checkaccess", "client", "client-ssl", "client-gnutls",
3089 "fakens", "iefbr14", "server")
3090 {
3091 next if ($prog eq "client-ssl" && !defined $parm_support{OpenSSL});
3092 next if ($prog eq "client-gnutls" && !defined $parm_support{GnuTLS});
3093 if (!-e "bin/$prog")
3094 {
3095 print "\n";
3096 print "** bin/$prog does not exist. Have you run ./configure and make?\n";
3097 die "** Test script abandoned\n";
3098 }
3099 }
3100
3101 # If the "loaded" binary is missing, we cut out tests for ${dlfunc. It isn't
3102 # compiled on systems where we don't know how to. However, if Exim does not
3103 # have that functionality compiled, we needn't bother.
3104
3105 $dlfunc_deleted = 0;
3106 if (defined $parm_support{Expand_dlfunc} && !-e 'bin/loaded')
3107 {
3108 delete $parm_support{Expand_dlfunc};
3109 $dlfunc_deleted = 1;
3110 }
3111
3112
3113 ##################################################
3114 # Find environmental details #
3115 ##################################################
3116
3117 # Find the caller of this program.
3118
3119 ($parm_caller,$pwpw,$parm_caller_uid,$parm_caller_gid,$pwquota,$pwcomm,
3120 $parm_caller_gecos, $parm_caller_home) = getpwuid($>);
3121
3122 $pwpw = $pwpw; # Kill Perl warnings
3123 $pwquota = $pwquota;
3124 $pwcomm = $pwcomm;
3125
3126 $parm_caller_group = getgrgid($parm_caller_gid);
3127
3128 print "Program caller is $parm_caller ($parm_caller_uid), whose group is $parm_caller_group ($parm_caller_gid)\n";
3129 print "Home directory is $parm_caller_home\n";
3130
3131 unless (defined $parm_eximgroup)
3132 {
3133 print "Unable to derive \$parm_eximgroup.\n";
3134 die "** ABANDONING.\n";
3135 }
3136
3137 print "You need to be in the Exim group to run these tests. Checking ...";
3138
3139 if (`groups` =~ /\b\Q$parm_eximgroup\E\b/)
3140 {
3141 print " OK\n";
3142 }
3143 else
3144 {
3145 print "\nOh dear, you are not in the Exim group.\n";
3146 die "** Testing abandoned.\n";
3147 }
3148
3149 # Find this host's IP addresses - there may be many, of course, but we keep
3150 # one of each type (IPv4 and IPv6).
3151
3152 open(IFCONFIG, '-|', (grep { -x "$_/ip" } split /:/, $ENV{PATH}) ? 'ip address' : 'ifconfig -a')
3153 or die "** Cannot run 'ip address' or 'ifconfig -a'\n";
3154 while (not ($parm_ipv4 and $parm_ipv6) and defined($_ = <IFCONFIG>))
3155 {
3156 if (not $parm_ipv4 and /^\s*inet(?:\saddr)?:?\s?(\d+\.\d+\.\d+\.\d+)(?:\/\d+)?\s/i)
3157 {
3158 next if $1 =~ /^(?:127|10)\./;
3159 $parm_ipv4 = $1;
3160 }
3161
3162 if (not $parm_ipv6 and /^\s*inet6(?:\saddr)?:?\s?([abcdef\d:]+)(?:\/\d+)/i)
3163 {
3164 next if $1 eq '::1' or $1 =~ /^fe80/i;
3165 $parm_ipv6 = $1;
3166 }
3167 }
3168 close(IFCONFIG);
3169
3170 # Use private IP addresses if there are no public ones.
3171
3172 # If either type of IP address is missing, we need to set the value to
3173 # something other than empty, because that wrecks the substitutions. The value
3174 # is reflected, so use a meaningful string. Set appropriate options for the
3175 # "server" command. In practice, however, many tests assume 127.0.0.1 is
3176 # available, so things will go wrong if there is no IPv4 address. The lack
3177 # of IPV4 or IPv6 can be simulated by command options, which force $have_ipv4
3178 # and $have_ipv6 false.
3179
3180 if (not $parm_ipv4)
3181 {
3182 $have_ipv4 = 0;
3183 $parm_ipv4 = "<no IPv4 address found>";
3184 $server_opts .= " -noipv4";
3185 }
3186 elsif ($have_ipv4 == 0)
3187 {
3188 $parm_ipv4 = "<IPv4 testing disabled>";
3189 $server_opts .= " -noipv4";
3190 }
3191 else
3192 {
3193 $parm_running{IPv4} = " ";
3194 }
3195
3196 if (not $parm_ipv6)
3197 {
3198 $have_ipv6 = 0;
3199 $parm_ipv6 = "<no IPv6 address found>";
3200 $server_opts .= " -noipv6";
3201 delete($parm_support{IPv6});
3202 }
3203 elsif ($have_ipv6 == 0)
3204 {
3205 $parm_ipv6 = "<IPv6 testing disabled>";
3206 $server_opts .= " -noipv6";
3207 delete($parm_support{IPv6});
3208 }
3209 elsif (!defined $parm_support{IPv6})
3210 {
3211 $have_ipv6 = 0;
3212 $parm_ipv6 = "<no IPv6 support in Exim binary>";
3213 $server_opts .= " -noipv6";
3214 }
3215 else
3216 {
3217 $parm_running{IPv6} = " ";
3218 }
3219
3220 print "IPv4 address is $parm_ipv4\n";
3221 print "IPv6 address is $parm_ipv6\n";
3222
3223 # For munging test output, we need the reversed IP addresses.
3224
3225 $parm_ipv4r = ($parm_ipv4 !~ /^\d/)? '' :
3226 join(".", reverse(split /\./, $parm_ipv4));
3227
3228 $parm_ipv6r = $parm_ipv6; # Appropriate if not in use
3229 if ($parm_ipv6 =~ /^[\da-f]/)
3230 {
3231 my(@comps) = split /:/, $parm_ipv6;
3232 my(@nibbles);
3233 foreach $comp (@comps)
3234 {
3235 push @nibbles, sprintf("%lx", hex($comp) >> 8);
3236 push @nibbles, sprintf("%lx", hex($comp) & 0xff);
3237 }
3238 $parm_ipv6r = join(".", reverse(@nibbles));
3239 }
3240
3241 # Find the host name, fully qualified.
3242
3243 chomp($temp = `hostname`);
3244 die "'hostname' didn't return anything\n" unless defined $temp and length $temp;
3245 if ($temp =~ /\./)
3246 {
3247 $parm_hostname = $temp;
3248 }
3249 else
3250 {
3251 $parm_hostname = (gethostbyname($temp))[0];
3252 $parm_hostname = "no.host.name.found" unless defined $parm_hostname and length $parm_hostname;
3253 }
3254 print "Hostname is $parm_hostname\n";
3255
3256 if ($parm_hostname !~ /\./)
3257 {
3258 print "\n*** Host name is not fully qualified: this may cause problems ***\n\n";
3259 }
3260
3261 if ($parm_hostname =~ /[[:upper:]]/)
3262 {
3263 print "\n*** Host name has upper case characters: this may cause problems ***\n\n";
3264 }
3265
3266
3267
3268 ##################################################
3269 # Create a testing version of Exim #
3270 ##################################################
3271
3272 # We want to be able to run Exim with a variety of configurations. Normally,
3273 # the use of -C to change configuration causes Exim to give up its root
3274 # privilege (unless the caller is exim or root). For these tests, we do not
3275 # want this to happen. Also, we want Exim to know that it is running in its
3276 # test harness.
3277
3278 # We achieve this by copying the binary and patching it as we go. The new
3279 # binary knows it is a testing copy, and it allows -C and -D without loss of
3280 # privilege. Clearly, this file is dangerous to have lying around on systems
3281 # where there are general users with login accounts. To protect against this,
3282 # we put the new binary in a special directory that is accessible only to the
3283 # caller of this script, who is known to have sudo root privilege from the test
3284 # that was done above. Furthermore, we ensure that the binary is deleted at the
3285 # end of the test. First ensure the directory exists.
3286
3287 if (-d "eximdir")
3288 { unlink "eximdir/exim"; } # Just in case
3289 else
3290 {
3291 mkdir("eximdir", 0710) || die "** Unable to mkdir $parm_cwd/eximdir: $!\n";
3292 system("sudo chgrp $parm_eximgroup eximdir");
3293 }
3294
3295 # The construction of the patched binary must be done as root, so we use
3296 # a separate script. As well as indicating that this is a test-harness binary,
3297 # the version number is patched to "x.yz" so that its length is always the
3298 # same. Otherwise, when it appears in Received: headers, it affects the length
3299 # of the message, which breaks certain comparisons.
3300
3301 die "** Unable to make patched exim: $!\n"
3302 if (system("sudo ./patchexim $parm_exim") != 0);
3303
3304 # From this point on, exits from the program must go via the subroutine
3305 # tests_exit(), so that suitable cleaning up can be done when required.
3306 # Arrange to catch interrupting signals, to assist with this.
3307
3308 $SIG{INT} = \&inthandler;
3309 $SIG{PIPE} = \&pipehandler;
3310
3311 # For some tests, we need another copy of the binary that is setuid exim rather
3312 # than root.
3313
3314 system("sudo cp eximdir/exim eximdir/exim_exim;" .
3315 "sudo chown $parm_eximuser eximdir/exim_exim;" .
3316 "sudo chgrp $parm_eximgroup eximdir/exim_exim;" .
3317 "sudo chmod 06755 eximdir/exim_exim");
3318
3319
3320 ##################################################
3321 # Make copies of utilities we might need #
3322 ##################################################
3323
3324 # Certain of the tests make use of some of Exim's utilities. We do not need
3325 # to be root to copy these.
3326
3327 ($parm_exim_dir) = $parm_exim =~ m?^(.*)/exim?;
3328
3329 $dbm_build_deleted = 0;
3330 if (defined $parm_lookups{dbm} &&
3331 system("cp $parm_exim_dir/exim_dbmbuild eximdir") != 0)
3332 {
3333 delete $parm_lookups{dbm};
3334 $dbm_build_deleted = 1;
3335 }
3336
3337 if (system("cp $parm_exim_dir/exim_dumpdb eximdir") != 0)
3338 {
3339 tests_exit(-1, "Failed to make a copy of exim_dumpdb: $!");
3340 }
3341
3342 if (system("cp $parm_exim_dir/exim_lock eximdir") != 0)
3343 {
3344 tests_exit(-1, "Failed to make a copy of exim_lock: $!");
3345 }
3346
3347 if (system("cp $parm_exim_dir/exinext eximdir") != 0)
3348 {
3349 tests_exit(-1, "Failed to make a copy of exinext: $!");
3350 }
3351
3352 if (system("cp $parm_exim_dir/exigrep eximdir") != 0)
3353 {
3354 tests_exit(-1, "Failed to make a copy of exigrep: $!");
3355 }
3356
3357 if (system("cp $parm_exim_dir/eximstats eximdir") != 0)
3358 {
3359 tests_exit(-1, "Failed to make a copy of eximstats: $!");
3360 }
3361
3362
3363 ##################################################
3364 # Check that the Exim user can access stuff #
3365 ##################################################
3366
3367 # We delay this test till here so that we can check access to the actual test
3368 # binary. This will be needed when Exim re-exec's itself to do deliveries.
3369
3370 print "Exim user is $parm_eximuser ($parm_exim_uid)\n";
3371 print "Exim group is $parm_eximgroup ($parm_exim_gid)\n";
3372
3373 if ($parm_caller_uid eq $parm_exim_uid) {
3374 tests_exit(-1, "Exim user ($parm_eximuser,$parm_exim_uid) cannot be "
3375 ."the same as caller ($parm_caller,$parm_caller_uid)");
3376 }
3377 if ($parm_caller_gid eq $parm_exim_gid) {
3378 tests_exit(-1, "Exim group ($parm_eximgroup,$parm_exim_gid) cannot be "
3379 ."the same as caller's ($parm_caller) group as it confuses "
3380 ."results analysis");
3381 }
3382
3383 print "The Exim user needs access to the test suite directory. Checking ...";
3384
3385 if (($rc = system("sudo bin/checkaccess $parm_cwd/eximdir/exim $parm_eximuser $parm_eximgroup")) != 0)
3386 {
3387 my($why) = "unknown failure $rc";
3388 $rc >>= 8;
3389 $why = "Couldn't find user \"$parm_eximuser\"" if $rc == 1;
3390 $why = "Couldn't find group \"$parm_eximgroup\"" if $rc == 2;
3391 $why = "Couldn't read auxiliary group list" if $rc == 3;
3392 $why = "Couldn't get rid of auxiliary groups" if $rc == 4;
3393 $why = "Couldn't set gid" if $rc == 5;
3394 $why = "Couldn't set uid" if $rc == 6;
3395 $why = "Couldn't open \"$parm_cwd/eximdir/exim\"" if $rc == 7;
3396 print "\n** $why\n";
3397 tests_exit(-1, "$parm_eximuser cannot access the test suite directory");
3398 }
3399 else
3400 {
3401 print " OK\n";
3402 }
3403
3404 tests_exit(-1, "Failed to unlink $log_summary_filename: $!")
3405 if not unlink($log_summary_filename) and -e $log_summary_filename;
3406
3407 ##################################################
3408 # Create a list of available tests #
3409 ##################################################
3410
3411 # The scripts directory contains a number of subdirectories whose names are
3412 # of the form 0000-xxxx, 1100-xxxx, 2000-xxxx, etc. Each set of tests apart
3413 # from the first requires certain optional features to be included in the Exim
3414 # binary. These requirements are contained in a file called "REQUIRES" within
3415 # the directory. We scan all these tests, discarding those that cannot be run
3416 # because the current binary does not support the right facilities, and also
3417 # those that are outside the numerical range selected.
3418
3419 printf "\nWill run %d tests between %d and %d for flavour %s\n",
3420 scalar(@wanted), $wanted[0], $wanted[-1], $flavour;
3421
3422 print "Omitting \${dlfunc expansion tests (loadable module not present)\n"
3423 if $dlfunc_deleted;
3424 print "Omitting dbm tests (unable to copy exim_dbmbuild)\n"
3425 if $dbm_build_deleted;
3426
3427
3428 my @test_dirs = grep { not /^CVS$/ } map { basename $_ } glob 'scripts/*'
3429 or die tests_exit(-1, "Failed to find test scripts in 'scripts/*`: $!");
3430
3431 # Scan for relevant tests
3432 # HS12: Needs to be reworked.
3433 DIR: for (my $i = 0; $i < @test_dirs; $i++)
3434 {
3435 my($testdir) = $test_dirs[$i];
3436 my($wantthis) = 1;
3437
3438 print ">>Checking $testdir\n" if $debug;
3439
3440 # Skip this directory if the first test is equal or greater than the first
3441 # test in the next directory.
3442
3443 next DIR if ($i < @test_dirs - 1) &&
3444 ($wanted[0] >= substr($test_dirs[$i+1], 0, 4));
3445
3446 # No need to carry on if the end test is less than the first test in this
3447 # subdirectory.
3448
3449 last DIR if $wanted[-1] < substr($testdir, 0, 4);
3450
3451 # Check requirements, if any.
3452
3453 if (open(my $requires, "scripts/$testdir/REQUIRES"))
3454 {
3455 while (<$requires>)
3456 {
3457 next if /^\s*$/;
3458 s/\s+$//;
3459 if (/^support (.*)$/)
3460 {
3461 if (!defined $parm_support{$1}) { $wantthis = 0; last; }
3462 }
3463 elsif (/^running (.*)$/)
3464 {
3465 if (!defined $parm_running{$1}) { $wantthis = 0; last; }
3466 }
3467 elsif (/^lookup (.*)$/)
3468 {
3469 if (!defined $parm_lookups{$1}) { $wantthis = 0; last; }
3470 }
3471 elsif (/^authenticators? (.*)$/)
3472 {
3473 if (!defined $parm_authenticators{$1}) { $wantthis = 0; last; }
3474 }
3475 elsif (/^router (.*)$/)
3476 {
3477 if (!defined $parm_routers{$1}) { $wantthis = 0; last; }
3478 }
3479 elsif (/^transport (.*)$/)
3480 {
3481 if (!defined $parm_transports{$1}) { $wantthis = 0; last; }
3482 }
3483 else
3484 {
3485 tests_exit(-1, "Unknown line in \"scripts/$testdir/REQUIRES\": \"$_\"");
3486 }
3487 }
3488 }
3489 else
3490 {
3491 tests_exit(-1, "Failed to open \"scripts/$testdir/REQUIRES\": $!")
3492 unless $!{ENOENT};
3493 }
3494
3495 # Loop if we do not want the tests in this subdirectory.
3496
3497 if (!$wantthis)
3498 {
3499 chomp;
3500 print "Omitting tests in $testdir (missing $_)\n";
3501 }
3502
3503 # We want the tests from this subdirectory, provided they are in the
3504 # range that was selected.
3505
3506 @testlist = grep { $_ ~~ @wanted } grep { /^\d+(?:\.\d+)?$/ } map { basename $_ } glob "scripts/$testdir/*";
3507 tests_exit(-1, "Failed to read test scripts from `scripts/$testdir/*': $!")
3508 if not @testlist;
3509
3510 foreach $test (@testlist)
3511 {
3512 if (!$wantthis)
3513 {
3514 log_test($log_summary_filename, $test, '.');
3515 }
3516 else
3517 {
3518 push @test_list, "$testdir/$test";
3519 }
3520 }
3521 }
3522
3523 print ">>Test List:\n", join "\n", @test_list, '' if $debug;
3524
3525
3526 ##################################################
3527 # Munge variable auxiliary data #
3528 ##################################################
3529
3530 # Some of the auxiliary data files have to refer to the current testing
3531 # directory and other parameter data. The generic versions of these files are
3532 # stored in the aux-var-src directory. At this point, we copy each of them
3533 # to the aux-var directory, making appropriate substitutions. There aren't very
3534 # many of them, so it's easiest just to do this every time. Ensure the mode
3535 # is standardized, as this path is used as a test for the ${stat: expansion.
3536
3537 # A similar job has to be done for the files in the dnszones-src directory, to
3538 # make the fake DNS zones for testing. Most of the zone files are copied to
3539 # files of the same name, but db.ipv4.V4NET and db.ipv6.V6NET use the testing
3540 # networks that are defined by parameter.
3541
3542 foreach $basedir ("aux-var", "dnszones")
3543 {
3544 system("sudo rm -rf $parm_cwd/$basedir");
3545 mkdir("$parm_cwd/$basedir", 0777);
3546 chmod(0755, "$parm_cwd/$basedir");
3547
3548 opendir(AUX, "$parm_cwd/$basedir-src") ||
3549 tests_exit(-1, "Failed to opendir $parm_cwd/$basedir-src: $!");
3550 my(@filelist) = readdir(AUX);
3551 close(AUX);
3552
3553 foreach $file (@filelist)
3554 {
3555 my($outfile) = $file;
3556 next if $file =~ /^\./;
3557
3558 if ($file eq "db.ip4.V4NET")
3559 {
3560 $outfile = "db.ip4.$parm_ipv4_test_net";
3561 }
3562 elsif ($file eq "db.ip6.V6NET")
3563 {
3564 my(@nibbles) = reverse(split /\s*/, $parm_ipv6_test_net);
3565 $" = '.';
3566 $outfile = "db.ip6.@nibbles";
3567 $" = ' ';
3568 }
3569
3570 print ">>Copying $basedir-src/$file to $basedir/$outfile\n" if $debug;
3571 open(IN, "$parm_cwd/$basedir-src/$file") ||
3572 tests_exit(-1, "Failed to open $parm_cwd/$basedir-src/$file: $!");
3573 open(OUT, ">$parm_cwd/$basedir/$outfile") ||
3574 tests_exit(-1, "Failed to open $parm_cwd/$basedir/$outfile: $!");
3575 while (<IN>)
3576 {
3577 do_substitute(0);
3578 print OUT;
3579 }
3580 close(IN);
3581 close(OUT);
3582 }
3583 }
3584
3585 # Set a user's shell, distinguishable from /bin/sh
3586
3587 symlink('/bin/sh' => 'aux-var/sh');
3588 $ENV{SHELL} = $parm_shell = "$parm_cwd/aux-var/sh";
3589
3590 ##################################################
3591 # Create fake DNS zones for this host #
3592 ##################################################
3593
3594 # There are fixed zone files for 127.0.0.1 and ::1, but we also want to be
3595 # sure that there are forward and reverse registrations for this host, using
3596 # its real IP addresses. Dynamically created zone files achieve this.
3597
3598 if ($have_ipv4 || $have_ipv6)
3599 {
3600 my($shortname,$domain) = $parm_hostname =~ /^([^.]+)(.*)/;
3601 open(OUT, ">$parm_cwd/dnszones/db$domain") ||
3602 tests_exit(-1, "Failed to open $parm_cwd/dnszones/db$domain: $!");
3603 print OUT "; This is a dynamically constructed fake zone file.\n" .
3604 "; The following line causes fakens to return PASS_ON\n" .
3605 "; for queries that it cannot answer\n\n" .
3606 "PASS ON NOT FOUND\n\n";
3607 print OUT "$shortname A $parm_ipv4\n" if $have_ipv4;
3608 print OUT "$shortname AAAA $parm_ipv6\n" if $have_ipv6;
3609 print OUT "\n; End\n";
3610 close(OUT);
3611 }
3612
3613 if ($have_ipv4 && $parm_ipv4 ne "127.0.0.1")
3614 {
3615 my(@components) = $parm_ipv4 =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)/;
3616 open(OUT, ">$parm_cwd/dnszones/db.ip4.$components[0]") ||
3617 tests_exit(-1,
3618 "Failed to open $parm_cwd/dnszones/db.ip4.$components[0]: $!");
3619 print OUT "; This is a dynamically constructed fake zone file.\n" .
3620 "; The zone is $components[0].in-addr.arpa.\n\n" .
3621 "$components[3].$components[2].$components[1] PTR $parm_hostname.\n\n" .
3622 "; End\n";
3623 close(OUT);
3624 }
3625
3626 if ($have_ipv6 && $parm_ipv6 ne "::1")
3627 {
3628 my($exp_v6) = $parm_ipv6;
3629 $exp_v6 =~ s/[^:]//g;
3630 if ( $parm_ipv6 =~ /^([^:].+)::$/ ) {
3631 $exp_v6 = $1 . ':0' x (9-length($exp_v6));
3632 } elsif ( $parm_ipv6 =~ /^(.+)::(.+)$/ ) {
3633 $exp_v6 = $1 . ':0' x (8-length($exp_v6)) . ':' . $2;
3634 } elsif ( $parm_ipv6 =~ /^::(.+[^:])$/ ) {
3635 $exp_v6 = '0:' x (9-length($exp_v6)) . $1;
3636 } else {
3637 $exp_v6 = $parm_ipv6;
3638 }
3639 my(@components) = split /:/, $exp_v6;
3640 my(@nibbles) = reverse (split /\s*/, shift @components);
3641 my($sep) = '';
3642
3643 $" = ".";
3644 open(OUT, ">$parm_cwd/dnszones/db.ip6.@nibbles") ||
3645 tests_exit(-1,
3646 "Failed to open $parm_cwd/dnszones/db.ip6.@nibbles: $!");
3647 print OUT "; This is a dynamically constructed fake zone file.\n" .
3648 "; The zone is @nibbles.ip6.arpa.\n\n";
3649
3650 @components = reverse @components;
3651 foreach $c (@components)
3652 {
3653 $c = "0$c" until $c =~ /^..../;
3654 @nibbles = reverse(split /\s*/, $c);
3655 print OUT "$sep@nibbles";
3656 $sep = ".";
3657 }
3658
3659 print OUT " PTR $parm_hostname.\n\n; End\n";
3660 close(OUT);
3661 $" = " ";
3662 }
3663
3664
3665
3666 ##################################################
3667 # Create lists of mailboxes and message logs #
3668 ##################################################
3669
3670 # We use these lists to check that a test has created the expected files. It
3671 # should be faster than looking for the file each time. For mailboxes, we have
3672 # to scan a complete subtree, in order to handle maildirs. For msglogs, there
3673 # is just a flat list of files.
3674
3675 @oldmails = list_files_below("mail");
3676 opendir(DIR, "msglog") || tests_exit(-1, "Failed to opendir msglog: $!");
3677 @oldmsglogs = readdir(DIR);
3678 closedir(DIR);
3679
3680
3681
3682 ##################################################
3683 # Run the required tests #
3684 ##################################################
3685
3686 # Each test script contains a number of tests, separated by a line that
3687 # contains ****. We open input from the terminal so that we can read responses
3688 # to prompts.
3689
3690 if (not $force_continue) {
3691 # runtest needs to interact if we're not in continue
3692 # mode. It does so by communicate to /dev/tty
3693 open(T, '<', '/dev/tty') or tests_exit(-1, "Failed to open /dev/tty: $!");
3694 print "\nPress RETURN to run the tests: ";
3695 <T>;
3696 }
3697
3698
3699 foreach $test (@test_list)
3700 {
3701 state $lasttestdir = '';
3702
3703 local $lineno = 0;
3704 local $commandno = 0;
3705 local $subtestno = 0;
3706 local $sortlog = 0;
3707
3708 (local $testno = $test) =~ s|.*/||;
3709
3710 # Leaving traces in the process table and in the environment
3711 # gives us a chance to identify hanging processes (exim daemons)
3712 local $0 = "[runtest $testno]";
3713 local $ENV{EXIM_TEST_NUMBER} = $testno;
3714
3715 my $gnutls = 0;
3716 my $docheck = 1;
3717 my $thistestdir = substr($test, 0, -5);
3718
3719 $dynamic_socket->close() if $dynamic_socket;
3720
3721 if ($lasttestdir ne $thistestdir)
3722 {
3723 $gnutls = 0;
3724 if (-s "scripts/$thistestdir/REQUIRES")
3725 {
3726 my $indent = '';
3727 print "\n>>> The following tests require: ";
3728 open(my $requires, '<', "scripts/$thistestdir/REQUIRES") ||
3729 tests_exit(-1, "Failed to open scripts/$thistestdir/REQUIRES: $!");
3730 while (<$requires>)
3731 {
3732 $gnutls = 1 if /^support GnuTLS/;
3733 print $indent, $_;
3734 $indent = ">>> ";
3735 }
3736 }
3737 $lasttestdir = $thistestdir;
3738 }
3739
3740 # Remove any debris in the spool directory and the test-mail directory
3741 # and also the files for collecting stdout and stderr. Then put back
3742 # the test-mail directory for appendfile deliveries.
3743
3744 system "sudo /bin/rm -rf spool test-*";
3745 system "mkdir test-mail 2>/dev/null";
3746
3747 # A privileged Exim will normally make its own spool directory, but some of
3748 # the tests run in unprivileged modes that don't always work if the spool
3749 # directory isn't already there. What is more, we want anybody to be able
3750 # to read it in order to find the daemon's pid.
3751
3752 system "mkdir spool; " .
3753 "sudo chown $parm_eximuser:$parm_eximgroup spool; " .
3754 "sudo chmod 0755 spool";
3755
3756 # Empty the cache that keeps track of things like message id mappings, and
3757 # set up the initial sequence strings.
3758
3759 undef %cache;
3760 $next_msgid = "aX";
3761 $next_pid = 1234;
3762 $next_port = 1111;
3763 $message_skip = 0;
3764 $msglog_skip = 0;
3765 $stderr_skip = 0;
3766 $stdout_skip = 0;
3767 $rmfiltertest = 0;
3768 $is_ipv6test = 0;
3769 $TEST_STATE->{munge} = '';
3770
3771 # Remove the associative arrays used to hold checked mail files and msglogs
3772
3773 undef %expected_mails;
3774 undef %expected_msglogs;
3775
3776 # Open the test's script
3777 open(SCRIPT, "scripts/$test") ||
3778 tests_exit(-1, "Failed to open \"scripts/$test\": $!");
3779 # Run through the script once to set variables which should be global
3780 while (<SCRIPT>)
3781 {
3782 if (/^no_message_check/) { $message_skip = 1; next; }
3783 if (/^no_msglog_check/) { $msglog_skip = 1; next; }
3784 if (/^no_stderr_check/) { $stderr_skip = 1; next; }
3785 if (/^no_stdout_check/) { $stdout_skip = 1; next; }
3786 if (/^rmfiltertest/) { $rmfiltertest = 1; next; }
3787 if (/^sortlog/) { $sortlog = 1; next; }
3788 if (/\bPORT_DYNAMIC\b/) { $dynamic_socket = Exim::Runtest::dynamic_socket(); next; }
3789 }
3790 # Reset to beginning of file for per test interpreting/processing
3791 seek(SCRIPT, 0, 0);
3792
3793 # The first line in the script must be a comment that is used to identify
3794 # the set of tests as a whole.
3795
3796 $_ = <SCRIPT>;
3797 $lineno++;
3798 tests_exit(-1, "Missing identifying comment at start of $test") if (!/^#/);
3799 printf("%s %s", (substr $test, 5), (substr $_, 2));
3800
3801 # Loop for each of the subtests within the script. The variable $server_pid
3802 # is used to remember the pid of a "server" process, for which we do not
3803 # wait until we have waited for a subsequent command.
3804
3805 local($server_pid) = 0;
3806 for ($commandno = 1; !eof SCRIPT; $commandno++)
3807 {
3808 # Skip further leading comments and blank lines, handle the flag setting
3809 # commands, and deal with tests for IP support.
3810
3811 while (<SCRIPT>)
3812 {
3813 $lineno++;
3814 # Could remove these variable settings because they are already
3815 # set above, but doesn't hurt to leave them here.
3816 if (/^no_message_check/) { $message_skip = 1; next; }
3817 if (/^no_msglog_check/) { $msglog_skip = 1; next; }
3818 if (/^no_stderr_check/) { $stderr_skip = 1; next; }
3819 if (/^no_stdout_check/) { $stdout_skip = 1; next; }
3820 if (/^rmfiltertest/) { $rmfiltertest = 1; next; }
3821 if (/^sortlog/) { $sortlog = 1; next; }
3822
3823 if (/^need_largefiles/)
3824 {
3825 next if $have_largefiles;
3826 print ">>> Large file support is needed for test $testno, but is not available: skipping\n";
3827 $docheck = 0; # don't check output
3828 undef $_; # pretend EOF
3829 last;
3830 }
3831
3832 if (/^need_ipv4/)
3833 {
3834 next if $have_ipv4;
3835 print ">>> IPv4 is needed for test $testno, but is not available: skipping\n";
3836 $docheck = 0; # don't check output
3837 undef $_; # pretend EOF
3838 last;
3839 }
3840
3841 if (/^need_ipv6/)
3842 {
3843 if ($have_ipv6)
3844 {
3845 $is_ipv6test = 1;
3846 next;
3847 }
3848 print ">>> IPv6 is needed for test $testno, but is not available: skipping\n";
3849 $docheck = 0; # don't check output
3850 undef $_; # pretend EOF
3851 last;
3852 }
3853
3854 if (/^need_move_frozen_messages/)
3855 {
3856 next if defined $parm_support{move_frozen_messages};
3857 print ">>> move frozen message support is needed for test $testno, " .
3858 "but is not\n>>> available: skipping\n";
3859 $docheck = 0; # don't check output
3860 undef $_; # pretend EOF
3861 last;
3862 }
3863
3864 last unless /^(?:#(?!##\s)|\s*$)/;
3865 }
3866 last if !defined $_; # Hit EOF
3867
3868 my($subtest_startline) = $lineno;
3869
3870 # Now run the command. The function returns 0 for an inline command,
3871 # 1 if a non-exim command was run and waited for, 2 if an exim
3872 # command was run and waited for, and 3 if a command
3873 # was run and not waited for (usually a daemon or server startup).
3874
3875 my($commandname) = '';
3876 my($expectrc) = 0;
3877 my($rc, $run_extra) = run_command($testno, \$subtestno, \$expectrc, \$commandname, $TEST_STATE);
3878 my($cmdrc) = $?;
3879
3880 if ($debug) {
3881 print ">> rc=$rc cmdrc=$cmdrc\n";
3882 if (defined $run_extra) {
3883 foreach my $k (keys %$run_extra) {
3884 my $v = defined $run_extra->{$k} ? qq!"$run_extra->{$k}"! : '<undef>';
3885 print ">> $k -> $v\n";
3886 }
3887 }
3888 }
3889 $run_extra = {} unless defined $run_extra;
3890 foreach my $k (keys %$run_extra) {
3891 if (exists $TEST_STATE->{$k}) {
3892 my $nv = defined $run_extra->{$k} ? qq!"$run_extra->{$k}"! : 'removed';
3893 print ">> override of $k; was $TEST_STATE->{$k}, now $nv\n" if $debug;
3894 }
3895 if (defined $run_extra->{$k}) {
3896 $TEST_STATE->{$k} = $run_extra->{$k};
3897 } elsif (exists $TEST_STATE->{$k}) {
3898 delete $TEST_STATE->{$k};
3899 }
3900 }
3901
3902 # Hit EOF after an initial return code number
3903
3904 tests_exit(-1, "Unexpected EOF in script") if ($rc == 4);
3905
3906 # Carry on with the next command if we did not wait for this one. $rc == 0
3907 # if no subprocess was run; $rc == 3 if we started a process but did not
3908 # wait for it.
3909
3910 next if ($rc == 0 || $rc == 3);
3911
3912 # We ran and waited for a command. Check for the expected result unless
3913 # it died.
3914
3915 if ($cmdrc != $expectrc && !$sigpipehappened)
3916 {
3917 printf("** Command $commandno (\"$commandname\", starting at line $subtest_startline)\n");
3918 if (($cmdrc & 0xff) == 0)
3919 {
3920 printf("** Return code %d (expected %d)", $cmdrc/256, $expectrc/256);
3921 }
3922 elsif (($cmdrc & 0xff00) == 0)
3923 { printf("** Killed by signal %d", $cmdrc & 255); }
3924 else
3925 { printf("** Status %x", $cmdrc); }
3926
3927 for (;;)
3928 {
3929 print "\nshow stdErr, show stdOut, Retry, Continue (without file comparison), or Quit? [Q] ";
3930 $_ = $force_continue ? "c" : <T>;
3931 tests_exit(1) if /^q?$/i;
3932 if (/^c$/ && $force_continue) {
3933 log_failure($log_failed_filename, $testno, "exit code unexpected");
3934 log_test($log_summary_filename, $testno, 'F')
3935 }
3936 if ($force_continue)
3937 {
3938 print "\nstdout tail:\n";
3939 print "==================>\n";
3940 system("tail -20 test-stdout");
3941 print "===================\n";
3942 print "stderr tail:\n";
3943 print "==================>\n";
3944 system("tail -20 test-stderr");
3945 print "===================\n";
3946 print "... continue forced\n";
3947 }
3948
3949 last if /^[rc]$/i;
3950 if (/^e$/i)
3951 {
3952 system("$more test-stderr");
3953 }
3954 elsif (/^o$/i)
3955 {
3956 system("$more test-stdout");
3957 }
3958 }
3959
3960 $retry = 1 if /^r$/i;
3961 $docheck = 0;
3962 }
3963
3964 # If the command was exim, and a listening server is running, we can now
3965 # close its input, which causes us to wait for it to finish, which is why
3966 # we didn't close it earlier.
3967
3968 if ($rc == 2 && $server_pid != 0)
3969 {
3970 close SERVERCMD;
3971 $server_pid = 0;
3972 if ($? != 0)
3973 {
3974 if (($? & 0xff) == 0)
3975 { printf("Server return code %d for test %d starting line %d", $?/256,
3976 $testno, $subtest_startline); }
3977 elsif (($? & 0xff00) == 0)
3978 { printf("Server killed by signal %d", $? & 255); }
3979 else
3980 { printf("Server status %x", $?); }
3981
3982 for (;;)
3983 {
3984 print "\nShow server stdout, Retry, Continue, or Quit? [Q] ";
3985 $_ = $force_continue ? "c" : <T>;
3986 tests_exit(1) if /^q?$/i;
3987 if (/^c$/ && $force_continue) {
3988 log_failure($log_failed_filename, $testno, "exit code unexpected");
3989 log_test($log_summary_filename, $testno, 'F')
3990 }
3991 print "... continue forced\n" if $force_continue;
3992 last if /^[rc]$/i;
3993
3994 if (/^s$/i)
3995 {
3996 open(S, "test-stdout-server") ||
3997 tests_exit(-1, "Failed to open test-stdout-server: $!");
3998 print while <S>;
3999 close(S);
4000 }
4001 }
4002 $retry = 1 if /^r$/i;
4003 }
4004 }
4005 }
4006
4007 close SCRIPT;
4008
4009 # The script has finished. Check the all the output that was generated. The
4010 # function returns 0 for a perfect pass, 1 if imperfect but ok, 2 if we should
4011 # rerun the test (the files # have been updated).
4012 # It does not return if the user responds Q to a prompt.
4013
4014 if ($retry)
4015 {
4016 $retry = '0';
4017 print (("#" x 79) . "\n");
4018 redo;
4019 }
4020
4021 if ($docheck)
4022 {
4023 sleep 1 if $slow;
4024 my $rc = check_output($TEST_STATE->{munge});
4025 log_test($log_summary_filename, $testno, 'P') if ($rc == 0);
4026 if ($rc < 2)
4027 {
4028 print (" Script completed\n");
4029 }
4030 else
4031 {
4032 print (("#" x 79) . "\n");
4033 redo;
4034 }
4035 }
4036 }
4037
4038
4039 ##################################################
4040 # Exit from the test script #
4041 ##################################################
4042
4043 tests_exit(-1, "No runnable tests selected") if not @test_list;
4044 tests_exit(0);
4045
4046 __END__
4047
4048 =head1 NAME
4049
4050 runtest - run the exim testsuite
4051
4052 =head1 SYNOPSIS
4053
4054 runtest [exim-path] [options] [test0 [test1]]
4055
4056 =head1 DESCRIPTION
4057
4058 B<runtest> runs the Exim testsuite.
4059
4060 =head1 OPTIONS
4061
4062 For legacy reasons the options are not case sensitive.
4063
4064 =over
4065
4066 =item B<--continue>
4067
4068 Do not stop for user interaction or on errors. (default: off)
4069
4070 =item B<--debug>
4071
4072 This option enables the output of debug information when running the
4073 various test commands. (default: off)
4074
4075 =item B<--diff>
4076
4077 Use C<diff -u> for comparing the expected output with the produced
4078 output. (default: use a built-in routine)
4079
4080 =item B<--flavor>|B<--flavour> I<flavour>
4081
4082 Override the expected results for results for a specific (OS) flavour.
4083 (default: unused)
4084
4085 =item B<--[no]ipv4>
4086
4087 Skip IPv4 related setup and tests (default: use ipv4)
4088
4089 =item B<--[no]ipv6>
4090
4091 Skip IPv6 related setup and tests (default: use ipv6)
4092
4093 =item B<--keep>
4094
4095 Keep the various output files produced during a test run. (default: don't keep)
4096
4097 =item B<--range> I<n0> I<n1>
4098
4099 Run tests between (including) I<n0> and I<n1>. A "+" may be used to specify the "last
4100 test available".
4101
4102 =item B<--slow>
4103
4104 Insert some delays to compensate for a slow host system. (default: off)
4105
4106 =item B<--test> I<n>
4107
4108 Run the specified test. This option may used multiple times.
4109
4110 =item B<--update>
4111
4112 Automatically update the recorded (expected) data on mismatch. (default: off)
4113
4114 =item B<--valgrind>
4115
4116 Start Exim wrapped by I<valgrind>. (default: don't use valgrind)
4117
4118 =back
4119
4120 =cut
4121
4122
4123 # End of runtest script