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