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

TAP::Parser::Result::Plan(3p) Perl Programmers Reference Guide

NNAAMMEE #

 TAP::Parser::Result::Plan - Plan result token.

VVEERRSSIIOONN #

 Version 3.44

DDEESSCCRRIIPPTTIIOONN #

 This is a subclass of TAP::Parser::Result.  A token of this class will be
 returned if a plan line is encountered.

  1..1
  ok 1 - woo hooo!

 1..1 is the plan.  Gotta have a plan.

OOVVEERRRRIIDDDDEENN MMEETTHHOODDSS #

 Mainly listed here to shut up the pitiful screams of the pod coverage
 tests.  They keep me awake at night.

 •   "as_string"

 •   "raw"

IInnssttaannccee MMeetthhooddss _"_p_l_a_n_"

   if ( $result->is_plan ) {
      print $result->plan;
   }

 This is merely a synonym for "as_string".

 _"_t_e_s_t_s___p_l_a_n_n_e_d_"

   my $planned = $result->tests_planned;

 Returns the number of tests planned.  For example, a plan of 1..17 will
 cause this method to return '17'.

 _"_d_i_r_e_c_t_i_v_e_"

  my $directive = $plan->directive;

 If a SKIP directive is included with the plan, this method will return
 it.

  1..0 # SKIP: why bother?

 _"_h_a_s___s_k_i_p_"

   if ( $result->has_skip ) { ... }

 Returns a boolean value indicating whether or not this test has a SKIP
 directive.

 _"_e_x_p_l_a_n_a_t_i_o_n_"

  my $explanation = $plan->explanation;

 If a SKIP directive was included with the plan, this method will return
 the explanation, if any.

 _"_t_o_d_o___l_i_s_t_"

   my $todo = $result->todo_list;
   for ( @$todo ) {
       ...
   }

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