Perl Diver 2.31
Main Environment Variables Perl Default Values Perl Config - Summary Perl Config - Full Installed Modules List Directory uptime Docs

Module Documentation
Details and documentation about a specific module, including version and documentation (if available). Note that while links to perldoc.com and search.cpan.org are provided, the module may be part of a larger distribution. If you reach a File Not Found page on either site, please try the parent module.

Test2::EventFacet::Plan

Name Test2::EventFacet::Plan
Version 1.302188
Located at /usr/local/share/perl5
File /usr/local/share/perl5/Test2/EventFacet/Plan.pm
Is Core No
Search CPAN for this module Test2::EventFacet::Plan
Documentation Test2::EventFacet::Plan
Module Details Test2::EventFacet::Plan


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 the Test::Builder manpage 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


AUTHORS

Chad Granum <exodist@cpan.org>Chad Granum


COPYRIGHT

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

Perl Diver brought to you by ScriptSolutions.com © 1997- 2024