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

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

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

NNAAMMEE #

 Test2::EventFacet::Plan - Facet for setting the plan

DDEESSCCRRIIPPTTIIOONN #

 Events use this facet when they need to set the plan.

FFIIEELLDDSS #

 $string = $plan->{details}
 $string = $plan->ddeettaaiillss(())
     Human readable explanation for the plan being set. This is normally
     not rendered by most formatters except when the "skip" field is also
     set.

 $positive_int = $plan->{count}
 $positive_int = $plan->ccoouunntt(())
     Set the number of expected assertions. This should usually be set to
     0 when "skip" or "none" are also set.

 $bool = $plan->{skip}
 $bool = $plan->sskkiipp(())
     When true the entire test should be skipped. This is usually paired
     with an explanation in the "details" field, and a "control" facet
     that has "terminate" set to 0.

 $bool = $plan->{none}
 $bool = $plan->nnoonnee(())
     This is mainly used by legacy Test::Builder tests which set the plan
     to "no plan", a construct that predates the much better
     "done_testing()".

     If you are using this in non-legacy code you may need to reconsider
     the course of your life, maybe a hermitage would suite you?

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::EventFacet::Plan(3p)