home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / perl-5.003-bin.lha / lib / perl5 / Test / Harness.pm
Encoding:
Perl POD Document  |  1996-10-10  |  6.5 KB  |  259 lines
  1. package Test::Harness;
  2.  
  3. use Exporter;
  4. use Benchmark;
  5. use Config;
  6. use FileHandle;
  7. use vars qw($VERSION $verbose $switches);
  8. require 5.002;
  9.  
  10. $VERSION = "1.07";
  11.  
  12. @ISA=('Exporter');
  13. @EXPORT= qw(&runtests);
  14. @EXPORT_OK= qw($verbose $switches);
  15.  
  16.  
  17. $verbose = 0;
  18. $switches = "-w";
  19.  
  20. sub runtests {
  21.     my(@tests) = @_;
  22.     local($|) = 1;
  23.     my($test,$te,$ok,$next,$max,$pct);
  24.     my $totmax = 0;
  25.     my $files = 0;
  26.     my $bad = 0;
  27.     my $good = 0;
  28.     my $total = @tests;
  29.     local($ENV{'PERL5LIB'}) = join($Config{path_sep}, @INC); # pass -I flags to children
  30.  
  31.     my $t_start = new Benchmark;
  32.     while ($test = shift(@tests)) {
  33.     $te = $test;
  34.     chop($te);
  35.     print "$te" . '.' x (20 - length($te));
  36.     my $fh = new FileHandle;
  37.     $fh->open("$^X $switches $test|") || (print "can't run. $!\n");
  38.     $ok = $next = $max = 0;
  39.     @failed = ();
  40.     while (<$fh>) {
  41.         if( $verbose ){
  42.         print $_;
  43.         }
  44.         unless (/^\s*\#/) {
  45.         if (/^1\.\.([0-9]+)/) {
  46.             $max = $1;
  47.             $totmax += $max;
  48.             $files++;
  49.             $next = 1;
  50.         } elsif ($max && /^(not\s+)?ok\b/) {
  51.             my $this = $next;
  52.             if (/^not ok\s*(\d*)/){
  53.             $this = $1 if $1 > 0;
  54.             push @failed, $this;
  55.             } elsif (/^ok\s*(\d*)/) {
  56.             $this = $1 if $1 > 0;
  57.             $ok++;
  58.             $totok++;
  59.             }
  60.             if ($this > $next) {
  61.             # warn "Test output counter mismatch [test $this]\n";
  62.             # no need to warn probably
  63.             push @failed, $next..$this-1;
  64.             } elsif ($this < $next) {
  65.             #we have seen more "ok" lines than the number suggests
  66.             warn "Aborting test: output counter mismatch [test $this answered when test $next expected]\n";
  67.             last;
  68.             }
  69.             $next = $this + 1;
  70.         }
  71.         }
  72.     }
  73.     $fh->close; # must close to reap child resource values
  74.     my $wstatus = $?;
  75.     my $estatus = $wstatus >> 8;
  76.     if ($ok == $max && $next == $max+1 && ! $estatus) {
  77.         print "ok\n";
  78.         $good++;
  79.     } elsif ($max) {
  80.         if ($next <= $max) {
  81.         push @failed, $next..$max;
  82.         }
  83.         if (@failed) {
  84.         print canonfailed($max,@failed);
  85.         } else {
  86.         print "Don't know which tests failed for some reason\n";
  87.         }
  88.         $bad++;
  89.     } elsif ($next == 0) {
  90.         print "FAILED before any test output arrived\n";
  91.         $bad++;
  92.     }
  93.     if ($wstatus) {
  94.         print "\tTest returned status $estatus (wstat $wstatus)\n";
  95.     }
  96.     }
  97.     my $t_total = timediff(new Benchmark, $t_start);
  98.     
  99.     if ($bad == 0 && $totmax) {
  100.         print "All tests successful.\n";
  101.     } elsif ($total==0){
  102.     die "FAILED--no tests were run for some reason.\n";
  103.     } elsif ($totmax==0) {
  104.     my $blurb = $total==1 ? "script" : "scripts";
  105.     die "FAILED--$total test $blurb could be run, alas -- no output ever seen\n";
  106.     } else {
  107.     $pct = sprintf("%.2f", $good / $total * 100);
  108.     my $subpct = sprintf " %d/%d subtests failed, %.2f%% okay.",
  109.     $totmax - $totok, $totmax, 100*$totok/$totmax;
  110.     if ($bad == 1) {
  111.         die "Failed 1 test script, $pct% okay.$subpct\n";
  112.     } else {
  113.         die "Failed $bad/$total test scripts, $pct% okay.$subpct\n";
  114.     }
  115.     }
  116.     printf("Files=%d,  Tests=%d, %s\n", $files, $totmax, timestr($t_total, 'nop'));
  117. }
  118.  
  119. sub canonfailed ($@) {
  120.     my($max,@failed) = @_;
  121.     my %seen;
  122.     @failed = sort {$a <=> $b} grep !$seen{$_}++, @failed;
  123.     my $failed = @failed;
  124.     my @result = ();
  125.     my @canon = ();
  126.     my $min;
  127.     my $last = $min = shift @failed;
  128.     if (@failed) {
  129.     for (@failed, $failed[-1]) { # don't forget the last one
  130.         if ($_ > $last+1 || $_ == $last) {
  131.         if ($min == $last) {
  132.             push @canon, $last;
  133.         } else {
  134.             push @canon, "$min-$last";
  135.         }
  136.         $min = $_;
  137.         }
  138.         $last = $_;
  139.     }
  140.     local $" = ", ";
  141.     push @result, "FAILED tests @canon\n";
  142.     } else {
  143.     push @result, "FAILED test $last\n";
  144.     }
  145.  
  146.     push @result, "\tFailed $failed/$max tests, ";
  147.     push @result, sprintf("%.2f",100*(1-$failed/$max)), "% okay\n";
  148.     join "", @result;
  149. }
  150.  
  151. 1;
  152. __END__
  153.  
  154. =head1 NAME
  155.  
  156. Test::Harness - run perl standard test scripts with statistics
  157.  
  158. =head1 SYNOPSIS
  159.  
  160. use Test::Harness;
  161.  
  162. runtests(@tests);
  163.  
  164. =head1 DESCRIPTION
  165.  
  166. Perl test scripts print to standard output C<"ok N"> for each single
  167. test, where C<N> is an increasing sequence of integers. The first line
  168. output by a standard test scxript is C<"1..M"> with C<M> being the
  169. number of tests that should be run within the test
  170. script. Test::Harness::runscripts(@tests) runs all the testscripts
  171. named as arguments and checks standard output for the expected
  172. C<"ok N"> strings.
  173.  
  174. After all tests have been performed, runscripts() prints some
  175. performance statistics that are computed by the Benchmark module.
  176.  
  177. =head2 The test script output
  178.  
  179. Any output from the testscript to standard error is ignored and
  180. bypassed, thus will be seen by the user. Lines written to standard
  181. output that look like perl comments (start with C</^\s*\#/>) are
  182. discarded. Lines containing C</^(not\s+)?ok\b/> are interpreted as
  183. feedback for runtests().
  184.  
  185. It is tolerated if the test numbers after C<ok> are omitted. In this
  186. case Test::Harness maintains temporarily its own counter until the
  187. script supplies test numbers again. So the following test script
  188.  
  189.     print <<END;
  190.     1..6
  191.     not ok
  192.     ok
  193.     not ok
  194.     ok
  195.     ok
  196.     END
  197.  
  198. will generate 
  199.  
  200.     FAILED tests 1, 3, 6
  201.     Failed 3/6 tests, 50.00% okay
  202.  
  203. The global variable $Test::Harness::verbose is exportable and can be
  204. used to let runscripts() display the standard output of the script
  205. without altering the behavior otherwise.
  206.  
  207. =head1 EXPORT
  208.  
  209. C<&runscripts> is exported by Test::Harness per default.
  210.  
  211. =head1 DIAGNOSTICS
  212.  
  213. =over 4
  214.  
  215. =item C<All tests successful.\nFiles=%d,  Tests=%d, %s>
  216.  
  217. If all tests are successful some statistics about the performance are
  218. printed.
  219.  
  220. =item C<FAILED tests %s\n\tFailed %d/%d tests, %.2f%% okay.>
  221.  
  222. For any single script that has failing subtests statistics like the
  223. above are printed.
  224.  
  225. =item C<Test returned status %d (wstat %d)>
  226.  
  227. Scripts that return a non-zero exit status, both $?>>8 and $? are
  228. printed in a message similar to the above.
  229.  
  230. =item C<Failed 1 test, %.2f%% okay. %s>
  231.  
  232. =item C<Failed %d/%d tests, %.2f%% okay. %s>
  233.  
  234. If not all tests were successful, the script dies with one of the
  235. above messages.
  236.  
  237. =back
  238.  
  239. =head1 SEE ALSO
  240.  
  241. See L<Benchmark> for the underlying timing routines.
  242.  
  243. =head1 AUTHORS
  244.  
  245. Either Tim Bunce or Andreas Koenig, we don't know. What we know for
  246. sure is, that it was inspired by Larry Wall's TEST script that came
  247. with perl distributions for ages. Current maintainer is Andreas
  248. Koenig.
  249.  
  250. =head1 BUGS
  251.  
  252. Test::Harness uses $^X to determine the perl binary to run the tests
  253. with. Test scripts running via the shebang (C<#!>) line may not be
  254. portable because $^X is not consistent for shebang scripts across
  255. platforms. This is no problem when Test::Harness is run with an
  256. absolute path to the perl binary or when $^X can be found in the path.
  257.  
  258. =cut
  259.