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