TAP::Harness - Run test scripts with statistics
Version 3.05
This is a simple test harness which allows tests to be run and results automatically aggregated and output to STDOUT.
use TAP::Harness; my $harness = TAP::Harness->new( \%args ); $harness->runtests(@tests);
new
my %args = ( verbosity => 1, lib => [ 'lib', 'blib/lib' ], ) my $harness = TAP::Harness->new( \%args );
The constructor returns a new TAP::Harness object. It accepts an optional hashref whose allowed keys are:
TAP::Harness
verbosity
Set the verbosity level:
1 verbose Print individual test results to STDOUT. 0 normal -1 quiet Suppress some test output (mostly failures while tests are running). -2 really quiet Suppress everything but the tests summary.
timer
Append run time for each test to output. Uses Time::HiRes if available.
failures
Only show test failures (this is a no-op if verbose is selected).
verbose
lib
Accepts a scalar value or array ref of scalar values indicating which paths to allowed libraries should be included if Perl tests are executed. Naturally, this only makes sense in the context of tests written in Perl.
switches
Accepts a scalar value or array ref of scalar values indicating which switches should be included if Perl tests are executed. Naturally, this only makes sense in the context of tests written in Perl.
test_args
A reference to an @INC style array of arguments to be passed to each test program.
@INC
color
Attempt to produce color output.
exec
Typically, Perl tests are run through this. However, anything which spits out TAP is fine. You can use this argument to specify the name of the program (and optional switches) to run your tests with:
exec => ['/usr/bin/ruby', '-w']
merge
If merge is true the harness will create parsers that merge STDOUT and STDERR together for any processes they start.
formatter_class
The name of the class to use to format output. The default is TAP::Formatter::Console.
formatter
If set formatter must be an object that is capable of formatting the TAP output. See TAP::Formatter::Console for an example.
errors
If parse errors are found in the TAP output, a note of this will be made in the summary report. To see all of the parse errors, set this argument to true:
errors => 1
directives
If set to a true value, only test results with directives will be displayed. This overrides other settings such as verbose or failures.
stdout
A filehandle for catching standard output.
Any keys for which the value is undef will be ignored.
undef
runtests
$harness->runtests(@tests);
Accepts and array of @tests to be run. This should generally be the names of test files, but this is not required. Each element in @tests will be passed to TAP::Parser::new() as a source. See TAP::Parser for more information.
@tests
TAP::Parser::new()
source
It is possible to provide aliases that will be displayed in place of the test name by supplying the test as a reference to an array containing [ $test, $alias ]:
[ $test, $alias ]
$harness->runtests( [ 't/foo.t', 'Foo Once' ], [ 't/foo.t', 'Foo Twice' ] );
Normally it is an error to attempt to run the same test twice. Aliases allow you to overcome this limitation by giving each run of the test a unique name.
Tests will be run in the order found.
If the environment variable PERL_TEST_HARNESS_DUMP_TAP is defined it should name a directory into which a copy of the raw TAP for each test will be written. TAP is written to files named for each test. Subdirectories will be created as needed.
PERL_TEST_HARNESS_DUMP_TAP
Returns a TAP::Parser::Aggregator containing the test results.
aggregate_tests
$harness->aggregate_tests( $aggregate, @tests );
jobs
Returns the number of concurrent test runs the harness is handling. For the default harness this value is always 1. A parallel harness such as TAP::Harness::Parallel will override this to return the number of jobs it is handling.
fork
If true the harness will attempt to fork and run the parser for each test in a separate process. Currently this option requires Parallel::Iterator to be installed.
TAP::Harness is designed to be (mostly) easy to subclass. If you don't like how a particular feature functions, just override the desired methods.
TODO: This is out of date
The following methods are ones you may wish to override if you want to subclass TAP::Harness.
summary
$harness->summary( \%args );
summary prints the summary report after all tests are run. The argument is a hashref with the following keys:
start
This is created with Benchmark->new and it the time the tests started. You can print a useful summary time, if desired, with:
Benchmark->new
$self->output(timestr( timediff( Benchmark->new, $start_time ), 'nop' ));
tests
This is an array reference of all test names. To get the TAP::Parser object for individual tests:
my $aggregate = $args->{aggregate}; my $tests = $args->{tests}; for my $name ( @$tests ) { my ($parser) = $aggregate->parsers($test); ... do something with $parser }
This is a bit clunky and will be cleaned up in a later release.
make_parser
Make a new parser and display formatter session. Typically used and/or overridden in subclasses.
my ( $parser, $session ) = $harness->make_parser;
finish_parser
Terminate use of a parser. Typically used and/or overridden in subclasses. The parser isn't destroyed as a result of this.
If you like the prove utility and TAP::Parser but you want your own harness, all you need to do is write one and provide new and runtests methods. Then you can use the prove utility like so:
prove
prove --harness My::Test::Harness
Note that while prove accepts a list of tests (or things to be tested), new has a fairly rich set of arguments. You'll probably want to read over this code carefully to see how all of them are being used.
Test::Harness
To install Test::Harness, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Test::Harness
CPAN shell
perl -MCPAN -e shell install Test::Harness
For more information on module installation, please visit the detailed CPAN module installation guide.