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