/ 
TAP-Parser-0.54
River stage zero No dependents
/ TAP::Parser::Aggregator

NAME

TAP::Parser::Aggregator - Aggregate TAP::Parser results.

VERSION

Version 0.54

SYNOPSIS

use TAP::Parser::Aggregator;

my $aggregate = TAP::Parser::Aggregator->new;
$aggregate->add( 't/00-load.t', $load_parser );
$aggregate->add( 't/10-lex.t',  $lex_parser  );

my $summary = <<'END_SUMMARY';
Passed:  %s
Failed:  %s
Unexpectedly succeeded: %s
END_SUMMARY
printf $summary, 
       scalar $aggregate->passed, 
       scalar $aggregate->failed,
       scalar $aggregate->todo_passed;

DESCRIPTION

TAP::Parser::Aggregator is a simple class which takes parser objects and allows reporting of aggregate results.

METHODS

Class Methods

new

my $aggregate = TAP::Parser::Aggregator->new;

Returns a new TAP::Parser::Aggregator object.

Instance Methods

add

$aggregate->add( $description, $parser );

Takes two arguments, the description of the TAP source (usually a test file name, but it doesn't have to be) and a TAP::Parser object.

Trying to reuse a description is a fatal error.

parsers

my $count   = $aggregate->parsers;
my @parsers = $aggregate->parsers;
my @parsers = $aggregate->parsers(@descriptions);

In scalar context without arguments, this method returns the number of parsers aggregated. In list context without arguments, returns the parsers in the order they were added.

If arguments are used, these should be a list of descriptions used with the add method. Returns an array in list context or an array reference in scalar context. The array contents will the requested parsers in the order they were listed in the argument list.

Passing in an unknown description is a fatal error.

Summary methods

Each of the following methods will return the total number of corresponding tests if called in scalar context. If called in list context, returns the descriptions of the parsers which contain the corresponding tests (see add for an explanation of description.

  • failed

  • parse_errors

  • passed

  • skipped

  • todo

  • todo_passed

  • wait

  • exit

For example, to find out how many tests unexpectedly succeeded (TODO tests which passed when they shouldn't):

my $count        = $aggregate->todo_passed;
my @descriptions = $aggregate->todo_passed;

Note that wait and exit are the totals of the wait and exit statuses of each of the tests. These values are totalled only to provide a true value if any of them are non-zero.

total

my $tests_run = $aggregate->total;

Returns the total number of tests run.

has_problems

if ( $parser->has_problems ) {
    ...
}

This is a 'catch-all' method which returns true if any tests have currently failed, any TODO tests unexpectedly succeeded, or any parse errors.

todo_failed

# deprecated in favor of 'todo_passed'.  This method was horribly misnamed.

This was a badly misnamed method. It indicates which TODO tests unexpectedly succeeded. Will now issue a warning and call todo_passed.