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