TAP::Parser::Aggregator(3p) Perl Programmers Reference Guide #

TAP::Parser::Aggregator(3p) Perl Programmers Reference Guide

NNAAMMEE #

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

VVEERRSSIIOONN #

 Version 3.44

SSYYNNOOPPSSIISS #

     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;

DDEESSCCRRIIPPTTIIOONN #

 "TAP::Parser::Aggregator" collects parser objects and allows
 reporting/querying their aggregate results.

MMEETTHHOODDSS #

CCllaassss MMeetthhooddss _"_n_e_w_"

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

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

IInnssttaannccee MMeetthhooddss _"_a_d_d_"

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

 The $description is usually a test file name (but only by convention.)
 It is used as a unique identifier (see e.g.  "parsers".)  Reusing a
 description is a fatal error.

 The $parser is a TAP::Parser object.

 _"_p_a_r_s_e_r_s_"

   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 @descriptions is given, these correspond to the keys used in each call
 to the aadddd(()) method.  Returns an array of the requested parsers (in the
 requested order) in list context or an array reference in scalar context.

 Requesting an unknown identifier is a fatal error.

 _"_d_e_s_c_r_i_p_t_i_o_n_s_"

 Get an array of descriptions in the order in which they were added to the
 aggregator.

 _"_s_t_a_r_t_"

 Call "start" immediately before adding any results to the aggregator.
 Among other times it records the start time for the test run.

 _"_s_t_o_p_"

 Call "stop" immediately after adding all test results to the aggregator.

 _"_e_l_a_p_s_e_d_"

 Elapsed returns a Benchmark object that represents the running time of
 the aggregated tests. In order for "elapsed" to be valid you must call
 "start" before running the tests and "stop" immediately afterwards.

 _"_e_l_a_p_s_e_d___t_i_m_e_s_t_r_"

 Returns a formatted string representing the runtime returned by
 "elapsed()".  This lets the caller not worry about Benchmark.

 _"_a_l_l___p_a_s_s_e_d_"

 Return true if all the tests passed and no parse errors were detected.

 _"_g_e_t___s_t_a_t_u_s_"

 Get a single word describing the status of the aggregated tests.
 Depending on the outcome of the tests returns 'PASS', 'FAIL' or
 'NOTESTS'. This token is understood by CPAN::Reporter.

SSuummmmaarryy mmeetthhooddss 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

 •   planned

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

 _"_t_o_t_a_l_"

   my $tests_run = $aggregate->total;

 Returns the total number of tests run.

 _"_h_a_s___p_r_o_b_l_e_m_s_"

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

 Identical to "has_errors", but also returns true if any TODO tests
 unexpectedly succeeded.  This is more akin to "warnings".

 _"_h_a_s___e_r_r_o_r_s_"

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

 Returns true if _a_n_y of the parsers failed.  This includes:

 •   Failed tests

 •   Parse errors

 •   Bad exit or wait status

 _"_t_o_d_o___f_a_i_l_e_d_"

   # 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".

SSeeee AAllssoo TAP::Parser

 TAP::Harness

perl v5.36.3 2023-02-15 TAP::Parser::Aggregator(3p)