Test2::Event::Plan(3p) Perl Programmers Reference Guide #

Test2::Event::Plan(3p) Perl Programmers Reference Guide

NNAAMMEE #

 Test2::Event::Plan - The event of a plan

DDEESSCCRRIIPPTTIIOONN #

 Plan events are fired off whenever a plan is declared, done testing is
 called, or a subtext completes.

SSYYNNOOPPSSIISS #

     use Test2::API qw/context/;
     use Test2::Event::Plan;

     my $ctx = context();

     # Plan for 10 tests to run
     my $event = $ctx->plan(10);

     # Plan to skip all tests (will exit 0)
     $ctx->plan(0, skip_all => "These tests need to be skipped");

AACCCCEESSSSOORRSS #

 $num = $plan->max
     Get the number of expected tests

 $dir = $plan->directive
     Get the directive (such as TODO, skip_all, or no_plan).

 $reason = $plan->reason
     Get the reason for the directive.

SSOOUURRCCEE #

 The source code repository for Test2 can be found at
 _h_t_t_p_:_/_/_g_i_t_h_u_b_._c_o_m_/_T_e_s_t_-_M_o_r_e_/_t_e_s_t_-_m_o_r_e_/.

MMAAIINNTTAAIINNEERRSS #

 Chad Granum <exodist@cpan.org>

AAUUTTHHOORRSS #

 Chad Granum <exodist@cpan.org>

CCOOPPYYRRIIGGHHTT #

 Copyright 2020 Chad Granum <exodist@cpan.org>.

 This program is free software; you can redistribute it and/or modify it
 under the same terms as Perl itself.

 See _h_t_t_p_:_/_/_d_e_v_._p_e_r_l_._o_r_g_/_l_i_c_e_n_s_e_s_/

perl v5.36.3 2023-02-15 Test2::Event::Plan(3p)