• NAME
• VERSION
• DESCRIPTION
• SYNOPSIS
• METHODS
• Class Methods
• new
• Instance Methods
• runtests
• aggregate_tests
• jobs
• fork
• SUBCLASSING
• Methods
• summary
• make_parser
• finish_parser
• REPLACING
• SEE ALSO

NAME

TAP::Harness - Run test scripts with statistics

VERSION

Version 3.10

DESCRIPTION

This is a simple test harness which allows tests to be run and results automatically aggregated and output to STDOUT.

SYNOPSIS

 use TAP::Harness;
 my $harness = TAP::Harness->new( \%args );
 $harness->runtests(@tests);

METHODS

Class Methods

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:

• 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 the Time::HiRes manpage if available.
• failures
  
Only show test failures (this is a no-op if verbose is selected).
• 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.
• 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']
  
=item * C<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 the TAP::Formatter::Console manpage.
• formatter
  
If set formatter must be an object that is capable of formatting the TAP output. See the TAP::Formatter::Console manpage 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.

Instance Methods

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 the TAP::Parser manpage for more information.

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 ]:

    $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.

Returns a the TAP::Parser::Aggregator manpage containing the test results.

aggregate_tests

  $harness->aggregate_tests( $aggregate, @tests );

Run the named tests and display a summary of result. Tests will be run in the order found.

Test results will be added to the supplied the TAP::Parser::Aggregator manpage. aggregate_tests may be called multiple times to run several sets of tests. Multiple Test::Harness instances may be used to pass results to a single aggregator so that different parts of a complex test suite may be run using different TAP::Harness settings. This is useful, for example, in the case where some tests should run in parallel but others are unsuitable for parallel execution.

    my $formatter = TAP::Formatter::Console->new;
    my $ser_harness = TAP::Harness->new( { formatter => $formatter } );
    my $par_harness = TAP::Harness->new( { formatter => $formatter,
                                           jobs => 9 } );
    my $aggregator = TAP::Parser::Aggregator->new;
    
    $aggregator->start();
    $ser_harness->aggregate_tests( $aggregator, @ser_tests );
    $par_harness->aggregate_tests( $aggregator, @par_tests );
    $aggregator->stop();
    $formatter->summary( $aggregator );

Note that for simpler testing requirements it will often be possible to replace the above code with a single call to runtests.

Each elements of the @tests array is either

• the file name of a test script to run
  
• a reference to a [ file name, display name ]
  

When you supply a separate display name it becomes possible to run a test more than once; the display name is effectively the alias by which the test is known inside the harness. The harness doesn't care if it runs the same script more than once when each invocation uses a different name.

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 the TAP::Harness::Parallel manpage 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 the Parallel::Iterator manpage to be installed.

SUBCLASSING

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.

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:

  $self->output(timestr( timediff( Benchmark->new, $start_time ), 'nop' ));

• tests
  
This is an array reference of all test names. To get the the TAP::Parser manpage 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.

REPLACING

If you like the prove utility and the TAP::Parser manpage 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 --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.

SEE ALSO

the Test::Harness manpage