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