dwww Home | Manual pages | Find package

Test2:...anning(3perl)  Perl Programmers Reference Guide Test2:...anning(3perl)

NAME
       Test2::Manual::Testing::Planning - The many ways to set a plan.

DESCRIPTION
       This tutorial covers the many ways of setting a plan.

TEST COUNT
       The plan() function is provided by Test2::Tools::Basic. This function
       lets you specify an exact number of tests to run. This can be done at
       the start of testing, or at the end. This cannot be done partway through
       testing.

           use Test2::Tools::Basic;
           plan(10); # 10 tests expected

           ...

DONE TESTING
       The done_testing() function is provided by Test2::Tools::Basic. This
       function will automatically set the plan to the number of tests that
       were run.  This must be used at the very end of testing.

           use Test2::Tools::Basic;

           ...

           done_testing();

SKIP ALL
       The skip_all() function is provided by Test2::Tools::Basic. This
       function will set the plan to 0, and exit the test immediately. You may
       provide a skip reason that explains why the test should be skipped.

           use Test2::Tools::Basic;
           skip_all("This test will not run here") if ...;

           ...

CUSTOM PLAN EVENT
       A plan is simply an Test2::Event::Plan event that gets sent to the
       current hub. You could always write your own tool to set the plan.

           use Test2::API qw/context/;

           sub set_plan {
               my $count = @_;

               my $ctx = context();
               $ctx->send_event('Plan', max => $count);
               $ctx->release;

               return $count;
           }

SEE ALSO
       Test2::Manual - Primary index of the manual.

SOURCE
       The source code repository for Test2-Manual can be found at
       https://github.com/Test-More/Test2-Suite/.

MAINTAINERS
       Chad Granum <exodist@cpan.org>

AUTHORS
       Chad Granum <exodist@cpan.org>

COPYRIGHT
       Copyright 2018 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/

perl v5.40.1                       2026-08-30            Test2:...anning(3perl)

Generated by dwww version 1.16 on Sat Oct 3 06:00:44 CEST 2026.