Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Test2::Manual::Testing::Planning.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Test2::Manual::Testing::Planning 3pm"
61 .TH Test2::Manual::Testing::Planning 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Test2::Manual::Testing::Planning \- The many ways to set a plan.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 This tutorial covers the many ways of setting a plan.
71 .SH "TEST COUNT"
72 .IX Header "TEST COUNT"
73 The \f(CWplan()\fR function is provided by Test2::Tools::Basic. This function lets
74 you specify an exact number of tests to run. This can be done at the start of
75 testing, or at the end. This cannot be done partway through testing.
76 .PP
77 .Vb 2
78 \& use Test2::Tools::Basic;
79 \& plan(10); # 10 tests expected
80 \&
81 \& ...
82 .Ve
83 .SH "DONE TESTING"
84 .IX Header "DONE TESTING"
85 The \f(CWdone_testing()\fR function is provided by Test2::Tools::Basic. This
86 function will automatically set the plan to the number of tests that were run.
87 This must be used at the very end of testing.
88 .PP
89 .Vb 1
90 \& use Test2::Tools::Basic;
91 \&
92 \& ...
93 \&
94 \& done_testing();
95 .Ve
96 .SH "SKIP ALL"
97 .IX Header "SKIP ALL"
98 The \f(CWskip_all()\fR function is provided by Test2::Tools::Basic. This function
99 will set the plan to \f(CW0\fR, and exit the test immediately. You may provide a skip
100 reason that explains why the test should be skipped.
101 .PP
102 .Vb 2
103 \& use Test2::Tools::Basic;
104 \& skip_all("This test will not run here") if ...;
105 \&
106 \& ...
107 .Ve
108 .SH "CUSTOM PLAN EVENT"
109 .IX Header "CUSTOM PLAN EVENT"
110 A plan is simply an Test2::Event::Plan event that gets sent to the current
111 hub. You could always write your own tool to set the plan.
112 .PP
113 .Vb 1
114 \& use Test2::API qw/context/;
115 \&
116 \& sub set_plan {
117 \& my $count = @_;
118 \&
119 \& my $ctx = context();
120 \& $ctx\->send_event(\*(AqPlan\*(Aq, max => $count);
121 \& $ctx\->release;
122 \&
123 \& return $count;
124 \& }
125 .Ve
126 .SH "SEE ALSO"
127 .IX Header "SEE ALSO"
128 Test2::Manual \- Primary index of the manual.
129 .SH SOURCE
130 .IX Header "SOURCE"
131 The source code repository for Test2\-Manual can be found at
132 \&\fIhttps://github.com/Test\-More/test\-more/\fR.
133 .SH MAINTAINERS
134 .IX Header "MAINTAINERS"
135 .IP "Chad Granum <[email protected]>" 4
136 .IX Item "Chad Granum <[email protected]>"
137 .SH AUTHORS
138 .IX Header "AUTHORS"
139 .IP "Chad Granum <[email protected]>" 4
140 .IX Item "Chad Granum <[email protected]>"
141 .SH COPYRIGHT
142 .IX Header "COPYRIGHT"
143 Copyright Chad Granum <[email protected]>.
144 .PP
145 This program is free software; you can redistribute it and/or
146 modify it under the same terms as Perl itself.
147 .PP
148 See \fIhttp://dev.perl.org/licenses/\fR