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