\s*\Z|ms, 'HTML report should be output last' );
libtap-formatter-html-perl-0.11+dfsg.orig/MANIFEST 0000444 0001750 0001750 00000001731 12076716223 020644 0 ustar salvi salvi Build.PL
Changes
examples/DBD-SQLite-example.html
examples/test-output.html
lib/App/Prove/Plugin/HTML.pm
lib/TAP/Formatter/HTML.pm
lib/TAP/Formatter/HTML/default_page.css
lib/TAP/Formatter/HTML/default_report.css
lib/TAP/Formatter/HTML/default_report.js
lib/TAP/Formatter/HTML/default_report.tt2
lib/TAP/Formatter/HTML/Session.pm
Makefile.PL
MANIFEST This list of files
META.json
META.yml
README
t/01_basic.t
t/02_escape_output.t
t/03_silent.t
t/04_really_quiet.t
t/05_quiet.t
t/06_output.t
t/07_multiple_aggregate.t
t/08_env_vars.t
t/09_empty_testdir.t
t/10_win32.t
t/11_force_inline.t
t/20_prove_html.t
t/30_tap_harness_compat.t
t/31_inc_path.t
t/99_test_pod.t
t/data/01_pass.pl
t/data/02_fail.pl
t/data/03_plan_fail.pl
t/data/04_die_fail.pl
t/data/05_compile_fail.pl
t/data/06_skip_all.pl
t/data/07_todo_pass.pl
t/data/08_html_in_output.pl
t/data/09_skip_error.pl
t/data/10_todo_skip.pl
t/data/11_lots_of_tests.pl
t/lib/FileTempTFH.pm
t/selenium/server.pl
t/selenium_basic.t
Todo
libtap-formatter-html-perl-0.11+dfsg.orig/Makefile.PL 0000444 0001750 0001750 00000002305 12076610727 021465 0 ustar salvi salvi # Note: this file was auto-generated by Module::Build::Compat version 0.3800
require 5.006000;
unless (eval "use Module::Build::Compat 0.02; 1" ) {
print "This module requires Module::Build to install itself.\n";
require ExtUtils::MakeMaker;
my $yn = ExtUtils::MakeMaker::prompt
(' Install Module::Build now from CPAN?', 'y');
unless ($yn =~ /^y/i) {
die " *** Cannot install without Module::Build. Exiting ...\n";
}
require Cwd;
require File::Spec;
require CPAN;
# Save this 'cause CPAN will chdir all over the place.
my $cwd = Cwd::cwd();
CPAN::Shell->install('Module::Build::Compat');
CPAN::Shell->expand("Module", "Module::Build::Compat")->uptodate
or die "Couldn't install Module::Build, giving up.\n";
chdir $cwd or die "Cannot chdir() back to $cwd: $!";
}
eval "use Module::Build::Compat 0.02; 1" or die $@;
Module::Build::Compat->run_build_pl(args => \@ARGV);
my $build_script = 'Build';
$build_script .= '.com' if $^O eq 'VMS';
exit(0) unless(-e $build_script); # cpantesters convention
require Module::Build;
Module::Build::Compat->write_makefile(build_class => 'Module::Build');
libtap-formatter-html-perl-0.11+dfsg.orig/Todo 0000444 0001750 0001750 00000002104 12076610727 020340 0 ustar salvi salvi More tests!
* parse the generated output
* check the view given to the TT view
Reports from Nadim Khemir:
* integrate into build scripts (eg: M::B)
* possible to open the test file and show the test itself?
* why the need to stop using Test::Harness?
Various bug reports (+ Patch!) by Hemingway:
* https://rt.cpan.org/Ticket/Display.html?id=41457
Progress console:
* https://rt.cpan.org/Ticket/Display.html?id=40627
Script still running bug
* when you navigate away from page
* only on big test outputs
* jquery cleanup?
Sometimes test details don't collapse properly!
* doesn't happen in FireFox 3?
* related to the scrollTo?
* could hide & show the tr after the slideToggle?
sort by cols
* time!
* test file
* percent
support file output - in progress
* prove --html=output.html
* allow output to STDOUT
* write an App::Prove plugin
wrap unknown test output's in
expand all tests
expand failed tests
collapse current test (from halway down big tests, maybe a mouseover file or something)
Give the test suite a title...
libtap-formatter-html-perl-0.11+dfsg.orig/lib/ 0000755 0001750 0001750 00000000000 12076610727 020263 5 ustar salvi salvi libtap-formatter-html-perl-0.11+dfsg.orig/lib/App/ 0000755 0001750 0001750 00000000000 12076610727 021003 5 ustar salvi salvi libtap-formatter-html-perl-0.11+dfsg.orig/lib/App/Prove/ 0000755 0001750 0001750 00000000000 12076610727 022076 5 ustar salvi salvi libtap-formatter-html-perl-0.11+dfsg.orig/lib/App/Prove/Plugin/ 0000755 0001750 0001750 00000000000 12076610727 023334 5 ustar salvi salvi libtap-formatter-html-perl-0.11+dfsg.orig/lib/App/Prove/Plugin/HTML.pm 0000444 0001750 0001750 00000006124 12076610727 024437 0 ustar salvi salvi package App::Prove::Plugin::HTML;
=head1 NAME
App::Prove::Plugin::HTML - a prove plugin for HTML output
=head1 SYNOPSIS
# command-line usage:
prove -P HTML=outfile:out.html,css_uri:style.css,js_uri:foo.js,force_inline_css:0
# NOTE: this is currently in alpha, this usage will likely change!
=cut
use strict;
use warnings;
use TAP::Formatter::HTML;
our $VERSION = '0.11';
sub import {
my ($class, @args) = @_;
# deprecated, do nothing
return $class;
}
sub load {
my ($class, $p) = @_;
my @args = @{ $p->{args} };
my $app = $p->{app_prove};
# parse the args
my %TFH_args;
foreach my $arg (@args) {
my ($key, $val) = split(/:/, $arg, 2);
if (grep {$key eq $_} qw(css_uri js_uri)) {
push @{ $TFH_args{$key . 's'}}, $val;
} else {
$TFH_args{$key} = $val;
}
}
# set the formatter to use
$app->formatter( 'TAP::Formatter::HTML' );
# set ENV vars in order to pass args to TAP::Formatter::HTML
# horrible, but it's currently the only way :-/
while (my ($key, $val) = each %TFH_args) {
$val = join( ':', @$val ) if (ref($val) eq 'ARRAY');
$ENV{"TAP_FORMATTER_HTML_".uc($key)} = $val;
}
# we're done
return $class;
}
1;
__END__
=head1 DESCRIPTION
This is a quick & dirty second attempt at making L easier
to use from the command line. It will change once L has better
support for plugins than need to take cmdline data.
The original goal was to be able to specify all the args on the cmdline, ala:
prove --html=output.html --css-uri foo.css --css-uri bar.css --force-inline-css 0
But this is currently not possible with the way the L plugin system
works.
As a compromise, you must use the following syntax:
prove -P HTML=arg1:val1,arg2:val2,...
Where I is any L parameter that is configurable via
C<%ENV>.
=head2 Example
prove -P HTML=outfile:out.html,css_uri:style.css,js_uri:foo.js,force_inline_css:0
This will cause L to load this plugin, which loads L
for you, and sets I to C to save you some typing.
To configure L, the following C<%ENV> vars are set:
TAP_FORMATTER_HTML_OUTFILE=out.html
TAP_FORMATTER_HTML_FORCE_INLINE_CSS=0
TAP_FORMATTER_HTML_CSS_URIS=style.css
TAP_FORMATTER_HTML_JS_URIS=func.js
Yes, you can pass 2 or more I or I args.
=head2 %ENV vars?!
Briefly, L currently only lets you specify the C for
L, it doesn't let you instantiate a formatter, or pass config to
the formatter.
I If it bugs you too,
then join the L devs and help us fix it ;-).
=head1 BUGS
Please use http://rt.cpan.org to report any issues.
=head1 AUTHOR
Steve Purkis
=head1 COPYRIGHT
Copyright (c) 2008-2010 Steve Purkis , S Purkis Consulting Ltd.
All rights reserved.
This module is released under the same terms as Perl itself.
=head1 SEE ALSO
L, L, L
=cut
libtap-formatter-html-perl-0.11+dfsg.orig/lib/TAP/ 0000755 0001750 0001750 00000000000 12076610727 020707 5 ustar salvi salvi libtap-formatter-html-perl-0.11+dfsg.orig/lib/TAP/Formatter/ 0000755 0001750 0001750 00000000000 12076610727 022652 5 ustar salvi salvi libtap-formatter-html-perl-0.11+dfsg.orig/lib/TAP/Formatter/HTML.pm 0000444 0001750 0001750 00000060041 12076610727 023753 0 ustar salvi salvi =head1 NAME
TAP::Formatter::HTML - TAP Test Harness output delegate for html output
=head1 SYNOPSIS
##
## command-line usage (alpha):
##
prove -m -Q -P HTML=outfile:out.html,css_uri:style.css,js_uri:foo.js,force_inline_css:0
# backwards compat usage:
prove -m -Q --formatter=TAP::Formatter::HTML >output.html
# for more detail:
perldoc App::Prove::Plugin::HTML
##
## perl usage:
##
use TAP::Harness;
my @tests = glob( 't/*.t' );
my $harness = TAP::Harness->new({ formatter_class => 'TAP::Formatter::HTML',
merge => 1 });
$harness->runtests( @tests );
# prints HTML to STDOUT by default
# or if you really don't want STDERR merged in:
my $harness = TAP::Harness->new({ formatter_class => 'TAP::Formatter::HTML' });
# to use a custom formatter:
my $fmt = TAP::Formatter::HTML->new;
$fmt->css_uris([])->inline_css( $my_css )
->js_uris(['http://mysite.com/jquery.js', 'http://mysite.com/custom.js'])
->inline_js( '$(div.summary).hide()' );
my $harness = TAP::Harness->new({ formatter => $fmt, merge => 1 });
# to output HTML to a file[handle]:
$fmt->output_fh( $fh );
$fmt->output_file( '/tmp/foo.html' );
# you can use your own customized templates too:
$fmt->template('custom.tt2')
->template_processor( Template->new )
->force_inline_css(0)
->force_inline_js(0);
=cut
package TAP::Formatter::HTML;
use strict;
use warnings;
use URI;
use URI::file;
use Template;
use POSIX qw( ceil );
use IO::File;
use File::Temp qw( tempfile tempdir );
use File::Spec::Functions qw( catdir catfile file_name_is_absolute rel2abs );
use TAP::Formatter::HTML::Session;
# DEBUG:
#use Data::Dumper 'Dumper';
use base qw( TAP::Base );
use accessors qw( verbosity stdout output_fh escape_output tests session_class sessions
template_processor template html html_id_iterator minify color
css_uris js_uris inline_css inline_js abs_file_paths force_inline_css force_inline_js );
use constant default_session_class => 'TAP::Formatter::HTML::Session';
use constant default_template => 'TAP/Formatter/HTML/default_report.tt2';
use constant default_js_uris => ['file:TAP/Formatter/HTML/jquery-1.4.2.min.js',
'file:TAP/Formatter/HTML/jquery.tablesorter-2.0.3.min.js',
'file:TAP/Formatter/HTML/default_report.js'];
use constant default_css_uris => ['file:TAP/Formatter/HTML/default_page.css',
'file:TAP/Formatter/HTML/default_report.css'];
use constant severity_map => {
'' => 0,
'very-low' => 1,
'low' => 2,
'med' => 3,
'high' => 4,
'very-high' => 5,
0 => '',
1 => 'very-low',
2 => 'low',
3 => 'med',
4 => 'high',
5 => 'very-high',
};
our $VERSION = '0.11';
our $FAKE_WIN32_URIS = 0; # for testing only
sub _initialize {
my ($self, $args) = @_;
$args ||= {};
$self->SUPER::_initialize($args);
my $stdout_fh = IO::File->new_from_fd( fileno(STDOUT), 'w' )
or die "Error opening STDOUT for writing: $!";
$self->verbosity( 0 )
->stdout( $stdout_fh )
->output_fh( $stdout_fh )
->minify( 1 )
->escape_output( 0 )
->abs_file_paths( 1 )
->abs_file_paths( 1 )
->force_inline_css( 1 )
->force_inline_js( 0 )
->session_class( $self->default_session_class )
->template_processor( $self->default_template_processor )
->template( $self->default_template )
->js_uris( $self->default_js_uris )
->css_uris( $self->default_css_uris )
->inline_js( '' )
->inline_css( '' )
->sessions( [] );
$self->check_for_overrides_in_env;
# Laziness...
# trust the user knows what they're doing with the args:
foreach my $key (keys %$args) {
$self->$key( $args->{$key} ) if ($self->can( $key ));
}
$self->html_id_iterator( $self->create_iterator( $args ) );
return $self;
}
sub check_for_overrides_in_env {
my $self = shift;
if (my $file = $ENV{TAP_FORMATTER_HTML_OUTFILE}) {
$self->output_file( $file );
}
my $force_css = $ENV{TAP_FORMATTER_HTML_FORCE_INLINE_CSS};
if (defined( $force_css )) {
$self->force_inline_css( $force_css );
}
my $force_js = $ENV{TAP_FORMATTER_HTML_FORCE_INLINE_JS};
if (defined( $force_js )) {
$self->force_inline_js( $force_js );
}
if (my $uris = $ENV{TAP_FORMATTER_HTML_CSS_URIS}) {
my $list = [ split( ':', $uris ) ];
$self->css_uris( $list );
}
if (my $uris = $ENV{TAP_FORMATTER_HTML_JS_URIS}) {
my $list = [ split( ':', $uris ) ];
$self->js_uris( $list );
}
if (my $file = $ENV{TAP_FORMATTER_HTML_TEMPLATE}) {
$self->template( $file );
}
return $self;
}
sub default_template_processor {
my $path = __FILE__;
$path =~ s/.TAP.Formatter.HTML.pm$//;
return Template->new(
# arguably shouldn't compile as this is only used once
COMPILE_DIR => catdir( tempdir( CLEANUP => 1 ), 'TAP-Formatter-HTML' ),
COMPILE_EXT => '.ttc',
INCLUDE_PATH => $path,
);
}
sub output_file {
my ($self, $file) = @_;
my $fh = IO::File->new( $file, 'w' )
or die "Error opening '$file' for writing: $!";
$self->output_fh( $fh );
}
sub create_iterator {
my $self = shift;
my $args = shift || {};
my $prefix = $args->{html_id_prefix} || 't';
my $i = 0;
my $iter = sub { return $prefix . $i++ };
}
sub verbose {
my $self = shift;
# emulate a classic accessor for compat w/TAP::Formatter::Console:
if (@_) { $self->verbosity(1) }
return $self->verbosity >= 1;
}
sub quiet {
my $self = shift;
# emulate a classic accessor for compat w/TAP::Formatter::Console:
if (@_) { $self->verbosity(-1) }
return $self->verbosity <= -1;
}
sub really_quiet {
my $self = shift;
# emulate a classic accessor for compat w/TAP::Formatter::Console:
if (@_) { $self->verbosity(-2) }
return $self->verbosity <= -2;
}
sub silent {
my $self = shift;
# emulate a classic accessor for compat w/TAP::Formatter::Console:
if (@_) { $self->verbosity(-3) }
return $self->verbosity <= -3;
}
# Called by Test::Harness before any test output is generated.
sub prepare {
my ($self, @tests) = @_;
# warn ref($self) . "->prepare called with args:\n" . Dumper( \@tests );
$self->info( 'running ', scalar @tests, ' tests' );
$self->tests( [@tests] );
}
# Called to create a new test session. A test session looks like this:
#
# my $session = $formatter->open_test( $test, $parser );
# while ( defined( my $result = $parser->next ) ) {
# $session->result($result);
# exit 1 if $result->is_bailout;
# }
# $session->close_test;
sub open_test {
my ($self, $test, $parser) = @_;
#warn ref($self) . "->open_test called with args: " . Dumper( [$test, $parser] );
my $session = $self->session_class->new({ test => $test,
parser => $parser,
formatter => $self });
push @{ $self->sessions }, $session;
return $session;
}
# $str = $harness->summary( $aggregate );
#
# C produces the summary report after all tests are run. The argument is
# an aggregate.
sub summary {
my ($self, $aggregate) = @_;
#warn ref($self) . "->summary called with args: " . Dumper( [$aggregate] );
# farmed out to make sub-classing easy:
my $report = $self->prepare_report( $aggregate );
$self->generate_report( $report );
# if silent is set, only print HTML if we're not printing to stdout
if (! $self->silent or $self->output_fh->fileno != fileno(STDOUT)) {
print { $self->output_fh } ${ $self->html };
$self->output_fh->flush;
}
return $self;
}
sub generate_report {
my ($self, $r) = @_;
$self->check_uris;
$self->slurp_css if $self->force_inline_css;
$self->slurp_js if $self->force_inline_js;
my $params = {
report => $r,
js_uris => $self->js_uris,
css_uris => $self->css_uris,
inline_js => $self->inline_js,
inline_css => $self->inline_css,
formatter => { class => ref( $self ),
version => $self->VERSION },
};
my $html = '';
$self->template_processor->process( $self->template, $params, \$html )
|| die $self->template_processor->error;
$self->html( \$html );
$self->minify_report if $self->minify;
return $self;
}
# try and reduce the size of the report
sub minify_report {
my $self = shift;
my $html_ref = $self->html;
$$html_ref =~ s/^\t+//mg;
return $self;
}
# convert all uris to URI objs
# check file uris (if relative & not found, try & find them in @INC)
sub check_uris {
my ($self) = @_;
foreach my $uri_list ($self->js_uris, $self->css_uris) {
# take them out of the list to verify, push them back on later
my @uris = splice( @$uri_list, 0, scalar @$uri_list );
foreach my $uri (@uris) {
if (($^O =~ /win32/i or $FAKE_WIN32_URIS)
and $uri =~ /^(?:(?:file)|(?:\w:)?\\)/) {
$uri = URI::file->new($uri, 'win32');
} else {
$uri = URI->new( $uri );
}
if ($uri->scheme && $uri->scheme eq 'file') {
my $path = $uri->path;
unless (file_name_is_absolute($path)) {
my $new_path;
if (-e $path) {
$new_path = rel2abs( $path ) if ($self->abs_file_paths);
} else {
$new_path = $self->find_in_INC( $path );
}
if ($new_path) {
if (($^O =~ /win32/i or $FAKE_WIN32_URIS)) {
$uri = URI::file->new("file://$new_path", 'win32');
} else {
$uri->path( $new_path );
}
}
}
}
push @$uri_list, $uri;
}
}
return $self;
}
sub prepare_report {
my ($self, $a) = @_;
my $r = {
tests => [],
start_time => '?',
end_time => '?',
elapsed_time => $a->elapsed_timestr,
};
# add aggregate test info:
for my $key (qw(
total
has_errors
has_problems
failed
parse_errors
passed
skipped
todo
todo_passed
wait
exit
)) {
$r->{$key} = $a->$key;
}
# do some other handy calcs:
$r->{actual_passed} = $r->{passed} + $r->{todo_passed};
if ($r->{total}) {
$r->{percent_passed} = sprintf('%.1f', $r->{actual_passed} / $r->{total} * 100);
} else {
$r->{percent_passed} = 0;
}
# estimate # files (# sessions could be different?):
$r->{num_files} = scalar @{ $self->sessions };
# add test results:
my $total_time = 0;
foreach my $s (@{ $self->sessions }) {
my $sr = $s->as_report;
push @{$r->{tests}}, $sr;
$total_time += $sr->{elapsed_time} || 0;
}
$r->{total_time} = $total_time;
# estimate total severity:
my $smap = $self->severity_map;
my $severity = 0;
$severity += $smap->{$_->{severity} || ''} for @{$r->{tests}};
my $avg_severity = 0;
if (scalar @{$r->{tests}}) {
$avg_severity = ceil($severity / scalar( @{$r->{tests}} ));
}
$r->{severity} = $smap->{$avg_severity};
# TODO: coverage?
return $r;
}
# adapted from Test::TAP::HTMLMatrix
# always return abs file paths if $self->abs_file_paths is on
sub find_in_INC {
my ($self, $file) = @_;
foreach my $path (grep { not ref } @INC) {
my $target = catfile($path, $file);
if (-e $target) {
$target = rel2abs($target) if $self->abs_file_paths;
return $target;
}
}
# non-fatal
$self->log("Warning: couldn't find $file in \@INC");
return;
}
# adapted from Test::TAP::HTMLMatrix
# slurp all 'file' uris, if possible
# note: doesn't remove them from the css_uris list, just in case...
sub slurp_css {
my ($self) = shift;
$self->info("slurping css files inline");
my $inline_css = '';
$self->_slurp_uris( $self->css_uris, \$inline_css );
# append any inline css so it gets interpreted last:
$inline_css .= "\n" . $self->inline_css if $self->inline_css;
$self->inline_css( $inline_css );
}
sub slurp_js {
my ($self) = shift;
$self->info("slurping js files inline");
my $inline_js = '';
$self->_slurp_uris( $self->js_uris, \$inline_js );
# append any inline js so it gets interpreted last:
$inline_js .= "\n" . $self->inline_js if $self->inline_js;
$self->inline_js( $inline_js );
}
sub _slurp_uris {
my ($self, $uris, $slurp_to_ref) = @_;
foreach my $uri (@$uris) {
my $scheme = $uri->scheme;
if ($scheme && $scheme eq 'file') {
my $path = $uri->path;
if (-e $path) {
if (open my $fh, $path) {
local $/ = undef;
$$slurp_to_ref .= <$fh>;
$$slurp_to_ref .= "\n";
} else {
$self->log("Warning: couldn't open $path: $!");
}
} else {
$self->log("Warning: couldn't read $path: file does not exist!");
}
} else {
$self->log("Warning: can't include $uri inline: not a file uri");
}
}
return $slurp_to_ref;
}
sub log {
my $self = shift;
push @_, "\n" unless grep {/\n/} @_;
$self->_output( @_ );
return $self;
}
sub info {
my $self = shift;
return unless $self->verbose;
return $self->log( @_ );
}
sub log_test {
my $self = shift;
return if $self->really_quiet;
return $self->log( @_ );
}
sub log_test_info {
my $self = shift;
return if $self->quiet;
return $self->log( @_ );
}
sub _output {
my $self = shift;
return if $self->silent;
if (ref($_[0]) && ref( $_[0]) eq 'SCALAR') {
# DEPRECATED: printing HTML:
print { $self->stdout } ${ $_[0] };
} else {
unshift @_, '# ' if $self->escape_output;
print { $self->stdout } @_;
}
}
1;
__END__
=head1 DESCRIPTION
This module provides HTML output formatting for L (a replacement
for L. It is largely based on ideas from
L (which was built on L and thus had a
few limitations - hence this module). For sample output, see:
L
This module is targeted at all users of automated test suites. It's meant to
make reading test results easier, giving you a visual summary of your test suite
and letting you drill down into individual failures (which will hopefully make
testing more likely to happen at your organization ;-).
The design goals are:
=over 4
=item *
I
Once you've got your test report, it should be obvious how to use it.
=item *
I
It should be helpful by pointing out I & I your test suite is
breaking. If you've written your tests well, it should give you enough info to
start tracking down the issue.
=item *
I
Eg: should be a clean install from CPAN, and you shouldn't need to modify your
existing test suite to get up & running, though I unfortunately>.
=item *
I
You shouldn't need to do any custom-coding to get it working - the default
configuration & templates should be enough to get started with. Once installed
it should be a matter of running:
% prove -m -Q --formatter=TAP::Formatter::HTML >output.html
From your project's home dir, and opening the resulting file.
=item *
I
You should be able to configure & customize it to suit your needs. As such,
css, javascript and templates are all configurable.
=back
=head1 METHODS
=head2 CONSTRUCTOR
=head3 new
my $fmt = $class->new({ %args });
=head2 ACCESSORS
All chaining L:
=head3 verbosity
$fmt->verbosity( [ $v ] )
Verbosity level, as defined in L:
1 verbose Print individual test results (and more) to STDOUT.
0 normal
-1 quiet Suppress some test output (eg: test failures).
-2 really quiet Suppress everything to STDOUT but the HTML report.
-3 silent Suppress all output to STDOUT, including the HTML report.
Note that the report is also available via L. You can also provide a
custom L (aka L) that will be used instead of
L, even if I is on.
=head3 stdout
$fmt->stdout( [ \*FH ] );
An L filehandle for catching standard output. Defaults to C.
=head3 output_fh
$fmt->output_fh( [ \*FH ] );
An L filehandle for printing the HTML report to. Defaults to the
same object as L.
B If L is set to C, printing to C will
still occur. (that is, assuming you've opened a different file, B
C).
=head3 output_file
$fmt->output_file( $file_name )
Not strictly an accessor - this is a shortcut for setting L,
equivalent to:
$fmt->output_fh( IO::File->new( $file_name, 'w' ) );
You can set this with the C
environment variable
=head3 escape_output
$fmt->escape_output( [ $boolean ] );
If set, all output to L is escaped. This is probably only useful
if you're testing the formatter.
Defaults to C<0>.
=head3 html
$fmt->html( [ \$html ] );
This is a reference to the scalar containing the html generated on the last
test run. Useful if you have L set to C, and have not
provided a custom L to write the report to.
=head3 tests
$fmt->tests( [ \@test_files ] )
A list of test files we're running, set by L.
=head3 session_class
$fmt->session_class( [ $class ] )
Class to use for L test sessions. You probably won't need to use
this unless you're hacking or sub-classing the formatter.
Defaults to L.
=head3 sessions
$fmt->sessions( [ \@sessions ] )
Test sessions added by L. You probably won't need to use this
unless you're hacking or sub-classing the formatter.
=head3 template_processor
$fmt->template_processor( [ $processor ] )
The template processor to use.
Defaults to a TT2 L processor with the following config:
COMPILE_DIR => catdir( tempdir(), 'TAP-Formatter-HTML' ),
COMPILE_EXT => '.ttc',
INCLUDE_PATH => parent directory TAP::Formatter::HTML was loaded from
Note: INCLUDE_PATH used to be set to: C but this was causing
issues on systems with > 64 dirs in C<@INC>. See RT #74364 for details.
=head3 template
$fmt->template( [ $file_name ] )
The template file to load.
Defaults to C.
You can set this with the C environment
variable.
=head3 css_uris
$fmt->css_uris( [ \@uris ] )
A list of Ls (or strings) to include as external stylesheets in
[%- END -%]
[%- IF inline_js %]
[%- END %]
[% IF report.has_errors %][% SET status = 'failed' %][% ELSE %][% SET status = 'passed' %][% END -%]
| Test file |
Test results |
Time |
% |
[%# tfoot must come before tbody %]
| [% report.num_files %] files |
[% report.total %] tests,
[% report.passed %] ok,
[% report.failed %] failed,
[% report.todo %] todo,
[% report.skipped %] skipped,
[% report.parse_errors %] parse errors
exit status: [% report.exit %],
wait status: [% report.wait %]
elapsed time: [% report.elapsed_time | trim %] |
[% report.total_time | format('%.2fs') %] |
[% report.percent_passed %]% |
[%- FOREACH test IN report.tests %]
|
[% test.test %]
|
[%- SET max_tests = 0 -%]
[%- SET max_tests = test.tests_planned IF test.tests_planned AND test.tests_planned > max_tests -%]
[%- SET max_tests = test.tests_run IF test.tests_run AND test.tests_run > max_tests %]
[%# TS=Test Summary. Note: use a table to caulculate widths automatically %]
[% IF test.tests_run AND test.tests_run > 0 -%]
[%- SET current_test = 0 -%]
[%- FOREACH result IN test.results -%]
[%- IF result.is_test %]
[%#-
Note: break up the tests at 100 so as to preserve sanity.
This may leave some tests looking silly (if there's only 101)
but in the case of 1000s of tests, it makes this more readable.
We do this before incrementing the counter to avoid the first
row being off by 1.
-%]
[%- IF current_test > 0 && (current_test % 100) == 0 %]
[%- END %]
[%- current_test = current_test + 1 -%]
| |
[%- END -%]
[%- END -%]
[%- ELSIF test.skip_all -%][%# below: class 's' = skip-ok -%]
|
[%- ELSE -%][%# below: class 'n' = not-ok -%]
|
[%- END %]
[%- IF test.parse_errors.size > 0 %]
[%- FOREACH e IN test.parse_errors %]
- Parse error: [% e %]
[%- END %]
[%- END %]
[%- FOREACH result IN test.results %]
- [% result.raw | html -%]
[%- IF result.is_unplanned %] (unplanned!)[% END -%]
[%- IF result.todo_passed %] (unexpectedly succeeded!)[% END %]
[%- END -%]
[%- IF test.exit OR test.wait -%]
- exit status: [% test.exit %], wait status: [% test.wait %]
[%- END %]
|
[% test.elapsed_time | format('%.2fs') %] |
[% test.percent_passed ? test.percent_passed _ '%' : 'n/a' %] |
[%- END %]