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