Testsuite: fix cmdline option for test flavour
[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
JH
1119 # TCP Fast Open
1120 next if /^setsockopt FASTOPEN: Network Error/;
1121
a2550b67
JH
1122 # Environment cleaning
1123 next if /\w+ in keep_environment\? (yes|no)/;
1124
76003495
JH
1125 # Sizes vary with test hostname
1126 s/^cmd buf flush \d+ bytes$/cmd buf flush ddd bytes/;
1127
ddf1b11a 1128 # Spool filesystem free space changes on different systems.
ad424056 1129 s/^((?:spool|log) directory space =) -?\d+K (inodes =)\s*-?\d+/$1 nnnnnK $2 nnnnn/;
ddf1b11a 1130
7373d852 1131 # Non-TLS builds have different expansions for received_header_text
340f3113 1132 if (s/(with \$received_protocol)\}\} \$\{if def:tls_cipher \{\(\$tls_cipher\)\n$/$1/)
7373d852
JH
1133 {
1134 $_ .= <IN>;
492fd282 1135 s/[\s╎]+\}\}(?=\(Exim )/\}\} /;
7373d852 1136 }
492fd282 1137 if (/^ ├──condition: def:tls_cipher$/)
340f3113
JH
1138 {
1139 <IN>; <IN>; <IN>; <IN>; <IN>; <IN>;
1140 <IN>; <IN>; <IN>; <IN>; <IN>; next;
1141 }
1142
1143 # Not all platforms build with DKIM enabled
1144 next if /^PDKIM >> Body data for hash, canonicalized/;
7373d852 1145
61453fd1
JH
1146 # Not all platforms have sendfile support
1147 next if /^cannot use sendfile for body: no support$/;
1148
cd1a5fe0 1149 # Parts of DKIM-specific debug output depend on the time/date
02b41d71 1150 next if /^date:\w+,\{SP\}/;
cd1a5fe0
JH
1151 next if /^PDKIM \[[^[]+\] (Header hash|b) computed:/;
1152
ef817659 1153 # Not all platforms support TCP Fast Open, and the compile omits the check
cb340d8d 1154 if (s/\S+ in hosts_try_fastopen\? no \(option unset\)\n$//)
ef817659 1155 {
7373d852
JH
1156 $_ .= <IN>;
1157 s/ \.\.\. >>> / ... /;
30d678d5 1158 s/Address family not supported by protocol family/Network Error/;
b3200ced 1159 s/Network is unreachable/Network Error/;
ef817659
JH
1160 }
1161
8170f6f7 1162 next if /^(ppppp )?setsockopt FASTOPEN: Protocol not available$/;
7373d852 1163
0a6c178c 1164 # Specific pointer values reported for DB operations change from run to run
966e829c
JH
1165 s/^(\s*returned from EXIM_DBOPEN: )(0x)?[0-9a-f]+/${1}0xAAAAAAAA/;
1166 s/^(\s*EXIM_DBCLOSE.)(0x)?[0-9a-f]+/${1}0xAAAAAAAA/;
0a6c178c 1167
ff059213
JH
1168 # Platform-dependent output during MySQL startup
1169 next if /PerconaFT file system space/;
1170 next if /^Waiting for MySQL server to answer/;
1171 next if /mysqladmin: CREATE DATABASE failed; .* database exists/;
1172
55997e6c
JH
1173 # Not all builds include DMARC
1174 next if /^DMARC: no (dmarc_tld_file|sender_host_address)$/ ;
1175
151b83f8
PH
1176 # When Exim is checking the size of directories for maildir, it uses
1177 # the check_dir_size() function to scan directories. Of course, the order
1178 # of the files that are obtained using readdir() varies from system to
1179 # system. We therefore buffer up debugging lines from check_dir_size()
1180 # and sort them before outputting them.
1181
1182 if (/^check_dir_size:/ || /^skipping TESTSUITE\/test-mail\//)
1183 {
1184 push @saved, $_;
1185 }
1186 else
1187 {
1188 if (@saved > 0)
1189 {
1190 print MUNGED "MUNGED: the check_dir_size lines have been sorted " .
1191 "to ensure consistency\n";
1192 @saved = sort(@saved);
1193 print MUNGED @saved;
1194 @saved = ();
1195 }
1196
1197 # Skip some lines that Exim puts out at the start of debugging output
1198 # because they will be different in different binaries.
1199
1200 print MUNGED
1201 unless (/^Berkeley DB: / ||
1202 /^Probably (?:Berkeley DB|ndbm|GDBM)/ ||
1203 /^Authenticators:/ ||
1204 /^Lookups:/ ||
1205 /^Support for:/ ||
1206 /^Routers:/ ||
1207 /^Transports:/ ||
c11d665d 1208 /^Malware:/ ||
151b83f8
PH
1209 /^log selectors =/ ||
1210 /^cwd=/ ||
21c28500 1211 /^Fixed never_users:/ ||
c9fb6994 1212 /^Configure owner:/ ||
21c28500 1213 /^Size of off_t:/
151b83f8 1214 );
9d4319df
JH
1215
1216
151b83f8
PH
1217 }
1218
1219 next;
1220 }
1221
42ec9880
JH
1222 # ======== log ========
1223
1224 elsif ($is_log)
1225 {
1226 # Berkeley DB version differences
1227 next if / Berkeley DB error: /;
23a217d9
JH
1228
1229 # CHUNKING: exact sizes depend on hostnames in headers
1230 s/(=>.* K C="250- \d)\d+ (byte chunk, total \d)\d+/$1nn $2nn/;
f5978b01
JH
1231
1232 # openssl version variances
42427533 1233 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 1234 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 1235 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
1236
1237 # DKIM timestamps
b24eb9cd
JH
1238 if ( /(DKIM: d=.*) t=([0-9]*) x=([0-9]*) / )
1239 {
1240 my ($prefix, $t_diff) = ($1, $3 - $2);
1241 s/DKIM: d=.* t=[0-9]* x=[0-9]* /${prefix} t=T x=T+${t_diff} /;
1242 }
2bc0f45e
JH
1243 }
1244
1245 # ======== mail ========
1246
1247 elsif ($is_mail)
1248 {
b24eb9cd
JH
1249 # DKIM timestamps, and signatures depending thereon
1250 if ( /^(\s+)t=([0-9]*); x=([0-9]*); b=[A-Za-z0-9+\/]+$/ )
1251 {
1252 my ($indent, $t_diff) = ($1, $3 - $2);
1253 s/.*/${indent}t=T; x=T+${t_diff}; b=bbbb;/;
2bc0f45e
JH
1254 <IN>;
1255 <IN>;
1256 }
42ec9880
JH
1257 }
1258
151b83f8
PH
1259 # ======== All files other than stderr ========
1260
1261 print MUNGED;
1262 }
1263
1264close(IN);
1265return $yield;
1266}
1267
1268
1269
1270
1271##################################################
1272# Subroutine to interact with caller #
1273##################################################
1274
1275# Arguments: [0] the prompt string
1276# [1] if there is a U in the prompt and $force_update is true
c1c469db 1277# [2] if there is a C in the prompt and $force_continue is true
2f8e6f30 1278# Returns: returns the answer
151b83f8 1279
0df394b5
HSHR
1280sub interact {
1281 my ($prompt, $have_u, $have_c) = @_;
1282
1283 print $prompt;
1284
1285 if ($have_u) {
1286 print "... update forced\n";
1287 return 'u';
1288 }
1289
1290 if ($have_c) {
1291 print "... continue forced\n";
1292 return 'c';
1293 }
1294
1295 return lc <T>;
151b83f8
PH
1296}
1297
1298
1299
c1c469db
TL
1300##################################################
1301# Subroutine to log in force_continue mode #
1302##################################################
1303
1304# In force_continue mode, we just want a terse output to a statically
1305# named logfile. If multiple files in same batch (stdout, stderr, etc)
1306# all have mismatches, it will log multiple times.
1307#
1308# Arguments: [0] the logfile to append to
1309# [1] the testno that failed
1310# Returns: nothing
1311
1312
1313
1314sub log_failure {
0df394b5
HSHR
1315 my ($logfile, $testno, $detail) = @_;
1316
1317 open(my $fh, '>>', $logfile) or return;
1318
1319 print $fh "Test $testno "
1320 . (defined $detail ? "$detail " : '')
1321 . "failed\n";
c1c469db
TL
1322}
1323
a4ecb6a7
JH
1324# Computer-readable summary results logfile
1325
1326sub log_test {
1327 my ($logfile, $testno, $resultchar) = @_;
1328
1329 open(my $fh, '>>', $logfile) or return;
1330 print $fh "$testno $resultchar\n";
1331}
1332
c1c469db 1333
151b83f8
PH
1334
1335##################################################
1336# Subroutine to compare one output file #
1337##################################################
1338
1339# When an Exim server is part of the test, its output is in separate files from
1340# an Exim client. The server data is concatenated with the client data as part
1341# of the munging operation.
1342#
1343# Arguments: [0] the name of the main raw output file
1344# [1] the name of the server raw output file or undef
1345# [2] where to put the munged copy
1346# [3] the name of the saved file
1347# [4] TRUE if this is a log file whose deliveries must be sorted
c9a55f6a 1348# [5] optionally, a custom munge command
151b83f8 1349#
a4ecb6a7
JH
1350# Returns: 0 comparison succeeded
1351# 1 comparison failed; differences to be ignored
1352# 2 comparison failed; files may have been updated (=> re-compare)
151b83f8
PH
1353#
1354# Does not return if the user replies "Q" to a prompt.
1355
1356sub check_file{
c9a55f6a 1357my($rf,$rsf,$mf,$sf,$sortfile,$extra) = @_;
151b83f8
PH
1358
1359# If there is no saved file, the raw files must either not exist, or be
1360# empty. The test ! -s is TRUE if the file does not exist or is empty.
1361
28e8a0f7
HSHR
1362# we check if there is a flavour specific file, but we remember
1363# the original file name as "generic"
1364$sf_generic = $sf;
1365$sf_flavour = "$sf_generic.$flavour";
1366$sf_current = -e $sf_flavour ? $sf_flavour : $sf_generic;
1367
1368if (! -e $sf_current)
151b83f8 1369 {
148e1ac6 1370 return 0 if (! -s $rf && (! defined $rsf || ! -s $rsf));
151b83f8
PH
1371
1372 print "\n";
1373 print "** $rf is not empty\n" if (-s $rf);
1374 print "** $rsf is not empty\n" if (defined $rsf && -s $rsf);
1375
1376 for (;;)
1377 {
0df394b5
HSHR
1378 $_ = interact('Continue, Show, or Quit? [Q] ', undef, $force_continue);
1379 tests_exit(1) if /^q?$/;
a4ecb6a7
JH
1380 if (/^c$/ && $force_continue) {
1381 log_failure($log_failed_filename, $testno, $rf);
1382 log_test($log_summary_filename, $testno, 'F') if ($force_continue);
1383 }
0aca614f
JH
1384 return 1 if /^c$/i && $rf !~ /paniclog/ && $rsf !~ /paniclog/;
1385 last if (/^[sc]$/);
151b83f8
PH
1386 }
1387
1388 foreach $f ($rf, $rsf)
1389 {
1390 if (defined $f && -s $f)
1391 {
1392 print "\n";
1393 print "------------ $f -----------\n"
1394 if (defined $rf && -s $rf && defined $rsf && -s $rsf);
bc64a74d 1395 system("$more '$f'");
151b83f8
PH
1396 }
1397 }
1398
1399 print "\n";
1400 for (;;)
1401 {
0df394b5
HSHR
1402 $_ = interact('Continue, Update & retry, Quit? [Q] ', $force_update, $force_continue);
1403 tests_exit(1) if /^q?$/;
a4ecb6a7
JH
1404 if (/^c$/ && $force_continue) {
1405 log_failure($log_failed_filename, $testno, $rf);
1406 log_test($log_summary_filename, $testno, 'F')
1407 }
1408 return 1 if /^c$/i;
151b83f8
PH
1409 last if (/^u$/i);
1410 }
1411 }
1412
2f8e6f30
HSHR
1413#### $_
1414
151b83f8
PH
1415# Control reaches here if either (a) there is a saved file ($sf), or (b) there
1416# was a request to create a saved file. First, create the munged file from any
1417# data that does exist.
1418
9edef117 1419open(MUNGED, '>', $mf) || tests_exit(-1, "Failed to open $mf: $!");
c9a55f6a 1420my($truncated) = munge($rf, $extra) if -e $rf;
4cc77633
HSHR
1421
1422# Append the raw server log, if it is non-empty
151b83f8
PH
1423if (defined $rsf && -e $rsf)
1424 {
1425 print MUNGED "\n******** SERVER ********\n";
c9a55f6a 1426 $truncated |= munge($rsf, $extra);
151b83f8
PH
1427 }
1428close(MUNGED);
1429
1430# If a saved file exists, do the comparison. There are two awkward cases:
1431#
1432# If "*** truncated ***" was found in the new file, it means that a log line
1433# was overlong, and truncated. The problem is that it may be truncated at
1434# different points on different systems, because of different user name
1435# lengths. We reload the file and the saved file, and remove lines from the new
1436# file that precede "*** truncated ***" until we reach one that matches the
1437# line that precedes it in the saved file.
1438#
1439# If $sortfile is set, we are dealing with a mainlog file where the deliveries
1440# for an individual message might vary in their order from system to system, as
1441# a result of parallel deliveries. We load the munged file and sort sequences
1442# of delivery lines.
1443
28e8a0f7 1444if (-e $sf_current)
151b83f8
PH
1445 {
1446 # Deal with truncated text items
1447
1448 if ($truncated)
1449 {
1450 my(@munged, @saved, $i, $j, $k);
1451
9edef117 1452 open(MUNGED, $mf) || tests_exit(-1, "Failed to open $mf: $!");
151b83f8
PH
1453 @munged = <MUNGED>;
1454 close(MUNGED);
28e8a0f7 1455 open(SAVED, $sf_current) || tests_exit(-1, "Failed to open $sf_current: $!");
151b83f8
PH
1456 @saved = <SAVED>;
1457 close(SAVED);
1458
1459 $j = 0;
1460 for ($i = 0; $i < @munged; $i++)
1461 {
1462 if ($munged[$i] =~ /\*\*\* truncated \*\*\*/)
1463 {
1464 for (; $j < @saved; $j++)
1465 { last if $saved[$j] =~ /\*\*\* truncated \*\*\*/; }
1466 last if $j >= @saved; # not found in saved
1467
1468 for ($k = $i - 1; $k >= 0; $k--)
1469 { last if $munged[$k] eq $saved[$j - 1]; }
1470
1471 last if $k <= 0; # failed to find previous match
1472 splice @munged, $k + 1, $i - $k - 1;
1473 $i = $k + 1;
1474 }
1475 }
1476
9edef117 1477 open(MUNGED, '>', $mf) || tests_exit(-1, "Failed to open $mf: $!");
151b83f8
PH
1478 for ($i = 0; $i < @munged; $i++)
1479 { print MUNGED $munged[$i]; }
1480 close(MUNGED);
1481 }
1482
1483 # Deal with log sorting
1484
1485 if ($sortfile)
1486 {
1487 my(@munged, $i, $j);
1488
9edef117 1489 open(MUNGED, $mf) || tests_exit(-1, "Failed to open $mf: $!");
151b83f8
PH
1490 @munged = <MUNGED>;
1491 close(MUNGED);
1492
1493 for ($i = 0; $i < @munged; $i++)
1494 {
1495 if ($munged[$i] =~ /^[-\d]{10}\s[:\d]{8}\s[-A-Za-z\d]{16}\s[-=*]>/)
1496 {
1497 for ($j = $i + 1; $j < @munged; $j++)
1498 {
1499 last if $munged[$j] !~
1500 /^[-\d]{10}\s[:\d]{8}\s[-A-Za-z\d]{16}\s[-=*]>/;
1501 }
1502 @temp = splice(@munged, $i, $j - $i);
1503 @temp = sort(@temp);
1504 splice(@munged, $i, 0, @temp);
1505 }
1506 }
1507
1508 open(MUNGED, ">$mf") || tests_exit(-1, "Failed to open $mf: $!");
1509 print MUNGED "**NOTE: The delivery lines in this file have been sorted.\n";
1510 for ($i = 0; $i < @munged; $i++)
1511 { print MUNGED $munged[$i]; }
1512 close(MUNGED);
1513 }
1514
1515 # Do the comparison
1516
28e8a0f7 1517 return 0 if (system("$cf '$mf' '$sf_current' >test-cf") == 0);
151b83f8
PH
1518
1519 # Handle comparison failure
1520
28e8a0f7 1521 print "** Comparison of $mf with $sf_current failed";
151b83f8
PH
1522 system("$more test-cf");
1523
1524 print "\n";
1525 for (;;)
1526 {
0df394b5
HSHR
1527 $_ = interact('Continue, Retry, Update current'
1528 . ($sf_current ne $sf_flavour ? "/Save for flavour '$flavour'" : '')
1529 . ' & retry, Quit? [Q] ', $force_update, $force_continue);
1530 tests_exit(1) if /^q?$/;
a4ecb6a7
JH
1531 if (/^c$/ && $force_continue) {
1532 log_failure($log_failed_filename, $testno, $sf_current);
1533 log_test($log_summary_filename, $testno, 'F')
1534 }
1535 return 1 if /^c$/i;
1536 return 2 if /^r$/i;
28e8a0f7 1537 last if (/^[us]$/i);
151b83f8
PH
1538 }
1539 }
1540
1541# Update or delete the saved file, and give the appropriate return code.
1542
1543if (-s $mf)
28e8a0f7 1544 {
a4ecb6a7
JH
1545 my $sf = /^u/i ? $sf_current : $sf_flavour;
1546 tests_exit(-1, "Failed to cp $mf $sf") if system("cp '$mf' '$sf'") != 0;
28e8a0f7 1547 }
151b83f8 1548else
28e8a0f7 1549 {
a4ecb6a7
JH
1550 # if we deal with a flavour file, we can't delete it, because next time the generic
1551 # file would be used again
1552 if ($sf_current eq $sf_flavour) {
1553 open(FOO, ">$sf_current");
1554 close(FOO);
1555 }
1556 else {
1557 tests_exit(-1, "Failed to unlink $sf_current") if !unlink($sf_current);
1558 }
28e8a0f7 1559 }
151b83f8 1560
a4ecb6a7 1561return 2;
151b83f8
PH
1562}
1563
1564
1565
1566##################################################
c9a55f6a
JH
1567# Custom munges
1568# keyed by name of munge; value is a ref to a hash
1569# which is keyed by file, value a string to look for.
1570# Usable files are:
1571# paniclog, rejectlog, mainlog, stdout, stderr, msglog, mail
1572# Search strings starting with 's' do substitutions;
1573# with '/' do line-skips.
74377a62 1574# Triggered by a scriptfile line "munge <name>"
c9a55f6a
JH
1575##################################################
1576$munges =
1577 { 'dnssec' =>
cf407cb6 1578 { 'stderr' => '/^Reverse DNS security status: unverified\n/' },
c9a55f6a
JH
1579
1580 'gnutls_unexpected' =>
cf407cb6 1581 { 'mainlog' => '/\(recv\): A TLS packet with unexpected length was received./' },
c9a55f6a
JH
1582
1583 'gnutls_handshake' =>
cf407cb6 1584 { 'mainlog' => 's/\(gnutls_handshake\): Error in the push function/\(gnutls_handshake\): A TLS packet with unexpected length was received/' },
c9a55f6a 1585
8008accd
JH
1586 'gnutls_bad_clientcert' =>
1587 { 'mainlog' => 's/\(certificate verification failed\): certificate invalid/\(gnutls_handshake\): The peer did not send any certificate./',
1588 'stdout' => 's/Succeeded in starting TLS/A TLS fatal alert has been received.\nFailed to start TLS'
1589 },
1590
74377a62 1591 'optional_events' =>
cf407cb6 1592 { 'stdout' => '/event_action =/' },
74377a62
JH
1593
1594 'optional_ocsp' =>
cf407cb6
JH
1595 { 'stderr' => '/127.0.0.1 in hosts_requ(ire|est)_ocsp/' },
1596
79547a5a
JH
1597 'optional_cert_hostnames' =>
1598 { 'stderr' => '/in tls_verify_cert_hostnames\? no/' },
1599
ac9a0d91
JH
1600 'loopback' =>
1601 { 'stdout' => 's/[[](127\.0\.0\.1|::1)]/[IP_LOOPBACK_ADDR]/' },
1602
35deab6a
JH
1603 'scanfile_size' =>
1604 { 'stdout' => 's/(Content-length:) \d\d\d/$1 ddd/' },
1605
846430d9
JH
1606 'delay_1500' =>
1607 { 'stderr' => 's/(1[5-9]|23\d)\d\d msec/ssss msec/' },
1608
b3ef41c9 1609 'tls_anycipher' =>
8ac90765
JH
1610 { 'mainlog' => 's! X=TLS\S+ ! X=TLS_proto_and_cipher !;
1611 s! DN="C=! DN="/C=!;
1612 s! DN="[^,"]*\K,!/!;
1613 s! DN="[^,"]*\K,!/!;
1614 s! DN="[^,"]*\K,!/!;
1615 ',
1616 'rejectlog' => 's/ X=TLS\S+ / X=TLS_proto_and_cipher /',
1617 'mail' => 's/ \(TLS[^)]*\)/ (TLS_proto_and_cipher)/',
1618 },
b3ef41c9 1619
ae9d18bc 1620 'debug_pid' =>
b1cf8494 1621 { 'stderr' => 's/(^\s{0,4}|(?<=Process )|(?<=child ))\d{1,5}/ppppp/g' },
ae9d18bc 1622
d658adda
JH
1623 'optional_dsn_info' =>
1624 { 'mail' => '/^(X-(Remote-MTA-(smtp-greeting|helo-response)|Exim-Diagnostic|(body|message)-linecount):|Remote-MTA: X-ip;)/'
6636495c
JH
1625 },
1626
06685b44 1627 'optional_config' =>
4dce3152 1628 { 'stdout' => '/^(
2bc0f45e 1629 dkim_(canon|domain|private_key|selector|sign_headers|strict|hash|identity|timestamps)
4dce3152
JH
1630 |gnutls_require_(kx|mac|protocols)
1631 |hosts_(requ(est|ire)|try)_(dane|ocsp)
295bebda 1632 |dane_require_tls_ciphers
c3161b1d 1633 |hosts_(avoid|nopass|noproxy|require|verify_avoid)_tls
06685b44 1634 |socks_proxy
4dce3152 1635 |tls_[^ ]*
71c15846 1636 |utf8_downconvert
c3161b1d
JH
1637 )($|[ ]=)/x'
1638 },
79c904e1 1639
6636495c 1640 'sys_bindir' =>
7329ca93 1641 { 'mainlog' => 's%/(usr/(local/)?)?bin/%SYSBINDIR/%' },
d658adda 1642
a0418528
JH
1643 'sync_check_data' =>
1644 { 'mainlog' => 's/^(.* SMTP protocol synchronization error .* next input=.{8}).*$/$1<suppressed>/',
1645 'rejectlog' => 's/^(.* SMTP protocol synchronization error .* next input=.{8}).*$/$1<suppressed>/'},
1646
b0d68adc 1647 'debuglog_stdout' =>
398f9af3 1648 { 'stdout' => 's/^\d\d:\d\d:\d\d\s+\d+ //;
b0d68adc
JH
1649 s/Process \d+ is ready for new message/Process pppp is ready for new message/'
1650 },
74ba91b1
JH
1651
1652 'timeout_errno' => # actual errno differs Solaris vs. Linux
1653 { 'mainlog' => 's/(host deferral .* errno) <\d+> /$1 <EEE> /' },
d0eb2d45
JH
1654
1655 'peer_terminated_conn' => # actual error differs FreedBSD vs. Linux
1656 { 'stderr' => 's/^( SMTP\()Connection reset by peer(\)<<)$/$1closed$2/' },
c3161b1d 1657
2566035f
JH
1658 'perl_variants' => # result of hash-in-scalar-context changed from bucket-fill to keycount
1659 { 'stdout' => 's%^> X/X$%> X%' },
c9a55f6a
JH
1660 };
1661
1662
a4ecb6a7
JH
1663sub max {
1664 my ($a, $b) = @_;
1665 return $a if ($a > $b);
1666 return $b;
1667}
1668
c9a55f6a 1669##################################################
151b83f8
PH
1670# Subroutine to check the output of a test #
1671##################################################
1672
1673# This function is called when the series of subtests is complete. It makes
c9a55f6a 1674# use of check_file(), whose arguments are:
151b83f8
PH
1675#
1676# [0] the name of the main raw output file
1677# [1] the name of the server raw output file or undef
1678# [2] where to put the munged copy
1679# [3] the name of the saved file
1680# [4] TRUE if this is a log file whose deliveries must be sorted
c9a55f6a 1681# [5] an optional custom munge command
151b83f8 1682#
ac9a0d91 1683# Arguments: Optionally, name of a single custom munge to run.
151b83f8 1684# Returns: 0 if the output compared equal
a4ecb6a7
JH
1685# 1 if comparison failed; differences to be ignored
1686# 2 if re-run needed (files may have been updated)
151b83f8
PH
1687
1688sub check_output{
c9a55f6a 1689my($mungename) = $_[0];
151b83f8 1690my($yield) = 0;
c9a55f6a 1691my($munge) = $munges->{$mungename} if defined $mungename;
151b83f8 1692
a4ecb6a7 1693$yield = max($yield, check_file("spool/log/paniclog",
151b83f8
PH
1694 "spool/log/serverpaniclog",
1695 "test-paniclog-munged",
c9a55f6a 1696 "paniclog/$testno", 0,
a4ecb6a7 1697 $munge->{paniclog}));
151b83f8 1698
a4ecb6a7 1699$yield = max($yield, check_file("spool/log/rejectlog",
151b83f8
PH
1700 "spool/log/serverrejectlog",
1701 "test-rejectlog-munged",
c9a55f6a 1702 "rejectlog/$testno", 0,
a4ecb6a7 1703 $munge->{rejectlog}));
151b83f8 1704
a4ecb6a7 1705$yield = max($yield, check_file("spool/log/mainlog",
151b83f8
PH
1706 "spool/log/servermainlog",
1707 "test-mainlog-munged",
c9a55f6a 1708 "log/$testno", $sortlog,
a4ecb6a7 1709 $munge->{mainlog}));
151b83f8
PH
1710
1711if (!$stdout_skip)
1712 {
a4ecb6a7 1713 $yield = max($yield, check_file("test-stdout",
151b83f8
PH
1714 "test-stdout-server",
1715 "test-stdout-munged",
c9a55f6a 1716 "stdout/$testno", 0,
a4ecb6a7 1717 $munge->{stdout}));
151b83f8
PH
1718 }
1719
1720if (!$stderr_skip)
1721 {
a4ecb6a7 1722 $yield = max($yield, check_file("test-stderr",
151b83f8
PH
1723 "test-stderr-server",
1724 "test-stderr-munged",
c9a55f6a 1725 "stderr/$testno", 0,
a4ecb6a7 1726 $munge->{stderr}));
151b83f8
PH
1727 }
1728
1729# Compare any delivered messages, unless this test is skipped.
1730
1731if (! $message_skip)
1732 {
1733 my($msgno) = 0;
1734
1735 # Get a list of expected mailbox files for this script. We don't bother with
1736 # directories, just the files within them.
1737
1738 foreach $oldmail (@oldmails)
1739 {
1740 next unless $oldmail =~ /^mail\/$testno\./;
1741 print ">> EXPECT $oldmail\n" if $debug;
1742 $expected_mails{$oldmail} = 1;
1743 }
1744
1745 # If there are any files in test-mail, compare them. Note that "." and
1746 # ".." are automatically omitted by list_files_below().
1747
1748 @mails = list_files_below("test-mail");
1749
1750 foreach $mail (@mails)
1751 {
1752 next if $mail eq "test-mail/oncelog";
1753
1754 $saved_mail = substr($mail, 10); # Remove "test-mail/"
1755 $saved_mail =~ s/^$parm_caller(\/|$)/CALLER/; # Convert caller name
1756
1757 if ($saved_mail =~ /(\d+\.[^.]+\.)/)
1758 {
1759 $msgno++;
1760 $saved_mail =~ s/(\d+\.[^.]+\.)/$msgno./gx;
1761 }
1762
1763 print ">> COMPARE $mail mail/$testno.$saved_mail\n" if $debug;
a4ecb6a7 1764 $yield = max($yield, check_file($mail, undef, "test-mail-munged",
c9a55f6a 1765 "mail/$testno.$saved_mail", 0,
a4ecb6a7 1766 $munge->{mail}));
151b83f8
PH
1767 delete $expected_mails{"mail/$testno.$saved_mail"};
1768 }
1769
1770 # Complain if not all expected mails have been found
1771
1772 if (scalar(keys %expected_mails) != 0)
1773 {
1774 foreach $key (keys %expected_mails)
1775 { print "** no test file found for $key\n"; }
1776
1777 for (;;)
1778 {
0df394b5
HSHR
1779 $_ = interact('Continue, Update & retry, or Quit? [Q] ', $force_update, $force_continue);
1780 tests_exit(1) if /^q?$/;
a4ecb6a7
JH
1781 if (/^c$/ && $force_continue) {
1782 log_failure($log_failed_filename, $testno, "missing email");
1783 log_test($log_summary_filename, $testno, 'F')
1784 }
0df394b5 1785 last if /^c$/;
151b83f8
PH
1786
1787 # For update, we not only have to unlink the file, but we must also
1788 # remove it from the @oldmails vector, as otherwise it will still be
1789 # checked for when we re-run the test.
1790
0df394b5 1791 if (/^u$/)
151b83f8
PH
1792 {
1793 foreach $key (keys %expected_mails)
1794 {
1795 my($i);
1796 tests_exit(-1, "Failed to unlink $key") if !unlink("$key");
1797 for ($i = 0; $i < @oldmails; $i++)
1798 {
1799 if ($oldmails[$i] eq $key)
1800 {
1801 splice @oldmails, $i, 1;
1802 last;
1803 }
1804 }
1805 }
1806 last;
1807 }
1808 }
1809 }
1810 }
1811
1812# Compare any remaining message logs, unless this test is skipped.
1813
1814if (! $msglog_skip)
1815 {
1816 # Get a list of expected msglog files for this test
1817
1818 foreach $oldmsglog (@oldmsglogs)
1819 {
1820 next unless $oldmsglog =~ /^$testno\./;
1821 $expected_msglogs{$oldmsglog} = 1;
1822 }
1823
1824 # If there are any files in spool/msglog, compare them. However, we have
1825 # to munge the file names because they are message ids, which are
1826 # time dependent.
1827
1828 if (opendir(DIR, "spool/msglog"))
1829 {
1830 @msglogs = sort readdir(DIR);
1831 closedir(DIR);
1832
1833 foreach $msglog (@msglogs)
1834 {
1835 next if ($msglog eq "." || $msglog eq ".." || $msglog eq "CVS");
1836 ($munged_msglog = $msglog) =~
1837 s/((?:[^\W_]{6}-){2}[^\W_]{2})
1838 /new_value($1, "10Hm%s-0005vi-00", \$next_msgid)/egx;
a4ecb6a7 1839 $yield = max($yield, check_file("spool/msglog/$msglog", undef,
c9a55f6a 1840 "test-msglog-munged", "msglog/$testno.$munged_msglog", 0,
a4ecb6a7 1841 $munge->{msglog}));
151b83f8
PH
1842 delete $expected_msglogs{"$testno.$munged_msglog"};
1843 }
1844 }
1845
1846 # Complain if not all expected msglogs have been found
1847
1848 if (scalar(keys %expected_msglogs) != 0)
1849 {
1850 foreach $key (keys %expected_msglogs)
1851 {
1852 print "** no test msglog found for msglog/$key\n";
1853 ($msgid) = $key =~ /^\d+\.(.*)$/;
1854 foreach $cachekey (keys %cache)
1855 {
1856 if ($cache{$cachekey} eq $msgid)
1857 {
1858 print "** original msgid $cachekey\n";
1859 last;
1860 }
1861 }
1862 }
1863
1864 for (;;)
1865 {
0df394b5
HSHR
1866 $_ = interact('Continue, Update, or Quit? [Q] ', $force_update, $force_continue);
1867 tests_exit(1) if /^q?$/;
a4ecb6a7
JH
1868 if (/^c$/ && $force_continue) {
1869 log_failure($log_failed_filename, $testno, "missing msglog");
1870 log_test($log_summary_filename, $testno, 'F')
1871 }
0df394b5
HSHR
1872 last if /^c$/;
1873 if (/^u$/)
151b83f8
PH
1874 {
1875 foreach $key (keys %expected_msglogs)
1876 {
1877 tests_exit(-1, "Failed to unlink msglog/$key")
1878 if !unlink("msglog/$key");
1879 }
1880 last;
1881 }
1882 }
1883 }
1884 }
1885
1886return $yield;
1887}
1888
1889
1890
1891##################################################
1892# Subroutine to run one "system" command #
1893##################################################
1894
1895# We put this in a subroutine so that the command can be reflected when
1896# debugging.
1897#
1898# Argument: the command to be run
1899# Returns: nothing
1900
1901sub run_system {
050514b5
JH
1902my($cmd) = $_[0];
1903if ($debug)
1904 {
1905 my($prcmd) = $cmd;
1906 $prcmd =~ s/; /;\n>> /;
1907 print ">> $prcmd\n";
1908 }
1909system("$cmd");
151b83f8
PH
1910}
1911
1912
1913
1914##################################################
1915# Subroutine to run one script command #
1916##################################################
1917
1918# The <SCRIPT> file is open for us to read an optional return code line,
1919# followed by the command line and any following data lines for stdin. The
1920# command line can be continued by the use of \. Data lines are not continued
4c04137d 1921# in this way. In all lines, the following substitutions are made:
151b83f8
PH
1922#
1923# DIR => the current directory
1924# CALLER => the caller of this script
1925#
1926# Arguments: the current test number
1927# reference to the subtest number, holding previous value
1928# reference to the expected return code value
1929# reference to where to put the command name (for messages)
4c04137d 1930# auxiliary information returned from a previous run
151b83f8 1931#
4c04137d 1932# Returns: 0 the command was executed inline, no subprocess was run
151b83f8
PH
1933# 1 a non-exim command was run and waited for
1934# 2 an exim command was run and waited for
1935# 3 a command was run and not waited for (daemon, server, exim_lock)
1936# 4 EOF was encountered after an initial return code line
4c04137d 1937# Optionally also a second parameter, a hash-ref, with auxiliary information:
1ca9f507 1938# exim_pid: pid of a run process
c9a55f6a 1939# munge: name of a post-script results munger
151b83f8
PH
1940
1941sub run_command{
1942my($testno) = $_[0];
1943my($subtestref) = $_[1];
1944my($commandnameref) = $_[3];
1ca9f507 1945my($aux_info) = $_[4];
151b83f8
PH
1946my($yield) = 1;
1947
bc3c7bb7
HSHR
1948our %ENV = map { $_ => $ENV{$_} } grep { /^(?:USER|SHELL|PATH|TERM|EXIM_TEST_.*)$/ } keys %ENV;
1949
151b83f8
PH
1950if (/^(\d+)\s*$/) # Handle unusual return code
1951 {
1952 my($r) = $_[2];
1953 $$r = $1 << 8;
1954 $_ = <SCRIPT>;
1955 return 4 if !defined $_; # Missing command
1956 $lineno++;
1957 }
1958
1959chomp;
1960$wait_time = 0;
1961
1962# Handle concatenated command lines
1963
1964s/\s+$//;
1965while (substr($_, -1) eq"\\")
1966 {
1967 my($temp);
1968 $_ = substr($_, 0, -1);
1969 chomp($temp = <SCRIPT>);
1970 if (defined $temp)
1971 {
1972 $lineno++;
1973 $temp =~ s/\s+$//;
1974 $temp =~ s/^\s+//;
1975 $_ .= $temp;
1976 }
1977 }
1978
1979# Do substitutions
1980
1981do_substitute($testno);
1982if ($debug) { printf ">> $_\n"; }
1983
1984# Pass back the command name (for messages)
1985
1986($$commandnameref) = /^(\S+)/;
1987
1988# Here follows code for handling the various different commands that are
1989# supported by this script. The first group of commands are all freestanding
1990# in that they share no common code and are not followed by any data lines.
1991
1992
1993###################
1994###################
1995
1996# The "dbmbuild" command runs exim_dbmbuild. This is used both to test the
1997# utility and to make DBM files for testing DBM lookups.
1998
1999if (/^dbmbuild\s+(\S+)\s+(\S+)/)
2000 {
2001 run_system("(./eximdir/exim_dbmbuild $parm_cwd/$1 $parm_cwd/$2;" .
2002 "echo exim_dbmbuild exit code = \$?)" .
2003 ">>test-stdout");
2004 return 1;
2005 }
2006
2007
2008# The "dump" command runs exim_dumpdb. On different systems, the output for
2009# some types of dump may appear in a different order because it's just hauled
2010# out of the DBM file. We can solve this by sorting. Ignore the leading
2011# date/time, as it will be flattened later during munging.
2012
2013if (/^dump\s+(\S+)/)
2014 {
2015 my($which) = $1;
2016 my(@temp);
2017 print ">> ./eximdir/exim_dumpdb $parm_cwd/spool $which\n" if $debug;
2018 open(IN, "./eximdir/exim_dumpdb $parm_cwd/spool $which |");
a0ff7619
JH
2019 open(OUT, ">>test-stdout");
2020 print OUT "+++++++++++++++++++++++++++\n";
2021
2022 if ($which eq "retry")
151b83f8 2023 {
a0ff7619
JH
2024 $/ = "\n ";
2025 @temp = <IN>;
2026 $/ = "\n";
2027
151b83f8 2028 @temp = sort {
a0ff7619
JH
2029 my($aa) = split(' ', $a);
2030 my($bb) = split(' ', $b);
2031 return $aa cmp $bb;
151b83f8 2032 } @temp;
a0ff7619
JH
2033
2034 foreach $item (@temp)
2035 {
7f8794a2 2036 $item =~ s/^\s*(.*)\n(.*)\n?\s*$/$1\n$2/m;
a0ff7619
JH
2037 print OUT " $item\n";
2038 }
151b83f8 2039 }
a0ff7619
JH
2040 else
2041 {
2042 @temp = <IN>;
2043 if ($which eq "callout")
2044 {
2045 @temp = sort {
2046 my($aa) = substr $a, 21;
2047 my($bb) = substr $b, 21;
2048 return $aa cmp $bb;
2049 } @temp;
2050 }
2051 print OUT @temp;
2052 }
2053
2054 close(IN);
151b83f8
PH
2055 close(OUT);
2056 return 1;
2057 }
2058
2059
4cc77633
HSHR
2060# verbose comments start with ###
2061if (/^###\s/) {
2062 for my $file (qw(test-stdout test-stderr test-stderr-server test-stdout-server)) {
2063 open my $fh, '>>', $file or die "Can't open >>$file: $!\n";
2064 say {$fh} $_;
2065 }
2066 return 0;
2067}
151b83f8 2068
9edef117 2069# The "echo" command is a way of writing comments to the screen.
151b83f8
PH
2070if (/^echo\s+(.*)$/)
2071 {
2072 print "$1\n";
2073 return 0;
2074 }
2075
2076
2077# The "exim_lock" command runs exim_lock in the same manner as "server",
2078# but it doesn't use any input.
2079
2080if (/^exim_lock\s+(.*)$/)
2081 {
2082 $cmd = "./eximdir/exim_lock $1 >>test-stdout";
2083 $server_pid = open SERVERCMD, "|$cmd" ||
2084 tests_exit(-1, "Failed to run $cmd\n");
2085
2086 # This gives the process time to get started; otherwise the next
2087 # process may not find it there when it expects it.
2088
6588a918 2089 select(undef, undef, undef, 0.1);
151b83f8
PH
2090 return 3;
2091 }
2092
2093
2094# The "exinext" command runs exinext
2095
2096if (/^exinext\s+(.*)/)
2097 {
2098 run_system("(./eximdir/exinext " .
2099 "-DEXIM_PATH=$parm_cwd/eximdir/exim " .
2100 "-C $parm_cwd/test-config $1;" .
2101 "echo exinext exit code = \$?)" .
2102 ">>test-stdout");
2103 return 1;
2104 }
2105
2106
f3f065bb
PH
2107# The "exigrep" command runs exigrep on the current mainlog
2108
2109if (/^exigrep\s+(.*)/)
2110 {
2111 run_system("(./eximdir/exigrep " .
2112 "$1 $parm_cwd/spool/log/mainlog;" .
2113 "echo exigrep exit code = \$?)" .
2114 ">>test-stdout");
2115 return 1;
2116 }
2117
2118
2119# The "eximstats" command runs eximstats on the current mainlog
2120
2121if (/^eximstats\s+(.*)/)
2122 {
2123 run_system("(./eximdir/eximstats " .
2124 "$1 $parm_cwd/spool/log/mainlog;" .
2125 "echo eximstats exit code = \$?)" .
2126 ">>test-stdout");
2127 return 1;
2128 }
2129
2130
151b83f8
PH
2131# The "gnutls" command makes a copy of saved GnuTLS parameter data in the
2132# spool directory, to save Exim from re-creating it each time.
2133
2134if (/^gnutls/)
2135 {
83e2f8a2
PP
2136 my $gen_fn = "spool/gnutls-params-$gnutls_dh_bits_normal";
2137 run_system "sudo cp -p aux-fixed/gnutls-params $gen_fn;" .
2138 "sudo chown $parm_eximuser:$parm_eximgroup $gen_fn;" .
2139 "sudo chmod 0400 $gen_fn";
151b83f8
PH
2140 return 1;
2141 }
2142
2143
2144# The "killdaemon" command should ultimately follow the starting of any Exim
2145# daemon with the -bd option. We kill with SIGINT rather than SIGTERM to stop
2146# it outputting "Terminated" to the terminal when not in the background.
2147
2148if (/^killdaemon/)
2149 {
1ca9f507
PP
2150 my $return_extra = {};
2151 if (exists $aux_info->{exim_pid})
2152 {
2153 $pid = $aux_info->{exim_pid};
2154 $return_extra->{exim_pid} = undef;
2155 print ">> killdaemon: recovered pid $pid\n" if $debug;
3ff2360f
JH
2156 if ($pid)
2157 {
ed54e8ae 2158 run_system("sudo /bin/kill -INT $pid");
3ff2360f
JH
2159 wait;
2160 }
1ca9f507
PP
2161 } else {
2162 $pid = `cat $parm_cwd/spool/exim-daemon.*`;
3ff2360f
JH
2163 if ($pid)
2164 {
ed54e8ae 2165 run_system("sudo /bin/kill -INT $pid");
3ff2360f
JH
2166 close DAEMONCMD; # Waits for process
2167 }
1ca9f507 2168 }
3ff2360f 2169 run_system("sudo /bin/rm -f spool/exim-daemon.*");
1ca9f507 2170 return (1, $return_extra);
151b83f8
PH
2171 }
2172
2173
2174# The "millisleep" command is like "sleep" except that its argument is in
2175# milliseconds, thus allowing for a subsecond sleep, which is, in fact, all it
2176# is used for.
2177
2178elsif (/^millisleep\s+(.*)$/)
2179 {
2180 select(undef, undef, undef, $1/1000);
2181 return 0;
2182 }
2183
2184
c9a55f6a
JH
2185# The "munge" command selects one of a hardwired set of test-result modifications
2186# to be made before result compares are run agains the golden set. This lets
2187# us account for test-system dependent things which only affect a few, but known,
2188# test-cases.
2189# Currently only the last munge takes effect.
2190
2191if (/^munge\s+(.*)$/)
2192 {
2193 return (0, { munge => $1 });
2194 }
2195
2196
151b83f8
PH
2197# The "sleep" command does just that. For sleeps longer than 1 second we
2198# tell the user what's going on.
2199
2200if (/^sleep\s+(.*)$/)
2201 {
2202 if ($1 == 1)
2203 {
2204 sleep(1);
2205 }
2206 else
2207 {
2208 printf(" Test %d sleep $1 ", $$subtestref);
2209 for (1..$1)
2210 {
2211 print ".";
2212 sleep(1);
2213 }
2214 printf("\r Test %d $cr", $$subtestref);
2215 }
2216 return 0;
2217 }
2218
2219
2220# Various Unix management commands are recognized
2221
21c28500 2222if (/^(ln|ls|du|mkdir|mkfifo|touch|cp|cat)\s/ ||
4e192008 2223 /^sudo\s(rmdir|rm|mv|chown|chmod)\s/)
151b83f8
PH
2224 {
2225 run_system("$_ >>test-stdout 2>>test-stderr");
2226 return 1;
2227 }
2228
2229
2230
2231###################
2232###################
2233
2234# The next group of commands are also freestanding, but they are all followed
2235# by data lines.
2236
2237
2238# The "server" command starts up a script-driven server that runs in parallel
2239# with the following exim command. Therefore, we want to run a subprocess and
2240# not yet wait for it to complete. The waiting happens after the next exim
2241# command, triggered by $server_pid being non-zero. The server sends its output
2242# to a different file. The variable $server_opts, if not empty, contains
2243# options to disable IPv4 or IPv6 if necessary.
b9d9c5a2 2244# This works because "server" swallows its stdin before waiting for a connection.
151b83f8
PH
2245
2246if (/^server\s+(.*)$/)
2247 {
f41e0506
JH
2248 $pidfile = "$parm_cwd/aux-var/server-daemon.pid";
2249 $cmd = "./bin/server $server_opts -oP $pidfile $1 >>test-stdout-server";
151b83f8
PH
2250 print ">> $cmd\n" if ($debug);
2251 $server_pid = open SERVERCMD, "|$cmd" || tests_exit(-1, "Failed to run $cmd");
2252 SERVERCMD->autoflush(1);
2253 print ">> Server pid is $server_pid\n" if $debug;
2254 while (<SCRIPT>)
2255 {
2256 $lineno++;
2257 last if /^\*{4}\s*$/;
2258 print SERVERCMD;
2259 }
2260 print SERVERCMD "++++\n"; # Send end to server; can't send EOF yet
2261 # because close() waits for the process.
2262
f41e0506 2263 # Interlock the server startup; otherwise the next
151b83f8 2264 # process may not find it there when it expects it.
f41e0506 2265 while (! stat("$pidfile") ) { select(undef, undef, undef, 0.3); }
151b83f8
PH
2266 return 3;
2267 }
2268
2269
2270# The "write" command is a way of creating files of specific sizes for
2271# buffering tests, or containing specific data lines from within the script
2272# (rather than hold lots of little files). The "catwrite" command does the
2273# same, but it also copies the lines to test-stdout.
2274
2275if (/^(cat)?write\s+(\S+)(?:\s+(.*))?\s*$/)
2276 {
2277 my($cat) = defined $1;
2278 @sizes = ();
2279 @sizes = split /\s+/, $3 if defined $3;
2280 open FILE, ">$2" || tests_exit(-1, "Failed to open \"$2\": $!");
2281
2282 if ($cat)
2283 {
2284 open CAT, ">>test-stdout" ||
2285 tests_exit(-1, "Failed to open test-stdout: $!");
2286 print CAT "==========\n";
2287 }
2288
2289 if (scalar @sizes > 0)
2290 {
2291 # Pre-data
2292
2293 while (<SCRIPT>)
2294 {
2295 $lineno++;
2296 last if /^\+{4}\s*$/;
2297 print FILE;
2298 print CAT if $cat;
2299 }
2300
2301 # Sized data
2302
2303 while (scalar @sizes > 0)
2304 {
2305 ($count,$len,$leadin) = (shift @sizes) =~ /(\d+)x(\d+)(?:=(.*))?/;
9a8a6839 2306 $leadin = '' if !defined $leadin;
151b83f8
PH
2307 $leadin =~ s/_/ /g;
2308 $len -= length($leadin) + 1;
2309 while ($count-- > 0)
2310 {
2311 print FILE $leadin, "a" x $len, "\n";
2312 print CAT $leadin, "a" x $len, "\n" if $cat;
2313 }
2314 }
2315 }
2316
2317 # Post data, or only data if no sized data
2318
2319 while (<SCRIPT>)
2320 {
2321 $lineno++;
2322 last if /^\*{4}\s*$/;
2323 print FILE;
2324 print CAT if $cat;
2325 }
2326 close FILE;
2327
2328 if ($cat)
2329 {
2330 print CAT "==========\n";
2331 close CAT;
2332 }
2333
2334 return 0;
2335 }
2336
2337
2338###################
2339###################
2340
2341# From this point on, script commands are implemented by setting up a shell
2342# command in the variable $cmd. Shared code to run this command and handle its
2343# input and output follows.
2344
cfc54830
PH
2345# The "client", "client-gnutls", and "client-ssl" commands run a script-driven
2346# program that plays the part of an email client. We also have the availability
2347# of running Perl for doing one-off special things. Note that all these
2348# commands expect stdin data to be supplied.
151b83f8 2349
cfc54830 2350if (/^client/ || /^(sudo\s+)?perl\b/)
151b83f8
PH
2351 {
2352 s"client"./bin/client";
2353 $cmd = "$_ >>test-stdout 2>>test-stderr";
2354 }
2355
2356# For the "exim" command, replace the text "exim" with the path for the test
2357# binary, plus -D options to pass over various parameters, and a -C option for
2358# the testing configuration file. When running in the test harness, Exim does
2359# not drop privilege when -C and -D options are present. To run the exim
2360# command as root, we use sudo.
2361
bc3c7bb7 2362elsif (/^((?i:[A-Z\d_]+=\S+\s+)+)?(\d+)?\s*(sudo(?:\s+-u\s+(\w+))?\s+)?exim(_\S+)?\s+(.*)$/)
151b83f8 2363 {
4c7220eb 2364 $args = $6;
9a8a6839
HSHR
2365 my($envset) = (defined $1)? $1 : '';
2366 my($sudo) = (defined $3)? "sudo " . (defined $4 ? "-u $4 ":'') : '';
2367 my($special)= (defined $5)? $5 : '';
151b83f8
PH
2368 $wait_time = (defined $2)? $2 : 0;
2369
2370 # Return 2 rather than 1 afterwards
2371
2372 $yield = 2;
2373
2374 # Update the test number
2375
2376 $$subtestref = $$subtestref + 1;
2377 printf(" Test %d $cr", $$subtestref);
2378
2379 # Copy the configuration file, making the usual substitutions.
2380
2381 open (IN, "$parm_cwd/confs/$testno") ||
2382 tests_exit(-1, "Couldn't open $parm_cwd/confs/$testno: $!\n");
2383 open (OUT, ">test-config") ||
2384 tests_exit(-1, "Couldn't open test-config: $!\n");
2385 while (<IN>)
2386 {
2387 do_substitute($testno);
2388 print OUT;
2389 }
2390 close(IN);
2391 close(OUT);
2392
2393 # The string $msg1 in args substitutes the message id of the first
2394 # message on the queue, and so on. */
2395
2396 if ($args =~ /\$msg/)
2397 {
562a0e6f
HSHR
2398 my @listcmd = ("$parm_cwd/eximdir/exim", '-bp',
2399 "-DEXIM_PATH=$parm_cwd/eximdir/exim",
2400 -C => "$parm_cwd/test-config");
2401 print ">> Getting queue list from:\n>> @listcmd\n" if $debug;
b402f294
HSHR
2402 # We need the message ids sorted in ascending order.
2403 # Message id is: <timestamp>-<pid>-<fractional-time>. On some systems (*BSD) the
2404 # PIDs are randomized, so sorting just the whole PID doesn't work.
2405 # We do the Schartz' transformation here (sort on
2406 # <timestamp><fractional-time>). Thanks to Kirill Miazine
562a0e6f
HSHR
2407 my @msglist =
2408 map { $_->[1] } # extract the values
2409 sort { $a->[0] cmp $b->[0] } # sort by key
2410 map { [join('.' => (split /-/, $_)[0,2]) => $_] } # key (timestamp.fractional-time) => value(message_id)
2411 map { /^\s*\d+[smhdw]\s+\S+\s+(\S+)/ } `@listcmd` or tests_exit(-1, "No output from `exim -bp` (@listcmd)\n");
151b83f8
PH
2412
2413 # Done backwards just in case there are more than 9
2414
25adc2a8 2415 for (my $i = @msglist; $i > 0; $i--) { $args =~ s/\$msg$i/$msglist[$i-1]/g; }
3ff2360f
JH
2416 if ( $args =~ /\$msg\d/ )
2417 {
8334b9b8
TL
2418 tests_exit(-1, "Not enough messages in spool, for test $testno line $lineno\n")
2419 unless $force_continue;
3ff2360f 2420 }
151b83f8
PH
2421 }
2422
2423 # If -d is specified in $optargs, remove it from $args; i.e. let
2424 # the command line for runtest override. Then run Exim.
2425
2426 $args =~ s/(?:^|\s)-d\S*// if $optargs =~ /(?:^|\s)-d/;
2427
9a8a6839 2428 my $opt_valgrind = $valgrind ? "valgrind --leak-check=yes --suppressions=$parm_cwd/aux-fixed/valgrind.supp " : '';
2c9f7ff8
JH
2429
2430 $cmd = "$envset$sudo$opt_valgrind" .
2431 "$parm_cwd/eximdir/exim$special$optargs " .
151b83f8
PH
2432 "-DEXIM_PATH=$parm_cwd/eximdir/exim$special " .
2433 "-C $parm_cwd/test-config $args " .
2434 ">>test-stdout 2>>test-stderr";
151b83f8
PH
2435 # If the command is starting an Exim daemon, we run it in the same
2436 # way as the "server" command above, that is, we don't want to wait
2437 # for the process to finish. That happens when "killdaemon" is obeyed later
2438 # in the script. We also send the stderr output to test-stderr-server. The
2439 # daemon has its log files put in a different place too (by configuring with
2440 # log_file_path). This requires the directory to be set up in advance.
2441 #
2442 # There are also times when we want to run a non-daemon version of Exim
2443 # (e.g. a queue runner) with the server configuration. In this case,
2444 # we also define -DNOTDAEMON.
2445
2446 if ($cmd =~ /\s-DSERVER=server\s/ && $cmd !~ /\s-DNOTDAEMON\s/)
2447 {
2448 if ($debug) { printf ">> daemon: $cmd\n"; }
050514b5 2449 run_system("sudo mkdir spool/log 2>/dev/null");
151b83f8
PH
2450 run_system("sudo chown $parm_eximuser:$parm_eximgroup spool/log");
2451
2452 # Before running the command, convert the -bd option into -bdf so that an
2453 # Exim daemon doesn't double fork. This means that when we wait close
1b781f48
PH
2454 # DAEMONCMD, it waits for the correct process. Also, ensure that the pid
2455 # file is written to the spool directory, in case the Exim binary was
2456 # built with PID_FILE_PATH pointing somewhere else.
151b83f8 2457
f41e0506
JH
2458 if ($cmd =~ /\s-oP\s/)
2459 {
2460 ($pidfile = $cmd) =~ s/^.*-oP ([^ ]+).*$/$1/;
2461 $cmd =~ s!\s-bd\s! -bdf !;
2462 }
2463 else
2464 {
2465 $pidfile = "$parm_cwd/spool/exim-daemon.pid";
2466 $cmd =~ s!\s-bd\s! -bdf -oP $pidfile !;
2467 }
151b83f8
PH
2468 print ">> |${cmd}-server\n" if ($debug);
2469 open DAEMONCMD, "|${cmd}-server" || tests_exit(-1, "Failed to run $cmd");
2470 DAEMONCMD->autoflush(1);
2471 while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; } # Ignore any input
f41e0506
JH
2472
2473 # Interlock with daemon startup
109b7eb1
JH
2474 for (my $count = 0; ! stat("$pidfile") && $count < 30; $count++ )
2475 { select(undef, undef, undef, 0.3); }
151b83f8
PH
2476 return 3; # Don't wait
2477 }
1ca9f507
PP
2478 elsif ($cmd =~ /\s-DSERVER=wait:(\d+)\s/)
2479 {
df613eb4
HSHR
2480
2481 # The port and the $dynamic_socket was already allocated while parsing the
2482 # script file, where -DSERVER=wait:PORT_DYNAMIC was encountered.
2483
1ca9f507
PP
2484 my $listen_port = $1;
2485 if ($debug) { printf ">> wait-mode daemon: $cmd\n"; }
050514b5 2486 run_system("sudo mkdir spool/log 2>/dev/null");
1ca9f507
PP
2487 run_system("sudo chown $parm_eximuser:$parm_eximgroup spool/log");
2488
1ca9f507
PP
2489 my $pid = fork();
2490 if (not defined $pid) { die "** fork failed: $!\n" }
2491 if (not $pid) {
2492 close(STDIN);
df613eb4
HSHR
2493 open(STDIN, '<&', $dynamic_socket) or die "** dup sock to stdin failed: $!\n";
2494 close($dynamic_socket);
1ca9f507
PP
2495 print "[$$]>> ${cmd}-server\n" if ($debug);
2496 exec "exec ${cmd}-server";
df613eb4 2497 die "Can't exec ${cmd}-server: $!\n";
1ca9f507
PP
2498 }
2499 while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; } # Ignore any input
2500 select(undef, undef, undef, 0.3); # Let the daemon get going
2501 return (3, { exim_pid => $pid }); # Don't wait
2502 }
151b83f8
PH
2503 }
2504
bdf36f7c
JH
2505# The "background" command is run but not waited-for, like exim -DSERVER=server.
2506# One script line is read and fork-exec'd. The PID is stored for a later
2507# killdaemon.
2508
2509elsif (/^background$/)
2510 {
2511 my $line;
2512# $pidfile = "$parm_cwd/aux-var/server-daemon.pid";
2513
2514 $_ = <SCRIPT>; $lineno++;
2515 chomp;
de1294ea 2516 do_substitute($testno);
bdf36f7c
JH
2517 $line = $_;
2518 if ($debug) { printf ">> daemon: $line >>test-stdout 2>>test-stderr\n"; }
2519
2520 my $pid = fork();
2521 if (not defined $pid) { die "** fork failed: $!\n" }
2522 if (not $pid) {
2523 print "[$$]>> ${line}\n" if ($debug);
2524 close(STDIN);
2525 open(STDIN, "<", "test-stdout");
2526 close(STDOUT);
2527 open(STDOUT, ">>", "test-stdout");
2528 close(STDERR);
2529 open(STDERR, ">>", "test-stderr-server");
2530 exec "exec ${line}";
2531 exit(1);
2532 }
2533
2534# open(my $fh, ">", $pidfile) ||
2535# tests_exit(-1, "Failed to open $pidfile: $!");
2536# printf($fh, "%d\n", $pid);
2537# close($fh);
2538
2539 while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; } # Ignore any input
2540 select(undef, undef, undef, 0.3); # Let the daemon get going
2541 return (3, { exim_pid => $pid }); # Don't wait
2542 }
2543
2544
151b83f8
PH
2545
2546# Unknown command
2547
2548else { tests_exit(-1, "Command unrecognized in line $lineno: $_"); }
2549
2550
2551# Run the command, with stdin connected to a pipe, and write the stdin data
2552# to it, with appropriate substitutions. If a line ends with \NONL\, chop off
2553# the terminating newline (and the \NONL\). If the command contains
2554# -DSERVER=server add "-server" to the command, where it will adjoin the name
2555# for the stderr file. See comment above about the use of -DSERVER.
2556
9a8a6839 2557$stderrsuffix = ($cmd =~ /\s-DSERVER=server\s/)? "-server" : '';
151b83f8
PH
2558print ">> |${cmd}${stderrsuffix}\n" if ($debug);
2559open CMD, "|${cmd}${stderrsuffix}" || tests_exit(1, "Failed to run $cmd");
2560
2561CMD->autoflush(1);
2562while (<SCRIPT>)
2563 {
2564 $lineno++;
2565 last if /^\*{4}\s*$/;
2566 do_substitute($testno);
2567 if (/^(.*)\\NONL\\\s*$/) { print CMD $1; } else { print CMD; }
2568 }
2569
2570# For timeout tests, wait before closing the pipe; we expect a
2571# SIGPIPE error in this case.
2572
2573if ($wait_time > 0)
2574 {
2575 printf(" Test %d sleep $wait_time ", $$subtestref);
2576 while ($wait_time-- > 0)
2577 {
2578 print ".";
2579 sleep(1);
2580 }
2581 printf("\r Test %d $cr", $$subtestref);
2582 }
2583
2584$sigpipehappened = 0;
2585close CMD; # Waits for command to finish
2586return $yield; # Ran command and waited
2587}
2588
2589
2590
2591
2592###############################################################################
2593###############################################################################
2594
d63a9563 2595# Here begins the Main Program ...
151b83f8
PH
2596
2597###############################################################################
2598###############################################################################
2599
2600
2601autoflush STDOUT 1;
2602print "Exim tester $testversion\n";
2603
26ab1da3
HSHR
2604# extend the PATH with .../sbin
2605# we map all (.../bin) to (.../sbin:.../bin)
2606$ENV{PATH} = do {
2607 my %seen = map { $_, 1 } split /:/, $ENV{PATH};
25adc2a8
HSHR
2608 join ':' => map { m{(.*)/bin$}
2609 ? ( $seen{"$1/sbin"} ? () : ("$1/sbin"), $_)
2610 : ($_) }
26ab1da3
HSHR
2611 split /:/, $ENV{PATH};
2612};
151b83f8
PH
2613
2614##################################################
650ececb
PP
2615# Some tests check created file modes #
2616##################################################
2617
2618umask 022;
2619
2620
2621##################################################
151b83f8
PH
2622# Check for the "less" command #
2623##################################################
2624
d63a9563 2625$more = 'more' if system('which less >/dev/null 2>&1') != 0;
151b83f8
PH
2626
2627
2628
2629##################################################
151b83f8
PH
2630# See if an Exim binary has been given #
2631##################################################
2632
2633# If the first character of the first argument is '/', the argument is taken
1c143d9d
HSHR
2634# as the path to the binary. If the first argument does not start with a
2635# '/' but exists in the file system, it's assumed to be the Exim binary.
151b83f8 2636
151b83f8
PH
2637
2638##################################################
2639# Sort out options and which tests are to be run #
2640##################################################
2641
2642# There are a few possible options for the test script itself; after these, any
2643# options are passed on to Exim calls within the tests. Typically, this is used
2644# to turn on Exim debugging while setting up a test.
2645
4d8393c0 2646Getopt::Long::Configure qw(no_getopt_compat);
ffe0a357
HSHR
2647GetOptions(
2648 'debug' => sub { $debug = 1; $cr = "\n" },
2649 'diff' => sub { $cf = 'diff -u' },
2650 'continue' => sub { $force_continue = 1; $more = 'cat' },
2651 'update' => \$force_update,
2652 'ipv4!' => \$have_ipv4,
2653 'ipv6!' => \$have_ipv6,
2654 'keep' => \$save_output,
2655 'slow' => \$slow,
2656 'valgrind' => \$valgrind,
c9102412 2657 'range=s{2}' => \my @range_wanted,
4d8393c0 2658 'test=i@' => \my @tests_wanted,
e99725fd 2659 'flavor|flavour=s' => \$flavour,
ffe0a357
HSHR
2660 'help' => sub { pod2usage(-exit => 0) },
2661 'man' => sub {
2662 pod2usage(
2663 -exit => 0,
2664 -verbose => 2,
2665 -noperldoc => system('perldoc -V 2>/dev/null 1>&2')
2666 );
2667 },
2668) or pod2usage;
2669
2670($parm_exim, @ARGV) = Exim::Runtest::exim_binary(@ARGV);
2671print "Exim binary is `$parm_exim'\n" if defined $parm_exim;
151b83f8 2672
151b83f8 2673
4d8393c0
HSHR
2674my @wanted = sort numerically uniq
2675 @tests_wanted ? @tests_wanted : (),
2676 @range_wanted ? $range_wanted[0] .. $range_wanted[1] : (),
2677 @ARGV ? @ARGV == 1 ? $ARGV[0] :
2678 $ARGV[1] eq '+' ? $ARGV[0]..($ARGV[0] >= 9000 ? TEST_SPECIAL_TOP : TEST_TOP) :
2679 0+$ARGV[0]..0+$ARGV[1] # add 0 to cope with test numbers starting with zero
2680 : ();
2681@wanted = 1..TEST_TOP if not @wanted;
ffe0a357
HSHR
2682
2683##################################################
2684# Check for sudo access to root #
2685##################################################
2686
2687print "You need to have sudo access to root to run these tests. Checking ...\n";
2688if (system('sudo true >/dev/null') != 0)
2689 {
2690 die "** Test for sudo failed: testing abandoned.\n";
2691 }
2692else
2693 {
2694 print "Test for sudo OK\n";
2695 }
2696
2697
151b83f8
PH
2698
2699
2700##################################################
2701# Make the command's directory current #
2702##################################################
2703
2704# After doing so, we find its absolute path name.
2705
2706$cwd = $0;
2707$cwd = '.' if ($cwd !~ s|/[^/]+$||);
2708chdir($cwd) || die "** Failed to chdir to \"$cwd\": $!\n";
2709$parm_cwd = Cwd::getcwd();
2710
2711
2712##################################################
2713# Search for an Exim binary to test #
2714##################################################
2715
2716# If an Exim binary hasn't been provided, try to find one. We can handle the
2717# case where exim-testsuite is installed alongside Exim source directories. For
2718# PH's private convenience, if there's a directory just called "exim4", that
2719# takes precedence; otherwise exim-snapshot takes precedence over any numbered
2720# releases.
2721
151b83f8
PH
2722# If $parm_exim is still empty, ask the caller
2723
4d8393c0 2724if (not $parm_exim)
151b83f8
PH
2725 {
2726 print "** Did not find an Exim binary to test\n";
2727 for ($i = 0; $i < 5; $i++)
2728 {
2729 my($trybin);
2730 print "** Enter pathname for Exim binary: ";
2731 chomp($trybin = <STDIN>);
2732 if (-e $trybin)
2733 {
2734 $parm_exim = $trybin;
2735 last;
2736 }
2737 else
2738 {
2739 print "** $trybin does not exist\n";
2740 }
2741 }
9a8a6839 2742 die "** Too many tries\n" if $parm_exim eq '';
151b83f8
PH
2743 }
2744
2745
2746
2747##################################################
2748# Find what is in the binary #
2749##################################################
2750
5f122889
PP
2751# deal with TRUSTED_CONFIG_LIST restrictions
2752unlink("$parm_cwd/test-config") if -e "$parm_cwd/test-config";
72acdf0f
JH
2753open (IN, "$parm_cwd/confs/0000") ||
2754 tests_exit(-1, "Couldn't open $parm_cwd/confs/0000: $!\n");
2755open (OUT, ">test-config") ||
2756 tests_exit(-1, "Couldn't open test-config: $!\n");
2757while (<IN>) { print OUT; }
2758close(IN);
2759close(OUT);
5f122889
PP
2760
2761print("Probing with config file: $parm_cwd/test-config\n");
0e1cd284 2762
109ad60f
HSHR
2763my $eximinfo = "$parm_exim -d -C $parm_cwd/test-config -DDIR=$parm_cwd -bP exim_user exim_group";
2764chomp(my @eximinfo = `$eximinfo 2>&1`);
0e1cd284
HSHR
2765die "$0: Can't run $eximinfo\n" if $? == -1;
2766
2767warn 'Got ' . $?>>8 . " from $eximinfo\n" if $?;
109ad60f 2768foreach (@eximinfo)
151b83f8 2769 {
c039ce61
HSHR
2770 if (my ($version) = /^Exim version (\S+)/) {
2771 my $git = `git describe --dirty=-XX --match 'exim-4*'`;
2772 if (defined $git and $? == 0) {
2773 chomp $git;
2774 $version =~ s/^\d+\K\./_/;
2775 $git =~ s/^exim-//i;
2776 $git =~ s/.*-\Kg([[:xdigit:]]+(?:-XX)?)/$1/;
fefe59d9
HSHR
2777 print <<___
2778
2779*** Version mismatch
2780*** Exim binary: $version
2781*** Git : $git
2782
2783___
c039ce61
HSHR
2784 if not $version eq $git;
2785 }
2786 }
151b83f8
PH
2787 $parm_eximuser = $1 if /^exim_user = (.*)$/;
2788 $parm_eximgroup = $1 if /^exim_group = (.*)$/;
32ca7e2d 2789 $parm_trusted_config_list = $1 if /^TRUSTED_CONFIG_LIST:.*?"(.*?)"$/;
c9fb6994
HSHR
2790 ($parm_configure_owner, $parm_configure_group) = ($1, $2)
2791 if /^Configure owner:\s*(\d+):(\d+)/;
0df394b5 2792 print if /wrong owner/;
151b83f8 2793 }
151b83f8 2794
109ad60f
HSHR
2795if (not defined $parm_eximuser) {
2796 die <<XXX, map { "|$_\n" } @eximinfo;
2797Unable to extract exim_user from binary.
2798Check if Exim refused to run; if so, consider:
2799 TRUSTED_CONFIG_LIST ALT_CONFIG_PREFIX WHITELIST_D_MACROS
2800If debug permission denied, are you in the exim group?
2801Failing to get information from binary.
2802Output from $eximinfo:
2803XXX
2804
2805}
2806
2807if ($parm_eximuser =~ /^\d+$/) { $parm_exim_uid = $parm_eximuser; }
2808else { $parm_exim_uid = getpwnam($parm_eximuser); }
151b83f8
PH
2809
2810if (defined $parm_eximgroup)
2811 {
2812 if ($parm_eximgroup =~ /^\d+$/) { $parm_exim_gid = $parm_eximgroup; }
2813 else { $parm_exim_gid = getgrnam($parm_eximgroup); }
2814 }
2815
32ca7e2d
HSHR
2816# check the permissions on the TRUSTED_CONFIG_LIST
2817if (defined $parm_trusted_config_list)
2818 {
2819 die "TRUSTED_CONFIG_LIST: $parm_trusted_config_list: $!\n"
2820 if not -f $parm_trusted_config_list;
2821
2822 die "TRUSTED_CONFIG_LIST $parm_trusted_config_list must not be world writable!\n"
2823 if 02 & (stat _)[2];
2824
2825 die sprintf "TRUSTED_CONFIG_LIST: $parm_trusted_config_list %d is group writable, but not owned by group '%s' or '%s'.\n",
2826 (stat _)[1],
2827 scalar(getgrgid 0), scalar(getgrgid $>)
2828 if (020 & (stat _)[2]) and not ((stat _)[5] == $> or (stat _)[5] == 0);
2829
2830 die sprintf "TRUSTED_CONFIG_LIST: $parm_trusted_config_list is not owned by user '%s' or '%s'.\n",
2831 scalar(getpwuid 0), scalar(getpwuid $>)
2832 if (not (-o _ or (stat _)[4] == 0));
2833
2834 open(TCL, $parm_trusted_config_list) or die "Can't open $parm_trusted_config_list: $!\n";
2835 my $test_config = getcwd() . '/test-config';
2836 die "Can't find '$test_config' in TRUSTED_CONFIG_LIST $parm_trusted_config_list."
93d55ee3 2837 if not grep { /^\Q$test_config\E$/ } <TCL>;
32ca7e2d
HSHR
2838 }
2839else
2840 {
2841 die "Unable to check the TRUSTED_CONFIG_LIST, seems to be empty?\n";
2842 }
2843
c9fb6994
HSHR
2844die "CONFIGURE_OWNER ($parm_configure_owner) does not match the user invoking $0 ($>)\n"
2845 if $parm_configure_owner != $>;
2846
2847die "CONFIGURE_GROUP ($parm_configure_group) does not match the group invoking $0 ($))\n"
2848 if 0020 & (stat "$parm_cwd/test-config")[2]
2849 and $parm_configure_group != $);
2850
01c59460
JH
2851die "aux-fixed file is world-writeable; best to strip them all, recursively\n"
2852 if 0020 & (stat "aux-fixed/0037.f-1")[2];
2853
c9fb6994 2854
b6a0dbb2 2855open(EXIMINFO, "$parm_exim -d-all+transport -bV -C $parm_cwd/test-config -DDIR=$parm_cwd |") ||
151b83f8
PH
2856 die "** Cannot run $parm_exim: $!\n";
2857
2858print "-" x 78, "\n";
2859
2860while (<EXIMINFO>)
2861 {
2862 my(@temp);
2863
b6a0dbb2 2864 if (/^(Exim|Library) version/) { print; }
96508de1 2865 if (/Runtime: /) {print; }
151b83f8 2866
21c28500
PH
2867 elsif (/^Size of off_t: (\d+)/)
2868 {
e1b3d58d 2869 print;
21c28500 2870 $have_largefiles = 1 if $1 > 4;
e1b3d58d
JJ
2871 die "** Size of off_t > 32 which seems improbable, not running tests\n"
2872 if ($1 > 32);
21c28500
PH
2873 }
2874
2875 elsif (/^Support for: (.*)/)
151b83f8
PH
2876 {
2877 print;
2878 @temp = split /(\s+)/, $1;
2879 push(@temp, ' ');
2880 %parm_support = @temp;
2881 }
2882
33191679 2883 elsif (/^Lookups \(built-in\): (.*)/)
151b83f8
PH
2884 {
2885 print;
2886 @temp = split /(\s+)/, $1;
2887 push(@temp, ' ');
2888 %parm_lookups = @temp;
2889 }
2890
21c28500 2891 elsif (/^Authenticators: (.*)/)
151b83f8
PH
2892 {
2893 print;
2894 @temp = split /(\s+)/, $1;
2895 push(@temp, ' ');
2896 %parm_authenticators = @temp;
2897 }
2898
21c28500 2899 elsif (/^Routers: (.*)/)
151b83f8
PH
2900 {
2901 print;
2902 @temp = split /(\s+)/, $1;
2903 push(@temp, ' ');
2904 %parm_routers = @temp;
2905 }
2906
2907 # Some transports have options, e.g. appendfile/maildir. For those, ensure
2908 # that the basic transport name is set, and then the name with each of the
2909 # options.
2910
21c28500 2911 elsif (/^Transports: (.*)/)
151b83f8
PH
2912 {
2913 print;
2914 @temp = split /(\s+)/, $1;
2915 my($i,$k);
2916 push(@temp, ' ');
2917 %parm_transports = @temp;
2918 foreach $k (keys %parm_transports)
2919 {
2920 if ($k =~ "/")
2921 {
2922 @temp = split /\//, $k;
9a8a6839 2923 $parm_transports{$temp[0]} = " ";
151b83f8
PH
2924 for ($i = 1; $i < @temp; $i++)
2925 { $parm_transports{"$temp[0]/$temp[$i]"} = " "; }
2926 }
2927 }
2928 }
c11d665d
JH
2929
2930 elsif (/^Malware: (.*)/)
2931 {
2932 print;
2933 @temp = split /(\s+)/, $1;
2934 push(@temp, ' ');
2935 %parm_malware = @temp;
2936 }
2937
151b83f8
PH
2938 }
2939close(EXIMINFO);
2940print "-" x 78, "\n";
2941
5f122889 2942unlink("$parm_cwd/test-config");
151b83f8
PH
2943
2944##################################################
2945# Check for SpamAssassin and ClamAV #
2946##################################################
2947
2948# These are crude tests. If they aren't good enough, we'll have to improve
2949# them, for example by actually passing a message through spamc or clamscan.
2950
9a8a6839 2951if (defined $parm_support{Content_Scanning})
151b83f8 2952 {
3ff2360f
JH
2953 my $sock = new FileHandle;
2954
151b83f8
PH
2955 if (system("spamc -h 2>/dev/null >/dev/null") == 0)
2956 {
151b83f8
PH
2957 print "The spamc command works:\n";
2958
2959 # This test for an active SpamAssassin is courtesy of John Jetmore.
2960 # The tests are hard coded to localhost:783, so no point in making
2961 # this test flexible like the clamav test until the test scripts are
4c04137d 2962 # changed. spamd doesn't have the nice PING/PONG protocol that
151b83f8
PH
2963 # clamd does, but it does respond to errors in an informative manner,
2964 # so use that.
2965
2966 my($sint,$sport) = ('127.0.0.1',783);
2967 eval
2968 {
2969 my $sin = sockaddr_in($sport, inet_aton($sint))
2970 or die "** Failed packing $sint:$sport\n";
3ff2360f 2971 socket($sock, PF_INET, SOCK_STREAM, getprotobyname('tcp'))
151b83f8
PH
2972 or die "** Unable to open socket $sint:$sport\n";
2973
2974 local $SIG{ALRM} =
2975 sub { die "** Timeout while connecting to socket $sint:$sport\n"; };
2976 alarm(5);
3ff2360f 2977 connect($sock, $sin)
151b83f8
PH
2978 or die "** Unable to connect to socket $sint:$sport\n";
2979 alarm(0);
2980
3ff2360f
JH
2981 select((select($sock), $| = 1)[0]);
2982 print $sock "bad command\r\n";
151b83f8
PH
2983
2984 $SIG{ALRM} =
2985 sub { die "** Timeout while reading from socket $sint:$sport\n"; };
2986 alarm(10);
3ff2360f 2987 my $res = <$sock>;
151b83f8
PH
2988 alarm(0);
2989
2990 $res =~ m|^SPAMD/|
2991 or die "** Did not get SPAMD from socket $sint:$sport. "
2992 ."It said: $res\n";
2993 };
2994 alarm(0);
2995 if($@)
2996 {
2997 print " $@";
2998 print " Assume SpamAssassin (spamd) is not running\n";
2999 }
3000 else
3001 {
9a8a6839 3002 $parm_running{SpamAssassin} = ' ';
151b83f8
PH
3003 print " SpamAssassin (spamd) seems to be running\n";
3004 }
3005 }
3006 else
3007 {
3008 print "The spamc command failed: assume SpamAssassin (spamd) is not running\n";
3009 }
3010
3011 # For ClamAV, we need to find the clamd socket for use in the Exim
3012 # configuration. Search for the clamd configuration file.
3013
3014 if (system("clamscan -h 2>/dev/null >/dev/null") == 0)
3015 {
3016 my($f, $clamconf, $test_prefix);
3017
3018 print "The clamscan command works";
3019
3020 $test_prefix = $ENV{EXIM_TEST_PREFIX};
9a8a6839 3021 $test_prefix = '' if !defined $test_prefix;
151b83f8
PH
3022
3023 foreach $f ("$test_prefix/etc/clamd.conf",
3024 "$test_prefix/usr/local/etc/clamd.conf",
9a8a6839 3025 "$test_prefix/etc/clamav/clamd.conf", '')
151b83f8
PH
3026 {
3027 if (-e $f)
3028 {
3029 $clamconf = $f;
3030 last;
3031 }
3032 }
3033
11b3bc4d
PH
3034 # Read the ClamAV configuration file and find the socket interface.
3035
9a8a6839 3036 if ($clamconf ne '')
151b83f8 3037 {
11b3bc4d 3038 my $socket_domain;
151b83f8
PH
3039 open(IN, "$clamconf") || die "\n** Unable to open $clamconf: $!\n";
3040 while (<IN>)
3041 {
3042 if (/^LocalSocket\s+(.*)/)
3043 {
3044 $parm_clamsocket = $1;
11b3bc4d 3045 $socket_domain = AF_UNIX;
151b83f8
PH
3046 last;
3047 }
11b3bc4d
PH
3048 if (/^TCPSocket\s+(\d+)/)
3049 {
3050 if (defined $parm_clamsocket)
3051 {
3052 $parm_clamsocket .= " $1";
3053 $socket_domain = AF_INET;
3054 last;
3055 }
3056 else
3057 {
3058 $parm_clamsocket = " $1";
3059 }
3060 }
3061 elsif (/^TCPAddr\s+(\S+)/)
3062 {
3063 if (defined $parm_clamsocket)
3064 {
3065 $parm_clamsocket = $1 . $parm_clamsocket;
3066 $socket_domain = AF_INET;
3067 last;
3068 }
3069 else
3070 {
3071 $parm_clamsocket = $1;
3072 }
3073 }
151b83f8
PH
3074 }
3075 close(IN);
11b3bc4d
PH
3076
3077 if (defined $socket_domain)
151b83f8
PH
3078 {
3079 print ":\n The clamd socket is $parm_clamsocket\n";
3080 # This test for an active ClamAV is courtesy of Daniel Tiefnig.
3081 eval
3082 {
11b3bc4d
PH
3083 my $socket;
3084 if ($socket_domain == AF_UNIX)
3085 {
3086 $socket = sockaddr_un($parm_clamsocket) or die "** Failed packing '$parm_clamsocket'\n";
3087 }
3088 elsif ($socket_domain == AF_INET)
3089 {
3090 my ($ca_host, $ca_port) = split(/\s+/,$parm_clamsocket);
3091 my $ca_hostent = gethostbyname($ca_host) or die "** Failed to get raw address for host '$ca_host'\n";
3092 $socket = sockaddr_in($ca_port, $ca_hostent) or die "** Failed packing '$parm_clamsocket'\n";
3093 }
3094 else
3095 {
3096 die "** Unknown socket domain '$socket_domain' (should not happen)\n";
3097 }
3ff2360f 3098 socket($sock, $socket_domain, SOCK_STREAM, 0) or die "** Unable to open socket '$parm_clamsocket'\n";
151b83f8
PH
3099 local $SIG{ALRM} = sub { die "** Timeout while connecting to socket '$parm_clamsocket'\n"; };
3100 alarm(5);
3ff2360f 3101 connect($sock, $socket) or die "** Unable to connect to socket '$parm_clamsocket'\n";
151b83f8
PH
3102 alarm(0);
3103
3ff2360f
JH
3104 my $ofh = select $sock; $| = 1; select $ofh;
3105 print $sock "PING\n";
151b83f8
PH
3106
3107 $SIG{ALRM} = sub { die "** Timeout while reading from socket '$parm_clamsocket'\n"; };
3108 alarm(10);
3ff2360f 3109 my $res = <$sock>;
151b83f8
PH
3110 alarm(0);
3111
3112 $res =~ /PONG/ or die "** Did not get PONG from socket '$parm_clamsocket'. It said: $res\n";
3113 };
3114 alarm(0);
3115
3116 if($@)
3117 {
520de300 3118 print " $@";
151b83f8
PH
3119 print " Assume ClamAV is not running\n";
3120 }
3121 else
3122 {
9a8a6839 3123 $parm_running{ClamAV} = ' ';
151b83f8
PH
3124 print " ClamAV seems to be running\n";
3125 }
3126 }
3127 else
3128 {
11b3bc4d 3129 print ", but the socket for clamd could not be determined\n";
151b83f8
PH
3130 print "Assume ClamAV is not running\n";
3131 }
3132 }
3133
3134 else
3135 {
3136 print ", but I can't find a configuration for clamd\n";
3137 print "Assume ClamAV is not running\n";
3138 }
3139 }
3140 }
3141
3142
3143##################################################
bdf36f7c
JH
3144# Check for redis #
3145##################################################
9a8a6839 3146if (defined $parm_lookups{redis})
bdf36f7c
JH
3147 {
3148 if (system("redis-server -v 2>/dev/null >/dev/null") == 0)
3149 {
3150 print "The redis-server command works\n";
9a8a6839 3151 $parm_running{redis} = ' ';
bdf36f7c
JH
3152 }
3153 else
3154 {
3155 print "The redis-server command failed: assume Redis not installed\n";
3156 }
3157 }
3158
3159##################################################
151b83f8
PH
3160# Test for the basic requirements #
3161##################################################
3162
3163# This test suite assumes that Exim has been built with at least the "usual"
3164# set of routers, transports, and lookups. Ensure that this is so.
3165
9a8a6839 3166$missing = '';
151b83f8 3167
9a8a6839 3168$missing .= " Lookup: lsearch\n" if (!defined $parm_lookups{lsearch});
151b83f8 3169
9a8a6839
HSHR
3170$missing .= " Router: accept\n" if (!defined $parm_routers{accept});
3171$missing .= " Router: dnslookup\n" if (!defined $parm_routers{dnslookup});
3172$missing .= " Router: manualroute\n" if (!defined $parm_routers{manualroute});
3173$missing .= " Router: redirect\n" if (!defined $parm_routers{redirect});
151b83f8 3174
9a8a6839
HSHR
3175$missing .= " Transport: appendfile\n" if (!defined $parm_transports{appendfile});
3176$missing .= " Transport: autoreply\n" if (!defined $parm_transports{autoreply});
3177$missing .= " Transport: pipe\n" if (!defined $parm_transports{pipe});
3178$missing .= " Transport: smtp\n" if (!defined $parm_transports{smtp});
151b83f8 3179
9a8a6839 3180if ($missing ne '')
151b83f8
PH
3181 {
3182 print "\n";
3183 print "** Many features can be included or excluded from Exim binaries.\n";
3184 print "** This test suite requires that Exim is built to contain a certain\n";
3185 print "** set of basic facilities. It seems that some of these are missing\n";
3186 print "** from the binary that is under test, so the test cannot proceed.\n";
3187 print "** The missing facilities are:\n";
3188 print "$missing";
3189 die "** Test script abandoned\n";
3190 }
3191
3192
3193##################################################
3194# Check for the auxiliary programs #
3195##################################################
3196
3197# These are always required:
3198
3199for $prog ("cf", "checkaccess", "client", "client-ssl", "client-gnutls",
3200 "fakens", "iefbr14", "server")
3201 {
9a8a6839
HSHR
3202 next if ($prog eq "client-ssl" && !defined $parm_support{OpenSSL});
3203 next if ($prog eq "client-gnutls" && !defined $parm_support{GnuTLS});
151b83f8
PH
3204 if (!-e "bin/$prog")
3205 {
3206 print "\n";
3207 print "** bin/$prog does not exist. Have you run ./configure and make?\n";
3208 die "** Test script abandoned\n";
3209 }
3210 }
3211
3212# If the "loaded" binary is missing, we cut out tests for ${dlfunc. It isn't
3213# compiled on systems where we don't know how to. However, if Exim does not
3214# have that functionality compiled, we needn't bother.
3215
3216$dlfunc_deleted = 0;
9a8a6839 3217if (defined $parm_support{Expand_dlfunc} && !-e 'bin/loaded')
151b83f8 3218 {
9a8a6839 3219 delete $parm_support{Expand_dlfunc};
151b83f8
PH
3220 $dlfunc_deleted = 1;
3221 }
3222
3223
3224##################################################
3225# Find environmental details #
3226##################################################
3227
3228# Find the caller of this program.
3229
3230($parm_caller,$pwpw,$parm_caller_uid,$parm_caller_gid,$pwquota,$pwcomm,
eeeda78a 3231 $parm_caller_gecos, $parm_caller_home) = getpwuid($>);
151b83f8
PH
3232
3233$pwpw = $pwpw; # Kill Perl warnings
3234$pwquota = $pwquota;
3235$pwcomm = $pwcomm;
151b83f8
PH
3236
3237$parm_caller_group = getgrgid($parm_caller_gid);
3238
42ec9880 3239print "Program caller is $parm_caller ($parm_caller_uid), whose group is $parm_caller_group ($parm_caller_gid)\n";
151b83f8
PH
3240print "Home directory is $parm_caller_home\n";
3241
5f122889
PP
3242unless (defined $parm_eximgroup)
3243 {
3244 print "Unable to derive \$parm_eximgroup.\n";
3245 die "** ABANDONING.\n";
01c59460
JH
3246 }
3247
3248if ($parm_caller_home eq $parm_cwd)
3249 {
3250 print "will confuse working dir with homedir; change homedir\n";
3251 die "** ABANDONING.\n";
5f122889
PP
3252 }
3253
151b83f8
PH
3254print "You need to be in the Exim group to run these tests. Checking ...";
3255
3256if (`groups` =~ /\b\Q$parm_eximgroup\E\b/)
3257 {
3258 print " OK\n";
3259 }
3260else
3261 {
3262 print "\nOh dear, you are not in the Exim group.\n";
3263 die "** Testing abandoned.\n";
3264 }
3265
3266# Find this host's IP addresses - there may be many, of course, but we keep
3267# one of each type (IPv4 and IPv6).
3268
bb660b56
HSHR
3269open(IFCONFIG, '-|', (grep { -x "$_/ip" } split /:/, $ENV{PATH}) ? 'ip address' : 'ifconfig -a')
3270 or die "** Cannot run 'ip address' or 'ifconfig -a'\n";
d63a9563 3271while (not ($parm_ipv4 and $parm_ipv6) and defined($_ = <IFCONFIG>))
151b83f8 3272 {
8bcf5607 3273 if (not $parm_ipv4 and /^\s*inet(?:\saddr)?:?\s?(\d+\.\d+\.\d+\.\d+)(?:\/\d+)?\s/i)
151b83f8 3274 {
d63a9563
HSHR
3275 next if $1 =~ /^(?:127|10)\./;
3276 $parm_ipv4 = $1;
151b83f8
PH
3277 }
3278
d63a9563 3279 if (not $parm_ipv6 and /^\s*inet6(?:\saddr)?:?\s?([abcdef\d:]+)(?:\/\d+)/i)
151b83f8 3280 {
d63a9563
HSHR
3281 next if $1 eq '::1' or $1 =~ /^fe80/i;
3282 $parm_ipv6 = $1;
151b83f8
PH
3283 }
3284 }
3285close(IFCONFIG);
3286
3287# Use private IP addresses if there are no public ones.
3288
151b83f8
PH
3289# If either type of IP address is missing, we need to set the value to
3290# something other than empty, because that wrecks the substitutions. The value
3291# is reflected, so use a meaningful string. Set appropriate options for the
3292# "server" command. In practice, however, many tests assume 127.0.0.1 is
3293# available, so things will go wrong if there is no IPv4 address. The lack
3294# of IPV4 or IPv6 can be simulated by command options, which force $have_ipv4
3295# and $have_ipv6 false.
3296
d63a9563 3297if (not $parm_ipv4)
151b83f8
PH
3298 {
3299 $have_ipv4 = 0;
3300 $parm_ipv4 = "<no IPv4 address found>";
3301 $server_opts .= " -noipv4";
3302 }
3303elsif ($have_ipv4 == 0)
3304 {
3305 $parm_ipv4 = "<IPv4 testing disabled>";
3306 $server_opts .= " -noipv4";
3307 }
3308else
3309 {
9a8a6839 3310 $parm_running{IPv4} = " ";
151b83f8
PH
3311 }
3312
d63a9563 3313if (not $parm_ipv6)
151b83f8
PH
3314 {
3315 $have_ipv6 = 0;
3316 $parm_ipv6 = "<no IPv6 address found>";
3317 $server_opts .= " -noipv6";
9a8a6839 3318 delete($parm_support{IPv6});
151b83f8
PH
3319 }
3320elsif ($have_ipv6 == 0)
3321 {
3322 $parm_ipv6 = "<IPv6 testing disabled>";
3323 $server_opts .= " -noipv6";
9a8a6839 3324 delete($parm_support{IPv6});
151b83f8 3325 }
9a8a6839 3326elsif (!defined $parm_support{IPv6})
151b83f8
PH
3327 {
3328 $have_ipv6 = 0;
3329 $parm_ipv6 = "<no IPv6 support in Exim binary>";
3330 $server_opts .= " -noipv6";
3331 }
3332else
3333 {
9a8a6839 3334 $parm_running{IPv6} = " ";
151b83f8
PH
3335 }
3336
3337print "IPv4 address is $parm_ipv4\n";
3338print "IPv6 address is $parm_ipv6\n";
3339
75758eeb
PH
3340# For munging test output, we need the reversed IP addresses.
3341
9a8a6839 3342$parm_ipv4r = ($parm_ipv4 !~ /^\d/)? '' :
75758eeb
PH
3343 join(".", reverse(split /\./, $parm_ipv4));
3344
1b781f48 3345$parm_ipv6r = $parm_ipv6; # Appropriate if not in use
75758eeb
PH
3346if ($parm_ipv6 =~ /^[\da-f]/)
3347 {
3348 my(@comps) = split /:/, $parm_ipv6;
3349 my(@nibbles);
3350 foreach $comp (@comps)
3351 {
3352 push @nibbles, sprintf("%lx", hex($comp) >> 8);
3353 push @nibbles, sprintf("%lx", hex($comp) & 0xff);
3354 }
3355 $parm_ipv6r = join(".", reverse(@nibbles));
3356 }
3357
151b83f8
PH
3358# Find the host name, fully qualified.
3359
3360chomp($temp = `hostname`);
d36e39d7 3361die "'hostname' didn't return anything\n" unless defined $temp and length $temp;
32c5107f
JH
3362if ($temp =~ /\./)
3363 {
3364 $parm_hostname = $temp;
3365 }
3366else
3367 {
3368 $parm_hostname = (gethostbyname($temp))[0];
3369 $parm_hostname = "no.host.name.found" unless defined $parm_hostname and length $parm_hostname;
3370 }
151b83f8
PH
3371print "Hostname is $parm_hostname\n";
3372
3373if ($parm_hostname !~ /\./)
3374 {
3375 print "\n*** Host name is not fully qualified: this may cause problems ***\n\n";
3376 }
3377
05e0ef26
TL
3378if ($parm_hostname =~ /[[:upper:]]/)
3379 {
3380 print "\n*** Host name has upper case characters: this may cause problems ***\n\n";
3381 }
3382
151b83f8
PH
3383
3384
3385##################################################
3386# Create a testing version of Exim #
3387##################################################
3388
3389# We want to be able to run Exim with a variety of configurations. Normally,
3390# the use of -C to change configuration causes Exim to give up its root
3391# privilege (unless the caller is exim or root). For these tests, we do not
3392# want this to happen. Also, we want Exim to know that it is running in its
3393# test harness.
3394
3395# We achieve this by copying the binary and patching it as we go. The new
3396# binary knows it is a testing copy, and it allows -C and -D without loss of
3397# privilege. Clearly, this file is dangerous to have lying around on systems
3398# where there are general users with login accounts. To protect against this,
3399# we put the new binary in a special directory that is accessible only to the
3400# caller of this script, who is known to have sudo root privilege from the test
3401# that was done above. Furthermore, we ensure that the binary is deleted at the
3402# end of the test. First ensure the directory exists.
3403
050514b5
JH
3404if (-d "eximdir")
3405 { unlink "eximdir/exim"; } # Just in case
3406else
3407 {
3408 mkdir("eximdir", 0710) || die "** Unable to mkdir $parm_cwd/eximdir: $!\n";
3409 system("sudo chgrp $parm_eximgroup eximdir");
3410 }
151b83f8
PH
3411
3412# The construction of the patched binary must be done as root, so we use
3413# a separate script. As well as indicating that this is a test-harness binary,
3414# the version number is patched to "x.yz" so that its length is always the
3415# same. Otherwise, when it appears in Received: headers, it affects the length
3416# of the message, which breaks certain comparisons.
3417
3418die "** Unable to make patched exim: $!\n"
3419 if (system("sudo ./patchexim $parm_exim") != 0);
3420
3421# From this point on, exits from the program must go via the subroutine
3422# tests_exit(), so that suitable cleaning up can be done when required.
3423# Arrange to catch interrupting signals, to assist with this.
3424
9a8a6839
HSHR
3425$SIG{INT} = \&inthandler;
3426$SIG{PIPE} = \&pipehandler;
151b83f8
PH
3427
3428# For some tests, we need another copy of the binary that is setuid exim rather
3429# than root.
3430
050514b5 3431system("sudo cp eximdir/exim eximdir/exim_exim;" .
151b83f8
PH
3432 "sudo chown $parm_eximuser eximdir/exim_exim;" .
3433 "sudo chgrp $parm_eximgroup eximdir/exim_exim;" .
050514b5 3434 "sudo chmod 06755 eximdir/exim_exim");
151b83f8 3435
151b83f8
PH
3436##################################################
3437# Make copies of utilities we might need #
3438##################################################
3439
3440# Certain of the tests make use of some of Exim's utilities. We do not need
3441# to be root to copy these.
3442
1ca9f507 3443($parm_exim_dir) = $parm_exim =~ m?^(.*)/exim?;
151b83f8
PH
3444
3445$dbm_build_deleted = 0;
9a8a6839 3446if (defined $parm_lookups{dbm} &&
151b83f8
PH
3447 system("cp $parm_exim_dir/exim_dbmbuild eximdir") != 0)
3448 {
9a8a6839 3449 delete $parm_lookups{dbm};
151b83f8
PH
3450 $dbm_build_deleted = 1;
3451 }
3452
3453if (system("cp $parm_exim_dir/exim_dumpdb eximdir") != 0)
3454 {
3455 tests_exit(-1, "Failed to make a copy of exim_dumpdb: $!");
3456 }
3457
3458if (system("cp $parm_exim_dir/exim_lock eximdir") != 0)
3459 {
3460 tests_exit(-1, "Failed to make a copy of exim_lock: $!");
3461 }
3462
3463if (system("cp $parm_exim_dir/exinext eximdir") != 0)
3464 {
3465 tests_exit(-1, "Failed to make a copy of exinext: $!");
3466 }
3467
f3f065bb
PH
3468if (system("cp $parm_exim_dir/exigrep eximdir") != 0)
3469 {
3470 tests_exit(-1, "Failed to make a copy of exigrep: $!");
3471 }
3472
3473if (system("cp $parm_exim_dir/eximstats eximdir") != 0)
3474 {
3475 tests_exit(-1, "Failed to make a copy of eximstats: $!");
3476 }
3477
fd1e42c5
HSHR
3478# Collect some version information
3479print '-' x 78, "\n";
02721dcd 3480print "Perl version for runtest: $]\n";
fd1e42c5
HSHR
3481foreach (map { "./eximdir/$_" } qw(exigrep exinext eximstats)) {
3482 # fold (or unfold?) multiline output into a one-liner
3483 print join(', ', map { chomp; $_ } `$_ --version`), "\n";
3484}
3485print '-' x 78, "\n";
3486
151b83f8
PH
3487
3488##################################################
3489# Check that the Exim user can access stuff #
3490##################################################
3491
3492# We delay this test till here so that we can check access to the actual test
3493# binary. This will be needed when Exim re-exec's itself to do deliveries.
3494
3495print "Exim user is $parm_eximuser ($parm_exim_uid)\n";
3496print "Exim group is $parm_eximgroup ($parm_exim_gid)\n";
a56f166d
JJ
3497
3498if ($parm_caller_uid eq $parm_exim_uid) {
3499 tests_exit(-1, "Exim user ($parm_eximuser,$parm_exim_uid) cannot be "
3500 ."the same as caller ($parm_caller,$parm_caller_uid)");
3501}
b43517ed
JH
3502if ($parm_caller_gid eq $parm_exim_gid) {
3503 tests_exit(-1, "Exim group ($parm_eximgroup,$parm_exim_gid) cannot be "
3504 ."the same as caller's ($parm_caller) group as it confuses "
3505 ."results analysis");
3506}
a56f166d 3507
151b83f8
PH
3508print "The Exim user needs access to the test suite directory. Checking ...";
3509
3510if (($rc = system("sudo bin/checkaccess $parm_cwd/eximdir/exim $parm_eximuser $parm_eximgroup")) != 0)
3511 {
3512 my($why) = "unknown failure $rc";
3513 $rc >>= 8;
3514 $why = "Couldn't find user \"$parm_eximuser\"" if $rc == 1;
3515 $why = "Couldn't find group \"$parm_eximgroup\"" if $rc == 2;
3516 $why = "Couldn't read auxiliary group list" if $rc == 3;
3517 $why = "Couldn't get rid of auxiliary groups" if $rc == 4;
3518 $why = "Couldn't set gid" if $rc == 5;
3519 $why = "Couldn't set uid" if $rc == 6;
3520 $why = "Couldn't open \"$parm_cwd/eximdir/exim\"" if $rc == 7;
3521 print "\n** $why\n";
3522 tests_exit(-1, "$parm_eximuser cannot access the test suite directory");
3523 }
3524else
3525 {
3526 print " OK\n";
3527 }
3528
9b25e4a9
HSHR
3529tests_exit(-1, "Failed to unlink $log_summary_filename: $!")
3530 if not unlink($log_summary_filename) and -e $log_summary_filename;
151b83f8
PH
3531
3532##################################################
3533# Create a list of available tests #
3534##################################################
3535
3536# The scripts directory contains a number of subdirectories whose names are
3537# of the form 0000-xxxx, 1100-xxxx, 2000-xxxx, etc. Each set of tests apart
3538# from the first requires certain optional features to be included in the Exim
3539# binary. These requirements are contained in a file called "REQUIRES" within
3540# the directory. We scan all these tests, discarding those that cannot be run
3541# because the current binary does not support the right facilities, and also
3542# those that are outside the numerical range selected.
3543
4d8393c0
HSHR
3544printf "\nWill run %d tests between %d and %d for flavour %s\n",
3545 scalar(@wanted), $wanted[0], $wanted[-1], $flavour;
3546
151b83f8
PH
3547print "Omitting \${dlfunc expansion tests (loadable module not present)\n"
3548 if $dlfunc_deleted;
3549print "Omitting dbm tests (unable to copy exim_dbmbuild)\n"
3550 if $dbm_build_deleted;
3551
9e146c9f 3552
9b25e4a9
HSHR
3553my @test_dirs = grep { not /^CVS$/ } map { basename $_ } glob 'scripts/*'
3554 or die tests_exit(-1, "Failed to find test scripts in 'scripts/*`: $!");
9e146c9f
PH
3555
3556# Scan for relevant tests
4d8393c0
HSHR
3557# HS12: Needs to be reworked.
3558DIR: for (my $i = 0; $i < @test_dirs; $i++)
151b83f8
PH
3559 {
3560 my($testdir) = $test_dirs[$i];
3561 my($wantthis) = 1;
3562
151b83f8
PH
3563 print ">>Checking $testdir\n" if $debug;
3564
3565 # Skip this directory if the first test is equal or greater than the first
3566 # test in the next directory.
3567
9b25e4a9 3568 next DIR if ($i < @test_dirs - 1) &&
4d8393c0 3569 ($wanted[0] >= substr($test_dirs[$i+1], 0, 4));
151b83f8
PH
3570
3571 # No need to carry on if the end test is less than the first test in this
3572 # subdirectory.
3573
4d8393c0 3574 last DIR if $wanted[-1] < substr($testdir, 0, 4);
151b83f8
PH
3575
3576 # Check requirements, if any.
3577
9b25e4a9 3578 if (open(my $requires, "scripts/$testdir/REQUIRES"))
151b83f8 3579 {
9b25e4a9 3580 while (<$requires>)
151b83f8
PH
3581 {
3582 next if /^\s*$/;
3583 s/\s+$//;
3584 if (/^support (.*)$/)
3585 {
3586 if (!defined $parm_support{$1}) { $wantthis = 0; last; }
3587 }
3588 elsif (/^running (.*)$/)
3589 {
3590 if (!defined $parm_running{$1}) { $wantthis = 0; last; }
3591 }
3592 elsif (/^lookup (.*)$/)
3593 {
3594 if (!defined $parm_lookups{$1}) { $wantthis = 0; last; }
3595 }
3596 elsif (/^authenticators? (.*)$/)
3597 {
3598 if (!defined $parm_authenticators{$1}) { $wantthis = 0; last; }
3599 }
3600 elsif (/^router (.*)$/)
3601 {
3602 if (!defined $parm_routers{$1}) { $wantthis = 0; last; }
3603 }
3604 elsif (/^transport (.*)$/)
3605 {
3606 if (!defined $parm_transports{$1}) { $wantthis = 0; last; }
3607 }
c11d665d
JH
3608 elsif (/^malware (.*)$/)
3609 {
3610 if (!defined $parm_malware{$1}) { $wantthis = 0; last; }
3611 }
4e6ad671
JH
3612 elsif (/^feature (.*)$/)
3613 {
3614 # move to a subroutine?
3615 my $eximinfo = "$parm_exim -C $parm_cwd/test-config -DDIR=$parm_cwd -bP macro $1";
3616
3617 open (IN, "$parm_cwd/confs/0000") ||
3618 tests_exit(-1, "Couldn't open $parm_cwd/confs/0000: $!\n");
3619 open (OUT, ">test-config") ||
3620 tests_exit(-1, "Couldn't open test-config: $!\n");
3621 while (<IN>)
3622 {
3623 do_substitute($testno);
3624 print OUT;
3625 }
3626 close(IN);
3627 close(OUT);
3628
3629 system($eximinfo . " >/dev/null 2>&1");
3630 if ($? != 0) {
3631 unlink("$parm_cwd/test-config");
3632 $wantthis = 0;
3633 $_ = "feature $1";
3634 last;
3635 }
3636 unlink("$parm_cwd/test-config");
3637 }
151b83f8
PH
3638 else
3639 {
3640 tests_exit(-1, "Unknown line in \"scripts/$testdir/REQUIRES\": \"$_\"");
3641 }
3642 }
151b83f8
PH
3643 }
3644 else
3645 {
3646 tests_exit(-1, "Failed to open \"scripts/$testdir/REQUIRES\": $!")
3647 unless $!{ENOENT};
3648 }
3649
3650 # Loop if we do not want the tests in this subdirectory.
3651
3652 if (!$wantthis)
3653 {
3654 chomp;
3655 print "Omitting tests in $testdir (missing $_)\n";
151b83f8
PH
3656 }
3657
3658 # We want the tests from this subdirectory, provided they are in the
3659 # range that was selected.
3660
4d8393c0 3661 @testlist = grep { $_ ~~ @wanted } grep { /^\d+(?:\.\d+)?$/ } map { basename $_ } glob "scripts/$testdir/*";
9b25e4a9
HSHR
3662 tests_exit(-1, "Failed to read test scripts from `scripts/$testdir/*': $!")
3663 if not @testlist;
151b83f8
PH
3664
3665 foreach $test (@testlist)
3666 {
4d8393c0 3667 if (!$wantthis)
a4ecb6a7
JH
3668 {
3669 log_test($log_summary_filename, $test, '.');
3670 }
3671 else
3672