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