Debian Codegraph @

upstream/debian-unstable/man3/Test2::Manual::Testing::Planning.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (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 .\"
57 .IX Title "Test2::Manual::Testing::Planning 3perl"
58 .TH Test2::Manual::Testing::Planning 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Test2::Manual::Testing::Planning \- The many ways to set a plan.
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 This tutorial covers the many ways of setting a plan.
68 .SH "TEST COUNT"
69 .IX Header "TEST COUNT"
70 The \f(CWplan()\fR function is provided by Test2::Tools::Basic. This function lets
71 you specify an exact number of tests to run. This can be done at the start of
72 testing, or at the end. This cannot be done partway through testing.
73 .PP
74 .Vb 2
75 \& use Test2::Tools::Basic;
76 \& plan(10); # 10 tests expected
77 \&
78 \& ...
79 .Ve
80 .SH "DONE TESTING"
81 .IX Header "DONE TESTING"
82 The \f(CWdone_testing()\fR function is provided by Test2::Tools::Basic. This
83 function will automatically set the plan to the number of tests that were run.
84 This must be used at the very end of testing.
85 .PP
86 .Vb 1
87 \& use Test2::Tools::Basic;
88 \&
89 \& ...
90 \&
91 \& done_testing();
92 .Ve
93 .SH "SKIP ALL"
94 .IX Header "SKIP ALL"
95 The \f(CWskip_all()\fR function is provided by Test2::Tools::Basic. This function
96 will set the plan to \f(CW0\fR, and exit the test immediately. You may provide a skip
97 reason that explains why the test should be skipped.
98 .PP
99 .Vb 2
100 \& use Test2::Tools::Basic;
101 \& skip_all("This test will not run here") if ...;
102 \&
103 \& ...
104 .Ve
105 .SH "CUSTOM PLAN EVENT"
106 .IX Header "CUSTOM PLAN EVENT"
107 A plan is simply an Test2::Event::Plan event that gets sent to the current
108 hub. You could always write your own tool to set the plan.
109 .PP
110 .Vb 1
111 \& use Test2::API qw/context/;
112 \&
113 \& sub set_plan {
114 \& my $count = @_;
115 \&
116 \& my $ctx = context();
117 \& $ctx\->send_event(\*(AqPlan\*(Aq, max => $count);
118 \& $ctx\->release;
119 \&
120 \& return $count;
121 \& }
122 .Ve
123 .SH "SEE ALSO"
124 .IX Header "SEE ALSO"
125 Test2::Manual \- Primary index of the manual.
126 .SH SOURCE
127 .IX Header "SOURCE"
128 The source code repository for Test2\-Manual can be found at
129 \&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR.
130 .SH MAINTAINERS
131 .IX Header "MAINTAINERS"
132 .IP "Chad Granum <[email protected]>" 4
133 .IX Item "Chad Granum <[email protected]>"
134 .SH AUTHORS
135 .IX Header "AUTHORS"
136 .PD 0
137 .IP "Chad Granum <[email protected]>" 4
138 .IX Item "Chad Granum <[email protected]>"
139 .PD
140 .SH COPYRIGHT
141 .IX Header "COPYRIGHT"
142 Copyright 2018 Chad Granum <[email protected]>.
143 .PP
144 This program is free software; you can redistribute it and/or
145 modify it under the same terms as Perl itself.
146 .PP
147 See \fIhttp://dev.perl.org/licenses/\fR