3 ###############################################################################
4 # This is the controlling script for the "new" test suite for Exim. It should #
5 # be possible to export this suite for running on a wide variety of hosts, in #
6 # contrast to the old suite, which was very dependent on the environment of #
7 # Philip Hazel's desktop computer. This implementation inspects the version #
8 # of Exim that it finds, and tests only those features that are included. The #
9 # surrounding environment is also tested to discover what is available. See #
10 # the README file for details of how it all works. #
12 # Implementation started: 03 August 2005 by Philip Hazel #
13 # Placed in the Exim CVS: 06 February 2006 #
14 ###############################################################################
25 # Start by initializing some global variables
27 $testversion = "4.80 (08-May-12)";
29 # This gets embedded in the D-H params filename, and the value comes
30 # from asking GnuTLS for "normal", but there appears to be no way to
31 # use certtool/... to ask what that value currently is. *sigh*
32 # We also clamp it because of NSS interop, see addition of tls_dh_max_bits.
33 # This value is correct as of GnuTLS 2.12.18 as clamped by tls_dh_max_bits.
34 # normal = 2432 tls_dh_max_bits = 2236
35 $gnutls_dh_bits_normal = 2236;
37 $cf = "bin/cf -exact";
42 $log_failed_filename = "failed-summary.log";
54 $test_end = $test_top = 8999;
55 $test_special_top = 9999;
60 # Networks to use for DNS tests. We need to choose some networks that will
61 # never be used so that there is no chance that the host on which we are
62 # running is actually in one of the test networks. Private networks such as
63 # the IPv4 10.0.0.0/8 network are no good because hosts may well use them.
64 # Rather than use some unassigned numbers (that might become assigned later),
65 # I have chosen some multicast networks, in the belief that such addresses
66 # won't ever be assigned to hosts. This is the only place where these numbers
67 # are defined, so it is trivially possible to change them should that ever
70 $parm_ipv4_test_net = "224";
71 $parm_ipv6_test_net = "ff00";
73 # Port numbers are currently hard-wired
75 $parm_port_n = 1223; # Nothing listening on this port
76 $parm_port_s = 1224; # Used for the "server" command
77 $parm_port_d = 1225; # Used for the Exim daemon
78 $parm_port_d2 = 1226; # Additional for daemon
79 $parm_port_d3 = 1227; # Additional for daemon
80 $parm_port_d4 = 1228; # Additional for daemon
87 ###############################################################################
88 ###############################################################################
90 # Define a number of subroutines
92 ###############################################################################
93 ###############################################################################
96 ##################################################
98 ##################################################
100 sub pipehandler { $sigpipehappened = 1; }
102 sub inthandler { print "\n"; tests_exit(-1, "Caught SIGINT"); }
105 ##################################################
106 # Do global macro substitutions #
107 ##################################################
109 # This function is applied to configurations, command lines and data lines in
110 # scripts, and to lines in the files of the aux-var-src and the dnszones-src
111 # directory. It takes one argument: the current test number, or zero when
112 # setting up files before running any tests.
115 s?\bCALLER\b?$parm_caller?g;
116 s?\bCALLERGROUP\b?$parm_caller_group?g;
117 s?\bCALLER_UID\b?$parm_caller_uid?g;
118 s?\bCALLER_GID\b?$parm_caller_gid?g;
119 s?\bCLAMSOCKET\b?$parm_clamsocket?g;
120 s?\bDIR/?$parm_cwd/?g;
121 s?\bEXIMGROUP\b?$parm_eximgroup?g;
122 s?\bEXIMUSER\b?$parm_eximuser?g;
123 s?\bHOSTIPV4\b?$parm_ipv4?g;
124 s?\bHOSTIPV6\b?$parm_ipv6?g;
125 s?\bHOSTNAME\b?$parm_hostname?g;
126 s?\bPORT_D\b?$parm_port_d?g;
127 s?\bPORT_D2\b?$parm_port_d2?g;
128 s?\bPORT_D3\b?$parm_port_d3?g;
129 s?\bPORT_D4\b?$parm_port_d4?g;
130 s?\bPORT_N\b?$parm_port_n?g;
131 s?\bPORT_S\b?$parm_port_s?g;
132 s?\bTESTNUM\b?$_[0]?g;
133 s?(\b|_)V4NET([\._])?$1$parm_ipv4_test_net$2?g;
134 s?\bV6NET:?$parm_ipv6_test_net:?g;
138 ##################################################
139 # Any state to be preserved across tests #
140 ##################################################
145 ##################################################
146 # Subroutine to tidy up and exit #
147 ##################################################
149 # In all cases, we check for any Exim daemons that have been left running, and
150 # kill them. Then remove all the spool data, test output, and the modified Exim
151 # binary if we are ending normally.
154 # $_[0] = 0 for a normal exit; full cleanup done
155 # $_[0] > 0 for an error exit; no files cleaned up
156 # $_[0] < 0 for a "die" exit; $_[1] contains a message
162 # Search for daemon pid files and kill the daemons. We kill with SIGINT rather
163 # than SIGTERM to stop it outputting "Terminated" to the terminal when not in
166 if (exists $TEST_STATE->{exim_pid})
168 $pid = $TEST_STATE->{exim_pid};
169 print "Tidyup: killing wait-mode daemon pid=$pid\n";
170 system("sudo kill -INT $pid");
173 if (opendir(DIR, "spool"))
175 my(@spools) = sort readdir(DIR);
177 foreach $spool (@spools)
179 next if $spool !~ /^exim-daemon./;
180 open(PID, "spool/$spool") || die "** Failed to open \"spool/$spool\": $!\n";
183 print "Tidyup: killing daemon pid=$pid\n";
184 system("sudo rm -f spool/$spool; sudo kill -INT $pid");
188 { die "** Failed to opendir(\"spool\"): $!\n" unless $!{ENOENT}; }
190 # Close the terminal input and remove the test files if all went well, unless
191 # the option to save them is set. Always remove the patched Exim binary. Then
192 # exit normally, or die.
195 system("sudo /bin/rm -rf ./spool test-* ./dnszones/*")
196 if ($rc == 0 && !$save_output);
198 system("sudo /bin/rm -rf ./eximdir/*")
201 print "\nYou were in test $test at the end there.\n\n" if defined $test;
202 exit $rc if ($rc >= 0);
203 die "** runtest error: $_[1]\n";
208 ##################################################
209 # Subroutines used by the munging subroutine #
210 ##################################################
212 # This function is used for things like message ids, where we want to generate
213 # more than one value, but keep a consistent mapping throughout.
216 # $oldid the value from the file
217 # $base a base string into which we insert a sequence
218 # $sequence the address of the current sequence counter
221 my($oldid, $base, $sequence) = @_;
222 my($newid) = $cache{$oldid};
223 if (! defined $newid)
225 $newid = sprintf($base, $$sequence++);
226 $cache{$oldid} = $newid;
232 # This is used while munging the output from exim_dumpdb.
233 # May go wrong across DST changes.
236 my($day,$month,$year,$hour,$min,$sec) =
237 $_[0] =~ /^(\d\d)-(\w\w\w)-(\d{4})\s(\d\d):(\d\d):(\d\d)/;
239 if ($month =~ /Jan/) {$mon = 0;}
240 elsif($month =~ /Feb/) {$mon = 1;}
241 elsif($month =~ /Mar/) {$mon = 2;}
242 elsif($month =~ /Apr/) {$mon = 3;}
243 elsif($month =~ /May/) {$mon = 4;}
244 elsif($month =~ /Jun/) {$mon = 5;}
245 elsif($month =~ /Jul/) {$mon = 6;}
246 elsif($month =~ /Aug/) {$mon = 7;}
247 elsif($month =~ /Sep/) {$mon = 8;}
248 elsif($month =~ /Oct/) {$mon = 9;}
249 elsif($month =~ /Nov/) {$mon = 10;}
250 elsif($month =~ /Dec/) {$mon = 11;}
251 return timelocal($sec,$min,$hour,$day,$mon,$year);
255 # This is a subroutine to sort maildir files into time-order. The second field
256 # is the microsecond field, and may vary in length, so must be compared
260 return $a cmp $b if ($a !~ /^\d+\.H\d/ || $b !~ /^\d+\.H\d/);
261 my($x1,$y1) = $a =~ /^(\d+)\.H(\d+)/;
262 my($x2,$y2) = $b =~ /^(\d+)\.H(\d+)/;
263 return ($x1 != $x2)? ($x1 <=> $x2) : ($y1 <=> $y2);
268 ##################################################
269 # Subroutine list files below a directory #
270 ##################################################
272 # This is used to build up a list of expected mail files below a certain path
273 # in the directory tree. It has to be recursive in order to deal with multiple
276 sub list_files_below {
281 opendir(DIR, $dir) || tests_exit(-1, "Failed to open $dir: $!");
282 @sublist = sort maildirsort readdir(DIR);
285 foreach $file (@sublist)
287 next if $file eq "." || $file eq ".." || $file eq "CVS";
289 { @yield = (@yield, list_files_below("$dir/$file")); }
291 { push @yield, "$dir/$file"; }
299 ##################################################
300 # Munge a file before comparing #
301 ##################################################
303 # The pre-processing turns all dates, times, Exim versions, message ids, and so
304 # on into standard values, so that the compare works. Perl's substitution with
305 # an expression provides a neat way to do some of these changes.
307 # We keep a global associative array for repeatedly turning the same values
308 # into the same standard values throughout the data from a single test.
309 # Message ids get this treatment (can't be made reliable for times), and
310 # times in dumped retry databases are also handled in a special way, as are
311 # incoming port numbers.
313 # On entry to the subroutine, the file to write to is already opened with the
314 # name MUNGED. The input file name is the only argument to the subroutine.
315 # Certain actions are taken only when the name contains "stderr", "stdout",
316 # or "log". The yield of the function is 1 if a line matching "*** truncated
317 # ***" is encountered; otherwise it is 0.
325 open(IN, "$file") || tests_exit(-1, "Failed to open $file: $!");
327 my($is_log) = $file =~ /log/;
328 my($is_stdout) = $file =~ /stdout/;
329 my($is_stderr) = $file =~ /stderr/;
333 $date = "\\d{2}-\\w{3}-\\d{4}\\s\\d{2}:\\d{2}:\\d{2}";
335 # Pattern for matching pids at start of stderr lines; initially something
338 $spid = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
340 # Scan the file and make the changes. Near the bottom there are some changes
341 # that are specific to certain file types, though there are also some of those
346 RESET_AFTER_EXTRA_LINE_READ:
350 next if $extra =~ m%^/% && eval $extra;
351 eval $extra if $extra =~ m/^s/;
354 # Check for "*** truncated ***"
355 $yield = 1 if /\*\*\* truncated \*\*\*/;
357 # Replace the name of this host
358 s/\Q$parm_hostname\E/the.local.host.name/g;
360 # But convert "name=the.local.host address=127.0.0.1" to use "localhost"
361 s/name=the\.local\.host address=127\.0\.0\.1/name=localhost address=127.0.0.1/g;
363 # The name of the shell may vary
364 s/\s\Q$parm_shell\E\b/ ENV_SHELL/;
366 # Replace the path to the testsuite directory
367 s?\Q$parm_cwd\E?TESTSUITE?g;
369 # Replace the Exim version number (may appear in various places)
370 # patchexim should have fixed this for us
371 #s/(Exim) \d+\.\d+[\w_-]*/$1 x.yz/i;
373 # Replace Exim message ids by a unique series
374 s/((?:[^\W_]{6}-){2}[^\W_]{2})
375 /new_value($1, "10Hm%s-0005vi-00", \$next_msgid)/egx;
377 # The names of lock files appear in some error and debug messages
378 s/\.lock(\.[-\w]+)+(\.[\da-f]+){2}/.lock.test.ex.dddddddd.pppppppp/;
380 # Unless we are in an IPv6 test, replace IPv4 and/or IPv6 in "listening on
381 # port" message, because it is not always the same.
382 s/port (\d+) \([^)]+\)/port $1/g
383 if !$is_ipv6test && m/listening for SMTP(S?) on port/;
385 # Challenges in SPA authentication
386 s/TlRMTVNTUAACAAAAAAAAAAAoAAABgg[\w+\/]+/TlRMTVNTUAACAAAAAAAAAAAoAAABggAAAEbBRwqFwwIAAAAAAAAAAAAt1sgAAAAA/;
389 s?prvs=([^/]+)/[\da-f]{10}@?prvs=$1/xxxxxxxxxx@?g; # Old form
390 s?prvs=[\da-f]{10}=([^@]+)@?prvs=xxxxxxxxxx=$1@?g; # New form
392 # Error lines on stdout from SSL contain process id values and file names.
393 # They also contain a source file name and line number, which may vary from
394 # release to release.
395 s/^\d+:error:/pppp:error:/;
396 s/:(?:\/[^\s:]+\/)?([^\/\s]+\.c):\d+:/:$1:dddd:/;
398 # There are differences in error messages between OpenSSL versions
399 s/SSL_CTX_set_cipher_list/SSL_connect/;
401 # One error test in expansions mentions base 62 or 36
402 s/is not a base (36|62) number/is not a base 36\/62 number/;
404 # This message sometimes has a different number of seconds
405 s/forced fail after \d seconds/forced fail after d seconds/;
407 # This message may contain a different DBM library name
408 s/Failed to open \S+( \([^\)]+\))? file/Failed to open DBM file/;
410 # The message for a non-listening FIFO varies
411 s/:[^:]+: while opening named pipe/: Error: while opening named pipe/;
413 # Debugging output of lists of hosts may have different sort keys
414 s/sort=\S+/sort=xx/ if /^\S+ (?:\d+\.){3}\d+ mx=\S+ sort=\S+/;
416 # Random local part in callout cache testing
417 s/myhost.test.ex-\d+-testing/myhost.test.ex-dddddddd-testing/;
418 s/the.local.host.name-\d+-testing/the.local.host.name-dddddddd-testing/;
420 # File descriptor numbers may vary
421 s/^writing data block fd=\d+/writing data block fd=dddd/;
422 s/running as transport filter: write=\d+ read=\d+/running as transport filter: write=dddd read=dddd/;
425 # ======== Dumpdb output ========
426 # This must be before the general date/date munging.
427 # Time data lines, which look like this:
428 # 25-Aug-2000 12:11:37 25-Aug-2000 12:11:37 26-Aug-2000 12:11:37
429 if (/^($date)\s+($date)\s+($date)(\s+\*)?\s*$/)
431 my($date1,$date2,$date3,$expired) = ($1,$2,$3,$4);
432 $expired = "" if !defined $expired;
433 my($increment) = date_seconds($date3) - date_seconds($date2);
435 # We used to use globally unique replacement values, but timing
436 # differences make this impossible. Just show the increment on the
439 printf MUNGED ("first failed = time last try = time2 next try = time2 + %s%s\n",
440 $increment, $expired);
444 # more_errno values in exim_dumpdb output which are times
445 s/T:(\S+)\s-22\s(\S+)\s/T:$1 -22 xxxx /;
448 # ======== Dates and times ========
450 # Dates and times are all turned into the same value - trying to turn
451 # them into different ones cannot be done repeatedly because they are
452 # real time stamps generated while running the test. The actual date and
453 # time used was fixed when I first started running automatic Exim tests.
455 # Date/time in header lines and SMTP responses
456 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}
457 /Tue, 2 Mar 1999 09:44:33 +0000/gx;
459 # Date/time in logs and in one instance of a filter test
460 s/^\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d(\s[+-]\d\d\d\d)?/1999-03-02 09:44:33/gx;
461 s/^Logwrite\s"\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d/Logwrite "1999-03-02 09:44:33/gx;
463 # Date/time in message separators
464 s/(?:[A-Z][a-z]{2}\s){2}\d\d\s\d\d:\d\d:\d\d\s\d\d\d\d
465 /Tue Mar 02 09:44:33 1999/gx;
467 # Date of message arrival in spool file as shown by -Mvh
468 s/^\d{9,10}\s0$/ddddddddd 0/;
470 # Date/time in mbx mailbox files
471 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;
473 # Dates/times in debugging output for writing retry records
474 if (/^ first failed=(\d+) last try=(\d+) next try=(\d+) (.*)$/)
477 $_ = " first failed=dddd last try=dddd next try=+$next $4\n";
479 s/^(\s*)now=\d+ first_failed=\d+ next_try=\d+ expired=(\d)/$1now=tttt first_failed=tttt next_try=tttt expired=$2/;
480 s/^(\s*)received_time=\d+ diff=\d+ timeout=(\d+)/$1received_time=tttt diff=tttt timeout=$2/;
482 # Time to retry may vary
483 s/time to retry = \S+/time to retry = tttt/;
484 s/retry record exists: age=\S+/retry record exists: age=ttt/;
485 s/failing_interval=\S+ message_age=\S+/failing_interval=ttt message_age=ttt/;
487 # Date/time in exim -bV output
488 s/\d\d-[A-Z][a-z]{2}-\d{4}\s\d\d:\d\d:\d\d/07-Mar-2000 12:21:52/g;
490 # Time on queue tolerance
494 s/Exim\sstatistics\sfrom\s\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d\sto\s
495 \d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d/Exim statistics from <time> to <time>/x;
497 # Treat ECONNRESET the same as ECONNREFUSED. At least some systems give
498 # us the former on a new connection.
499 s/(could not connect to .*: Connection) reset by peer$/$1 refused/;
501 # ======== TLS certificate algorithms ========
502 # Test machines might have various different TLS library versions supporting
503 # different protocols; can't rely upon TLS 1.2's AES256-GCM-SHA384, so we
504 # treat the standard algorithms the same.
506 # TLSv1:AES128-GCM-SHA256:128
507 # TLSv1:AES256-SHA:256
508 # TLSv1.1:AES256-SHA:256
509 # TLSv1.2:AES256-GCM-SHA384:256
510 # TLSv1.2:DHE-RSA-AES256-SHA:256
511 # TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128
512 # We also need to handle the ciphersuite without the TLS part present, for
513 # client-ssl's output. We also see some older forced ciphersuites, but
514 # negotiating TLS 1.2 instead of 1.0.
515 # Mail headers (...), log-lines X=..., client-ssl output ...
516 # (and \b doesn't match between ' ' and '(' )
518 s/( (?: (?:\b|\s) [\(=] ) | \s )TLSv1\.[12]:/$1TLSv1:/xg;
519 s/\bAES128-GCM-SHA256:128\b/AES256-SHA:256/g;
520 s/\bAES128-GCM-SHA256\b/AES256-SHA/g;
521 s/\bAES256-GCM-SHA384\b/AES256-SHA/g;
522 s/\bDHE-RSA-AES256-SHA\b/AES256-SHA/g;
525 # TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256
526 # TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128
527 # TLS1.2:RSA_AES_256_CBC_SHA1:256 (canonical)
528 # TLS1.2:DHE_RSA_AES_128_CBC_SHA1:128
530 # X=TLS1.2:DHE_RSA_AES_256_CBC_SHA256:256
531 # X=TLS1.2:RSA_AES_256_CBC_SHA1:256
532 # X=TLS1.1:RSA_AES_256_CBC_SHA1:256
533 # X=TLS1.0:DHE_RSA_AES_256_CBC_SHA1:256
534 # and as stand-alone cipher:
535 # ECDHE-RSA-AES256-SHA
536 # DHE-RSA-AES256-SHA256
538 # picking latter as canonical simply because regex easier that way.
539 s/\bDHE_RSA_AES_128_CBC_SHA1:128/RSA_AES_256_CBC_SHA1:256/g;
540 s/TLS1.[012]:((EC)?DHE_)?RSA_AES_(256|128)_(CBC|GCM)_SHA(1|256|384):(256|128)/TLS1.x:xxxxRSA_AES_256_CBC_SHAnnn:256/g;
541 s/\b(ECDHE-RSA-AES256-SHA|DHE-RSA-AES256-SHA256)\b/AES256-SHA/g;
543 # GnuTLS library error message changes
544 s/No certificate was found/The peer did not send any certificate/g;
545 #(dodgy test?) s/\(certificate verification failed\): invalid/\(gnutls_handshake\): The peer did not send any certificate./g;
546 s/\(gnutls_priority_set\): No or insufficient priorities were set/\(gnutls_handshake\): Could not negotiate a supported cipher suite/g;
548 # (this new one is a generic channel-read error, but the testsuite
549 # only hits it in one place)
550 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;
552 # (replace old with new, hoping that old only happens in one situation)
553 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;
554 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;
556 # signature algorithm names
560 # ======== Caller's login, uid, gid, home, gecos ========
562 s/\Q$parm_caller_home\E/CALLER_HOME/g; # NOTE: these must be done
563 s/\b\Q$parm_caller\E\b/CALLER/g; # in this order!
564 s/\b\Q$parm_caller_group\E\b/CALLER/g; # In case group name different
566 s/\beuid=$parm_caller_uid\b/euid=CALLER_UID/g;
567 s/\begid=$parm_caller_gid\b/egid=CALLER_GID/g;
569 s/\buid=$parm_caller_uid\b/uid=CALLER_UID/g;
570 s/\bgid=$parm_caller_gid\b/gid=CALLER_GID/g;
572 s/\bname="?$parm_caller_gecos"?/name=CALLER_GECOS/g;
574 # When looking at spool files with -Mvh, we will find not only the caller
575 # login, but also the uid and gid. It seems that $) in some Perls gives all
576 # the auxiliary gids as well, so don't bother checking for that.
578 s/^CALLER $> \d+$/CALLER UID GID/;
580 # There is one case where the caller's login is forced to something else,
581 # in order to test the processing of logins that contain spaces. Weird what
582 # some people do, isn't it?
584 s/^spaced user $> \d+$/CALLER UID GID/;
587 # ======== Exim's login ========
588 # For messages received by the daemon, this is in the -H file, which some
589 # tests inspect. For bounce messages, this will appear on the U= lines in
590 # logs and also after Received: and in addresses. In one pipe test it appears
591 # after "Running as:". It also appears in addresses, and in the names of lock
594 s/U=$parm_eximuser/U=EXIMUSER/;
595 s/user=$parm_eximuser/user=EXIMUSER/;
596 s/login=$parm_eximuser/login=EXIMUSER/;
597 s/Received: from $parm_eximuser /Received: from EXIMUSER /;
598 s/Running as: $parm_eximuser/Running as: EXIMUSER/;
599 s/\b$parm_eximuser@/EXIMUSER@/;
600 s/\b$parm_eximuser\.lock\./EXIMUSER.lock./;
602 s/\beuid=$parm_exim_uid\b/euid=EXIM_UID/g;
603 s/\begid=$parm_exim_gid\b/egid=EXIM_GID/g;
605 s/\buid=$parm_exim_uid\b/uid=EXIM_UID/g;
606 s/\bgid=$parm_exim_gid\b/gid=EXIM_GID/g;
608 s/^$parm_eximuser $parm_exim_uid $parm_exim_gid/EXIMUSER EXIM_UID EXIM_GID/;
611 # ======== General uids, gids, and pids ========
612 # Note: this must come after munges for caller's and exim's uid/gid
614 # These are for systems where long int is 64
615 s/\buid=4294967295/uid=-1/;
616 s/\beuid=4294967295/euid=-1/;
617 s/\bgid=4294967295/gid=-1/;
618 s/\begid=4294967295/egid=-1/;
620 s/\bgid=\d+/gid=gggg/;
621 s/\begid=\d+/egid=gggg/;
622 s/\bpid=\d+/pid=pppp/;
623 s/\buid=\d+/uid=uuuu/;
624 s/\beuid=\d+/euid=uuuu/;
625 s/set_process_info:\s+\d+/set_process_info: pppp/;
626 s/queue run pid \d+/queue run pid ppppp/;
627 s/process \d+ running as transport filter/process pppp running as transport filter/;
628 s/process \d+ writing to transport filter/process pppp writing to transport filter/;
629 s/reading pipe for subprocess \d+/reading pipe for subprocess pppp/;
630 s/remote delivery process \d+ ended/remote delivery process pppp ended/;
632 # Pid in temp file in appendfile transport
633 s"test-mail/temp\.\d+\."test-mail/temp.pppp.";
635 # Optional pid in log lines
636 s/^(\d{4}-\d\d-\d\d\s\d\d:\d\d:\d\d)(\s[+-]\d\d\d\d|)(\s\[\d+\])/
637 "$1$2 [" . new_value($3, "%s", \$next_pid) . "]"/gxe;
639 # Detect a daemon stderr line with a pid and save the pid for subsequent
640 # removal from following lines.
641 $spid = $1 if /^(\s*\d+) (?:listening|LOG: MAIN|(?:daemon_smtp_port|local_interfaces) overridden by)/;
644 # Queue runner waiting messages
645 s/waiting for children of \d+/waiting for children of pppp/;
646 s/waiting for (\S+) \(\d+\)/waiting for $1 (pppp)/;
648 # ======== Port numbers ========
649 # Incoming port numbers may vary, but not in daemon startup line.
651 s/^Port: (\d+)/"Port: " . new_value($1, "%s", \$next_port)/e;
652 s/\(port=(\d+)/"(port=" . new_value($1, "%s", \$next_port)/e;
654 # This handles "connection from" and the like, when the port is given
655 if (!/listening for SMTP on/ && !/Connecting to/ && !/=>/ && !/->/
656 && !/\*>/ && !/Connection refused/)
658 s/\[([a-z\d:]+|\d+(?:\.\d+){3})\]:(\d+)/"[".$1."]:".new_value($2,"%s",\$next_port)/ie;
661 # Port in host address in spool file output from -Mvh
662 s/^-host_address (.*)\.\d+/-host_address $1.9999/;
665 # ======== Local IP addresses ========
666 # The amount of space between "host" and the address in verification output
667 # depends on the length of the host name. We therefore reduce it to one space
669 # Also, the length of space at the end of the host line is dependent
670 # on the length of the longest line, so strip it also on otherwise
671 # un-rewritten lines like localhost
673 s/^\s+host\s(\S+)\s+(\S+)/ host $1 $2/;
674 s/^\s+(host\s\S+\s\S+)\s+(port=.*)/ host $1 $2/;
675 s/^\s+(host\s\S+\s\S+)\s+(?=MX=)/ $1 /;
676 s/host\s\Q$parm_ipv4\E\s\[\Q$parm_ipv4\E\]/host ipv4.ipv4.ipv4.ipv4 [ipv4.ipv4.ipv4.ipv4]/;
677 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]/;
678 s/\b\Q$parm_ipv4\E\b/ip4.ip4.ip4.ip4/g;
679 s/(^|\W)\K\Q$parm_ipv6\E/ip6:ip6:ip6:ip6:ip6:ip6:ip6:ip6/g;
680 s/\b\Q$parm_ipv4r\E\b/ip4-reverse/g;
681 s/(^|\W)\K\Q$parm_ipv6r\E/ip6-reverse/g;
682 s/^(\s+host\s\S+\s+\[\S+\]) +$/$1 /;
685 # ======== Test network IP addresses ========
686 s/(\b|_)\Q$parm_ipv4_test_net\E(?=\.\d+\.\d+\.\d+\b|_|\.rbl|\.in-addr|\.test\.again\.dns)/$1V4NET/g;
687 s/\b\Q$parm_ipv6_test_net\E(?=:[\da-f]+:[\da-f]+:[\da-f]+)/V6NET/gi;
690 # ======== IP error numbers and messages ========
691 # These vary between operating systems
692 s/Can't assign requested address/Network Error/;
693 s/Cannot assign requested address/Network Error/;
694 s/Operation timed out/Connection timed out/;
695 s/Address family not supported by protocol family/Network Error/;
696 s/Network is unreachable/Network Error/;
697 s/Invalid argument/Network Error/;
699 s/\(\d+\): Network/(dd): Network/;
700 s/\(\d+\): Connection refused/(dd): Connection refused/;
701 s/\(\d+\): Connection timed out/(dd): Connection timed out/;
702 s/\d+ 65 Connection refused/dd 65 Connection refused/;
703 s/\d+ 321 Connection timed out/dd 321 Connection timed out/;
706 # ======== Other error numbers ========
707 s/errno=\d+/errno=dd/g;
709 # ======== System Error Messages ======
710 # depending on the underlaying file system the error message seems to differ
711 s/(?: is not a regular file)|(?: has too many links \(\d+\))/ not a regular file or too many links/;
713 # ======== Output from ls ========
714 # Different operating systems use different spacing on long output
715 #s/ +/ /g if /^[-rwd]{10} /;
716 # (Bug 1226) SUSv3 allows a trailing printable char for modified access method control.
717 # Handle only the Gnu and MacOS space, dot, plus and at-sign. A full [[:graph:]]
718 # unfortunately matches a non-ls linefull of dashes.
719 # Allow the case where we've already picked out the file protection bits.
720 if (s/^([-d](?:[-r][-w][-SsTtx]){3})[.+@]?( +|$)/$1$2/) {
725 # ======== Message sizes =========
726 # Message sizes vary, owing to different logins and host names that get
727 # automatically inserted. I can't think of any way of even approximately
730 s/([\s,])S=\d+\b/$1S=sss/;
732 s/^(\s*\d+m\s+)\d+(\s+[a-z0-9-]{16} <)/$1sss$2/i if $is_stdout;
733 s/\sSIZE=\d+\b/ SIZE=ssss/;
734 s/\ssize=\d+\b/ size=sss/ if $is_stderr;
735 s/old size = \d+\b/old size = sssss/;
736 s/message size = \d+\b/message size = sss/;
737 s/this message = \d+\b/this message = sss/;
738 s/Size of headers = \d+/Size of headers = sss/;
739 s/sum=(?!0)\d+/sum=dddd/;
740 s/(?<=sum=dddd )count=\d+\b/count=dd/;
741 s/(?<=sum=0 )count=\d+\b/count=dd/;
742 s/,S is \d+\b/,S is ddddd/;
743 s/\+0100,\d+;/+0100,ddd;/;
744 s/\(\d+ bytes written\)/(ddd bytes written)/;
745 s/added '\d+ 1'/added 'ddd 1'/;
746 s/Received\s+\d+/Received nnn/;
747 s/Delivered\s+\d+/Delivered nnn/;
750 # ======== Values in spool space failure message ========
751 s/space=\d+ inodes=[+-]?\d+/space=xxxxx inodes=xxxxx/;
754 # ======== Filter sizes ========
755 # The sizes of filter files may vary because of the substitution of local
756 # filenames, logins, etc.
758 s/^\d+(?= bytes read from )/ssss/;
761 # ======== OpenSSL error messages ========
762 # Different releases of the OpenSSL libraries seem to give different error
763 # numbers, or handle specific bad conditions in different ways, leading to
764 # different wording in the error messages, so we cannot compare them.
766 s/(TLS error on connection (?:from .* )?\(SSL_\w+\): error:)(.*)/$1 <<detail omitted>>/;
768 # ======== Maildir things ========
769 # timestamp output in maildir processing
770 s/(timestamp=|\(timestamp_only\): )\d+/$1ddddddd/g;
772 # maildir delivery files appearing in log lines (in cases of error)
773 s/writing to(?: file)? tmp\/\d+\.[^.]+\.(\S+)/writing to tmp\/MAILDIR.$1/;
775 s/renamed tmp\/\d+\.[^.]+\.(\S+) as new\/\d+\.[^.]+\.(\S+)/renamed tmp\/MAILDIR.$1 as new\/MAILDIR.$1/;
777 # Maildir file names in general
778 s/\b\d+\.H\d+P\d+\b/dddddddddd.HddddddPddddd/;
781 while (/^\d+S,\d+C\s*$/)
786 last if !/^\d+ \d+\s*$/;
787 print MUNGED "ddd d\n";
794 # ======== Output from the "fd" program about open descriptors ========
795 # The statuses seem to be different on different operating systems, but
796 # at least we'll still be checking the number of open fd's.
798 s/max fd = \d+/max fd = dddd/;
799 s/status=0 RDONLY/STATUS/g;
800 s/status=1 WRONLY/STATUS/g;
801 s/status=2 RDWR/STATUS/g;
804 # ======== Contents of spool files ========
805 # A couple of tests dump the contents of the -H file. The length fields
806 # will be wrong because of different user names, etc.
807 s/^\d\d\d(?=[PFS*])/ddd/;
810 # ========= Exim lookups ==================
811 # Lookups have a char which depends on the number of lookup types compiled in,
812 # in stderr output. Replace with a "0". Recognising this while avoiding
813 # other output is fragile; perhaps the debug output should be revised instead.
814 s%(?<!sqlite)(?<!lsearch\*@)(?<!lsearch\*)(?<!lsearch)[0-?]TESTSUITE/aux-fixed/%0TESTSUITE/aux-fixed/%g;
816 # ==========================================================
817 # MIME boundaries in RFC3461 DSN messages
818 s/\d{8,10}-eximdsn-\d+/NNNNNNNNNN-eximdsn-MMMMMMMMMM/;
820 # ==========================================================
821 # Some munging is specific to the specific file types
823 # ======== stdout ========
827 # Skip translate_ip_address and use_classresources in -bP output because
828 # they aren't always there.
830 next if /translate_ip_address =/;
831 next if /use_classresources/;
833 # In certain filter tests, remove initial filter lines because they just
834 # clog up by repetition.
838 next if /^(Sender\staken\sfrom|
839 Return-path\scopied\sfrom|
842 if (/^Testing \S+ filter/)
844 $_ = <IN>; # remove blank line
849 # openssl version variances
850 next if /^SSL info: unknown state/;
851 next if /^SSL info: SSLv2\/v3 write client hello A/;
852 next if /^SSL info: SSLv3 read server key exchange A/;
855 # ======== stderr ========
859 # The very first line of debugging output will vary
861 s/^Exim version .*/Exim version x.yz ..../;
863 # Debugging lines for Exim terminations
865 s/(?<=^>>>>>>>>>>>>>>>> Exim pid=)\d+(?= terminating)/pppp/;
867 # IP address lookups use gethostbyname() when IPv6 is not supported,
868 # and gethostbyname2() or getipnodebyname() when it is.
870 s/\bgethostbyname2?|\bgetipnodebyname/get[host|ipnode]byname[2]/;
872 # drop gnutls version strings
873 next if /GnuTLS compile-time version: \d+[\.\d]+$/;
874 next if /GnuTLS runtime version: \d+[\.\d]+$/;
876 # drop openssl version strings
877 next if /OpenSSL compile-time version: OpenSSL \d+[\.\da-z]+/;
878 next if /OpenSSL runtime version: OpenSSL \d+[\.\da-z]+/;
881 next if /^Lookups \(built-in\):/;
882 next if /^Loading lookup modules from/;
883 next if /^Loaded \d+ lookup modules/;
884 next if /^Total \d+ lookups/;
886 # drop compiler information
887 next if /^Compiler:/;
890 # different libraries will have different numbers (possibly 0) of follow-up
891 # lines, indenting with more data
892 if (/^Library version:/) {
896 goto RESET_AFTER_EXTRA_LINE_READ;
900 # drop other build-time controls emitted for debugging
901 next if /^WHITELIST_D_MACROS:/;
902 next if /^TRUSTED_CONFIG_LIST:/;
904 # As of Exim 4.74, we log when a setgid fails; because we invoke Exim
905 # with -be, privileges will have been dropped, so this will always
907 next if /^changing group to \d+ failed: (Operation not permitted|Not owner)/;
909 # We might not keep this check; rather than change all the tests, just
910 # ignore it as long as it succeeds; then we only need to change the
911 # TLS tests where tls_require_ciphers has been set.
912 if (m{^changed uid/gid: calling tls_validate_require_cipher}) {
916 next if /^tls_validate_require_cipher child \d+ ended: status=0x0/;
918 # We invoke Exim with -D, so we hit this new messag as of Exim 4.73:
919 next if /^macros_trusted overridden to true by whitelisting/;
921 # We have to omit the localhost ::1 address so that all is well in
922 # the IPv4-only case.
924 print MUNGED "MUNGED: ::1 will be omitted in what follows\n"
925 if (/looked up these IP addresses/);
926 next if /name=localhost address=::1/;
928 # drop pdkim debugging header
929 next if /^PDKIM <<<<<<<<<<<<<<<<<<<<<<<<<<<<<+$/;
931 # Various other IPv6 lines must be omitted too
933 next if /using host_fake_gethostbyname for \S+ \(IPv6\)/;
934 next if /get\[host\|ipnode\]byname\[2\]\(af=inet6\)/;
935 next if /DNS lookup of \S+ \(AAAA\) using fakens/;
936 next if / in dns_ipv4_lookup?/;
938 if (/DNS lookup of \S+ \(AAAA\) gave NO_DATA/)
940 $_= <IN>; # Gets "returning DNS_NODATA"
944 # Skip tls_advertise_hosts and hosts_require_tls checks when the options
945 # are unset, because tls ain't always there.
947 next if /in\s(?:tls_advertise_hosts\?|hosts_require_tls\?)
948 \sno\s\(option\sunset\)/x;
950 # Skip auxiliary group lists because they will vary.
952 next if /auxiliary group list:/;
954 # Skip "extracted from gecos field" because the gecos field varies
956 next if /extracted from gecos field/;
958 # Skip "waiting for data on socket" and "read response data: size=" lines
959 # because some systems pack more stuff into packets than others.
961 next if /waiting for data on socket/;
962 next if /read response data: size=/;
964 # If Exim is compiled with readline support but it can't find the library
965 # to load, there will be an extra debug line. Omit it.
967 next if /failed to load readline:/;
969 # Some DBM libraries seem to make DBM files on opening with O_RDWR without
970 # O_CREAT; other's don't. In the latter case there is some debugging output
971 # which is not present in the former. Skip the relevant lines (there are
974 if (/TESTSUITE\/spool\/db\/\S+ appears not to exist: trying to create/)
980 # Some tests turn on +expand debugging to check on expansions.
981 # Unfortunately, the Received: expansion varies, depending on whether TLS
982 # is compiled or not. So we must remove the relevant debugging if it is.
984 if (/^condition: def:tls_cipher/)
986 while (<IN>) { last if /^condition: def:sender_address/; }
988 elsif (/^expanding: Received: /)
990 while (<IN>) { last if !/^\s/; }
993 # When Exim is checking the size of directories for maildir, it uses
994 # the check_dir_size() function to scan directories. Of course, the order
995 # of the files that are obtained using readdir() varies from system to
996 # system. We therefore buffer up debugging lines from check_dir_size()
997 # and sort them before outputting them.
999 if (/^check_dir_size:/ || /^skipping TESTSUITE\/test-mail\//)
1007 print MUNGED "MUNGED: the check_dir_size lines have been sorted " .
1008 "to ensure consistency\n";
1009 @saved = sort(@saved);
1010 print MUNGED @saved;
1014 # Skip hosts_require_dane checks when the options
1015 # are unset, because dane ain't always there.
1017 next if /in\shosts_require_dane\?\sno\s\(option\sunset\)/x;
1019 # Experimental_International
1020 next if / in smtputf8_advertise_hosts\? no \(option unset\)/;
1022 # Skip some lines that Exim puts out at the start of debugging output
1023 # because they will be different in different binaries.
1026 unless (/^Berkeley DB: / ||
1027 /^Probably (?:Berkeley DB|ndbm|GDBM)/ ||
1028 /^Authenticators:/ ||
1033 /^log selectors =/ ||
1035 /^Fixed never_users:/ ||
1045 # ======== log ========
1049 # Berkeley DB version differences
1050 next if / Berkeley DB error: /;
1053 # ======== All files other than stderr ========
1065 ##################################################
1066 # Subroutine to interact with caller #
1067 ##################################################
1069 # Arguments: [0] the prompt string
1070 # [1] if there is a U in the prompt and $force_update is true
1071 # [2] if there is a C in the prompt and $force_continue is true
1072 # Returns: nothing (it sets $_)
1076 if ($_[1]) { $_ = "u"; print "... update forced\n"; }
1077 elsif ($_[2]) { $_ = "c"; print "... continue forced\n"; }
1083 ##################################################
1084 # Subroutine to log in force_continue mode #
1085 ##################################################
1087 # In force_continue mode, we just want a terse output to a statically
1088 # named logfile. If multiple files in same batch (stdout, stderr, etc)
1089 # all have mismatches, it will log multiple times.
1091 # Arguments: [0] the logfile to append to
1092 # [1] the testno that failed
1098 my $logfile = shift();
1099 my $testno = shift();
1100 my $detail = shift() || '';
1101 if ( open(my $fh, ">>", $logfile) ) {
1102 print $fh "Test $testno $detail failed\n";
1109 ##################################################
1110 # Subroutine to compare one output file #
1111 ##################################################
1113 # When an Exim server is part of the test, its output is in separate files from
1114 # an Exim client. The server data is concatenated with the client data as part
1115 # of the munging operation.
1117 # Arguments: [0] the name of the main raw output file
1118 # [1] the name of the server raw output file or undef
1119 # [2] where to put the munged copy
1120 # [3] the name of the saved file
1121 # [4] TRUE if this is a log file whose deliveries must be sorted
1122 # [5] optionally, a custom munge command
1124 # Returns: 0 comparison succeeded or differences to be ignored
1125 # 1 comparison failed; files may have been updated (=> re-compare)
1127 # Does not return if the user replies "Q" to a prompt.
1130 my($rf,$rsf,$mf,$sf,$sortfile,$extra) = @_;
1132 # If there is no saved file, the raw files must either not exist, or be
1133 # empty. The test ! -s is TRUE if the file does not exist or is empty.
1135 # we check if there is a flavour specific file, but we remember
1136 # the original file name as "generic"
1138 $sf_flavour = "$sf_generic.$flavour";
1139 $sf_current = -e $sf_flavour ? $sf_flavour : $sf_generic;
1141 if (! -e $sf_current)
1143 return 0 if (! -s $rf && (! defined $rsf || ! -s $rsf));
1146 print "** $rf is not empty\n" if (-s $rf);
1147 print "** $rsf is not empty\n" if (defined $rsf && -s $rsf);
1151 print "Continue, Show, or Quit? [Q] ";
1152 $_ = $force_continue ? "c" : <T>;
1153 tests_exit(1) if /^q?$/i;
1154 log_failure($log_failed_filename, $testno, $rf) if (/^c$/i && $force_continue);
1159 foreach $f ($rf, $rsf)
1161 if (defined $f && -s $f)
1164 print "------------ $f -----------\n"
1165 if (defined $rf && -s $rf && defined $rsf && -s $rsf);
1166 system("$more '$f'");
1173 interact("Continue, Update & retry, Quit? [Q] ", $force_update, $force_continue);
1174 tests_exit(1) if /^q?$/i;
1175 log_failure($log_failed_filename, $testno, $rsf) if (/^c$/i && $force_continue);
1181 # Control reaches here if either (a) there is a saved file ($sf), or (b) there
1182 # was a request to create a saved file. First, create the munged file from any
1183 # data that does exist.
1185 open(MUNGED, ">$mf") || tests_exit(-1, "Failed to open $mf: $!");
1186 my($truncated) = munge($rf, $extra) if -e $rf;
1187 if (defined $rsf && -e $rsf)
1189 print MUNGED "\n******** SERVER ********\n";
1190 $truncated |= munge($rsf, $extra);
1194 # If a saved file exists, do the comparison. There are two awkward cases:
1196 # If "*** truncated ***" was found in the new file, it means that a log line
1197 # was overlong, and truncated. The problem is that it may be truncated at
1198 # different points on different systems, because of different user name
1199 # lengths. We reload the file and the saved file, and remove lines from the new
1200 # file that precede "*** truncated ***" until we reach one that matches the
1201 # line that precedes it in the saved file.
1203 # If $sortfile is set, we are dealing with a mainlog file where the deliveries
1204 # for an individual message might vary in their order from system to system, as
1205 # a result of parallel deliveries. We load the munged file and sort sequences
1206 # of delivery lines.
1210 # Deal with truncated text items
1214 my(@munged, @saved, $i, $j, $k);
1216 open(MUNGED, "$mf") || tests_exit(-1, "Failed to open $mf: $!");
1219 open(SAVED, $sf_current) || tests_exit(-1, "Failed to open $sf_current: $!");
1224 for ($i = 0; $i < @munged; $i++)
1226 if ($munged[$i] =~ /\*\*\* truncated \*\*\*/)
1228 for (; $j < @saved; $j++)
1229 { last if $saved[$j] =~ /\*\*\* truncated \*\*\*/; }
1230 last if $j >= @saved; # not found in saved
1232 for ($k = $i - 1; $k >= 0; $k--)
1233 { last if $munged[$k] eq $saved[$j - 1]; }
1235 last if $k <= 0; # failed to find previous match
1236 splice @munged, $k + 1, $i - $k - 1;
1241 open(MUNGED, ">$mf") || tests_exit(-1, "Failed to open $mf: $!");
1242 for ($i = 0; $i < @munged; $i++)
1243 { print MUNGED $munged[$i]; }
1247 # Deal with log sorting
1251 my(@munged, $i, $j);
1253 open(MUNGED, "$mf") || tests_exit(-1, "Failed to open $mf: $!");
1257 for ($i = 0; $i < @munged; $i++)
1259 if ($munged[$i] =~ /^[-\d]{10}\s[:\d]{8}\s[-A-Za-z\d]{16}\s[-=*]>/)
1261 for ($j = $i + 1; $j < @munged; $j++)
1263 last if $munged[$j] !~
1264 /^[-\d]{10}\s[:\d]{8}\s[-A-Za-z\d]{16}\s[-=*]>/;
1266 @temp = splice(@munged, $i, $j - $i);
1267 @temp = sort(@temp);
1268 splice(@munged, $i, 0, @temp);
1272 open(MUNGED, ">$mf") || tests_exit(-1, "Failed to open $mf: $!");
1273 print MUNGED "**NOTE: The delivery lines in this file have been sorted.\n";
1274 for ($i = 0; $i < @munged; $i++)
1275 { print MUNGED $munged[$i]; }
1281 return 0 if (system("$cf '$mf' '$sf_current' >test-cf") == 0);
1283 # Handle comparison failure
1285 print "** Comparison of $mf with $sf_current failed";
1286 system("$more test-cf");
1291 interact("Continue, Retry, Update current"
1292 . ($sf_current ne $sf_flavour ? "/Save for flavour '$flavour'" : "")
1293 . " & retry, Quit? [Q] ", $force_update, $force_continue);
1294 tests_exit(1) if /^q?$/i;
1295 log_failure($log_failed_filename, $testno, $sf_current) if (/^c$/i && $force_continue);
1298 last if (/^[us]$/i);
1302 # Update or delete the saved file, and give the appropriate return code.
1306 my $sf = /^u/i ? $sf_current : $sf_flavour;
1307 tests_exit(-1, "Failed to cp $mf $sf") if system("cp '$mf' '$sf'") != 0;
1311 # if we deal with a flavour file, we can't delete it, because next time the generic
1312 # file would be used again
1313 if ($sf_current eq $sf_flavour) {
1314 open(FOO, ">$sf_current");
1318 tests_exit(-1, "Failed to unlink $sf_current") if !unlink($sf_current);
1327 ##################################################
1329 # keyed by name of munge; value is a ref to a hash
1330 # which is keyed by file, value a string to look for.
1332 # paniclog, rejectlog, mainlog, stdout, stderr, msglog, mail
1333 # Search strings starting with 's' do substitutions;
1334 # with '/' do line-skips.
1335 # Triggered by a scriptfile line "munge <name>"
1336 ##################################################
1339 { 'stderr' => '/^Reverse DNS security status: unverified\n/' },
1341 'gnutls_unexpected' =>
1342 { 'mainlog' => '/\(recv\): A TLS packet with unexpected length was received./' },
1344 'gnutls_handshake' =>
1345 { 'mainlog' => 's/\(gnutls_handshake\): Error in the push function/\(gnutls_handshake\): A TLS packet with unexpected length was received/' },
1347 'optional_events' =>
1348 { 'stdout' => '/event_action =/' },
1351 { 'stderr' => '/127.0.0.1 in hosts_requ(ire|est)_ocsp/' },
1353 'no_tpt_filter_epipe' =>
1354 { 'stderr' => '/^writing error 32: Broken pipe$/' },
1356 'optional_cert_hostnames' =>
1357 { 'stderr' => '/in tls_verify_cert_hostnames\? no/' },
1360 { 'stdout' => 's/[[](127\.0\.0\.1|::1)]/[IP_LOOPBACK_ADDR]/' },
1363 { 'stdout' => 's/(Content-length:) \d\d\d/$1 ddd/' },
1368 ##################################################
1369 # Subroutine to check the output of a test #
1370 ##################################################
1372 # This function is called when the series of subtests is complete. It makes
1373 # use of check_file(), whose arguments are:
1375 # [0] the name of the main raw output file
1376 # [1] the name of the server raw output file or undef
1377 # [2] where to put the munged copy
1378 # [3] the name of the saved file
1379 # [4] TRUE if this is a log file whose deliveries must be sorted
1380 # [5] an optional custom munge command
1382 # Arguments: Optionally, name of a single custom munge to run.
1383 # Returns: 0 if the output compared equal
1384 # 1 if re-run needed (files may have been updated)
1387 my($mungename) = $_[0];
1389 my($munge) = $munges->{$mungename} if defined $mungename;
1391 $yield = 1 if check_file("spool/log/paniclog",
1392 "spool/log/serverpaniclog",
1393 "test-paniclog-munged",
1394 "paniclog/$testno", 0,
1395 $munge->{'paniclog'});
1397 $yield = 1 if check_file("spool/log/rejectlog",
1398 "spool/log/serverrejectlog",
1399 "test-rejectlog-munged",
1400 "rejectlog/$testno", 0,
1401 $munge->{'rejectlog'});
1403 $yield = 1 if check_file("spool/log/mainlog",
1404 "spool/log/servermainlog",
1405 "test-mainlog-munged",
1406 "log/$testno", $sortlog,
1407 $munge->{'mainlog'});
1411 $yield = 1 if check_file("test-stdout",
1412 "test-stdout-server",
1413 "test-stdout-munged",
1414 "stdout/$testno", 0,
1415 $munge->{'stdout'});
1420 $yield = 1 if check_file("test-stderr",
1421 "test-stderr-server",
1422 "test-stderr-munged",
1423 "stderr/$testno", 0,
1424 $munge->{'stderr'});
1427 # Compare any delivered messages, unless this test is skipped.
1429 if (! $message_skip)
1433 # Get a list of expected mailbox files for this script. We don't bother with
1434 # directories, just the files within them.
1436 foreach $oldmail (@oldmails)
1438 next unless $oldmail =~ /^mail\/$testno\./;
1439 print ">> EXPECT $oldmail\n" if $debug;
1440 $expected_mails{$oldmail} = 1;
1443 # If there are any files in test-mail, compare them. Note that "." and
1444 # ".." are automatically omitted by list_files_below().
1446 @mails = list_files_below("test-mail");
1448 foreach $mail (@mails)
1450 next if $mail eq "test-mail/oncelog";
1452 $saved_mail = substr($mail, 10); # Remove "test-mail/"
1453 $saved_mail =~ s/^$parm_caller(\/|$)/CALLER/; # Convert caller name
1455 if ($saved_mail =~ /(\d+\.[^.]+\.)/)
1458 $saved_mail =~ s/(\d+\.[^.]+\.)/$msgno./gx;
1461 print ">> COMPARE $mail mail/$testno.$saved_mail\n" if $debug;
1462 $yield = 1 if check_file($mail, undef, "test-mail-munged",
1463 "mail/$testno.$saved_mail", 0,
1465 delete $expected_mails{"mail/$testno.$saved_mail"};
1468 # Complain if not all expected mails have been found
1470 if (scalar(keys %expected_mails) != 0)
1472 foreach $key (keys %expected_mails)
1473 { print "** no test file found for $key\n"; }
1477 interact("Continue, Update & retry, or Quit? [Q] ", $force_update, $force_continue);
1478 tests_exit(1) if /^q?$/i;
1479 log_failure($log_failed_filename, $testno, "missing email") if (/^c$/i && $force_continue);
1482 # For update, we not only have to unlink the file, but we must also
1483 # remove it from the @oldmails vector, as otherwise it will still be
1484 # checked for when we re-run the test.
1488 foreach $key (keys %expected_mails)
1491 tests_exit(-1, "Failed to unlink $key") if !unlink("$key");
1492 for ($i = 0; $i < @oldmails; $i++)
1494 if ($oldmails[$i] eq $key)
1496 splice @oldmails, $i, 1;
1507 # Compare any remaining message logs, unless this test is skipped.
1511 # Get a list of expected msglog files for this test
1513 foreach $oldmsglog (@oldmsglogs)
1515 next unless $oldmsglog =~ /^$testno\./;
1516 $expected_msglogs{$oldmsglog} = 1;
1519 # If there are any files in spool/msglog, compare them. However, we have
1520 # to munge the file names because they are message ids, which are
1523 if (opendir(DIR, "spool/msglog"))
1525 @msglogs = sort readdir(DIR);
1528 foreach $msglog (@msglogs)
1530 next if ($msglog eq "." || $msglog eq ".." || $msglog eq "CVS");
1531 ($munged_msglog = $msglog) =~
1532 s/((?:[^\W_]{6}-){2}[^\W_]{2})
1533 /new_value($1, "10Hm%s-0005vi-00", \$next_msgid)/egx;
1534 $yield = 1 if check_file("spool/msglog/$msglog", undef,
1535 "test-msglog-munged", "msglog/$testno.$munged_msglog", 0,
1536 $munge->{'msglog'});
1537 delete $expected_msglogs{"$testno.$munged_msglog"};
1541 # Complain if not all expected msglogs have been found
1543 if (scalar(keys %expected_msglogs) != 0)
1545 foreach $key (keys %expected_msglogs)
1547 print "** no test msglog found for msglog/$key\n";
1548 ($msgid) = $key =~ /^\d+\.(.*)$/;
1549 foreach $cachekey (keys %cache)
1551 if ($cache{$cachekey} eq $msgid)
1553 print "** original msgid $cachekey\n";
1561 interact("Continue, Update, or Quit? [Q] ", $force_update, $force_continue);
1562 tests_exit(1) if /^q?$/i;
1563 log_failure($log_failed_filename, $testno, "missing msglog") if (/^c$/i && $force_continue);
1567 foreach $key (keys %expected_msglogs)
1569 tests_exit(-1, "Failed to unlink msglog/$key")
1570 if !unlink("msglog/$key");
1583 ##################################################
1584 # Subroutine to run one "system" command #
1585 ##################################################
1587 # We put this in a subroutine so that the command can be reflected when
1590 # Argument: the command to be run
1598 $prcmd =~ s/; /;\n>> /;
1599 print ">> $prcmd\n";
1606 ##################################################
1607 # Subroutine to run one script command #
1608 ##################################################
1610 # The <SCRIPT> file is open for us to read an optional return code line,
1611 # followed by the command line and any following data lines for stdin. The
1612 # command line can be continued by the use of \. Data lines are not continued
1613 # in this way. In all lines, the following substutions are made:
1615 # DIR => the current directory
1616 # CALLER => the caller of this script
1618 # Arguments: the current test number
1619 # reference to the subtest number, holding previous value
1620 # reference to the expected return code value
1621 # reference to where to put the command name (for messages)
1622 # auxilliary information returned from a previous run
1624 # Returns: 0 the commmand was executed inline, no subprocess was run
1625 # 1 a non-exim command was run and waited for
1626 # 2 an exim command was run and waited for
1627 # 3 a command was run and not waited for (daemon, server, exim_lock)
1628 # 4 EOF was encountered after an initial return code line
1629 # Optionally alse a second parameter, a hash-ref, with auxilliary information:
1630 # exim_pid: pid of a run process
1631 # munge: name of a post-script results munger
1634 my($testno) = $_[0];
1635 my($subtestref) = $_[1];
1636 my($commandnameref) = $_[3];
1637 my($aux_info) = $_[4];
1640 if (/^(\d+)\s*$/) # Handle unusual return code
1645 return 4 if !defined $_; # Missing command
1652 # Handle concatenated command lines
1655 while (substr($_, -1) eq"\\")
1658 $_ = substr($_, 0, -1);
1659 chomp($temp = <SCRIPT>);
1671 do_substitute($testno);
1672 if ($debug) { printf ">> $_\n"; }
1674 # Pass back the command name (for messages)
1676 ($$commandnameref) = /^(\S+)/;
1678 # Here follows code for handling the various different commands that are
1679 # supported by this script. The first group of commands are all freestanding
1680 # in that they share no common code and are not followed by any data lines.
1686 # The "dbmbuild" command runs exim_dbmbuild. This is used both to test the
1687 # utility and to make DBM files for testing DBM lookups.
1689 if (/^dbmbuild\s+(\S+)\s+(\S+)/)
1691 run_system("(./eximdir/exim_dbmbuild $parm_cwd/$1 $parm_cwd/$2;" .
1692 "echo exim_dbmbuild exit code = \$?)" .
1698 # The "dump" command runs exim_dumpdb. On different systems, the output for
1699 # some types of dump may appear in a different order because it's just hauled
1700 # out of the DBM file. We can solve this by sorting. Ignore the leading
1701 # date/time, as it will be flattened later during munging.
1703 if (/^dump\s+(\S+)/)
1707 print ">> ./eximdir/exim_dumpdb $parm_cwd/spool $which\n" if $debug;
1708 open(IN, "./eximdir/exim_dumpdb $parm_cwd/spool $which |");
1709 open(OUT, ">>test-stdout");
1710 print OUT "+++++++++++++++++++++++++++\n";
1712 if ($which eq "retry")
1719 my($aa) = split(' ', $a);
1720 my($bb) = split(' ', $b);
1724 foreach $item (@temp)
1726 $item =~ s/^\s*(.*)\n(.*)\n?\s*$/$1\n$2/m;
1727 print OUT " $item\n";
1733 if ($which eq "callout")
1736 my($aa) = substr $a, 21;
1737 my($bb) = substr $b, 21;
1750 # The "echo" command is a way of writing comments to the screen.
1752 if (/^echo\s+(.*)$/)
1759 # The "exim_lock" command runs exim_lock in the same manner as "server",
1760 # but it doesn't use any input.
1762 if (/^exim_lock\s+(.*)$/)
1764 $cmd = "./eximdir/exim_lock $1 >>test-stdout";
1765 $server_pid = open SERVERCMD, "|$cmd" ||
1766 tests_exit(-1, "Failed to run $cmd\n");
1768 # This gives the process time to get started; otherwise the next
1769 # process may not find it there when it expects it.
1771 select(undef, undef, undef, 0.1);
1776 # The "exinext" command runs exinext
1778 if (/^exinext\s+(.*)/)
1780 run_system("(./eximdir/exinext " .
1781 "-DEXIM_PATH=$parm_cwd/eximdir/exim " .
1782 "-C $parm_cwd/test-config $1;" .
1783 "echo exinext exit code = \$?)" .
1789 # The "exigrep" command runs exigrep on the current mainlog
1791 if (/^exigrep\s+(.*)/)
1793 run_system("(./eximdir/exigrep " .
1794 "$1 $parm_cwd/spool/log/mainlog;" .
1795 "echo exigrep exit code = \$?)" .
1801 # The "eximstats" command runs eximstats on the current mainlog
1803 if (/^eximstats\s+(.*)/)
1805 run_system("(./eximdir/eximstats " .
1806 "$1 $parm_cwd/spool/log/mainlog;" .
1807 "echo eximstats exit code = \$?)" .
1813 # The "gnutls" command makes a copy of saved GnuTLS parameter data in the
1814 # spool directory, to save Exim from re-creating it each time.
1818 my $gen_fn = "spool/gnutls-params-$gnutls_dh_bits_normal";
1819 run_system "sudo cp -p aux-fixed/gnutls-params $gen_fn;" .
1820 "sudo chown $parm_eximuser:$parm_eximgroup $gen_fn;" .
1821 "sudo chmod 0400 $gen_fn";
1826 # The "killdaemon" command should ultimately follow the starting of any Exim
1827 # daemon with the -bd option. We kill with SIGINT rather than SIGTERM to stop
1828 # it outputting "Terminated" to the terminal when not in the background.
1832 my $return_extra = {};
1833 if (exists $aux_info->{exim_pid})
1835 $pid = $aux_info->{exim_pid};
1836 $return_extra->{exim_pid} = undef;
1837 print ">> killdaemon: recovered pid $pid\n" if $debug;
1840 run_system("sudo /bin/kill -INT $pid");
1844 $pid = `cat $parm_cwd/spool/exim-daemon.*`;
1847 run_system("sudo /bin/kill -INT $pid");
1848 close DAEMONCMD; # Waits for process
1851 run_system("sudo /bin/rm -f spool/exim-daemon.*");
1852 return (1, $return_extra);
1856 # The "millisleep" command is like "sleep" except that its argument is in
1857 # milliseconds, thus allowing for a subsecond sleep, which is, in fact, all it
1860 elsif (/^millisleep\s+(.*)$/)
1862 select(undef, undef, undef, $1/1000);
1867 # The "munge" command selects one of a hardwired set of test-result modifications
1868 # to be made before result compares are run agains the golden set. This lets
1869 # us account for test-system dependent things which only affect a few, but known,
1871 # Currently only the last munge takes effect.
1873 if (/^munge\s+(.*)$/)
1875 return (0, { munge => $1 });
1879 # The "sleep" command does just that. For sleeps longer than 1 second we
1880 # tell the user what's going on.
1882 if (/^sleep\s+(.*)$/)
1890 printf(" Test %d sleep $1 ", $$subtestref);
1896 printf("\r Test %d $cr", $$subtestref);
1902 # Various Unix management commands are recognized
1904 if (/^(ln|ls|du|mkdir|mkfifo|touch|cp|cat)\s/ ||
1905 /^sudo (rmdir|rm|chown|chmod)\s/)
1907 run_system("$_ >>test-stdout 2>>test-stderr");
1916 # The next group of commands are also freestanding, but they are all followed
1920 # The "server" command starts up a script-driven server that runs in parallel
1921 # with the following exim command. Therefore, we want to run a subprocess and
1922 # not yet wait for it to complete. The waiting happens after the next exim
1923 # command, triggered by $server_pid being non-zero. The server sends its output
1924 # to a different file. The variable $server_opts, if not empty, contains
1925 # options to disable IPv4 or IPv6 if necessary.
1927 if (/^server\s+(.*)$/)
1929 $cmd = "./bin/server $server_opts $1 >>test-stdout-server";
1930 print ">> $cmd\n" if ($debug);
1931 $server_pid = open SERVERCMD, "|$cmd" || tests_exit(-1, "Failed to run $cmd");
1932 SERVERCMD->autoflush(1);
1933 print ">> Server pid is $server_pid\n" if $debug;
1937 last if /^\*{4}\s*$/;
1940 print SERVERCMD "++++\n"; # Send end to server; can't send EOF yet
1941 # because close() waits for the process.
1943 # This gives the server time to get started; otherwise the next
1944 # process may not find it there when it expects it.
1946 select(undef, undef, undef, 0.5);
1951 # The "write" command is a way of creating files of specific sizes for
1952 # buffering tests, or containing specific data lines from within the script
1953 # (rather than hold lots of little files). The "catwrite" command does the
1954 # same, but it also copies the lines to test-stdout.
1956 if (/^(cat)?write\s+(\S+)(?:\s+(.*))?\s*$/)
1958 my($cat) = defined $1;
1960 @sizes = split /\s+/, $3 if defined $3;
1961 open FILE, ">$2" || tests_exit(-1, "Failed to open \"$2\": $!");
1965 open CAT, ">>test-stdout" ||
1966 tests_exit(-1, "Failed to open test-stdout: $!");
1967 print CAT "==========\n";
1970 if (scalar @sizes > 0)
1977 last if /^\+{4}\s*$/;
1984 while (scalar @sizes > 0)
1986 ($count,$len,$leadin) = (shift @sizes) =~ /(\d+)x(\d+)(?:=(.*))?/;
1987 $leadin = "" if !defined $leadin;
1989 $len -= length($leadin) + 1;
1990 while ($count-- > 0)
1992 print FILE $leadin, "a" x $len, "\n";
1993 print CAT $leadin, "a" x $len, "\n" if $cat;
1998 # Post data, or only data if no sized data
2003 last if /^\*{4}\s*$/;
2011 print CAT "==========\n";
2022 # From this point on, script commands are implemented by setting up a shell
2023 # command in the variable $cmd. Shared code to run this command and handle its
2024 # input and output follows.
2026 # The "client", "client-gnutls", and "client-ssl" commands run a script-driven
2027 # program that plays the part of an email client. We also have the availability
2028 # of running Perl for doing one-off special things. Note that all these
2029 # commands expect stdin data to be supplied.
2031 if (/^client/ || /^(sudo\s+)?perl\b/)
2033 s"client"./bin/client";
2034 $cmd = "$_ >>test-stdout 2>>test-stderr";
2037 # For the "exim" command, replace the text "exim" with the path for the test
2038 # binary, plus -D options to pass over various parameters, and a -C option for
2039 # the testing configuration file. When running in the test harness, Exim does
2040 # not drop privilege when -C and -D options are present. To run the exim
2041 # command as root, we use sudo.
2043 elsif (/^([A-Z_]+=\S+\s+)?(\d+)?\s*(sudo\s+)?exim(_\S+)?\s+(.*)$/)
2046 my($envset) = (defined $1)? $1 : "";
2047 my($sudo) = (defined $3)? "sudo " : "";
2048 my($special)= (defined $4)? $4 : "";
2049 $wait_time = (defined $2)? $2 : 0;
2051 # Return 2 rather than 1 afterwards
2055 # Update the test number
2057 $$subtestref = $$subtestref + 1;
2058 printf(" Test %d $cr", $$subtestref);
2060 # Copy the configuration file, making the usual substitutions.
2062 open (IN, "$parm_cwd/confs/$testno") ||
2063 tests_exit(-1, "Couldn't open $parm_cwd/confs/$testno: $!\n");
2064 open (OUT, ">test-config") ||
2065 tests_exit(-1, "Couldn't open test-config: $!\n");
2068 do_substitute($testno);
2074 # The string $msg1 in args substitutes the message id of the first
2075 # message on the queue, and so on. */
2077 if ($args =~ /\$msg/)
2079 my($listcmd) = "$parm_cwd/eximdir/exim -bp " .
2080 "-DEXIM_PATH=$parm_cwd/eximdir/exim " .
2081 "-C $parm_cwd/test-config |";
2082 print ">> Getting queue list from:\n>> $listcmd\n" if ($debug);
2083 open (QLIST, $listcmd) || tests_exit(-1, "Couldn't run \"exim -bp\": $!\n");
2085 while (<QLIST>) { push (@msglist, $1) if /^\s*\d+[smhdw]\s+\S+\s+(\S+)/; }
2088 # Done backwards just in case there are more than 9
2091 for ($i = @msglist; $i > 0; $i--) { $args =~ s/\$msg$i/$msglist[$i-1]/g; }
2092 if ( $args =~ /\$msg\d/ )
2094 tests_exit(-1, "Not enough messages in spool, for test $testno line $lineno\n")
2095 unless $force_continue;
2099 # If -d is specified in $optargs, remove it from $args; i.e. let
2100 # the command line for runtest override. Then run Exim.
2102 $args =~ s/(?:^|\s)-d\S*// if $optargs =~ /(?:^|\s)-d/;
2104 $cmd = "$envset$sudo$parm_cwd/eximdir/exim$special$optargs " .
2105 "-DEXIM_PATH=$parm_cwd/eximdir/exim$special " .
2106 "-C $parm_cwd/test-config $args " .
2107 ">>test-stdout 2>>test-stderr";
2109 # If the command is starting an Exim daemon, we run it in the same
2110 # way as the "server" command above, that is, we don't want to wait
2111 # for the process to finish. That happens when "killdaemon" is obeyed later
2112 # in the script. We also send the stderr output to test-stderr-server. The
2113 # daemon has its log files put in a different place too (by configuring with
2114 # log_file_path). This requires the directory to be set up in advance.
2116 # There are also times when we want to run a non-daemon version of Exim
2117 # (e.g. a queue runner) with the server configuration. In this case,
2118 # we also define -DNOTDAEMON.
2120 if ($cmd =~ /\s-DSERVER=server\s/ && $cmd !~ /\s-DNOTDAEMON\s/)
2122 if ($debug) { printf ">> daemon: $cmd\n"; }
2123 run_system("sudo mkdir spool/log 2>/dev/null");
2124 run_system("sudo chown $parm_eximuser:$parm_eximgroup spool/log");
2126 # Before running the command, convert the -bd option into -bdf so that an
2127 # Exim daemon doesn't double fork. This means that when we wait close
2128 # DAEMONCMD, it waits for the correct process. Also, ensure that the pid
2129 # file is written to the spool directory, in case the Exim binary was
2130 # built with PID_FILE_PATH pointing somewhere else.
2132 $cmd =~ s!\s-bd\s! -bdf -oP $parm_cwd/spool/exim-daemon.pid !;
2133 print ">> |${cmd}-server\n" if ($debug);
2134 open DAEMONCMD, "|${cmd}-server" || tests_exit(-1, "Failed to run $cmd");
2135 DAEMONCMD->autoflush(1);
2136 while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; } # Ignore any input
2137 select(undef, undef, undef, 0.3); # Let the daemon get going
2138 return 3; # Don't wait
2140 elsif ($cmd =~ /\s-DSERVER=wait:(\d+)\s/)
2142 my $listen_port = $1;
2143 my $waitmode_sock = new FileHandle;
2144 if ($debug) { printf ">> wait-mode daemon: $cmd\n"; }
2145 run_system("sudo mkdir spool/log 2>/dev/null");
2146 run_system("sudo chown $parm_eximuser:$parm_eximgroup spool/log");
2148 my ($s_ip,$s_port) = ('127.0.0.1', $listen_port);
2149 my $sin = sockaddr_in($s_port, inet_aton($s_ip))
2150 or die "** Failed packing $s_ip:$s_port\n";
2151 socket($waitmode_sock, PF_INET, SOCK_STREAM, getprotobyname('tcp'))
2152 or die "** Unable to open socket $s_ip:$s_port: $!\n";
2153 setsockopt($waitmode_sock, SOL_SOCKET, SO_REUSEADDR, 1)
2154 or die "** Unable to setsockopt(SO_REUSEADDR): $!\n";
2155 bind($waitmode_sock, $sin)
2156 or die "** Unable to bind socket ($s_port): $!\n";
2157 listen($waitmode_sock, 5);
2159 if (not defined $pid) { die "** fork failed: $!\n" }
2162 open(STDIN, "<&", $waitmode_sock) or die "** dup sock to stdin failed: $!\n";
2163 close($waitmode_sock);
2164 print "[$$]>> ${cmd}-server\n" if ($debug);
2165 exec "exec ${cmd}-server";
2168 while (<SCRIPT>) { $lineno++; last if /^\*{4}\s*$/; } # Ignore any input
2169 select(undef, undef, undef, 0.3); # Let the daemon get going
2170 return (3, { exim_pid => $pid }); # Don't wait
2177 else { tests_exit(-1, "Command unrecognized in line $lineno: $_"); }
2180 # Run the command, with stdin connected to a pipe, and write the stdin data
2181 # to it, with appropriate substitutions. If a line ends with \NONL\, chop off
2182 # the terminating newline (and the \NONL\). If the command contains
2183 # -DSERVER=server add "-server" to the command, where it will adjoin the name
2184 # for the stderr file. See comment above about the use of -DSERVER.
2186 $stderrsuffix = ($cmd =~ /\s-DSERVER=server\s/)? "-server" : "";
2187 print ">> |${cmd}${stderrsuffix}\n" if ($debug);
2188 open CMD, "|${cmd}${stderrsuffix}" || tests_exit(1, "Failed to run $cmd");
2194 last if /^\*{4}\s*$/;
2195 do_substitute($testno);
2196 if (/^(.*)\\NONL\\\s*$/) { print CMD $1; } else { print CMD; }
2199 # For timeout tests, wait before closing the pipe; we expect a
2200 # SIGPIPE error in this case.
2204 printf(" Test %d sleep $wait_time ", $$subtestref);
2205 while ($wait_time-- > 0)
2210 printf("\r Test %d $cr", $$subtestref);
2213 $sigpipehappened = 0;
2214 close CMD; # Waits for command to finish
2215 return $yield; # Ran command and waited
2221 ###############################################################################
2222 ###############################################################################
2224 # Here beginneth the Main Program ...
2226 ###############################################################################
2227 ###############################################################################
2231 print "Exim tester $testversion\n";
2233 # extend the PATH with .../sbin
2234 # we map all (.../bin) to (.../sbin:.../bin)
2236 my %seen = map { $_, 1 } split /:/, $ENV{PATH};
2237 join ':' => map { m{(.*)/bin$}
2238 ? ( $seen{"$1/sbin"} ? () : ("$1/sbin"), $_)
2240 split /:/, $ENV{PATH};
2243 ##################################################
2244 # Some tests check created file modes #
2245 ##################################################
2250 ##################################################
2251 # Check for the "less" command #
2252 ##################################################
2254 $more = "more" if system("which less >/dev/null 2>&1") != 0;
2258 ##################################################
2259 # Check for sudo access to root #
2260 ##################################################
2262 print "You need to have sudo access to root to run these tests. Checking ...\n";
2263 if (system("sudo date >/dev/null") != 0)
2265 die "** Test for sudo failed: testing abandoned.\n";
2269 print "Test for sudo OK\n";
2274 ##################################################
2275 # See if an Exim binary has been given #
2276 ##################################################
2278 # If the first character of the first argument is '/', the argument is taken
2279 # as the path to the binary. If the first argument does not start with a
2280 # '/' but exists in the file system, it's assumed to be the Exim binary.
2282 $parm_exim = (@ARGV > 0 && (-x $ARGV[0] or $ARGV[0] =~ m?^/?))? Cwd::abs_path(shift @ARGV) : "";
2283 print "Exim binary is $parm_exim\n" if $parm_exim ne "";
2287 ##################################################
2288 # Sort out options and which tests are to be run #
2289 ##################################################
2291 # There are a few possible options for the test script itself; after these, any
2292 # options are passed on to Exim calls within the tests. Typically, this is used
2293 # to turn on Exim debugging while setting up a test.
2295 while (@ARGV > 0 && $ARGV[0] =~ /^-/)
2297 my($arg) = shift @ARGV;
2300 if ($arg eq "-DEBUG") { $debug = 1; $cr = "\n"; next; }
2301 if ($arg eq "-DIFF") { $cf = "diff -u"; next; }
2302 if ($arg eq "-CONTINUE"){$force_continue = 1;
2305 if ($arg eq "-UPDATE") { $force_update = 1; next; }
2306 if ($arg eq "-NOIPV4") { $have_ipv4 = 0; next; }
2307 if ($arg eq "-NOIPV6") { $have_ipv6 = 0; next; }
2308 if ($arg eq "-KEEP") { $save_output = 1; next; }
2309 if ($arg =~ /^-FLAVOU?R$/) { $flavour = shift; next; }
2311 $optargs .= " $arg";
2314 # Any subsequent arguments are a range of test numbers.
2318 $test_end = $test_start = $ARGV[0];
2319 $test_end = $ARGV[1] if (@ARGV > 1);
2320 $test_end = ($test_start >= 9000)? $test_special_top : $test_top
2321 if $test_end eq "+";
2322 die "** Test numbers out of order\n" if ($test_end < $test_start);
2326 ##################################################
2327 # Make the command's directory current #
2328 ##################################################
2330 # After doing so, we find its absolute path name.
2333 $cwd = '.' if ($cwd !~ s|/[^/]+$||);
2334 chdir($cwd) || die "** Failed to chdir to \"$cwd\": $!\n";
2335 $parm_cwd = Cwd::getcwd();
2338 ##################################################
2339 # Search for an Exim binary to test #
2340 ##################################################
2342 # If an Exim binary hasn't been provided, try to find one. We can handle the
2343 # case where exim-testsuite is installed alongside Exim source directories. For
2344 # PH's private convenience, if there's a directory just called "exim4", that
2345 # takes precedence; otherwise exim-snapshot takes precedence over any numbered
2348 if ($parm_exim eq "")
2350 my($use_srcdir) = "";
2352 opendir DIR, ".." || die "** Failed to opendir \"..\": $!\n";
2353 while ($f = readdir(DIR))
2357 # Try this directory if it is "exim4" or if it is exim-snapshot or exim-n.m
2358 # possibly followed by -RCx where n.m is greater than any previously tried
2359 # directory. Thus, we should choose the highest version of Exim that has
2362 if ($f eq "exim4" || $f eq "exim-snapshot")
2366 if ($f =~ /^exim-\d+\.\d+(-RC\d+)?$/ && $f gt $use_srcdir); }
2368 # Look for a build directory with a binary in it. If we find a binary,
2369 # accept this source directory.
2373 opendir SRCDIR, "../$srcdir" ||
2374 die "** Failed to opendir \"$cwd/../$srcdir\": $!\n";
2375 while ($f = readdir(SRCDIR))
2377 if ($f =~ /^build-/ && -e "../$srcdir/$f/exim")
2379 $use_srcdir = $srcdir;
2380 $parm_exim = "$cwd/../$srcdir/$f/exim";
2381 $parm_exim =~ s'/[^/]+/\.\./'/';
2388 # If we have found "exim4" or "exim-snapshot", that takes precedence.
2389 # Otherwise, continue to see if there's a later version.
2391 last if $use_srcdir eq "exim4" || $use_srcdir eq "exim-snapshot";
2394 print "Exim binary found in $parm_exim\n" if $parm_exim ne "";
2397 # If $parm_exim is still empty, ask the caller
2399 if ($parm_exim eq "")
2401 print "** Did not find an Exim binary to test\n";
2402 for ($i = 0; $i < 5; $i++)
2405 print "** Enter pathname for Exim binary: ";
2406 chomp($trybin = <STDIN>);
2409 $parm_exim = $trybin;
2414 print "** $trybin does not exist\n";
2417 die "** Too many tries\n" if $parm_exim eq "";
2422 ##################################################
2423 # Find what is in the binary #
2424 ##################################################
2426 # deal with TRUSTED_CONFIG_LIST restrictions
2427 unlink("$parm_cwd/test-config") if -e "$parm_cwd/test-config";
2428 symlink("$parm_cwd/confs/0000", "$parm_cwd/test-config")
2429 or die "Unable to link initial config into place: $!\n";
2431 print("Probing with config file: $parm_cwd/test-config\n");
2432 open(EXIMINFO, "$parm_exim -d -C $parm_cwd/test-config -DDIR=$parm_cwd " .
2433 "-bP exim_user exim_group 2>&1|") ||
2434 die "** Cannot run $parm_exim: $!\n";
2437 $parm_eximuser = $1 if /^exim_user = (.*)$/;
2438 $parm_eximgroup = $1 if /^exim_group = (.*)$/;
2439 $parm_trusted_config_list = $1 if /^TRUSTED_CONFIG_LIST:.*?"(.*?)"$/;
2443 if (defined $parm_eximuser)
2445 if ($parm_eximuser =~ /^\d+$/) { $parm_exim_uid = $parm_eximuser; }
2446 else { $parm_exim_uid = getpwnam($parm_eximuser); }
2450 print "Unable to extract exim_user from binary.\n";
2451 print "Check if Exim refused to run; if so, consider:\n";
2452 print " TRUSTED_CONFIG_LIST ALT_CONFIG_PREFIX WHITELIST_D_MACROS\n";
2453 die "Failing to get information from binary.\n";
2456 if (defined $parm_eximgroup)
2458 if ($parm_eximgroup =~ /^\d+$/) { $parm_exim_gid = $parm_eximgroup; }
2459 else { $parm_exim_gid = getgrnam($parm_eximgroup); }
2462 # check the permissions on the TRUSTED_CONFIG_LIST
2463 if (defined $parm_trusted_config_list)
2465 die "TRUSTED_CONFIG_LIST: $parm_trusted_config_list: $!\n"
2466 if not -f $parm_trusted_config_list;
2468 die "TRUSTED_CONFIG_LIST $parm_trusted_config_list must not be world writable!\n"
2469 if 02 & (stat _)[2];
2471 die sprintf "TRUSTED_CONFIG_LIST: $parm_trusted_config_list %d is group writable, but not owned by group '%s' or '%s'.\n",
2473 scalar(getgrgid 0), scalar(getgrgid $>)
2474 if (020 & (stat _)[2]) and not ((stat _)[5] == $> or (stat _)[5] == 0);
2476 die sprintf "TRUSTED_CONFIG_LIST: $parm_trusted_config_list is not owned by user '%s' or '%s'.\n",
2477 scalar(getpwuid 0), scalar(getpwuid $>)
2478 if (not (-o _ or (stat _)[4] == 0));
2480 open(TCL, $parm_trusted_config_list) or die "Can't open $parm_trusted_config_list: $!\n";
2481 my $test_config = getcwd() . '/test-config';
2482 die "Can't find '$test_config' in TRUSTED_CONFIG_LIST $parm_trusted_config_list."
2483 if not grep { /^$test_config$/ } <TCL>;
2487 die "Unable to check the TRUSTED_CONFIG_LIST, seems to be empty?\n";
2490 open(EXIMINFO, "$parm_exim -bV -C $parm_cwd/test-config -DDIR=$parm_cwd |") ||
2491 die "** Cannot run $parm_exim: $!\n";
2493 print "-" x 78, "\n";
2499 if (/^Exim version/) { print; }
2501 elsif (/^Size of off_t: (\d+)/)
2504 $have_largefiles = 1 if $1 > 4;
2505 die "** Size of off_t > 32 which seems improbable, not running tests\n"
2509 elsif (/^Support for: (.*)/)
2512 @temp = split /(\s+)/, $1;
2514 %parm_support = @temp;
2517 elsif (/^Lookups \(built-in\): (.*)/)
2520 @temp = split /(\s+)/, $1;
2522 %parm_lookups = @temp;
2525 elsif (/^Authenticators: (.*)/)
2528 @temp = split /(\s+)/, $1;
2530 %parm_authenticators = @temp;
2533 elsif (/^Routers: (.*)/)
2536 @temp = split /(\s+)/, $1;
2538 %parm_routers = @temp;
2541 # Some transports have options, e.g. appendfile/maildir. For those, ensure
2542 # that the basic transport name is set, and then the name with each of the
2545 elsif (/^Transports: (.*)/)
2548 @temp = split /(\s+)/, $1;
2551 %parm_transports = @temp;
2552 foreach $k (keys %parm_transports)
2556 @temp = split /\//, $k;
2557 $parm_transports{"$temp[0]"} = " ";
2558 for ($i = 1; $i < @temp; $i++)
2559 { $parm_transports{"$temp[0]/$temp[$i]"} = " "; }
2565 print "-" x 78, "\n";
2567 unlink("$parm_cwd/test-config");
2569 ##################################################
2570 # Check for SpamAssassin and ClamAV #
2571 ##################################################
2573 # These are crude tests. If they aren't good enough, we'll have to improve
2574 # them, for example by actually passing a message through spamc or clamscan.
2576 if (defined $parm_support{'Content_Scanning'})
2578 my $sock = new FileHandle;
2580 if (system("spamc -h 2>/dev/null >/dev/null") == 0)
2582 print "The spamc command works:\n";
2584 # This test for an active SpamAssassin is courtesy of John Jetmore.
2585 # The tests are hard coded to localhost:783, so no point in making
2586 # this test flexible like the clamav test until the test scripts are
2587 # changed. spamd doesn't have the nice PING/PONG protoccol that
2588 # clamd does, but it does respond to errors in an informative manner,
2591 my($sint,$sport) = ('127.0.0.1',783);
2594 my $sin = sockaddr_in($sport, inet_aton($sint))
2595 or die "** Failed packing $sint:$sport\n";
2596 socket($sock, PF_INET, SOCK_STREAM, getprotobyname('tcp'))
2597 or die "** Unable to open socket $sint:$sport\n";
2600 sub { die "** Timeout while connecting to socket $sint:$sport\n"; };
2602 connect($sock, $sin)
2603 or die "** Unable to connect to socket $sint:$sport\n";
2606 select((select($sock), $| = 1)[0]);
2607 print $sock "bad command\r\n";
2610 sub { die "** Timeout while reading from socket $sint:$sport\n"; };
2616 or die "** Did not get SPAMD from socket $sint:$sport. "
2623 print " Assume SpamAssassin (spamd) is not running\n";
2627 $parm_running{'SpamAssassin'} = ' ';
2628 print " SpamAssassin (spamd) seems to be running\n";
2633 print "The spamc command failed: assume SpamAssassin (spamd) is not running\n";
2636 # For ClamAV, we need to find the clamd socket for use in the Exim
2637 # configuration. Search for the clamd configuration file.
2639 if (system("clamscan -h 2>/dev/null >/dev/null") == 0)
2641 my($f, $clamconf, $test_prefix);
2643 print "The clamscan command works";
2645 $test_prefix = $ENV{EXIM_TEST_PREFIX};
2646 $test_prefix = "" if !defined $test_prefix;
2648 foreach $f ("$test_prefix/etc/clamd.conf",
2649 "$test_prefix/usr/local/etc/clamd.conf",
2650 "$test_prefix/etc/clamav/clamd.conf", "")
2659 # Read the ClamAV configuration file and find the socket interface.
2661 if ($clamconf ne "")
2664 open(IN, "$clamconf") || die "\n** Unable to open $clamconf: $!\n";
2667 if (/^LocalSocket\s+(.*)/)
2669 $parm_clamsocket = $1;
2670 $socket_domain = AF_UNIX;
2673 if (/^TCPSocket\s+(\d+)/)
2675 if (defined $parm_clamsocket)
2677 $parm_clamsocket .= " $1";
2678 $socket_domain = AF_INET;
2683 $parm_clamsocket = " $1";
2686 elsif (/^TCPAddr\s+(\S+)/)
2688 if (defined $parm_clamsocket)
2690 $parm_clamsocket = $1 . $parm_clamsocket;
2691 $socket_domain = AF_INET;
2696 $parm_clamsocket = $1;
2702 if (defined $socket_domain)
2704 print ":\n The clamd socket is $parm_clamsocket\n";
2705 # This test for an active ClamAV is courtesy of Daniel Tiefnig.
2709 if ($socket_domain == AF_UNIX)
2711 $socket = sockaddr_un($parm_clamsocket) or die "** Failed packing '$parm_clamsocket'\n";
2713 elsif ($socket_domain == AF_INET)
2715 my ($ca_host, $ca_port) = split(/\s+/,$parm_clamsocket);
2716 my $ca_hostent = gethostbyname($ca_host) or die "** Failed to get raw address for host '$ca_host'\n";
2717 $socket = sockaddr_in($ca_port, $ca_hostent) or die "** Failed packing '$parm_clamsocket'\n";
2721 die "** Unknown socket domain '$socket_domain' (should not happen)\n";
2723 socket($sock, $socket_domain, SOCK_STREAM, 0) or die "** Unable to open socket '$parm_clamsocket'\n";
2724 local $SIG{ALRM} = sub { die "** Timeout while connecting to socket '$parm_clamsocket'\n"; };
2726 connect($sock, $socket) or die "** Unable to connect to socket '$parm_clamsocket'\n";
2729 my $ofh = select $sock; $| = 1; select $ofh;
2730 print $sock "PING\n";
2732 $SIG{ALRM} = sub { die "** Timeout while reading from socket '$parm_clamsocket'\n"; };
2737 $res =~ /PONG/ or die "** Did not get PONG from socket '$parm_clamsocket'. It said: $res\n";
2744 print " Assume ClamAV is not running\n";
2748 $parm_running{'ClamAV'} = ' ';
2749 print " ClamAV seems to be running\n";
2754 print ", but the socket for clamd could not be determined\n";
2755 print "Assume ClamAV is not running\n";
2761 print ", but I can't find a configuration for clamd\n";
2762 print "Assume ClamAV is not running\n";
2768 ##################################################
2769 # Test for the basic requirements #
2770 ##################################################
2772 # This test suite assumes that Exim has been built with at least the "usual"
2773 # set of routers, transports, and lookups. Ensure that this is so.
2777 $missing .= " Lookup: lsearch\n" if (!defined $parm_lookups{'lsearch'});
2779 $missing .= " Router: accept\n" if (!defined $parm_routers{'accept'});
2780 $missing .= " Router: dnslookup\n" if (!defined $parm_routers{'dnslookup'});
2781 $missing .= " Router: manualroute\n" if (!defined $parm_routers{'manualroute'});
2782 $missing .= " Router: redirect\n" if (!defined $parm_routers{'redirect'});
2784 $missing .= " Transport: appendfile\n" if (!defined $parm_transports{'appendfile'});
2785 $missing .= " Transport: autoreply\n" if (!defined $parm_transports{'autoreply'});
2786 $missing .= " Transport: pipe\n" if (!defined $parm_transports{'pipe'});
2787 $missing .= " Transport: smtp\n" if (!defined $parm_transports{'smtp'});
2792 print "** Many features can be included or excluded from Exim binaries.\n";
2793 print "** This test suite requires that Exim is built to contain a certain\n";
2794 print "** set of basic facilities. It seems that some of these are missing\n";
2795 print "** from the binary that is under test, so the test cannot proceed.\n";
2796 print "** The missing facilities are:\n";
2798 die "** Test script abandoned\n";
2802 ##################################################
2803 # Check for the auxiliary programs #
2804 ##################################################
2806 # These are always required:
2808 for $prog ("cf", "checkaccess", "client", "client-ssl", "client-gnutls",
2809 "fakens", "iefbr14", "server")
2811 next if ($prog eq "client-ssl" && !defined $parm_support{'OpenSSL'});
2812 next if ($prog eq "client-gnutls" && !defined $parm_support{'GnuTLS'});
2813 if (!-e "bin/$prog")
2816 print "** bin/$prog does not exist. Have you run ./configure and make?\n";
2817 die "** Test script abandoned\n";
2821 # If the "loaded" binary is missing, we cut out tests for ${dlfunc. It isn't
2822 # compiled on systems where we don't know how to. However, if Exim does not
2823 # have that functionality compiled, we needn't bother.
2825 $dlfunc_deleted = 0;
2826 if (defined $parm_support{'Expand_dlfunc'} && !-e "bin/loaded")
2828 delete $parm_support{'Expand_dlfunc'};
2829 $dlfunc_deleted = 1;
2833 ##################################################
2834 # Find environmental details #
2835 ##################################################
2837 # Find the caller of this program.
2839 ($parm_caller,$pwpw,$parm_caller_uid,$parm_caller_gid,$pwquota,$pwcomm,
2840 $parm_caller_gecos, $parm_caller_home) = getpwuid($>);
2842 $pwpw = $pwpw; # Kill Perl warnings
2843 $pwquota = $pwquota;
2846 $parm_caller_group = getgrgid($parm_caller_gid);
2848 print "Program caller is $parm_caller ($parm_caller_uid), whose group is $parm_caller_group ($parm_caller_gid)\n";
2849 print "Home directory is $parm_caller_home\n";
2851 unless (defined $parm_eximgroup)
2853 print "Unable to derive \$parm_eximgroup.\n";
2854 die "** ABANDONING.\n";
2857 print "You need to be in the Exim group to run these tests. Checking ...";
2859 if (`groups` =~ /\b\Q$parm_eximgroup\E\b/)
2865 print "\nOh dear, you are not in the Exim group.\n";
2866 die "** Testing abandoned.\n";
2869 # Find this host's IP addresses - there may be many, of course, but we keep
2870 # one of each type (IPv4 and IPv6).
2878 open(IFCONFIG, "ifconfig -a|") || die "** Cannot run \"ifconfig\": $!\n";
2879 while (($parm_ipv4 eq "" || $parm_ipv6 eq "") && ($_ = <IFCONFIG>))
2882 if ($parm_ipv4 eq "" &&
2883 $_ =~ /^\s*inet(?:\saddr)?:?\s?(\d+\.\d+\.\d+\.\d+)\s/i)
2886 next if ($ip =~ /^127\./);
2890 if ($parm_ipv6 eq "" &&
2891 $_ =~ /^\s*inet6(?:\saddr)?:?\s?([abcdef\d:]+)/i)
2894 next if ($ip eq "::1" || $ip =~ /^fe80/i);
2900 # Use private IP addresses if there are no public ones.
2902 $parm_ipv4 = $local_ipv4 if ($parm_ipv4 eq "");
2903 $parm_ipv6 = $local_ipv6 if ($parm_ipv6 eq "");
2905 # If either type of IP address is missing, we need to set the value to
2906 # something other than empty, because that wrecks the substitutions. The value
2907 # is reflected, so use a meaningful string. Set appropriate options for the
2908 # "server" command. In practice, however, many tests assume 127.0.0.1 is
2909 # available, so things will go wrong if there is no IPv4 address. The lack
2910 # of IPV4 or IPv6 can be simulated by command options, which force $have_ipv4
2911 # and $have_ipv6 false.
2913 if ($parm_ipv4 eq "")
2916 $parm_ipv4 = "<no IPv4 address found>";
2917 $server_opts .= " -noipv4";
2919 elsif ($have_ipv4 == 0)
2921 $parm_ipv4 = "<IPv4 testing disabled>";
2922 $server_opts .= " -noipv4";
2926 $parm_running{"IPv4"} = " ";
2929 if ($parm_ipv6 eq "")
2932 $parm_ipv6 = "<no IPv6 address found>";
2933 $server_opts .= " -noipv6";
2934 delete($parm_support{"IPv6"});
2936 elsif ($have_ipv6 == 0)
2938 $parm_ipv6 = "<IPv6 testing disabled>";
2939 $server_opts .= " -noipv6";
2940 delete($parm_support{"IPv6"});
2942 elsif (!defined $parm_support{'IPv6'})
2945 $parm_ipv6 = "<no IPv6 support in Exim binary>";
2946 $server_opts .= " -noipv6";
2950 $parm_running{"IPv6"} = " ";
2953 print "IPv4 address is $parm_ipv4\n";
2954 print "IPv6 address is $parm_ipv6\n";
2956 # For munging test output, we need the reversed IP addresses.
2958 $parm_ipv4r = ($parm_ipv4 !~ /^\d/)? "" :
2959 join(".", reverse(split /\./, $parm_ipv4));
2961 $parm_ipv6r = $parm_ipv6; # Appropriate if not in use
2962 if ($parm_ipv6 =~ /^[\da-f]/)
2964 my(@comps) = split /:/, $parm_ipv6;
2966 foreach $comp (@comps)
2968 push @nibbles, sprintf("%lx", hex($comp) >> 8);
2969 push @nibbles, sprintf("%lx", hex($comp) & 0xff);
2971 $parm_ipv6r = join(".", reverse(@nibbles));
2974 # Find the host name, fully qualified.
2976 chomp($temp = `hostname`);
2977 $parm_hostname = (gethostbyname($temp))[0];
2978 $parm_hostname = "no.host.name.found" if $parm_hostname eq "";
2979 print "Hostname is $parm_hostname\n";
2981 if ($parm_hostname !~ /\./)
2983 print "\n*** Host name is not fully qualified: this may cause problems ***\n\n";
2986 if ($parm_hostname =~ /[[:upper:]]/)
2988 print "\n*** Host name has upper case characters: this may cause problems ***\n\n";
2993 ##################################################
2994 # Create a testing version of Exim #
2995 ##################################################
2997 # We want to be able to run Exim with a variety of configurations. Normally,
2998 # the use of -C to change configuration causes Exim to give up its root
2999 # privilege (unless the caller is exim or root). For these tests, we do not
3000 # want this to happen. Also, we want Exim to know that it is running in its
3003 # We achieve this by copying the binary and patching it as we go. The new
3004 # binary knows it is a testing copy, and it allows -C and -D without loss of
3005 # privilege. Clearly, this file is dangerous to have lying around on systems
3006 # where there are general users with login accounts. To protect against this,
3007 # we put the new binary in a special directory that is accessible only to the
3008 # caller of this script, who is known to have sudo root privilege from the test
3009 # that was done above. Furthermore, we ensure that the binary is deleted at the
3010 # end of the test. First ensure the directory exists.
3013 { unlink "eximdir/exim"; } # Just in case
3016 mkdir("eximdir", 0710) || die "** Unable to mkdir $parm_cwd/eximdir: $!\n";
3017 system("sudo chgrp $parm_eximgroup eximdir");
3020 # The construction of the patched binary must be done as root, so we use
3021 # a separate script. As well as indicating that this is a test-harness binary,
3022 # the version number is patched to "x.yz" so that its length is always the
3023 # same. Otherwise, when it appears in Received: headers, it affects the length
3024 # of the message, which breaks certain comparisons.
3026 die "** Unable to make patched exim: $!\n"
3027 if (system("sudo ./patchexim $parm_exim") != 0);
3029 # From this point on, exits from the program must go via the subroutine
3030 # tests_exit(), so that suitable cleaning up can be done when required.
3031 # Arrange to catch interrupting signals, to assist with this.
3033 $SIG{'INT'} = \&inthandler;
3034 $SIG{'PIPE'} = \&pipehandler;
3036 # For some tests, we need another copy of the binary that is setuid exim rather
3039 system("sudo cp eximdir/exim eximdir/exim_exim;" .
3040 "sudo chown $parm_eximuser eximdir/exim_exim;" .
3041 "sudo chgrp $parm_eximgroup eximdir/exim_exim;" .
3042 "sudo chmod 06755 eximdir/exim_exim");
3045 ##################################################
3046 # Make copies of utilities we might need #
3047 ##################################################
3049 # Certain of the tests make use of some of Exim's utilities. We do not need
3050 # to be root to copy these.
3052 ($parm_exim_dir) = $parm_exim =~ m?^(.*)/exim?;
3054 $dbm_build_deleted = 0;
3055 if (defined $parm_lookups{'dbm'} &&
3056 system("cp $parm_exim_dir/exim_dbmbuild eximdir") != 0)
3058 delete $parm_lookups{'dbm'};
3059 $dbm_build_deleted = 1;
3062 if (system("cp $parm_exim_dir/exim_dumpdb eximdir") != 0)
3064 tests_exit(-1, "Failed to make a copy of exim_dumpdb: $!");
3067 if (system("cp $parm_exim_dir/exim_lock eximdir") != 0)
3069 tests_exit(-1, "Failed to make a copy of exim_lock: $!");
3072 if (system("cp $parm_exim_dir/exinext eximdir") != 0)
3074 tests_exit(-1, "Failed to make a copy of exinext: $!");
3077 if (system("cp $parm_exim_dir/exigrep eximdir") != 0)
3079 tests_exit(-1, "Failed to make a copy of exigrep: $!");
3082 if (system("cp $parm_exim_dir/eximstats eximdir") != 0)
3084 tests_exit(-1, "Failed to make a copy of eximstats: $!");
3088 ##################################################
3089 # Check that the Exim user can access stuff #
3090 ##################################################
3092 # We delay this test till here so that we can check access to the actual test
3093 # binary. This will be needed when Exim re-exec's itself to do deliveries.
3095 print "Exim user is $parm_eximuser ($parm_exim_uid)\n";
3096 print "Exim group is $parm_eximgroup ($parm_exim_gid)\n";
3098 if ($parm_caller_uid eq $parm_exim_uid) {
3099 tests_exit(-1, "Exim user ($parm_eximuser,$parm_exim_uid) cannot be "
3100 ."the same as caller ($parm_caller,$parm_caller_uid)");
3103 print "The Exim user needs access to the test suite directory. Checking ...";
3105 if (($rc = system("sudo bin/checkaccess $parm_cwd/eximdir/exim $parm_eximuser $parm_eximgroup")) != 0)
3107 my($why) = "unknown failure $rc";
3109 $why = "Couldn't find user \"$parm_eximuser\"" if $rc == 1;
3110 $why = "Couldn't find group \"$parm_eximgroup\"" if $rc == 2;
3111 $why = "Couldn't read auxiliary group list" if $rc == 3;
3112 $why = "Couldn't get rid of auxiliary groups" if $rc == 4;
3113 $why = "Couldn't set gid" if $rc == 5;
3114 $why = "Couldn't set uid" if $rc == 6;
3115 $why = "Couldn't open \"$parm_cwd/eximdir/exim\"" if $rc == 7;
3116 print "\n** $why\n";
3117 tests_exit(-1, "$parm_eximuser cannot access the test suite directory");
3125 ##################################################
3126 # Create a list of available tests #
3127 ##################################################
3129 # The scripts directory contains a number of subdirectories whose names are
3130 # of the form 0000-xxxx, 1100-xxxx, 2000-xxxx, etc. Each set of tests apart
3131 # from the first requires certain optional features to be included in the Exim
3132 # binary. These requirements are contained in a file called "REQUIRES" within
3133 # the directory. We scan all these tests, discarding those that cannot be run
3134 # because the current binary does not support the right facilities, and also
3135 # those that are outside the numerical range selected.
3137 print "\nTest range is $test_start to $test_end (flavour $flavour)\n";
3138 print "Omitting \${dlfunc expansion tests (loadable module not present)\n"
3140 print "Omitting dbm tests (unable to copy exim_dbmbuild)\n"
3141 if $dbm_build_deleted;
3143 opendir(DIR, "scripts") || tests_exit(-1, "Failed to opendir(\"scripts\"): $!");
3144 @test_dirs = sort readdir(DIR);
3147 # Remove . and .. and CVS from the list.
3149 for ($i = 0; $i < @test_dirs; $i++)
3151 my($d) = $test_dirs[$i];
3152 if ($d eq "." || $d eq ".." || $d eq "CVS")
3154 splice @test_dirs, $i, 1;
3159 # Scan for relevant tests
3161 for ($i = 0; $i < @test_dirs; $i++)
3163 my($testdir) = $test_dirs[$i];
3166 print ">>Checking $testdir\n" if $debug;
3168 # Skip this directory if the first test is equal or greater than the first
3169 # test in the next directory.
3171 next if ($i < @test_dirs - 1) &&
3172 ($test_start >= substr($test_dirs[$i+1], 0, 4));
3174 # No need to carry on if the end test is less than the first test in this
3177 last if $test_end < substr($testdir, 0, 4);
3179 # Check requirements, if any.
3181 if (open(REQUIRES, "scripts/$testdir/REQUIRES"))
3187 if (/^support (.*)$/)
3189 if (!defined $parm_support{$1}) { $wantthis = 0; last; }
3191 elsif (/^running (.*)$/)
3193 if (!defined $parm_running{$1}) { $wantthis = 0; last; }
3195 elsif (/^lookup (.*)$/)
3197 if (!defined $parm_lookups{$1}) { $wantthis = 0; last; }
3199 elsif (/^authenticators? (.*)$/)
3201 if (!defined $parm_authenticators{$1}) { $wantthis = 0; last; }
3203 elsif (/^router (.*)$/)
3205 if (!defined $parm_routers{$1}) { $wantthis = 0; last; }
3207 elsif (/^transport (.*)$/)
3209 if (!defined $parm_transports{$1}) { $wantthis = 0; last; }
3213 tests_exit(-1, "Unknown line in \"scripts/$testdir/REQUIRES\": \"$_\"");
3220 tests_exit(-1, "Failed to open \"scripts/$testdir/REQUIRES\": $!")
3224 # Loop if we do not want the tests in this subdirectory.
3229 print "Omitting tests in $testdir (missing $_)\n";
3233 # We want the tests from this subdirectory, provided they are in the
3234 # range that was selected.
3236 opendir(SUBDIR, "scripts/$testdir") ||
3237 tests_exit(-1, "Failed to opendir(\"scripts/$testdir\"): $!");
3238 @testlist = sort readdir(SUBDIR);
3241 foreach $test (@testlist)
3243 next if $test !~ /^\d{4}(?:\.\d+)?$/;
3244 next if $test < $test_start || $test > $test_end;
3245 push @test_list, "$testdir/$test";
3249 print ">>Test List: @test_list\n", if $debug;
3252 ##################################################
3253 # Munge variable auxiliary data #
3254 ##################################################
3256 # Some of the auxiliary data files have to refer to the current testing
3257 # directory and other parameter data. The generic versions of these files are
3258 # stored in the aux-var-src directory. At this point, we copy each of them
3259 # to the aux-var directory, making appropriate substitutions. There aren't very
3260 # many of them, so it's easiest just to do this every time. Ensure the mode
3261 # is standardized, as this path is used as a test for the ${stat: expansion.
3263 # A similar job has to be done for the files in the dnszones-src directory, to
3264 # make the fake DNS zones for testing. Most of the zone files are copied to
3265 # files of the same name, but db.ipv4.V4NET and db.ipv6.V6NET use the testing
3266 # networks that are defined by parameter.
3268 foreach $basedir ("aux-var", "dnszones")
3270 system("sudo rm -rf $parm_cwd/$basedir");
3271 mkdir("$parm_cwd/$basedir", 0777);
3272 chmod(0755, "$parm_cwd/$basedir");
3274 opendir(AUX, "$parm_cwd/$basedir-src") ||
3275 tests_exit(-1, "Failed to opendir $parm_cwd/$basedir-src: $!");
3276 my(@filelist) = readdir(AUX);
3279 foreach $file (@filelist)
3281 my($outfile) = $file;
3282 next if $file =~ /^\./;
3284 if ($file eq "db.ip4.V4NET")
3286 $outfile = "db.ip4.$parm_ipv4_test_net";
3288 elsif ($file eq "db.ip6.V6NET")
3290 my(@nibbles) = reverse(split /\s*/, $parm_ipv6_test_net);
3292 $outfile = "db.ip6.@nibbles";
3296 print ">>Copying $basedir-src/$file to $basedir/$outfile\n" if $debug;
3297 open(IN, "$parm_cwd/$basedir-src/$file") ||
3298 tests_exit(-1, "Failed to open $parm_cwd/$basedir-src/$file: $!");
3299 open(OUT, ">$parm_cwd/$basedir/$outfile") ||
3300 tests_exit(-1, "Failed to open $parm_cwd/$basedir/$outfile: $!");
3311 # Set a user's shell, distinguishable from /bin/sh
3313 symlink("/bin/sh","aux-var/sh");
3314 $ENV{'SHELL'} = $parm_shell = $parm_cwd . "/aux-var/sh";
3316 ##################################################
3317 # Create fake DNS zones for this host #
3318 ##################################################
3320 # There are fixed zone files for 127.0.0.1 and ::1, but we also want to be
3321 # sure that there are forward and reverse registrations for this host, using
3322 # its real IP addresses. Dynamically created zone files achieve this.
3324 if ($have_ipv4 || $have_ipv6)
3326 my($shortname,$domain) = $parm_hostname =~ /^([^.]+)(.*)/;
3327 open(OUT, ">$parm_cwd/dnszones/db$domain") ||
3328 tests_exit(-1, "Failed to open $parm_cwd/dnszones/db$domain: $!");
3329 print OUT "; This is a dynamically constructed fake zone file.\n" .
3330 "; The following line causes fakens to return PASS_ON\n" .
3331 "; for queries that it cannot answer\n\n" .
3332 "PASS ON NOT FOUND\n\n";
3333 print OUT "$shortname A $parm_ipv4\n" if $have_ipv4;
3334 print OUT "$shortname AAAA $parm_ipv6\n" if $have_ipv6;
3335 print OUT "\n; End\n";
3339 if ($have_ipv4 && $parm_ipv4 ne "127.0.0.1")
3341 my(@components) = $parm_ipv4 =~ /^(\d+)\.(\d+)\.(\d+)\.(\d+)/;
3342 open(OUT, ">$parm_cwd/dnszones/db.ip4.$components[0]") ||
3344 "Failed to open $parm_cwd/dnszones/db.ip4.$components[0]: $!");
3345 print OUT "; This is a dynamically constructed fake zone file.\n" .
3346 "; The zone is $components[0].in-addr.arpa.\n\n" .
3347 "$components[3].$components[2].$components[1] PTR $parm_hostname.\n\n" .
3352 if ($have_ipv6 && $parm_ipv6 ne "::1")
3354 my($exp_v6) = $parm_ipv6;
3355 $exp_v6 =~ s/[^:]//g;
3356 if ( $parm_ipv6 =~ /^([^:].+)::$/ ) {
3357 $exp_v6 = $1 . ':0' x (9-length($exp_v6));
3358 } elsif ( $parm_ipv6 =~ /^(.+)::(.+)$/ ) {
3359 $exp_v6 = $1 . ':0' x (8-length($exp_v6)) . ':' . $2;
3360 } elsif ( $parm_ipv6 =~ /^::(.+[^:])$/ ) {
3361 $exp_v6 = '0:' x (9-length($exp_v6)) . $1;
3363 $exp_v6 = $parm_ipv6;
3365 my(@components) = split /:/, $exp_v6;
3366 my(@nibbles) = reverse (split /\s*/, shift @components);
3370 open(OUT, ">$parm_cwd/dnszones/db.ip6.@nibbles") ||
3372 "Failed to open $parm_cwd/dnszones/db.ip6.@nibbles: $!");
3373 print OUT "; This is a dynamically constructed fake zone file.\n" .
3374 "; The zone is @nibbles.ip6.arpa.\n\n";
3376 @components = reverse @components;
3377 foreach $c (@components)
3379 $c = "0$c" until $c =~ /^..../;
3380 @nibbles = reverse(split /\s*/, $c);
3381 print OUT "$sep@nibbles";
3385 print OUT " PTR $parm_hostname.\n\n; End\n";
3392 ##################################################
3393 # Create lists of mailboxes and message logs #
3394 ##################################################
3396 # We use these lists to check that a test has created the expected files. It
3397 # should be faster than looking for the file each time. For mailboxes, we have
3398 # to scan a complete subtree, in order to handle maildirs. For msglogs, there
3399 # is just a flat list of files.
3401 @oldmails = list_files_below("mail");
3402 opendir(DIR, "msglog") || tests_exit(-1, "Failed to opendir msglog: $!");
3403 @oldmsglogs = readdir(DIR);
3408 ##################################################
3409 # Run the required tests #
3410 ##################################################
3412 # Each test script contains a number of tests, separated by a line that
3413 # contains ****. We open input from the terminal so that we can read responses
3416 open(T, "/dev/tty") || tests_exit(-1, "Failed to open /dev/tty: $!");
3418 print "\nPress RETURN to run the tests: ";
3419 $_ = $force_continue ? "c" : <T>;
3424 foreach $test (@test_list)
3427 local($commandno) = 0;
3428 local($subtestno) = 0;
3429 (local $testno = $test) =~ s|.*/||;
3430 local($sortlog) = 0;
3434 my($thistestdir) = substr($test, 0, -5);
3436 if ($lasttestdir ne $thistestdir)
3439 if (-s "scripts/$thistestdir/REQUIRES")
3442 print "\n>>> The following tests require: ";
3443 open(IN, "scripts/$thistestdir/REQUIRES") ||
3444 tests_exit(-1, "Failed to open scripts/$thistestdir/REQUIRES: $1");
3447 $gnutls = 1 if /^support GnuTLS/;
3454 $lasttestdir = $thistestdir;
3456 # Remove any debris in the spool directory and the test-mail directory
3457 # and also the files for collecting stdout and stderr. Then put back
3458 # the test-mail directory for appendfile deliveries.
3460 system "sudo /bin/rm -rf spool test-*";
3461 system "mkdir test-mail 2>/dev/null";
3463 # A privileged Exim will normally make its own spool directory, but some of
3464 # the tests run in unprivileged modes that don't always work if the spool
3465 # directory isn't already there. What is more, we want anybody to be able
3466 # to read it in order to find the daemon's pid.
3468 system "mkdir spool; " .
3469 "sudo chown $parm_eximuser:$parm_eximgroup spool; " .
3470 "sudo chmod 0755 spool";
3472 # Empty the cache that keeps track of things like message id mappings, and
3473 # set up the initial sequence strings.
3485 $TEST_STATE->{munge} = "";
3487 # Remove the associative arrays used to hold checked mail files and msglogs
3489 undef %expected_mails;
3490 undef %expected_msglogs;
3492 # Open the test's script
3493 open(SCRIPT, "scripts/$test") ||
3494 tests_exit(-1, "Failed to open \"scripts/$test\": $!");
3495 # Run through the script once to set variables which should be global
3498 if (/^no_message_check/) { $message_skip = 1; next; }
3499 if (/^no_msglog_check/) { $msglog_skip = 1; next; }
3500 if (/^no_stderr_check/) { $stderr_skip = 1; next; }
3501 if (/^no_stdout_check/) { $stdout_skip = 1; next; }
3502 if (/^rmfiltertest/) { $rmfiltertest = 1; next; }
3503 if (/^sortlog/) { $sortlog = 1; next; }
3505 # Reset to beginning of file for per test interpreting/processing
3508 # The first line in the script must be a comment that is used to identify
3509 # the set of tests as a whole.
3513 tests_exit(-1, "Missing identifying comment at start of $test") if (!/^#/);
3514 printf("%s %s", (substr $test, 5), (substr $_, 2));
3516 # Loop for each of the subtests within the script. The variable $server_pid
3517 # is used to remember the pid of a "server" process, for which we do not
3518 # wait until we have waited for a subsequent command.
3520 local($server_pid) = 0;
3521 for ($commandno = 1; !eof SCRIPT; $commandno++)
3523 # Skip further leading comments and blank lines, handle the flag setting
3524 # commands, and deal with tests for IP support.
3529 # Could remove these variable settings because they are already
3530 # set above, but doesn't hurt to leave them here.
3531 if (/^no_message_check/) { $message_skip = 1; next; }
3532 if (/^no_msglog_check/) { $msglog_skip = 1; next; }
3533 if (/^no_stderr_check/) { $stderr_skip = 1; next; }
3534 if (/^no_stdout_check/) { $stdout_skip = 1; next; }
3535 if (/^rmfiltertest/) { $rmfiltertest = 1; next; }
3536 if (/^sortlog/) { $sortlog = 1; next; }
3538 if (/^need_largefiles/)
3540 next if $have_largefiles;
3541 print ">>> Large file support is needed for test $testno, but is not available: skipping\n";
3542 $docheck = 0; # don't check output
3543 undef $_; # pretend EOF
3550 print ">>> IPv4 is needed for test $testno, but is not available: skipping\n";
3551 $docheck = 0; # don't check output
3552 undef $_; # pretend EOF
3563 print ">>> IPv6 is needed for test $testno, but is not available: skipping\n";
3564 $docheck = 0; # don't check output
3565 undef $_; # pretend EOF
3569 if (/^need_move_frozen_messages/)
3571 next if defined $parm_support{"move_frozen_messages"};
3572 print ">>> move frozen message support is needed for test $testno, " .
3573 "but is not\n>>> available: skipping\n";
3574 $docheck = 0; # don't check output
3575 undef $_; # pretend EOF
3579 last unless /^(#|\s*$)/;
3581 last if !defined $_; # Hit EOF
3583 my($subtest_startline) = $lineno;
3585 # Now run the command. The function returns 0 if exim was run and waited
3586 # for, 1 if any other command was run and waited for, and 2 if a command
3587 # was run and not waited for (usually a daemon or server startup).
3589 my($commandname) = "";
3591 my($rc, $run_extra) = run_command($testno, \$subtestno, \$expectrc, \$commandname, $TEST_STATE);
3595 print ">> rc=$rc cmdrc=$cmdrc\n";
3596 if (defined $run_extra) {
3597 foreach my $k (keys %$run_extra) {
3598 my $v = defined $run_extra->{$k} ? qq!"$run_extra->{$k}"! : '<undef>';
3599 print ">> $k -> $v\n";
3603 $run_extra = {} unless defined $run_extra;
3604 foreach my $k (keys %$run_extra) {
3605 if (exists $TEST_STATE->{$k}) {
3606 my $nv = defined $run_extra->{$k} ? qq!"$run_extra->{$k}"! : 'removed';
3607 print ">> override of $k; was $TEST_STATE->{$k}, now $nv\n" if $debug;
3609 if (defined $run_extra->{$k}) {
3610 $TEST_STATE->{$k} = $run_extra->{$k};
3611 } elsif (exists $TEST_STATE->{$k}) {
3612 delete $TEST_STATE->{$k};
3616 # Hit EOF after an initial return code number
3618 tests_exit(-1, "Unexpected EOF in script") if ($rc == 4);
3620 # Carry on with the next command if we did not wait for this one. $rc == 0
3621 # if no subprocess was run; $rc == 3 if we started a process but did not
3624 next if ($rc == 0 || $rc == 3);
3626 # We ran and waited for a command. Check for the expected result unless
3629 if ($cmdrc != $expectrc && !$sigpipehappened)
3631 printf("** Command $commandno (\"$commandname\", starting at line $subtest_startline)\n");
3632 if (($cmdrc & 0xff) == 0)
3634 printf("** Return code %d (expected %d)", $cmdrc/256, $expectrc/256);
3636 elsif (($cmdrc & 0xff00) == 0)
3637 { printf("** Killed by signal %d", $cmdrc & 255); }
3639 { printf("** Status %x", $cmdrc); }
3643 print "\nshow stdErr, show stdOut, Retry, Continue (without file comparison), or Quit? [Q] ";
3644 $_ = $force_continue ? "c" : <T>;
3645 tests_exit(1) if /^q?$/i;
3646 log_failure($log_failed_filename, $testno, "exit code unexpected") if (/^c$/i && $force_continue);
3647 print "... continue forced\n" if $force_continue;
3651 system("$more test-stderr");
3655 system("$more test-stdout");
3659 $retry = 1 if /^r$/i;
3663 # If the command was exim, and a listening server is running, we can now
3664 # close its input, which causes us to wait for it to finish, which is why
3665 # we didn't close it earlier.
3667 if ($rc == 2 && $server_pid != 0)
3673 if (($? & 0xff) == 0)
3674 { printf("Server return code %d", $?/256); }
3675 elsif (($? & 0xff00) == 0)
3676 { printf("Server killed by signal %d", $? & 255); }
3678 { printf("Server status %x", $?); }
3682 print "\nShow server stdout, Retry, Continue, or Quit? [Q] ";
3683 $_ = $force_continue ? "c" : <T>;
3684 tests_exit(1) if /^q?$/i;
3685 log_failure($log_failed_filename, $testno, "exit code unexpected") if (/^c$/i && $force_continue);
3686 print "... continue forced\n" if $force_continue;
3691 open(S, "test-stdout-server") ||
3692 tests_exit(-1, "Failed to open test-stdout-server: $!");
3697 $retry = 1 if /^r$/i;
3704 # The script has finished. Check the all the output that was generated. The
3705 # function returns 0 if all is well, 1 if we should rerun the test (the files
3706 # have been updated). It does not return if the user responds Q to a prompt.
3711 print (("#" x 79) . "\n");
3717 if (check_output($TEST_STATE->{munge}) != 0)
3719 print (("#" x 79) . "\n");
3724 print (" Script completed\n");
3730 ##################################################
3731 # Exit from the test script #
3732 ##################################################
3734 tests_exit(-1, "No runnable tests selected") if @test_list == 0;
3737 # End of runtest script
3738 # vim: set sw=2 et :