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