prettier Test::Harness output on failed tests (from Nicholas Clark
[p5sagit/p5-mst-13.2.git] / lib / Test / Harness.pm
index 738f36d..aded0e9 100644 (file)
@@ -1,17 +1,17 @@
 package Test::Harness;
 
-BEGIN {require 5.002;}
+use 5.005_64;
 use Exporter;
 use Benchmark;
 use Config;
 use FileHandle;
 use strict;
 
-use vars qw($VERSION $verbose $switches $have_devel_corestack $curtest
-           @ISA @EXPORT @EXPORT_OK);
+our($VERSION, $verbose, $switches, $have_devel_corestack, $curtest,
+    $columns, @ISA, @EXPORT, @EXPORT_OK);
 $have_devel_corestack = 0;
 
-$VERSION = "1.1602";
+$VERSION = "1.1604";
 
 $ENV{HARNESS_ACTIVE} = 1;
 
@@ -27,36 +27,18 @@ my $subtests_skipped = 0;
 @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}
-}
-~~                                            ^<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
-                                              $curtest->{canon}
-.
-
-
 $verbose = 0;
 $switches = "-w";
+$columns = $ENV{HARNESS_COLUMNS} || $ENV{COLUMNS} || 80;
 
 sub globdir { opendir DIRH, shift; my @f = readdir DIRH; closedir DIRH; @f }
 
 sub runtests {
     my(@tests) = @_;
     local($|) = 1;
-    my($test,$te,$ok,$next,$max,$pct,$totok,$totbonus,@failed,%failedtests);
+    my($test,$te,$ok,$next,$max,$pct,$totbonus,@failed,%failedtests);
     my $totmax = 0;
+    my $totok = 0;
     my $files = 0;
     my $bad = 0;
     my $good = 0;
@@ -64,26 +46,46 @@ sub runtests {
 
     # pass -I flags to children
     my $old5lib = $ENV{PERL5LIB};
-    local($ENV{'PERL5LIB'}) = join($Config{path_sep}, @INC);
 
-    if ($^O eq 'VMS') { $switches =~ s/-(\S*[A-Z]\S*)/"-$1"/g }
+    # VMS has a 255-byte limit on the length of %ENV entries, so
+    # toss the ones that involve perl_root, the install location
+    # for VMS
+    my $new5lib;
+    if ($^O eq 'VMS') {
+       $new5lib = join($Config{path_sep}, grep {!/perl_root/i;} @INC);
+       $switches =~ s/-(\S*[A-Z]\S*)/"-$1"/g;
+    }
+    else {
+        $new5lib = join($Config{path_sep}, @INC);
+    }
+
+    local($ENV{'PERL5LIB'}) = $new5lib;
 
     my @dir_files = globdir $files_in_dir if defined $files_in_dir;
     my $t_start = new Benchmark;
     while ($test = shift(@tests)) {
        $te = $test;
        chop($te);
-       if ($^O eq 'VMS') { $te =~ s/^.*\.t\./[.t./; }
-       print "$te" . '.' x (20 - length($te));
+       if ($^O eq 'VMS') { $te =~ s/^.*\.t\./[.t./s; }
+       my $blank = (' ' x 77);
+       my $leader = "$te" . '.' x (20 - length($te));
+       my $ml = "";
+       $ml = "\r$blank\r$leader"
+           if -t STDOUT and not $ENV{HARNESS_NOTTY} and not $verbose;
+       print $leader;
        my $fh = new FileHandle;
        $fh->open($test) or print "can't open $test. $!\n";
        my $first = <$fh>;
        my $s = $switches;
-       $s .= q[ "-T"] if $first =~ /^#!.*\bperl.*-\w*T/;
+       $s .= " $ENV{'HARNESS_PERL_SWITCHES'}"
+           if exists $ENV{'HARNESS_PERL_SWITCHES'};
+       $s .= join " ", q[ "-T"], map {qq["-I$_"]} @INC
+           if $first =~ /^#!.*\bperl.*-\w*T/;
        $fh->close or print "can't close $test. $!\n";
-       my $cmd = ($ENV{'COMPILE_TEST'})? 
-"./perl -I../lib ../utils/perlcc $test -run -verbose dcf -log ./compilelog |" 
-                                                                                                                       :  "$^X $s $test|";
+       my $cmd = ($ENV{'HARNESS_COMPILE_TEST'})
+               ? "./perl -I../lib ../utils/perlcc $test "
+                 . "-run 2>> ./compilelog |" 
+               : "$^X $s $test|";
        $cmd = "MCR $cmd" if $^O eq 'VMS';
        $fh->open($cmd) or print "can't run $test. $!\n";
        $ok = $next = $max = 0;
@@ -91,6 +93,7 @@ sub runtests {
        my %todo = ();
         my $bonus = 0;
        my $skipped = 0;
+       my $skip_reason;
        while (<$fh>) {
            if( $verbose ){
                print $_;
@@ -101,26 +104,39 @@ sub runtests {
                $totmax += $max;
                $files++;
                $next = 1;
-           } elsif (/^1\.\.([0-9]+)/) {
+           } elsif (/^1\.\.([0-9]+)(\s*\#\s*[Ss]kip\S*(?>\s+)(.+))?/) {
                $max = $1;
                $totmax += $max;
                $files++;
                $next = 1;
+               $skip_reason = $3 if not $max and defined $3;
            } elsif ($max && /^(not\s+)?ok\b/) {
                my $this = $next;
                if (/^not ok\s*(\d*)/){
                    $this = $1 if $1 > 0;
+                   print "${ml}NOK $this" if $ml;
                    if (!$todo{$this}) {
                        push @failed, $this;
                    } else {
                        $ok++;
                        $totok++;
                    }
-               } elsif (/^ok\s*(\d*)(\s*\#\s*[Ss]kip)?/) {
+               } elsif (/^ok\s*(\d*)(\s*\#\s*[Ss]kip\S*(?:(?>\s+)(.+))?)?/) {
                    $this = $1 if $1 > 0;
+                   print "${ml}ok $this/$max" if $ml;
                    $ok++;
                    $totok++;
                    $skipped++ if defined $2;
+                   my $reason;
+                   $reason = 'unknown reason' if defined $2;
+                   $reason = $3 if defined $3;
+                   if (defined $reason and defined $skip_reason) {
+                     # print "was: '$skip_reason' new '$reason'\n";
+                     $skip_reason = 'various reasons'
+                       if $skip_reason ne $reason;
+                   } elsif (defined $reason) {
+                     $skip_reason = $reason;
+                   }
                    $bonus++, $totbonus++ if $todo{$this};
                }
                if ($this > $next) {
@@ -143,7 +159,7 @@ sub runtests {
                       : $wstatus >> 8);
        if ($wstatus) {
            my ($failed, $canon, $percent) = ('??', '??');
-           printf "dubious\n\tTest returned status $estatus (wstat %d, 0x%x)\n",
+           printf "${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';
            if (corestatus($wstatus)) { # until we have a wait module
@@ -175,16 +191,18 @@ sub runtests {
        } elsif ($ok == $max && $next == $max+1) {
            if ($max and $skipped + $bonus) {
                my @msg;
-               push(@msg, "$skipped/$max subtest".($skipped>1?'s':'')." skipped")
+               push(@msg, "$skipped/$max skipped: $skip_reason")
                    if $skipped;
-               push(@msg, "$bonus subtest".($bonus>1?'s':'').
-                    " unexpectedly succeeded")
+               push(@msg, "$bonus/$max unexpectedly succeeded")
                    if $bonus;
-               print "ok, ".join(', ', @msg)."\n";
+               print "${ml}ok, ".join(', ', @msg)."\n";
            } elsif ($max) {
-               print "ok\n";
+               print "${ml}ok\n";
+           } elsif (defined $skip_reason) {
+               print "skipped: $skip_reason\n";
+               $tests_skipped++;
            } else {
-               print "skipping test on this platform\n";
+               print "skipped test on this platform\n";
                $tests_skipped++;
            }
            $good++;
@@ -194,7 +212,7 @@ sub runtests {
            }
            if (@failed) {
                my ($txt, $canon) = canonfailed($max,$skipped,@failed);
-               print $txt;
+               print "${ml}$txt";
                $failedtests{$test} = { canon => $canon,  max => $max,
                                        failed => scalar @failed,
                                        name => $test, percent => 100*(scalar @failed)/$max,
@@ -268,7 +286,54 @@ sub runtests {
        $pct = sprintf("%.2f", $good / $total * 100);
        my $subpct = sprintf " %d/%d subtests failed, %.2f%% okay.",
        $totmax - $totok, $totmax, 100*$totok/$totmax;
+       # Create formats
+       #    First, figure out max length of test names
+       my $failed_str = "Failed Test";
+       my $middle_str = " Status Wstat Total Fail  Failed  ";
+       my $list_str = "List of Failed";
+       my $max_namelen = length($failed_str);
        my $script;
+       foreach $script (keys %failedtests) {
+           $max_namelen =
+               (length $failedtests{$script}->{name} > $max_namelen) ?
+                   length $failedtests{$script}->{name} : $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;
+           }
+       }
+
+       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 $@;
+
+       # Now write to formats
        for $script (sort keys %failedtests) {
          $curtest = $failedtests{$script};
          write;
@@ -279,7 +344,7 @@ sub runtests {
            die "Failed $bad/$total test scripts, $pct% okay.$subpct\n";
        }
     }
-    printf("Files=%d,  Tests=%d, %s\n", $files, $totmax, timestr($t_total, 'nop'));
+    printf("Files=%d, Tests=%d, %s\n", $files, $totmax, timestr($t_total, 'nop'));
 
     return ($bad == 0 && $totmax) ;
 }
@@ -287,16 +352,9 @@ sub runtests {
 my $tried_devel_corestack;
 sub corestatus {
     my($st) = @_;
-    my($ret);
 
     eval {require 'wait.ph'};
-    if ($@) {
-      SWITCH: {
-           $ret = ($st & 0200); # Tim says, this is for 90%
-       }
-    } else {
-       $ret = WCOREDUMP($st);
-    }
+    my $ret = defined &WCOREDUMP ? WCOREDUMP($st) : $st & 0200;
 
     eval { require Devel::CoreStack; $have_devel_corestack++ } 
       unless $tried_devel_corestack++;
@@ -413,6 +471,12 @@ variations in spacing and case) after C<ok> or C<ok NUMBER>, it is
 counted as a skipped test.  If the whole testscript succeeds, the
 count of skipped tests is included in the generated output.
 
+C<Test::Harness> reports the text after C< # Skip(whatever)> as a
+reason for skipping.  Similarly, one can include a similar explanation
+in a C<1..0> line emitted if the test is skipped completely:
+
+  1..0 # Skipped: no leverage found
+
 =head1 EXPORT
 
 C<&runtests> is exported by Test::Harness per default.
@@ -450,6 +514,15 @@ above messages.
 Setting C<HARNESS_IGNORE_EXITCODE> makes harness ignore the exit status
 of child processes.
 
+Setting C<HARNESS_NOTTY> 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).
+
+Setting C<HARNESS_COMPILE_TEST> to a true value will make harness attempt
+to compile the test using C<perlcc> before running it.
+
 If C<HARNESS_FILELEAK_IN_DIR> is set to the name of a directory, harness
 will check after each test whether new files appeared in that directory,
 and report them as
@@ -460,6 +533,17 @@ If relative, directory name is with respect to the current directory at
 the moment runtests() was called.  Putting absolute path into 
 C<HARNESS_FILELEAK_IN_DIR> may give more predicatable results.
 
+The value of C<HARNESS_PERL_SWITCHES> will be prepended to the
+switches used to invoke perl on each test.  For example, setting
+C<HARNESS_PERL_SWITCHES> to "-W" will run all tests with all
+warnings enabled.
+
+If C<HARNESS_COLUMNS> is set, then this value will be used for the
+width of the terminal. If it is not set then it will default to
+C<COLUMNS>. If this is not set, it will default to 80. Note that users
+of Bourne-sh based shells will need to C<export COLUMNS> for this
+module to use that variable.
+
 Harness sets C<HARNESS_ACTIVE> before executing the individual tests.
 This allows the tests to determine if they are being executed through the
 harness or by any other means.