1 # -*- Mode: cperl; cperl-indent-level: 4 -*-
2 # $Id: Harness.pm,v 1.76 2003/11/25 04:41:03 andy Exp $
7 use Test::Harness::Straps;
8 use Test::Harness::Assert;
16 @ISA @EXPORT @EXPORT_OK
17 $Verbose $Switches $Debug
18 $verbose $switches $debug
28 Test::Harness - Run Perl standard test scripts with statistics
34 $Header: /home/cvs/test-harness/lib/Test/Harness.pm,v 1.76 2003/11/25 04:41:03 andy Exp $
40 # Backwards compatibility for exportable variable names.
42 *switches = *Switches;
45 $Have_Devel_Corestack = 0;
47 $ENV{HARNESS_ACTIVE} = 1;
51 delete $ENV{HARNESS_ACTIVE};
54 # Some experimental versions of OS/2 build have broken $?
55 my $Ignore_Exitcode = $ENV{HARNESS_IGNORE_EXITCODE};
57 my $Files_In_Dir = $ENV{HARNESS_FILELEAK_IN_DIR};
59 my $Ok_Slow = $ENV{HARNESS_OK_SLOW};
61 $Strap = Test::Harness::Straps->new;
64 @EXPORT = qw(&runtests);
65 @EXPORT_OK = qw($verbose $switches);
67 $Verbose = $ENV{HARNESS_VERBOSE} || 0;
68 $Debug = $ENV{HARNESS_DEBUG} || 0;
70 $Columns = $ENV{HARNESS_COLUMNS} || $ENV{COLUMNS} || 80;
71 $Columns--; # Some shells have trouble with a full line of text.
77 runtests(@test_files);
81 B<STOP!> If all you want to do is write a test script, consider using
82 Test::Simple. Otherwise, read on.
84 (By using the Test module, you can write test scripts without
85 knowing the exact output this module expects. However, if you need to
86 know the specifics, read on!)
88 Perl test scripts print to standard output C<"ok N"> for each single
89 test, where C<N> is an increasing sequence of integers. The first line
90 output by a standard test script is C<"1..M"> with C<M> being the
91 number of tests that should be run within the test
92 script. Test::Harness::runtests(@tests) runs all the testscripts
93 named as arguments and checks standard output for the expected
96 After all tests have been performed, runtests() prints some
97 performance statistics that are computed by the Benchmark module.
99 =head2 The test script output
101 The following explains how Test::Harness interprets the output of your
108 This header tells how many tests there will be. For example, C<1..10>
109 means you plan on running 10 tests. This is a safeguard in case your
110 test dies quietly in the middle of its run.
112 It should be the first non-comment line output by your test program.
114 In certain instances, you may not know how many tests you will
115 ultimately be running. In this case, it is permitted for the 1..M
116 header to appear as the B<last> line output by your test (again, it
117 can be followed by further comments).
119 Under B<no> circumstances should 1..M appear in the middle of your
120 output or more than once.
123 =item B<'ok', 'not ok'. Ok?>
125 Any output from the testscript to standard error is ignored and
126 bypassed, thus will be seen by the user. Lines written to standard
127 output containing C</^(not\s+)?ok\b/> are interpreted as feedback for
128 runtests(). All other lines are discarded.
130 C</^not ok/> indicates a failed test. C</^ok/> is a successful test.
133 =item B<test numbers>
135 Perl normally expects the 'ok' or 'not ok' to be followed by a test
136 number. It is tolerated if the test numbers after 'ok' are
137 omitted. In this case Test::Harness maintains temporarily its own
138 counter until the script supplies test numbers again. So the following
153 Failed 3/6 tests, 50.00% okay
157 Anything after the test number but before the # is considered to be
158 the name of the test.
160 ok 42 this is the name of the test
162 Currently, Test::Harness does nothing with this information.
164 =item B<Skipping tests>
166 If the standard output line contains the substring C< # Skip> (with
167 variations in spacing and case) after C<ok> or C<ok NUMBER>, it is
168 counted as a skipped test. If the whole testscript succeeds, the
169 count of skipped tests is included in the generated output.
170 C<Test::Harness> reports the text after C< # Skip\S*\s+> as a reason
173 ok 23 # skip Insufficient flogiston pressure.
175 Similarly, one can include a similar explanation in a C<1..0> line
176 emitted if the test script is skipped completely:
178 1..0 # Skipped: no leverage found
182 If the standard output line contains the substring C< # TODO > after
183 C<not ok> or C<not ok NUMBER>, it is counted as a todo test. The text
184 afterwards is the thing that has to be done before this test will
187 not ok 13 # TODO harness the power of the atom
189 Note that the TODO must have a space after it.
193 Alternatively, you can specify a list of what tests are todo as part
198 This only works if the header appears at the beginning of the test.
200 This style is B<deprecated>.
204 These tests represent a feature to be implemented or a bug to be fixed
205 and act as something of an executable "thing to do" list. They are
206 B<not> expected to succeed. Should a todo test begin succeeding,
207 Test::Harness will report it as a bonus. This indicates that whatever
208 you were supposed to do has been done and you should promote this to a
213 As an emergency measure, a test script can decide that further tests
214 are useless (e.g. missing dependencies) and testing should stop
215 immediately. In that case the test script prints the magic words
219 to standard output. Any message after these words will be displayed by
220 C<Test::Harness> as the reason why testing is stopped.
224 Additional comments may be put into the testing output on their own
225 lines. Comment lines should begin with a '#', Test::Harness will
229 # Life is good, the sun is shining, RAM is cheap.
231 # got 'Bush' expected 'Gore'
233 =item B<Anything else>
235 Any other output Test::Harness sees it will silently ignore B<BUT WE
236 PLAN TO CHANGE THIS!> If you wish to place additional output in your
237 test script, please use a comment.
243 Test::Harness will honor the C<-T> or C<-t> in the #! line on your
244 test files. So if you begin a test with:
248 the test will be run with taint mode on.
250 =head2 Configuration variables.
252 These variables can be used to configure the behavior of
253 Test::Harness. They are exported on request.
257 =item B<$Test::Harness::Verbose>
259 The global variable C<$Test::Harness::Verbose> is exportable and can be
260 used to let C<runtests()> display the standard output of the script
261 without altering the behavior otherwise. The F<prove> utility's C<-v>
264 =item B<$Test::Harness::switches>
266 The global variable C<$Test::Harness::switches> is exportable and can be
267 used to set perl command line options used for running the test
268 script(s). The default value is C<-w>. It overrides C<HARNESS_SWITCHES>.
275 It will happen: your tests will fail. After you mop up your ego, you
276 can begin examining the summary report:
278 t/base..............ok
279 t/nonumbers.........ok
280 t/ok................ok
281 t/test-harness......ok
282 t/waterloo..........dubious
283 Test returned status 3 (wstat 768, 0x300)
284 DIED. FAILED tests 1, 3, 5, 7, 9, 11, 13, 15, 17, 19
285 Failed 10/20 tests, 50.00% okay
286 Failed Test Stat Wstat Total Fail Failed List of Failed
287 -----------------------------------------------------------------------
288 t/waterloo.t 3 768 20 10 50.00% 1 3 5 7 9 11 13 15 17 19
289 Failed 1/5 test scripts, 80.00% okay. 10/44 subtests failed, 77.27% okay.
291 Everything passed but t/waterloo.t. It failed 10 of 20 tests and
292 exited with non-zero status indicating something dubious happened.
294 The columns in the summary report mean:
300 The test file which failed.
304 If the test exited with non-zero, this is its exit status.
308 The wait status of the test.
312 Total number of tests expected to run.
316 Number which failed, either from "not ok" or because they never ran.
320 Percentage of the total tests which failed.
322 =item B<List of Failed>
324 A list of the tests which failed. Successive failures may be
325 abbreviated (ie. 15-20 to indicate that tests 15, 16, 17, 18, 19 and
333 Test::Harness currently only has one function, here it is.
339 my $allok = runtests(@test_files);
341 This runs all the given @test_files and divines whether they passed
342 or failed based on their output to STDOUT (details above). It prints
343 out each individual test which failed along with a summary report and
344 a how long it all took.
346 It returns true if everything was ok. Otherwise it will die() with
347 one of the messages in the DIAGNOSTICS section.
351 This is just _run_all_tests() plus _show_results()
360 my($tot, $failedtests) = _run_all_tests(@tests);
361 _show_results($tot, $failedtests);
363 my $ok = _all_ok($tot);
365 assert(($ok xor keys %$failedtests),
366 q{ok status jives with $failedtests});
375 my $ok = _all_ok(\%tot);
377 Tells you if this test run is overall successful or not.
384 return $tot->{bad} == 0 && ($tot->{max} || $tot->{skipped}) ? 1 : 0;
389 my @files = _globdir $dir;
391 Returns all the files in a directory. This is shorthand for backwards
392 compatibility on systems where glob() doesn't work right.
398 my @f = readdir DIRH;
404 =item B<_run_all_tests>
406 my($total, $failed) = _run_all_tests(@test_files);
408 Runs all the given C<@test_files> (as C<runtests()>) but does it
409 quietly (no report). $total is a hash ref summary of all the tests
410 run. Its keys and values are this:
412 bonus Number of individual todo tests unexpectedly passed
413 max Number of individual tests ran
414 ok Number of individual tests passed
415 sub_skipped Number of individual tests skipped
416 todo Number of individual todo tests
418 files Number of test files ran
419 good Number of test files passed
420 bad Number of test files failed
421 tests Number of test files originally given
422 skipped Number of test files skipped
424 If C<< $total->{bad} == 0 >> and C<< $total->{max} > 0 >>, you've
425 got a successful test.
427 $failed is a hash ref of all the test scripts which failed. Each key
428 is the name of a test script, each value is another hash representing
429 how that script failed. Its keys are these:
431 name Name of the test which failed
432 estat Script's exit value
433 wstat Script's wait status
434 max Number of individual tests
435 failed Number which failed
436 percent Percentage of tests which failed
437 canon List of tests which failed (as string).
439 C<$failed> should be empty if everything passed.
441 B<NOTE> Currently this function is still noisy. I'm working on it.
459 tests => scalar @tests,
466 my @dir_files = _globdir $Files_In_Dir if defined $Files_In_Dir;
467 my $t_start = new Benchmark;
469 my $width = _leader_width(@tests);
470 foreach my $tfile (@tests) {
471 if ( $Test::Harness::Debug ) {
472 print "# Running: ", $Strap->_command_line($tfile), "\n";
475 $Last_ML_Print = 0; # so each test prints at least once
476 my($leader, $ml) = _mk_leader($tfile, $width);
483 $Strap->{_seen_header} = 0;
484 my %results = $Strap->analyze_file($tfile) or
485 do { warn $Strap->{error}, "\n"; next };
487 # state of the current test.
488 my @failed = grep { !$results{details}[$_-1]{ok} }
489 1..@{$results{details}};
492 'next' => $Strap->{'next'},
493 max => $results{max},
495 bonus => $results{bonus},
496 skipped => $results{skip},
497 skip_reason => $results{skip_reason},
498 skip_all => $Strap->{skip_all},
502 $tot{bonus} += $results{bonus};
503 $tot{max} += $results{max};
504 $tot{ok} += $results{ok};
505 $tot{todo} += $results{todo};
506 $tot{sub_skipped} += $results{skip};
508 my($estatus, $wstatus) = @results{qw(exit wait)};
510 if ($results{passing}) {
511 if ($test{max} and $test{skipped} + $test{bonus}) {
513 push(@msg, "$test{skipped}/$test{max} skipped: $test{skip_reason}")
515 push(@msg, "$test{bonus}/$test{max} unexpectedly succeeded")
517 print "$test{ml}ok\n ".join(', ', @msg)."\n";
518 } elsif ($test{max}) {
519 print "$test{ml}ok\n";
520 } elsif (defined $test{skip_all} and length $test{skip_all}) {
521 print "skipped\n all skipped: $test{skip_all}\n";
524 print "skipped\n all skipped: no reason given\n";
530 # List unrun tests as failures.
531 if ($test{'next'} <= $test{max}) {
532 push @{$test{failed}}, $test{'next'}..$test{max};
534 # List overruns as failures.
536 my $details = $results{details};
537 foreach my $overrun ($test{max}+1..@$details)
539 next unless ref $details->[$overrun-1];
540 push @{$test{failed}}, $overrun
545 $failedtests{$tfile} = _dubious_return(\%test, \%tot,
547 $failedtests{$tfile}{name} = $tfile;
549 elsif($results{seen}) {
550 if (@{$test{failed}} and $test{max}) {
551 my ($txt, $canon) = canonfailed($test{max},$test{skipped},
553 print "$test{ml}$txt";
554 $failedtests{$tfile} = { canon => $canon,
556 failed => scalar @{$test{failed}},
558 percent => 100*(scalar @{$test{failed}})/$test{max},
563 print "Don't know which tests failed: got $test{ok} ok, ".
564 "expected $test{max}\n";
565 $failedtests{$tfile} = { canon => '??',
576 print "FAILED before any test output arrived\n";
578 $failedtests{$tfile} = { canon => '??',
589 if (defined $Files_In_Dir) {
590 my @new_dir_files = _globdir $Files_In_Dir;
591 if (@new_dir_files != @dir_files) {
593 @f{@new_dir_files} = (1) x @new_dir_files;
594 delete @f{@dir_files};
595 my @f = sort keys %f;
596 print "LEAKED FILES: @f\n";
597 @dir_files = @new_dir_files;
601 $tot{bench} = timediff(new Benchmark, $t_start);
603 $Strap->_restore_PERL5LIB;
605 return(\%tot, \%failedtests);
610 my($leader, $ml) = _mk_leader($test_file, $width);
612 Generates the 't/foo........' $leader for the given C<$test_file> as well
613 as a similar version which will overwrite the current line (by use of
614 \r and such). C<$ml> may be empty if Test::Harness doesn't think you're
617 The C<$width> is the width of the "yada/blah.." string.
622 my($te, $width) = @_;
626 if ($^O eq 'VMS') { $te =~ s/^.*\.t\./\[.t./s; }
627 my $blank = (' ' x 77);
628 my $leader = "$te" . '.' x ($width - length($te));
631 $ml = "\r$blank\r$leader"
632 if -t STDOUT and not $ENV{HARNESS_NOTTY} and not $Verbose;
634 return($leader, $ml);
637 =item B<_leader_width>
639 my($width) = _leader_width(@test_files);
641 Calculates how wide the leader should be based on the length of the
650 my $suf = /\.(\w+)$/ ? $1 : '';
652 my $suflen = length $suf;
653 $maxlen = $len if $len > $maxlen;
654 $maxsuflen = $suflen if $suflen > $maxsuflen;
656 # + 3 : we want three dots between the test name and the "ok"
657 return $maxlen + 3 - $maxsuflen;
662 my($tot, $failedtests) = @_;
665 my $bonusmsg = _bonusmsg($tot);
668 print "All tests successful$bonusmsg.\n";
669 } elsif (!$tot->{tests}){
670 die "FAILED--no tests were run for some reason.\n";
671 } elsif (!$tot->{max}) {
672 my $blurb = $tot->{tests}==1 ? "script" : "scripts";
673 die "FAILED--$tot->{tests} test $blurb could be run, ".
674 "alas--no output ever seen\n";
676 $pct = sprintf("%.2f", $tot->{good} / $tot->{tests} * 100);
677 my $percent_ok = 100*$tot->{ok}/$tot->{max};
678 my $subpct = sprintf " %d/%d subtests failed, %.2f%% okay.",
679 $tot->{max} - $tot->{ok}, $tot->{max},
682 my($fmt_top, $fmt) = _create_fmts($failedtests);
684 # Now write to formats
685 for my $script (sort keys %$failedtests) {
686 $Curtest = $failedtests->{$script};
690 $bonusmsg =~ s/^,\s*//;
691 print "$bonusmsg.\n" if $bonusmsg;
692 die "Failed $tot->{bad}/$tot->{tests} test scripts, $pct% okay.".
697 printf("Files=%d, Tests=%d, %s\n",
698 $tot->{files}, $tot->{max}, timestr($tot->{bench}, 'nop'));
703 $Strap->{callback} = sub {
704 my($self, $line, $type, $totals) = @_;
705 print $line if $Verbose;
707 my $meth = $Handlers{$type};
708 $meth->($self, $line, $type, $totals) if $meth;
712 $Handlers{header} = sub {
713 my($self, $line, $type, $totals) = @_;
715 warn "Test header seen more than once!\n" if $self->{_seen_header};
717 $self->{_seen_header}++;
719 warn "1..M can only appear at the beginning or end of tests\n"
720 if $totals->{seen} &&
721 $totals->{max} < $totals->{seen};
724 $Handlers{test} = sub {
725 my($self, $line, $type, $totals) = @_;
727 my $curr = $totals->{seen};
728 my $next = $self->{'next'};
729 my $max = $totals->{max};
730 my $detail = $totals->{details}[-1];
732 if( $detail->{ok} ) {
733 _print_ml_less("ok $curr/$max");
735 if( $detail->{type} eq 'skip' ) {
736 $totals->{skip_reason} = $detail->{reason}
737 unless defined $totals->{skip_reason};
738 $totals->{skip_reason} = 'various reasons'
739 if $totals->{skip_reason} ne $detail->{reason};
743 _print_ml("NOK $curr");
746 if( $curr > $next ) {
747 print "Test output counter mismatch [test $curr]\n";
749 elsif( $curr < $next ) {
750 print "Confused test output: test $curr answered after ".
751 "test ", $next - 1, "\n";
756 $Handlers{bailout} = sub {
757 my($self, $line, $type, $totals) = @_;
759 die "FAILED--Further testing stopped" .
760 ($self->{bailout_reason} ? ": $self->{bailout_reason}\n" : ".\n");
765 print join '', $ML, @_ if $ML;
769 # For slow connections, we save lots of bandwidth by printing only once
772 if( !$Ok_Slow || $Last_ML_Print != time ) {
774 $Last_ML_Print = time;
782 $bonusmsg = (" ($tot->{bonus} subtest".($tot->{bonus} > 1 ? 's' : '').
783 " UNEXPECTEDLY SUCCEEDED)")
786 if ($tot->{skipped}) {
787 $bonusmsg .= ", $tot->{skipped} test"
788 . ($tot->{skipped} != 1 ? 's' : '');
789 if ($tot->{sub_skipped}) {
790 $bonusmsg .= " and $tot->{sub_skipped} subtest"
791 . ($tot->{sub_skipped} != 1 ? 's' : '');
793 $bonusmsg .= ' skipped';
795 elsif ($tot->{sub_skipped}) {
796 $bonusmsg .= ", $tot->{sub_skipped} subtest"
797 . ($tot->{sub_skipped} != 1 ? 's' : '')
804 # Test program go boom.
805 sub _dubious_return {
806 my($test, $tot, $estatus, $wstatus) = @_;
807 my ($failed, $canon, $percent) = ('??', '??');
809 printf "$test->{ml}dubious\n\tTest returned status $estatus ".
810 "(wstat %d, 0x%x)\n",
812 print "\t\t(VMS status is $estatus)\n" if $^O eq 'VMS';
814 if (corestatus($wstatus)) { # until we have a wait module
815 if ($Have_Devel_Corestack) {
816 Devel::CoreStack::stack($^X);
818 print "\ttest program seems to have generated a core\n";
825 if ($test->{'next'} == $test->{max} + 1 and not @{$test->{failed}}) {
826 print "\tafter all the subtests completed successfully\n";
828 $failed = 0; # But we do not set $canon!
831 push @{$test->{failed}}, $test->{'next'}..$test->{max};
832 $failed = @{$test->{failed}};
833 (my $txt, $canon) = canonfailed($test->{max},$test->{skipped},@{$test->{failed}});
834 $percent = 100*(scalar @{$test->{failed}})/$test->{max};
839 return { canon => $canon, max => $test->{max} || '??',
842 estat => $estatus, wstat => $wstatus,
848 my($failedtests) = @_;
850 my $failed_str = "Failed Test";
851 my $middle_str = " Stat Wstat Total Fail Failed ";
852 my $list_str = "List of Failed";
854 # Figure out our longest name string for formatting purposes.
855 my $max_namelen = length($failed_str);
856 foreach my $script (keys %$failedtests) {
857 my $namelen = length $failedtests->{$script}->{name};
858 $max_namelen = $namelen if $namelen > $max_namelen;
861 my $list_len = $Columns - length($middle_str) - $max_namelen;
862 if ($list_len < length($list_str)) {
863 $list_len = length($list_str);
864 $max_namelen = $Columns - length($middle_str) - $list_len;
865 if ($max_namelen < length($failed_str)) {
866 $max_namelen = length($failed_str);
867 $Columns = $max_namelen + length($middle_str) + $list_len;
871 my $fmt_top = "format STDOUT_TOP =\n"
872 . sprintf("%-${max_namelen}s", $failed_str)
878 my $fmt = "format STDOUT =\n"
879 . "@" . "<" x ($max_namelen - 1)
880 . " @>> @>>>> @>>>> @>>> ^##.##% "
881 . "^" . "<" x ($list_len - 1) . "\n"
882 . '{ $Curtest->{name}, $Curtest->{estat},'
883 . ' $Curtest->{wstat}, $Curtest->{max},'
884 . ' $Curtest->{failed}, $Curtest->{percent},'
885 . ' $Curtest->{canon}'
887 . "~~" . " " x ($Columns - $list_len - 2) . "^"
888 . "<" x ($list_len - 1) . "\n"
889 . '$Curtest->{canon}'
897 return($fmt_top, $fmt);
901 my $tried_devel_corestack;
907 eval { # we may not have a WCOREDUMP
908 local $^W = 0; # *.ph files are often *very* noisy
910 $did_core = WCOREDUMP($st);
913 $did_core = $st & 0200;
916 eval { require Devel::CoreStack; $Have_Devel_Corestack++ }
917 unless $tried_devel_corestack++;
923 sub canonfailed ($$@) {
924 my($max,$skipped,@failed) = @_;
926 @failed = sort {$a <=> $b} grep !$seen{$_}++, @failed;
927 my $failed = @failed;
931 my $last = $min = shift @failed;
934 for (@failed, $failed[-1]) { # don't forget the last one
935 if ($_ > $last+1 || $_ == $last) {
939 push @canon, "$min-$last";
946 push @result, "FAILED tests @canon\n";
947 $canon = join ' ', @canon;
949 push @result, "FAILED test $last\n";
953 push @result, "\tFailed $failed/$max tests, ";
955 push @result, sprintf("%.2f",100*(1-$failed/$max)), "% okay";
957 push @result, "?% okay";
959 my $ender = 's' x ($skipped > 1);
960 my $good = $max - $failed - $skipped;
962 my $skipmsg = " (less $skipped skipped test$ender: $good okay, ";
964 my $goodper = sprintf("%.2f",100*($good/$max));
965 $skipmsg .= "$goodper%)";
969 push @result, $skipmsg;
972 my $txt = join "", @result;
989 C<&runtests> is exported by Test::Harness by default.
991 C<$verbose>, C<$switches> and C<$debug> are exported upon request.
997 =item C<All tests successful.\nFiles=%d, Tests=%d, %s>
999 If all tests are successful some statistics about the performance are
1002 =item C<FAILED tests %s\n\tFailed %d/%d tests, %.2f%% okay.>
1004 For any single script that has failing subtests statistics like the
1007 =item C<Test returned status %d (wstat %d)>
1009 Scripts that return a non-zero exit status, both C<$? E<gt>E<gt> 8>
1010 and C<$?> are printed in a message similar to the above.
1012 =item C<Failed 1 test, %.2f%% okay. %s>
1014 =item C<Failed %d/%d tests, %.2f%% okay. %s>
1016 If not all tests were successful, the script dies with one of the
1019 =item C<FAILED--Further testing stopped: %s>
1021 If a single subtest decides that further testing will not make sense,
1022 the script dies with this message.
1030 =item C<HARNESS_ACTIVE>
1032 Harness sets this before executing the individual tests. This allows
1033 the tests to determine if they are being executed through the harness
1034 or by any other means.
1036 =item C<HARNESS_COLUMNS>
1038 This value will be used for the width of the terminal. If it is not
1039 set then it will default to C<COLUMNS>. If this is not set, it will
1040 default to 80. Note that users of Bourne-sh based shells will need to
1041 C<export COLUMNS> for this module to use that variable.
1043 =item C<HARNESS_COMPILE_TEST>
1045 When true it will make harness attempt to compile the test using
1046 C<perlcc> before running it.
1048 B<NOTE> This currently only works when sitting in the perl source
1051 =item C<HARNESS_DEBUG>
1053 If true, Test::Harness will print debugging information about itself as
1054 it runs the tests. This is different from C<HARNESS_VERBOSE>, which prints
1055 the output from the test being run. Setting C<$Test::Harness::Debug> will
1056 override this, or you can use the C<-d> switch in the F<prove> utility.
1058 =item C<HARNESS_FILELEAK_IN_DIR>
1060 When set to the name of a directory, harness will check after each
1061 test whether new files appeared in that directory, and report them as
1063 LEAKED FILES: scr.tmp 0 my.db
1065 If relative, directory name is with respect to the current directory at
1066 the moment runtests() was called. Putting absolute path into
1067 C<HARNESS_FILELEAK_IN_DIR> may give more predictable results.
1069 =item C<HARNESS_IGNORE_EXITCODE>
1071 Makes harness ignore the exit status of child processes when defined.
1073 =item C<HARNESS_NOTTY>
1075 When set to a true value, forces it to behave as though STDOUT were
1076 not a console. You may need to set this if you don't want harness to
1077 output more frequent progress messages using carriage returns. Some
1078 consoles may not handle carriage returns properly (which results in a
1079 somewhat messy output).
1081 =item C<HARNESS_OK_SLOW>
1083 If true, the C<ok> messages are printed out only every second. This
1084 reduces output and may help increase testing speed over slow
1085 connections, or with very large numbers of tests.
1087 =item C<HARNESS_PERL>
1089 Usually your tests will be run by C<$^X>, the currently-executing Perl.
1090 However, you may want to have it run by a different executable, such as
1091 a threading perl, or a different version.
1093 If you're using the F<prove> utility, you can use the C<--perl> switch.
1095 =item C<HARNESS_PERL_SWITCHES>
1097 Its value will be prepended to the switches used to invoke perl on
1098 each test. For example, setting C<HARNESS_PERL_SWITCHES> to C<-W> will
1099 run all tests with all warnings enabled.
1101 =item C<HARNESS_VERBOSE>
1103 If true, Test::Harness will output the verbose results of running
1104 its tests. Setting C<$Test::Harness::verbose> will override this,
1105 or you can use the C<-v> switch in the F<prove> utility.
1111 Here's how Test::Harness tests itself
1113 $ cd ~/src/devel/Test-Harness
1114 $ perl -Mblib -e 'use Test::Harness qw(&runtests $verbose);
1115 $verbose=0; runtests @ARGV;' t/*.t
1116 Using /home/schwern/src/devel/Test-Harness/blib
1117 t/base..............ok
1118 t/nonumbers.........ok
1119 t/ok................ok
1120 t/test-harness......ok
1121 All tests successful.
1122 Files=4, Tests=24, 2 wallclock secs ( 0.61 cusr + 0.41 csys = 1.02 CPU)
1126 L<Test> and L<Test::Simple> for writing test scripts, L<Benchmark> for
1127 the underlying timing routines, L<Devel::CoreStack> to generate core
1128 dumps from failed tests and L<Devel::Cover> for test coverage
1133 Either Tim Bunce or Andreas Koenig, we don't know. What we know for
1134 sure is, that it was inspired by Larry Wall's TEST script that came
1135 with perl distributions for ages. Numerous anonymous contributors
1136 exist. Andreas Koenig held the torch for many years, and then
1139 Current maintainer is Andy Lester C<< <andy@petdance.com> >>.
1143 This program is free software; you can redistribute it and/or
1144 modify it under the same terms as Perl itself.
1146 See L<http://www.perl.com/perl/misc/Artistic.html>
1150 Provide a way of running tests quietly (ie. no printing) for automated
1151 validation of tests. This will probably take the form of a version
1152 of runtests() which rather than printing its output returns raw data
1153 on the state of the tests. (Partially done in Test::Harness::Straps)
1155 Document the format.
1157 Fix HARNESS_COMPILE_TEST without breaking its core usage.
1159 Figure a way to report test names in the failure summary.
1161 Rework the test summary so long test names are not truncated as badly.
1162 (Partially done with new skip test styles)
1164 Deal with VMS's "not \nok 4\n" mistake.
1166 Add option for coverage analysis.
1170 Implement Straps total_results()
1174 Completely redo the print summary code.
1176 Implement Straps callbacks. (experimentally implemented)
1178 Straps->analyze_file() not taint clean, don't know if it can be
1180 Fix that damned VMS nit.
1182 HARNESS_TODOFAIL to display TODO failures
1184 Add a test for verbose.
1186 Change internal list of test results to a hash.
1188 Fix stats display when there's an overrun.
1190 Fix so perls with spaces in the filename work.
1194 Keeping whittling away at _run_all_tests()
1198 Clean up how the summary is printed. Get rid of those damned formats.
1202 HARNESS_COMPILE_TEST currently assumes it's run from the Perl source
1205 Please use the CPAN bug ticketing system at L<http://rt.cpan.org/>.
1206 You can also mail bugs, fixes and enhancements to
1207 C<< <bug-test-harness@rt.cpan.org> >>.
1211 Original code by Michael G Schwern, maintained by Andy Lester.
1215 Copyright 2003 by Michael G Schwern C<< <schwern@pobox.com> >>,
1216 Andy Lester C<< <andy@petdance.com> >>.
1218 This program is free software; you can redistribute it and/or
1219 modify it under the same terms as Perl itself.
1221 See L<http://www.perl.com/perl/misc/Artistic.html>.