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