X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FTest%2FHarness.pm;h=99abb0ceaad5f6882602a0d94fab89a73496d2cc;hb=ca09b0215ac24a6274ba2f802c2fc35a5abc44e1;hp=5d7d8bfef0673ce1fc9b9a1a2eb78fcbb6358ea5;hpb=81ff29e3f2c8b2515c4356170a4e8ec2243abc34;p=p5sagit%2Fp5-mst-13.2.git diff --git a/lib/Test/Harness.pm b/lib/Test/Harness.pm index 5d7d8bf..99abb0c 100644 --- a/lib/Test/Harness.pm +++ b/lib/Test/Harness.pm @@ -1,201 +1,780 @@ +# -*- Mode: cperl; cperl-indent-level: 4 -*- + package Test::Harness; -use 5.002; +require 5.00405; +use Test::Harness::Straps; +use Test::Harness::Assert; use Exporter; use Benchmark; use Config; -use FileHandle; use strict; -use vars qw($VERSION $verbose $switches $have_devel_corestack $curtest - @ISA @EXPORT @EXPORT_OK); -$have_devel_corestack = 0; - -$VERSION = "1.13"; - -@ISA=('Exporter'); -@EXPORT= qw(&runtests); -@EXPORT_OK= qw($verbose $switches); - -format STDOUT_TOP = -Failed Test Status Wstat Total Fail Failed List of failed ------------------------------------------------------------------------------- -. - -format STDOUT = -@<<<<<<<<<<<<<< @>> @>>>> @>>>> @>>> ^##.##% @<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< -{ $curtest->{name}, - $curtest->{estat}, - $curtest->{wstat}, - $curtest->{max}, - $curtest->{failed}, - $curtest->{percent}, - $curtest->{canon} +use vars '$has_time_hires'; + +BEGIN { + eval "use Time::HiRes 'time'"; + $has_time_hires = !$@; +} + +use vars qw( + $VERSION + @ISA @EXPORT @EXPORT_OK + $Verbose $Switches $Debug + $verbose $switches $debug + $Curtest + $Columns + $ML $Last_ML_Print + $Strap +); + +=head1 NAME + +Test::Harness - Run Perl standard test scripts with statistics + +=head1 VERSION + +Version 2.49_02 + +=cut + +$VERSION = "2.49_02"; + +# Backwards compatibility for exportable variable names. +*verbose = *Verbose; +*switches = *Switches; +*debug = *Debug; + +$ENV{HARNESS_ACTIVE} = 1; +$ENV{HARNESS_VERSION} = $VERSION; + +END { + # For VMS. + delete $ENV{HARNESS_ACTIVE}; + delete $ENV{HARNESS_VERSION}; } -. +# Some experimental versions of OS/2 build have broken $? +my $Ignore_Exitcode = $ENV{HARNESS_IGNORE_EXITCODE}; + +my $Files_In_Dir = $ENV{HARNESS_FILELEAK_IN_DIR}; + +$Strap = Test::Harness::Straps->new; + +sub strap { return $Strap }; + +@ISA = ('Exporter'); +@EXPORT = qw(&runtests); +@EXPORT_OK = qw($verbose $switches); + +$Verbose = $ENV{HARNESS_VERBOSE} || 0; +$Debug = $ENV{HARNESS_DEBUG} || 0; +$Switches = "-w"; +$Columns = $ENV{HARNESS_COLUMNS} || $ENV{COLUMNS} || 80; +$Columns--; # Some shells have trouble with a full line of text. + +=head1 SYNOPSIS + + use Test::Harness; + + runtests(@test_files); + +=head1 DESCRIPTION + +B If all you want to do is write a test script, consider +using Test::Simple. Test::Harness is the module that reads the +output from Test::Simple, Test::More and other modules based on +Test::Builder. You don't need to know about Test::Harness to use +those modules. + +Test::Harness runs tests and expects output from the test in a +certain format. That format is called TAP, the Test Anything +Protocol. It is defined in L. + +C runs all the testscripts named +as arguments and checks standard output for the expected strings +in TAP format. + +The F utility is a thin wrapper around Test::Harness. + +=head2 Taint mode + +Test::Harness will honor the C<-T> or C<-t> in the #! line on your +test files. So if you begin a test with: + + #!perl -T + +the test will be run with taint mode on. + +=head2 Configuration variables. + +These variables can be used to configure the behavior of +Test::Harness. They are exported on request. + +=over 4 + +=item C<$Test::Harness::Verbose> -$verbose = 0; -$switches = "-w"; +The package variable C<$Test::Harness::Verbose> is exportable and can be +used to let C display the standard output of the script +without altering the behavior otherwise. The F utility's C<-v> +flag will set this. + +=item C<$Test::Harness::switches> + +The package variable C<$Test::Harness::switches> is exportable and can be +used to set perl command line options used for running the test +script(s). The default value is C<-w>. It overrides C. + +=back + + +=head2 Failure + +When tests fail, analyze the summary report: + + t/base..............ok + t/nonumbers.........ok + t/ok................ok + t/test-harness......ok + t/waterloo..........dubious + Test returned status 3 (wstat 768, 0x300) + DIED. FAILED tests 1, 3, 5, 7, 9, 11, 13, 15, 17, 19 + Failed 10/20 tests, 50.00% okay + Failed Test Stat Wstat Total Fail Failed List of Failed + ----------------------------------------------------------------------- + t/waterloo.t 3 768 20 10 50.00% 1 3 5 7 9 11 13 15 17 19 + Failed 1/5 test scripts, 80.00% okay. 10/44 subtests failed, 77.27% okay. + +Everything passed but F. It failed 10 of 20 tests and +exited with non-zero status indicating something dubious happened. + +The columns in the summary report mean: + +=over 4 + +=item B + +The test file which failed. + +=item B + +If the test exited with non-zero, this is its exit status. + +=item B + +The wait status of the test. + +=item B + +Total number of tests expected to run. + +=item B + +Number which failed, either from "not ok" or because they never ran. + +=item B + +Percentage of the total tests which failed. + +=item B + +A list of the tests which failed. Successive failures may be +abbreviated (ie. 15-20 to indicate that tests 15, 16, 17, 18, 19 and +20 failed). + +=back + + +=head2 Functions + +Test::Harness currently only has one function, here it is. + +=over 4 + +=item B + + my $allok = runtests(@test_files); + +This runs all the given I<@test_files> and divines whether they passed +or failed based on their output to STDOUT (details above). It prints +out each individual test which failed along with a summary report and +a how long it all took. + +It returns true if everything was ok. Otherwise it will C with +one of the messages in the DIAGNOSTICS section. + +=cut sub runtests { my(@tests) = @_; - local($|) = 1; - my($test,$te,$ok,$next,$max,$pct,$totok,@failed,%failedtests); - my $totmax = 0; - my $files = 0; - my $bad = 0; - my $good = 0; - my $total = @tests; - my $old5lib = $ENV{PERL5LIB}; - local($ENV{'PERL5LIB'}) = join($Config{path_sep}, @INC); # pass -I flags to children - - my $t_start = new Benchmark; - while ($test = shift(@tests)) { - $te = $test; - chop($te); - print "$te" . '.' x (20 - length($te)); - my $fh = new FileHandle; - if ($^O eq 'VMS') { $fh->open("MCR $^X $switches $test|") || (print "can't run. $!\n"); } - else { $fh->open("$^X $switches $test|") || (print "can't run. $!\n"); } - $ok = $next = $max = 0; - @failed = (); - while (<$fh>) { - if( $verbose ){ - print $_; - } - if (/^1\.\.([0-9]+)/) { - $max = $1; - $totmax += $max; - $files++; - $next = 1; - } elsif ($max && /^(not\s+)?ok\b/) { - my $this = $next; - if (/^not ok\s*(\d*)/){ - $this = $1 if $1 > 0; - push @failed, $this; - } elsif (/^ok\s*(\d*)/) { - $this = $1 if $1 > 0; - $ok++; - $totok++; - } - if ($this > $next) { - # warn "Test output counter mismatch [test $this]\n"; - # no need to warn probably - push @failed, $next..$this-1; - } elsif ($this < $next) { - #we have seen more "ok" lines than the number suggests - warn "Confused test output: test $this answered after test ", $next-1, "\n"; - $next = $this; - } - $next = $this + 1; - } - } - $fh->close; # must close to reap child resource values - my $wstatus = $?; - my $estatus = $^O eq 'VMS' ? $wstatus : $wstatus >> 8; - if ($^O eq 'VMS' ? !($wstatus & 1) : $wstatus) { - print "dubious\n\tTest returned status $estatus (wstat $wstatus)\n"; - if (corestatus($wstatus)) { # until we have a wait module - if ($have_devel_corestack) { - Devel::CoreStack::stack($^X); - } else { - print "\ttest program seems to have generated a core\n"; - } - } - $bad++; - $failedtests{$test} = { canon => '??', max => $max || '??', - failed => '??', - name => $test, percent => undef, - estat => $estatus, wstat => $wstatus, - }; - } elsif ($ok == $max && $next == $max+1) { - if ($max) { - print "ok\n"; - } else { - print "skipping test on this platform\n"; - } - $good++; - } elsif ($max) { - if ($next <= $max) { - push @failed, $next..$max; - } - if (@failed) { - my ($txt, $canon) = canonfailed($max,@failed); - print $txt; - $failedtests{$test} = { canon => $canon, max => $max, - failed => scalar @failed, - name => $test, percent => 100*(scalar @failed)/$max, - estat => '', wstat => '', - }; - } else { - print "Don't know which tests failed: got $ok ok, expected $max\n"; - $failedtests{$test} = { canon => '??', max => $max, - failed => '??', - name => $test, percent => undef, - estat => '', wstat => '', - }; - } - $bad++; - } elsif ($next == 0) { - print "FAILED before any test output arrived\n"; - $bad++; - $failedtests{$test} = { canon => '??', max => '??', - failed => '??', - name => $test, percent => undef, - estat => '', wstat => '', - }; - } + + local ($\, $,); + + my($tot, $failedtests) = _run_all_tests(@tests); + _show_results($tot, $failedtests); + + my $ok = _all_ok($tot); + + assert(($ok xor keys %$failedtests), + q{ok status jives with $failedtests}); + + return $ok; +} + +=begin _private + +=item B<_all_ok> + + my $ok = _all_ok(\%tot); + +Tells you if this test run is overall successful or not. + +=cut + +sub _all_ok { + my($tot) = shift; + + return $tot->{bad} == 0 && ($tot->{max} || $tot->{skipped}) ? 1 : 0; +} + +=item B<_globdir> + + my @files = _globdir $dir; + +Returns all the files in a directory. This is shorthand for backwards +compatibility on systems where C doesn't work right. + +=cut + +sub _globdir { + opendir DIRH, shift; + my @f = readdir DIRH; + closedir DIRH; + + return @f; +} + +=item B<_run_all_tests> + + my($total, $failed) = _run_all_tests(@test_files); + +Runs all the given C<@test_files> (as C) but does it +quietly (no report). $total is a hash ref summary of all the tests +run. Its keys and values are this: + + bonus Number of individual todo tests unexpectedly passed + max Number of individual tests ran + ok Number of individual tests passed + sub_skipped Number of individual tests skipped + todo Number of individual todo tests + + files Number of test files ran + good Number of test files passed + bad Number of test files failed + tests Number of test files originally given + skipped Number of test files skipped + +If C<< $total->{bad} == 0 >> and C<< $total->{max} > 0 >>, you've +got a successful test. + +$failed is a hash ref of all the test scripts which failed. Each key +is the name of a test script, each value is another hash representing +how that script failed. Its keys are these: + + name Name of the test which failed + estat Script's exit value + wstat Script's wait status + max Number of individual tests + failed Number which failed + percent Percentage of tests which failed + canon List of tests which failed (as string). + +C<$failed> should be empty if everything passed. + +B Currently this function is still noisy. I'm working on it. + +=cut + +# Turns on autoflush for the handle passed +sub _autoflush { + my $flushy_fh = shift; + my $old_fh = select $flushy_fh; + $| = 1; + select $old_fh; +} + +sub _run_all_tests { + my @tests = @_; + + _autoflush(\*STDOUT); + _autoflush(\*STDERR); + + my(%failedtests); + + # Test-wide totals. + my(%tot) = ( + bonus => 0, + max => 0, + ok => 0, + files => 0, + bad => 0, + good => 0, + tests => scalar @tests, + sub_skipped => 0, + todo => 0, + skipped => 0, + bench => 0, + ); + + my @dir_files; + @dir_files = _globdir $Files_In_Dir if defined $Files_In_Dir; + my $run_start_time = new Benchmark; + + my $width = _leader_width(@tests); + foreach my $tfile (@tests) { + $Last_ML_Print = 0; # so each test prints at least once + my($leader, $ml) = _mk_leader($tfile, $width); + local $ML = $ml; + + print $leader; + + $tot{files}++; + + $Strap->{_seen_header} = 0; + if ( $Test::Harness::Debug ) { + print "# Running: ", $Strap->_command_line($tfile), "\n"; + } + my $test_start_time = time; + my %results = $Strap->analyze_file($tfile) or + do { warn $Strap->{error}, "\n"; next }; + my $test_end_time = time; + my $elapsed = $test_end_time - $test_start_time; + $elapsed = $has_time_hires ? sprintf( " %8.3fs", $elapsed ) : ""; + + # state of the current test. + my @failed = grep { !$results{details}[$_-1]{ok} } + 1..@{$results{details}}; + my %test = ( + ok => $results{ok}, + 'next' => $Strap->{'next'}, + max => $results{max}, + failed => \@failed, + bonus => $results{bonus}, + skipped => $results{skip}, + skip_reason => $results{skip_reason}, + skip_all => $Strap->{skip_all}, + ml => $ml, + ); + + $tot{bonus} += $results{bonus}; + $tot{max} += $results{max}; + $tot{ok} += $results{ok}; + $tot{todo} += $results{todo}; + $tot{sub_skipped} += $results{skip}; + + my($estatus, $wstatus) = @results{qw(exit wait)}; + + if ($results{passing}) { + # XXX Combine these first two + if ($test{max} and $test{skipped} + $test{bonus}) { + my @msg; + push(@msg, "$test{skipped}/$test{max} skipped: $test{skip_reason}") + if $test{skipped}; + push(@msg, "$test{bonus}/$test{max} unexpectedly succeeded") + if $test{bonus}; + print "$test{ml}ok$elapsed\n ".join(', ', @msg)."\n"; + } + elsif ( $test{max} ) { + print "$test{ml}ok$elapsed\n"; + } + elsif ( defined $test{skip_all} and length $test{skip_all} ) { + print "skipped\n all skipped: $test{skip_all}\n"; + $tot{skipped}++; + } + else { + print "skipped\n all skipped: no reason given\n"; + $tot{skipped}++; + } + $tot{good}++; + } + else { + # List unrun tests as failures. + if ($test{'next'} <= $test{max}) { + push @{$test{failed}}, $test{'next'}..$test{max}; + } + # List overruns as failures. + else { + my $details = $results{details}; + foreach my $overrun ($test{max}+1..@$details) { + next unless ref $details->[$overrun-1]; + push @{$test{failed}}, $overrun + } + } + + if ($wstatus) { + $failedtests{$tfile} = _dubious_return(\%test, \%tot, + $estatus, $wstatus); + $failedtests{$tfile}{name} = $tfile; + } + elsif($results{seen}) { + if (@{$test{failed}} and $test{max}) { + my ($txt, $canon) = _canonfailed($test{max},$test{skipped}, + @{$test{failed}}); + print "$test{ml}$txt"; + $failedtests{$tfile} = { canon => $canon, + max => $test{max}, + failed => scalar @{$test{failed}}, + name => $tfile, + percent => 100*(scalar @{$test{failed}})/$test{max}, + estat => '', + wstat => '', + }; + } + else { + print "Don't know which tests failed: got $test{ok} ok, ". + "expected $test{max}\n"; + $failedtests{$tfile} = { canon => '??', + max => $test{max}, + failed => '??', + name => $tfile, + percent => undef, + estat => '', + wstat => '', + }; + } + $tot{bad}++; + } + else { + print "FAILED before any test output arrived\n"; + $tot{bad}++; + $failedtests{$tfile} = { canon => '??', + max => '??', + failed => '??', + name => $tfile, + percent => undef, + estat => '', + wstat => '', + }; + } + } + + if (defined $Files_In_Dir) { + my @new_dir_files = _globdir $Files_In_Dir; + if (@new_dir_files != @dir_files) { + my %f; + @f{@new_dir_files} = (1) x @new_dir_files; + delete @f{@dir_files}; + my @f = sort keys %f; + print "LEAKED FILES: @f\n"; + @dir_files = @new_dir_files; + } + } + } # foreach test + $tot{bench} = timediff(new Benchmark, $run_start_time); + + $Strap->_restore_PERL5LIB; + + return(\%tot, \%failedtests); +} + +=item B<_mk_leader> + + my($leader, $ml) = _mk_leader($test_file, $width); + +Generates the 't/foo........' leader for the given C<$test_file> as well +as a similar version which will overwrite the current line (by use of +\r and such). C<$ml> may be empty if Test::Harness doesn't think you're +on TTY. + +The C<$width> is the width of the "yada/blah.." string. + +=cut + +sub _mk_leader { + my($te, $width) = @_; + chomp($te); + $te =~ s/\.\w+$/./; + + if ($^O eq 'VMS') { + $te =~ s/^.*\.t\./\[.t./s; } - my $t_total = timediff(new Benchmark, $t_start); - - if ($^O eq 'VMS' and defined($old5lib)) { $ENV{PERL5LIB} = $old5lib; } - if ($bad == 0 && $totmax) { - print "All tests successful.\n"; - } elsif ($total==0){ - die "FAILED--no tests were run for some reason.\n"; - } elsif ($totmax==0) { - my $blurb = $total==1 ? "script" : "scripts"; - die "FAILED--$total test $blurb could be run, alas--no output ever seen\n"; - } else { - $pct = sprintf("%.2f", $good / $total * 100); - my $subpct = sprintf " %d/%d subtests failed, %.2f%% okay.", - $totmax - $totok, $totmax, 100*$totok/$totmax; - my $script; - for $script (sort keys %failedtests) { - $curtest = $failedtests{$script}; - write; - } - if ($bad > 1) { - die "Failed $bad/$total test scripts, $pct% okay.$subpct\n"; - } + my $leader = "$te" . '.' x ($width - length($te)); + my $ml = ""; + + if ( -t STDOUT and not $ENV{HARNESS_NOTTY} and not $Verbose ) { + $ml = "\r" . (' ' x 77) . "\r$leader" } - printf("Files=%d, Tests=%d, %s\n", $files, $totmax, timestr($t_total, 'nop')); - return ($bad == 0 && $totmax) ; + return($leader, $ml); } -sub corestatus { - my($st) = @_; - my($ret); +=item B<_leader_width> - eval {require 'wait.ph'}; - if ($@) { - SWITCH: { - $ret = ($st & 0200); # Tim says, this is for 90% - } - } else { - $ret = WCOREDUMP($st); + my($width) = _leader_width(@test_files); + +Calculates how wide the leader should be based on the length of the +longest test name. + +=cut + +sub _leader_width { + my $maxlen = 0; + my $maxsuflen = 0; + foreach (@_) { + my $suf = /\.(\w+)$/ ? $1 : ''; + my $len = length; + my $suflen = length $suf; + $maxlen = $len if $len > $maxlen; + $maxsuflen = $suflen if $suflen > $maxsuflen; + } + # + 3 : we want three dots between the test name and the "ok" + return $maxlen + 3 - $maxsuflen; +} + + +sub _show_results { + my($tot, $failedtests) = @_; + + my $pct; + my $bonusmsg = _bonusmsg($tot); + + if (_all_ok($tot)) { + print "All tests successful$bonusmsg.\n"; + } + elsif (!$tot->{tests}){ + die "FAILED--no tests were run for some reason.\n"; + } + elsif (!$tot->{max}) { + my $blurb = $tot->{tests}==1 ? "script" : "scripts"; + die "FAILED--$tot->{tests} test $blurb could be run, ". + "alas--no output ever seen\n"; + } + else { + $pct = sprintf("%.2f", $tot->{good} / $tot->{tests} * 100); + my $percent_ok = 100*$tot->{ok}/$tot->{max}; + my $subpct = sprintf " %d/%d subtests failed, %.2f%% okay.", + $tot->{max} - $tot->{ok}, $tot->{max}, + $percent_ok; + + my($fmt_top, $fmt) = _create_fmts($failedtests); + + # Now write to formats + for my $script (sort keys %$failedtests) { + $Curtest = $failedtests->{$script}; + write; + } + if ($tot->{bad}) { + $bonusmsg =~ s/^,\s*//; + print "$bonusmsg.\n" if $bonusmsg; + die "Failed $tot->{bad}/$tot->{tests} test scripts, $pct% okay.". + "$subpct\n"; + } + } + + printf("Files=%d, Tests=%d, %s\n", + $tot->{files}, $tot->{max}, timestr($tot->{bench}, 'nop')); +} + + +my %Handlers = ( + header => \&header_handler, + test => \&test_handler, + bailout => \&bailout_handler, +); + +$Strap->{callback} = \&strap_callback; +sub strap_callback { + my($self, $line, $type, $totals) = @_; + print $line if $Verbose; + + my $meth = $Handlers{$type}; + $meth->($self, $line, $type, $totals) if $meth; +}; + + +sub header_handler { + my($self, $line, $type, $totals) = @_; + + warn "Test header seen more than once!\n" if $self->{_seen_header}; + + $self->{_seen_header}++; + + warn "1..M can only appear at the beginning or end of tests\n" + if $totals->{seen} && + $totals->{max} < $totals->{seen}; +}; + +sub test_handler { + my($self, $line, $type, $totals) = @_; + + my $curr = $totals->{seen}; + my $next = $self->{'next'}; + my $max = $totals->{max}; + my $detail = $totals->{details}[-1]; + + if( $detail->{ok} ) { + _print_ml_less("ok $curr/$max"); + + if( $detail->{type} eq 'skip' ) { + $totals->{skip_reason} = $detail->{reason} + unless defined $totals->{skip_reason}; + $totals->{skip_reason} = 'various reasons' + if $totals->{skip_reason} ne $detail->{reason}; + } + } + else { + _print_ml("NOK $curr"); + } + + if( $curr > $next ) { + print "Test output counter mismatch [test $curr]\n"; + } + elsif( $curr < $next ) { + print "Confused test output: test $curr answered after ". + "test ", $next - 1, "\n"; + } + +}; + +sub bailout_handler { + my($self, $line, $type, $totals) = @_; + + die "FAILED--Further testing stopped" . + ($self->{bailout_reason} ? ": $self->{bailout_reason}\n" : ".\n"); +}; + + +sub _print_ml { + print join '', $ML, @_ if $ML; +} + + +# For slow connections, we save lots of bandwidth by printing only once +# per second. +sub _print_ml_less { + if ( $Last_ML_Print != time ) { + _print_ml(@_); + $Last_ML_Print = time; + } +} + +sub _bonusmsg { + my($tot) = @_; + + my $bonusmsg = ''; + $bonusmsg = (" ($tot->{bonus} subtest".($tot->{bonus} > 1 ? 's' : ''). + " UNEXPECTEDLY SUCCEEDED)") + if $tot->{bonus}; + + if ($tot->{skipped}) { + $bonusmsg .= ", $tot->{skipped} test" + . ($tot->{skipped} != 1 ? 's' : ''); + if ($tot->{sub_skipped}) { + $bonusmsg .= " and $tot->{sub_skipped} subtest" + . ($tot->{sub_skipped} != 1 ? 's' : ''); + } + $bonusmsg .= ' skipped'; + } + elsif ($tot->{sub_skipped}) { + $bonusmsg .= ", $tot->{sub_skipped} subtest" + . ($tot->{sub_skipped} != 1 ? 's' : '') + . " skipped"; + } + + return $bonusmsg; +} + +# Test program go boom. +sub _dubious_return { + my($test, $tot, $estatus, $wstatus) = @_; + my ($failed, $canon, $percent) = ('??', '??'); + + printf "$test->{ml}dubious\n\tTest returned status $estatus ". + "(wstat %d, 0x%x)\n", + $wstatus,$wstatus; + print "\t\t(VMS status is $estatus)\n" if $^O eq 'VMS'; + + $tot->{bad}++; + + if ($test->{max}) { + if ($test->{'next'} == $test->{max} + 1 and not @{$test->{failed}}) { + print "\tafter all the subtests completed successfully\n"; + $percent = 0; + $failed = 0; # But we do not set $canon! + } + else { + push @{$test->{failed}}, $test->{'next'}..$test->{max}; + $failed = @{$test->{failed}}; + (my $txt, $canon) = _canonfailed($test->{max},$test->{skipped},@{$test->{failed}}); + $percent = 100*(scalar @{$test->{failed}})/$test->{max}; + print "DIED. ",$txt; + } + } + + return { canon => $canon, max => $test->{max} || '??', + failed => $failed, + percent => $percent, + estat => $estatus, wstat => $wstatus, + }; +} + + +sub _create_fmts { + my($failedtests) = @_; + + my $failed_str = "Failed Test"; + my $middle_str = " Stat Wstat Total Fail Failed "; + my $list_str = "List of Failed"; + + # Figure out our longest name string for formatting purposes. + my $max_namelen = length($failed_str); + foreach my $script (keys %$failedtests) { + my $namelen = length $failedtests->{$script}->{name}; + $max_namelen = $namelen if $namelen > $max_namelen; + } + + my $list_len = $Columns - length($middle_str) - $max_namelen; + if ($list_len < length($list_str)) { + $list_len = length($list_str); + $max_namelen = $Columns - length($middle_str) - $list_len; + if ($max_namelen < length($failed_str)) { + $max_namelen = length($failed_str); + $Columns = $max_namelen + length($middle_str) + $list_len; + } } - eval {require Devel::CoreStack}; - $have_devel_corestack++ unless $@; + my $fmt_top = "format STDOUT_TOP =\n" + . sprintf("%-${max_namelen}s", $failed_str) + . $middle_str + . $list_str . "\n" + . "-" x $Columns + . "\n.\n"; + + my $fmt = "format STDOUT =\n" + . "@" . "<" x ($max_namelen - 1) + . " @>> @>>>> @>>>> @>>> ^##.##% " + . "^" . "<" x ($list_len - 1) . "\n" + . '{ $Curtest->{name}, $Curtest->{estat},' + . ' $Curtest->{wstat}, $Curtest->{max},' + . ' $Curtest->{failed}, $Curtest->{percent},' + . ' $Curtest->{canon}' + . "\n}\n" + . "~~" . " " x ($Columns - $list_len - 2) . "^" + . "<" x ($list_len - 1) . "\n" + . '$Curtest->{canon}' + . "\n.\n"; + + eval $fmt_top; + die $@ if $@; + eval $fmt; + die $@ if $@; - $ret; + return($fmt_top, $fmt); } -sub canonfailed ($@) { - my($max,@failed) = @_; +sub _canonfailed ($$@) { + my($max,$skipped,@failed) = @_; my %seen; @failed = sort {$a <=> $b} grep !$seen{$_}++, @failed; my $failed = @failed; @@ -205,89 +784,63 @@ sub canonfailed ($@) { my $last = $min = shift @failed; my $canon; if (@failed) { - for (@failed, $failed[-1]) { # don't forget the last one - if ($_ > $last+1 || $_ == $last) { - if ($min == $last) { - push @canon, $last; - } else { - push @canon, "$min-$last"; - } - $min = $_; - } - $last = $_; - } - local $" = ", "; - push @result, "FAILED tests @canon\n"; - $canon = "@canon"; - } else { - push @result, "FAILED test $last\n"; - $canon = $last; + for (@failed, $failed[-1]) { # don't forget the last one + if ($_ > $last+1 || $_ == $last) { + push @canon, ($min == $last) ? $last : "$min-$last"; + $min = $_; + } + $last = $_; + } + local $" = ", "; + push @result, "FAILED tests @canon\n"; + $canon = join ' ', @canon; + } + else { + push @result, "FAILED test $last\n"; + $canon = $last; } push @result, "\tFailed $failed/$max tests, "; - push @result, sprintf("%.2f",100*(1-$failed/$max)), "% okay\n"; + if ($max) { + push @result, sprintf("%.2f",100*(1-$failed/$max)), "% okay"; + } + else { + push @result, "?% okay"; + } + my $ender = 's' x ($skipped > 1); + if ($skipped) { + my $good = $max - $failed - $skipped; + my $skipmsg = " (less $skipped skipped test$ender: $good okay, "; + if ($max) { + my $goodper = sprintf("%.2f",100*($good/$max)); + $skipmsg .= "$goodper%)"; + } + else { + $skipmsg .= "?%)"; + } + push @result, $skipmsg; + } + push @result, "\n"; my $txt = join "", @result; ($txt, $canon); } -1; -__END__ - -=head1 NAME - -Test::Harness - run perl standard test scripts with statistics - -=head1 SYNOPSIS - -use Test::Harness; - -runtests(@tests); - -=head1 DESCRIPTION - -Perl test scripts print to standard output C<"ok N"> for each single -test, where C is an increasing sequence of integers. The first line -output by a standard test script is C<"1..M"> with C being the -number of tests that should be run within the test -script. Test::Harness::runtests(@tests) runs all the testscripts -named as arguments and checks standard output for the expected -C<"ok N"> strings. - -After all tests have been performed, runtests() prints some -performance statistics that are computed by the Benchmark module. +=end _private -=head2 The test script output - -Any output from the testscript to standard error is ignored and -bypassed, thus will be seen by the user. Lines written to standard -output containing C are interpreted as feedback for -runtests(). All other lines are discarded. - -It is tolerated if the test numbers after C are omitted. In this -case Test::Harness maintains temporarily its own counter until the -script supplies test numbers again. So the following test script +=back - print < is exported by Test::Harness per default. +C<&runtests> is exported by Test::Harness by default. + +C<$verbose>, C<$switches> and C<$debug> are exported upon request. =head1 DIAGNOSTICS @@ -305,8 +858,8 @@ above are printed. =item C -Scripts that return a non-zero exit status, both C<$? EE 8> and C<$?> are -printed in a message similar to the above. +Scripts that return a non-zero exit status, both C<$? EE 8> +and C<$?> are printed in a message similar to the above. =item C @@ -315,25 +868,197 @@ printed in a message similar to the above. If not all tests were successful, the script dies with one of the above messages. +=item C + +If a single subtest decides that further testing will not make sense, +the script dies with this message. + +=back + +=head1 ENVIRONMENT VARIABLES THAT TEST::HARNESS SETS + +Test::Harness sets these before executing the individual tests. + +=over 4 + +=item C + +This is set to a true value. It allows the tests to determine if they +are being executed through the harness or by any other means. + +=item C + +This is the version of Test::Harness. + +=back + +=head1 ENVIRONMENT VARIABLES THAT AFFECT TEST::HARNESS + +=over 4 + +=item C + +This value will be used for the width of the terminal. If it is not +set then it will default to C. If this is not set, it will +default to 80. Note that users of Bourne-sh based shells will need to +C for this module to use that variable. + +=item C + +When true it will make harness attempt to compile the test using +C before running it. + +B This currently only works when sitting in the perl source +directory! + +=item C + +If true, Test::Harness will print debugging information about itself as +it runs the tests. This is different from C, which prints +the output from the test being run. Setting C<$Test::Harness::Debug> will +override this, or you can use the C<-d> switch in the F utility. + +=item C + +When set to the name of a directory, harness will check after each +test whether new files appeared in that directory, and report them as + + LEAKED FILES: scr.tmp 0 my.db + +If relative, directory name is with respect to the current directory at +the moment runtests() was called. Putting absolute path into +C may give more predictable results. + +=item C + +Makes harness ignore the exit status of child processes when defined. + +=item C + +When set to a true value, forces it to behave as though STDOUT were +not a console. You may need to set this if you don't want harness to +output more frequent progress messages using carriage returns. Some +consoles may not handle carriage returns properly (which results in a +somewhat messy output). + +=item C + +Usually your tests will be run by C<$^X>, the currently-executing Perl. +However, you may want to have it run by a different executable, such as +a threading perl, or a different version. + +If you're using the F utility, you can use the C<--perl> switch. + +=item C + +Its value will be prepended to the switches used to invoke perl on +each test. For example, setting C to C<-W> will +run all tests with all warnings enabled. + +=item C + +If true, Test::Harness will output the verbose results of running +its tests. Setting C<$Test::Harness::verbose> will override this, +or you can use the C<-v> switch in the F utility. + =back +=head1 EXAMPLE + +Here's how Test::Harness tests itself + + $ cd ~/src/devel/Test-Harness + $ perl -Mblib -e 'use Test::Harness qw(&runtests $verbose); + $verbose=0; runtests @ARGV;' t/*.t + Using /home/schwern/src/devel/Test-Harness/blib + t/base..............ok + t/nonumbers.........ok + t/ok................ok + t/test-harness......ok + All tests successful. + Files=4, Tests=24, 2 wallclock secs ( 0.61 cusr + 0.41 csys = 1.02 CPU) + =head1 SEE ALSO -See L for the underlying timing routines. +The included F utility for running test scripts from the command line, +L and L for writing test scripts, L for +the underlying timing routines, and L for test coverage +analysis. + +=head1 TODO + +Provide a way of running tests quietly (ie. no printing) for automated +validation of tests. This will probably take the form of a version +of runtests() which rather than printing its output returns raw data +on the state of the tests. (Partially done in Test::Harness::Straps) + +Document the format. + +Fix HARNESS_COMPILE_TEST without breaking its core usage. + +Figure a way to report test names in the failure summary. + +Rework the test summary so long test names are not truncated as badly. +(Partially done with new skip test styles) + +Add option for coverage analysis. + +Trap STDERR. + +Implement Straps total_results() + +Remember exit code + +Completely redo the print summary code. + +Implement Straps callbacks. (experimentally implemented) + +Straps->analyze_file() not taint clean, don't know if it can be + +Fix that damned VMS nit. + +HARNESS_TODOFAIL to display TODO failures + +Add a test for verbose. + +Change internal list of test results to a hash. + +Fix stats display when there's an overrun. + +Fix so perls with spaces in the filename work. + +Keeping whittling away at _run_all_tests() + +Clean up how the summary is printed. Get rid of those damned formats. + +=head1 BUGS + +HARNESS_COMPILE_TEST currently assumes it's run from the Perl source +directory. + +Please use the CPAN bug ticketing system at L. +You can also mail bugs, fixes and enhancements to +C<< > at C<< rt.cpan.org> >>. =head1 AUTHORS Either Tim Bunce or Andreas Koenig, we don't know. What we know for sure is, that it was inspired by Larry Wall's TEST script that came -with perl distributions for ages. Current maintainer is Andreas -Koenig. +with perl distributions for ages. Numerous anonymous contributors +exist. Andreas Koenig held the torch for many years, and then +Michael G Schwern. -=head1 BUGS +Current maintainer is Andy Lester C<< >>. + +=head1 COPYRIGHT + +Copyright 2002-2005 +by Michael G Schwern C<< >>, +Andy Lester C<< >>. + +This program is free software; you can redistribute it and/or +modify it under the same terms as Perl itself. -Test::Harness uses $^X to determine the perl binary to run the tests -with. Test scripts running via the shebang (C<#!>) line may not be -portable because $^X is not consistent for shebang scripts across -platforms. This is no problem when Test::Harness is run with an -absolute path to the perl binary or when $^X can be found in the path. +See L. =cut