10 use vars qw($VERSION $verbose $switches $have_devel_corestack $curtest
11 @ISA @EXPORT @EXPORT_OK);
12 $have_devel_corestack = 0;
16 $ENV{HARNESS_ACTIVE} = 1;
18 # Some experimental versions of OS/2 build have broken $?
19 my $ignore_exitcode = $ENV{HARNESS_IGNORE_EXITCODE};
21 my $files_in_dir = $ENV{HARNESS_FILELEAK_IN_DIR};
23 my $tests_skipped = 0;
24 my $subtests_skipped = 0;
27 @EXPORT= qw(&runtests);
28 @EXPORT_OK= qw($verbose $switches);
31 Failed Test Status Wstat Total Fail Failed List of failed
32 -------------------------------------------------------------------------------
36 @<<<<<<<<<<<<<< @>> @>>>> @>>>> @>>> ^##.##% ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
45 ~~ ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
53 sub globdir { opendir DIRH, shift; my @f = readdir DIRH; closedir DIRH; @f }
58 my($test,$te,$ok,$next,$max,$pct,$totok,$totbonus,@failed,%failedtests);
65 # pass -I flags to children
66 my $old5lib = $ENV{PERL5LIB};
67 local($ENV{'PERL5LIB'}) = join($Config{path_sep}, @INC);
69 if ($^O eq 'VMS') { $switches =~ s/-(\S*[A-Z]\S*)/"-$1"/g }
71 my @dir_files = globdir $files_in_dir if defined $files_in_dir;
72 my $t_start = new Benchmark;
73 while ($test = shift(@tests)) {
76 if ($^O eq 'VMS') { $te =~ s/^.*\.t\./[.t./; }
77 my $blank = (' ' x 77);
78 my $leader = "$te" . '.' x (20 - length($te));
80 $ml = "\r$blank\r$leader"
81 if -t STDOUT and not $ENV{HARNESS_NOTTY} and not $verbose;
83 my $fh = new FileHandle;
84 $fh->open($test) or print "can't open $test. $!\n";
87 $s .= join " ", q[ "-T"], map {qq["-I$_"]} @INC
88 if $first =~ /^#!.*\bperl.*-\w*T/;
89 $fh->close or print "can't close $test. $!\n";
90 my $cmd = ($ENV{'COMPILE_TEST'})?
91 "./perl -I../lib ../utils/perlcc $test -run 2>> ./compilelog |"
93 $cmd = "MCR $cmd" if $^O eq 'VMS';
94 $fh->open($cmd) or print "can't run $test. $!\n";
95 $ok = $next = $max = 0;
105 if (/^1\.\.([0-9]+) todo([\d\s]+)\;/) {
107 for (split(/\s+/, $2)) { $todo{$_} = 1; }
111 } elsif (/^1\.\.([0-9]+)(\s*\#\s*[Ss]kip\S*(?>\s+)(.+))?/) {
116 $skip_reason = $3 if not $max and defined $3;
117 } elsif ($max && /^(not\s+)?ok\b/) {
119 if (/^not ok\s*(\d*)/){
120 $this = $1 if $1 > 0;
121 print "${ml}NOK $this" if $ml;
128 } elsif (/^ok\s*(\d*)(\s*\#\s*[Ss]kip\S*(?:(?>\s+)(.+))?)?/) {
129 $this = $1 if $1 > 0;
130 print "${ml}ok $this/$max" if $ml;
133 $skipped++ if defined $2;
135 $reason = 'unknown reason' if defined $2;
136 $reason = $3 if defined $3;
137 if (defined $reason and defined $skip_reason) {
138 # print "was: '$skip_reason' new '$reason'\n";
139 $skip_reason = 'various reasons'
140 if $skip_reason ne $reason;
141 } elsif (defined $reason) {
142 $skip_reason = $reason;
144 $bonus++, $totbonus++ if $todo{$this};
147 # warn "Test output counter mismatch [test $this]\n";
148 # no need to warn probably
149 push @failed, $next..$this-1;
150 } elsif ($this < $next) {
151 #we have seen more "ok" lines than the number suggests
152 warn "Confused test output: test $this answered after test ", $next-1, "\n";
158 $fh->close; # must close to reap child resource values
159 my $wstatus = $ignore_exitcode ? 0 : $?; # Can trust $? ?
161 $estatus = ($^O eq 'VMS'
162 ? eval 'use vmsish "status"; $estatus = $?'
165 my ($failed, $canon, $percent) = ('??', '??');
166 printf "${ml}dubious\n\tTest returned status $estatus (wstat %d, 0x%x)\n",
168 print "\t\t(VMS status is $estatus)\n" if $^O eq 'VMS';
169 if (corestatus($wstatus)) { # until we have a wait module
170 if ($have_devel_corestack) {
171 Devel::CoreStack::stack($^X);
173 print "\ttest program seems to have generated a core\n";
178 if ($next == $max + 1 and not @failed) {
179 print "\tafter all the subtests completed successfully\n";
181 $failed = 0; # But we do not set $canon!
183 push @failed, $next..$max;
185 (my $txt, $canon) = canonfailed($max,$skipped,@failed);
186 $percent = 100*(scalar @failed)/$max;
190 $failedtests{$test} = { canon => $canon, max => $max || '??',
192 name => $test, percent => $percent,
193 estat => $estatus, wstat => $wstatus,
195 } elsif ($ok == $max && $next == $max+1) {
196 if ($max and $skipped + $bonus) {
198 push(@msg, "$skipped/$max skipped: $skip_reason")
200 push(@msg, "$bonus/$max unexpectedly succeeded")
202 print "${ml}ok, ".join(', ', @msg)."\n";
205 } elsif (defined $skip_reason) {
206 print "skipped: $skip_reason\n";
209 print "skipped test on this platform\n";
215 push @failed, $next..$max;
218 my ($txt, $canon) = canonfailed($max,$skipped,@failed);
220 $failedtests{$test} = { canon => $canon, max => $max,
221 failed => scalar @failed,
222 name => $test, percent => 100*(scalar @failed)/$max,
223 estat => '', wstat => '',
226 print "Don't know which tests failed: got $ok ok, expected $max\n";
227 $failedtests{$test} = { canon => '??', max => $max,
229 name => $test, percent => undef,
230 estat => '', wstat => '',
234 } elsif ($next == 0) {
235 print "FAILED before any test output arrived\n";
237 $failedtests{$test} = { canon => '??', max => '??',
239 name => $test, percent => undef,
240 estat => '', wstat => '',
243 $subtests_skipped += $skipped;
244 if (defined $files_in_dir) {
245 my @new_dir_files = globdir $files_in_dir;
246 if (@new_dir_files != @dir_files) {
248 @f{@new_dir_files} = (1) x @new_dir_files;
249 delete @f{@dir_files};
250 my @f = sort keys %f;
251 print "LEAKED FILES: @f\n";
252 @dir_files = @new_dir_files;
256 my $t_total = timediff(new Benchmark, $t_start);
259 if (defined $old5lib) {
260 $ENV{PERL5LIB} = $old5lib;
262 delete $ENV{PERL5LIB};
266 $bonusmsg = (" ($totbonus subtest".($totbonus>1?'s':'').
267 " UNEXPECTEDLY SUCCEEDED)")
269 if ($tests_skipped) {
270 $bonusmsg .= ", $tests_skipped test" . ($tests_skipped != 1 ? 's' : '');
271 if ($subtests_skipped) {
272 $bonusmsg .= " and $subtests_skipped subtest"
273 . ($subtests_skipped != 1 ? 's' : '');
275 $bonusmsg .= ' skipped';
277 elsif ($subtests_skipped) {
278 $bonusmsg .= ", $subtests_skipped subtest"
279 . ($subtests_skipped != 1 ? 's' : '')
282 if ($bad == 0 && $totmax) {
283 print "All tests successful$bonusmsg.\n";
285 die "FAILED--no tests were run for some reason.\n";
286 } elsif ($totmax==0) {
287 my $blurb = $total==1 ? "script" : "scripts";
288 die "FAILED--$total test $blurb could be run, alas--no output ever seen\n";
290 $pct = sprintf("%.2f", $good / $total * 100);
291 my $subpct = sprintf " %d/%d subtests failed, %.2f%% okay.",
292 $totmax - $totok, $totmax, 100*$totok/$totmax;
294 for $script (sort keys %failedtests) {
295 $curtest = $failedtests{$script};
299 $bonusmsg =~ s/^,\s*//;
300 print "$bonusmsg.\n" if $bonusmsg;
301 die "Failed $bad/$total test scripts, $pct% okay.$subpct\n";
304 printf("Files=%d, Tests=%d, %s\n", $files, $totmax, timestr($t_total, 'nop'));
306 return ($bad == 0 && $totmax) ;
309 my $tried_devel_corestack;
314 eval {require 'wait.ph'};
317 $ret = ($st & 0200); # Tim says, this is for 90%
320 $ret = WCOREDUMP($st);
323 eval { require Devel::CoreStack; $have_devel_corestack++ }
324 unless $tried_devel_corestack++;
329 sub canonfailed ($@) {
330 my($max,$skipped,@failed) = @_;
332 @failed = sort {$a <=> $b} grep !$seen{$_}++, @failed;
333 my $failed = @failed;
337 my $last = $min = shift @failed;
340 for (@failed, $failed[-1]) { # don't forget the last one
341 if ($_ > $last+1 || $_ == $last) {
345 push @canon, "$min-$last";
352 push @result, "FAILED tests @canon\n";
355 push @result, "FAILED test $last\n";
359 push @result, "\tFailed $failed/$max tests, ";
360 push @result, sprintf("%.2f",100*(1-$failed/$max)), "% okay";
361 my $ender = 's' x ($skipped > 1);
362 my $good = $max - $failed - $skipped;
363 my $goodper = sprintf("%.2f",100*($good/$max));
364 push @result, " (-$skipped skipped test$ender: $good okay, $goodper%)" if $skipped;
366 my $txt = join "", @result;
375 Test::Harness - run perl standard test scripts with statistics
385 (By using the L<Test> module, you can write test scripts without
386 knowing the exact output this module expects. However, if you need to
387 know the specifics, read on!)
389 Perl test scripts print to standard output C<"ok N"> for each single
390 test, where C<N> is an increasing sequence of integers. The first line
391 output by a standard test script is C<"1..M"> with C<M> being the
392 number of tests that should be run within the test
393 script. Test::Harness::runtests(@tests) runs all the testscripts
394 named as arguments and checks standard output for the expected
397 After all tests have been performed, runtests() prints some
398 performance statistics that are computed by the Benchmark module.
400 =head2 The test script output
402 Any output from the testscript to standard error is ignored and
403 bypassed, thus will be seen by the user. Lines written to standard
404 output containing C</^(not\s+)?ok\b/> are interpreted as feedback for
405 runtests(). All other lines are discarded.
407 It is tolerated if the test numbers after C<ok> are omitted. In this
408 case Test::Harness maintains temporarily its own counter until the
409 script supplies test numbers again. So the following test script
423 Failed 3/6 tests, 50.00% okay
425 The global variable $Test::Harness::verbose is exportable and can be
426 used to let runtests() display the standard output of the script
427 without altering the behavior otherwise.
429 The global variable $Test::Harness::switches is exportable and can be
430 used to set perl command line options used for running the test
431 script(s). The default value is C<-w>.
433 If the standard output line contains substring C< # Skip> (with
434 variations in spacing and case) after C<ok> or C<ok NUMBER>, it is
435 counted as a skipped test. If the whole testscript succeeds, the
436 count of skipped tests is included in the generated output.
438 C<Test::Harness> reports the text after C< # Skip(whatever)> as a
439 reason for skipping. Similarly, one can include a similar explanation
440 in a C<1..0> line emitted if the test is skipped completely:
442 1..0 # Skipped: no leverage found
446 C<&runtests> is exported by Test::Harness per default.
452 =item C<All tests successful.\nFiles=%d, Tests=%d, %s>
454 If all tests are successful some statistics about the performance are
457 =item C<FAILED tests %s\n\tFailed %d/%d tests, %.2f%% okay.>
459 For any single script that has failing subtests statistics like the
462 =item C<Test returned status %d (wstat %d)>
464 Scripts that return a non-zero exit status, both C<$? E<gt>E<gt> 8> and C<$?> are
465 printed in a message similar to the above.
467 =item C<Failed 1 test, %.2f%% okay. %s>
469 =item C<Failed %d/%d tests, %.2f%% okay. %s>
471 If not all tests were successful, the script dies with one of the
478 Setting C<HARNESS_IGNORE_EXITCODE> makes harness ignore the exit status
481 Setting C<HARNESS_NOTTY> to a true value forces it to behave as though
482 STDOUT were not a console. You may need to set this if you don't want
483 harness to output more frequent progress messages using carriage returns.
484 Some consoles may not handle carriage returns properly (which results
485 in a somewhat messy output).
487 If C<HARNESS_FILELEAK_IN_DIR> is set to the name of a directory, harness
488 will check after each test whether new files appeared in that directory,
491 LEAKED FILES: scr.tmp 0 my.db
493 If relative, directory name is with respect to the current directory at
494 the moment runtests() was called. Putting absolute path into
495 C<HARNESS_FILELEAK_IN_DIR> may give more predicatable results.
497 Harness sets C<HARNESS_ACTIVE> before executing the individual tests.
498 This allows the tests to determine if they are being executed through the
499 harness or by any other means.
503 L<Test> for writing test scripts and also L<Benchmark> for the
504 underlying timing routines.
508 Either Tim Bunce or Andreas Koenig, we don't know. What we know for
509 sure is, that it was inspired by Larry Wall's TEST script that came
510 with perl distributions for ages. Numerous anonymous contributors
511 exist. Current maintainer is Andreas Koenig.
515 Test::Harness uses $^X to determine the perl binary to run the tests
516 with. Test scripts running via the shebang (C<#!>) line may not be
517 portable because $^X is not consistent for shebang scripts across
518 platforms. This is no problem when Test::Harness is run with an
519 absolute path to the perl binary or when $^X can be found in the path.