1Test2::EventFacet::PlanU(s3e)r Contributed Perl DocumentaTteisotn2::EventFacet::Plan(3)
2
3
4
6 Test2::EventFacet::Plan - Facet for setting the plan
7
9 Events use this facet when they need to set the plan.
10
12 $string = $plan->{details}
13 $string = $plan->details()
14 Human readable explanation for the plan being set. This is normally
15 not rendered by most formatters except when the "skip" field is
16 also set.
17
18 $positive_int = $plan->{count}
19 $positive_int = $plan->count()
20 Set the number of expected assertions. This should usually be set
21 to 0 when "skip" or "none" are also set.
22
23 $bool = $plan->{skip}
24 $bool = $plan->skip()
25 When true the entire test should be skipped. This is usually paired
26 with an explanation in the "details" field, and a "control" facet
27 that has "terminate" set to 0.
28
29 $bool = $plan->{none}
30 $bool = $plan->none()
31 This is mainly used by legacy Test::Builder tests which set the
32 plan to "no plan", a construct that predates the much better
33 done_testing().
34
35 If you are using this in non-legacy code you may need to reconsider
36 the course of your life, maybe a hermitage would suite you?
37
39 The source code repository for Test2 can be found at
40 http://github.com/Test-More/test-more/.
41
43 Chad Granum <exodist@cpan.org>
44
46 Chad Granum <exodist@cpan.org>
47
49 Copyright 2020 Chad Granum <exodist@cpan.org>.
50
51 This program is free software; you can redistribute it and/or modify it
52 under the same terms as Perl itself.
53
54 See http://dev.perl.org/licenses/
55
56
57
58perl v5.38.0 2023-07-21 Test2::EventFacet::Plan(3)