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