Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

Test2::EventFacet::Plan (3)

Name

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

Synopsis

Please see following description for synopsis

Description

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



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

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

FIELDS
       $string = $plan->{details}
       $string = $plan->details()
           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->count()
           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->skip()
           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->none()
           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?

SOURCE
       The source code repository for Test2 can be found at
       http://github.com/Test-More/test-more/.

MAINTAINERS
       Chad Granum <exodist@cpan.org>

AUTHORS
       Chad Granum <exodist@cpan.org>

COPYRIGHT
       Copyright 2019 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 http://dev.perl.org/licenses/



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | runtime/perl-532      |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+

NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       http://www.cpan.org/src/5.0/perl-5.32.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.perl.org/.



perl v5.32.0                      2020-06-14
                                                    Test2::EventFacet::Plan(3)