Test2::Event::Plan - man pages section 3: Library Interfaces and Headers

Language:

Test2::Event::Plan (3)

Name

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

Synopsis

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");

Description

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



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

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

SYNOPSIS
           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");

ACCESSORS
       $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.

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