Debian Codegraph @

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