Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Test2::Bundle::Simple.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::Bundle::Simple 3pm"
61 .TH Test2::Bundle::Simple 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::Bundle::Simple \- ALMOST a drop\-in replacement for Test::Simple.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 This bundle is intended to be a (mostly) drop\-in replacement for
71 Test::Simple. See "KEY DIFFERENCES FROM Test::Simple" for details.
72 .SH SYNOPSIS
73 .IX Header "SYNOPSIS"
74 .Vb 1
75 \& use Test2::Bundle::Simple;
76 \&
77 \& ok(1, "pass");
78 \&
79 \& done_testing;
80 .Ve
81 .SH PLUGINS
82 .IX Header "PLUGINS"
83 This loads Test2::Plugin::ExitSummary.
84 .SH TOOLS
85 .IX Header "TOOLS"
86 These are all from Test2::Tools::Basic.
87 .ie n .IP "ok($bool, $name)" 4
88 .el .IP "ok($bool, \f(CW$name\fR)" 4
89 .IX Item "ok($bool, $name)"
90 Run a test. If bool is true, the test passes. If bool is false, it fails.
91 .IP plan($count) 4
92 .IX Item "plan($count)"
93 Tell the system how many tests to expect.
94 .IP skip_all($reason) 4
95 .IX Item "skip_all($reason)"
96 Tell the system to skip all the tests (this will exit the script).
97 .IP \fBdone_testing()\fR; 4
98 .IX Item "done_testing();"
99 Tell the system that all tests are complete. You can use this instead of
100 setting a plan.
101 .SH "KEY DIFFERENCES FROM Test::Simple"
102 .IX Header "KEY DIFFERENCES FROM Test::Simple"
103 .IP "You cannot plan at import." 4
104 .IX Item "You cannot plan at import."
105 THIS WILL \fBNOT\fR WORK:
106 .Sp
107 .Vb 1
108 \& use Test2::Bundle::Simple tests => 5;
109 .Ve
110 .Sp
111 Instead you must plan in a separate statement:
112 .Sp
113 .Vb 2
114 \& use Test2::Bundle::Simple;
115 \& plan 5;
116 .Ve
117 .IP "You have three subs imported for use in planning" 4
118 .IX Item "You have three subs imported for use in planning"
119 Use \f(CWplan($count)\fR, \f(CWskip_all($reason)\fR, or \f(CWdone_testing()\fR for your
120 planning.
121 .SH SOURCE
122 .IX Header "SOURCE"
123 The source code repository for Test2\-Suite can be found at
124 \&\fIhttps://github.com/Test\-More/test\-more/\fR.
125 .SH MAINTAINERS
126 .IX Header "MAINTAINERS"
127 .IP "Chad Granum <[email protected]>" 4
128 .IX Item "Chad Granum <[email protected]>"
129 .SH AUTHORS
130 .IX Header "AUTHORS"
131 .IP "Chad Granum <[email protected]>" 4
132 .IX Item "Chad Granum <[email protected]>"
133 .SH COPYRIGHT
134 .IX Header "COPYRIGHT"
135 Copyright Chad Granum <[email protected]>.
136 .PP
137 This program is free software; you can redistribute it and/or
138 modify it under the same terms as Perl itself.
139 .PP
140 See \fIhttp://dev.perl.org/licenses/\fR