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