| 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::Extended 3perl" |
| 58 |
.TH Test2::Bundle::Extended 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::Extended \- Old name for Test2::V0 |
| 65 |
.SH "*** DEPRECATED ***" |
| 66 |
.IX Header "*** DEPRECATED ***" |
| 67 |
This bundle has been renamed to Test2::V0, in which the \f(CW\*(Aq:v1\*(Aq\fR tag has |
| 68 |
been removed as unnecessary. |
| 69 |
.SH DESCRIPTION |
| 70 |
.IX Header "DESCRIPTION" |
| 71 |
This is the big-daddy bundle. This bundle includes nearly every tool, and |
| 72 |
several plugins, that the Test2 author uses. This bundle is used |
| 73 |
extensively to test Test2::Suite itself. |
| 74 |
.SH SYNOPSIS |
| 75 |
.IX Header "SYNOPSIS" |
| 76 |
.Vb 1 |
| 77 |
\& use Test2::Bundle::Extended \*(Aq:v1\*(Aq; |
| 78 |
\& |
| 79 |
\& ok(1, "pass"); |
| 80 |
\& |
| 81 |
\& ... |
| 82 |
\& |
| 83 |
\& done_testing; |
| 84 |
.Ve |
| 85 |
.SH "RESOLVING CONFLICTS WITH MOOSE" |
| 86 |
.IX Header "RESOLVING CONFLICTS WITH MOOSE" |
| 87 |
.Vb 1 |
| 88 |
\& use Test2::Bundle::Extended \*(Aq!meta\*(Aq; |
| 89 |
.Ve |
| 90 |
.PP |
| 91 |
Moose and Test2::Bundle::Extended both export very different \f(CWmeta()\fR |
| 92 |
subs. Adding \f(CW\*(Aq!meta\*(Aq\fR to the import args will prevent the sub from being |
| 93 |
imported. This bundle also exports the sub under the name \f(CWmeta_check()\fR so |
| 94 |
you can use that spelling as an alternative. |
| 95 |
.SS TAGS |
| 96 |
.IX Subsection "TAGS" |
| 97 |
.IP :v1 4 |
| 98 |
.IX Item ":v1" |
| 99 |
.PD 0 |
| 100 |
.IP :DEFAULT 4 |
| 101 |
.IX Item ":DEFAULT" |
| 102 |
.PD |
| 103 |
The following are all identical: |
| 104 |
.Sp |
| 105 |
.Vb 1 |
| 106 |
\& use Test2::Bundle::Extended; |
| 107 |
\& |
| 108 |
\& use Test2::Bundle::Extended \*(Aq:v1\*(Aq; |
| 109 |
\& |
| 110 |
\& use Test2::Bundle::Extended \*(Aq:DEFAULT\*(Aq; |
| 111 |
.Ve |
| 112 |
.SS "RENAMING ON IMPORT" |
| 113 |
.IX Subsection "RENAMING ON IMPORT" |
| 114 |
.Vb 1 |
| 115 |
\& use Test2::Bundle::Extended \*(Aq:v1\*(Aq, \*(Aq!ok\*(Aq, ok => {\-as => \*(Aqmy_ok\*(Aq}; |
| 116 |
.Ve |
| 117 |
.PP |
| 118 |
This bundle uses Importer for exporting, as such you can use any arguments |
| 119 |
it accepts. |
| 120 |
.PP |
| 121 |
Explanation: |
| 122 |
.IP ':v1' 4 |
| 123 |
.IX Item "':v1'" |
| 124 |
Use the default tag, all default exports. |
| 125 |
.IP '!ok' 4 |
| 126 |
.IX Item "'!ok'" |
| 127 |
Do not export \f(CWok()\fR |
| 128 |
.IP "ok => {\-as => 'my_ok'}" 4 |
| 129 |
.IX Item "ok => {-as => 'my_ok'}" |
| 130 |
Actually, go ahead and import \f(CWok()\fR but under the name \f(CWmy_ok()\fR. |
| 131 |
.PP |
| 132 |
If you did not add the \f(CW\*(Aq!ok\*(Aq\fR argument then you would have both \f(CWok()\fR and |
| 133 |
\&\f(CWmy_ok()\fR |
| 134 |
.SH PRAGMAS |
| 135 |
.IX Header "PRAGMAS" |
| 136 |
All of these can be disabled via individual import arguments, or by the |
| 137 |
\&\f(CW\*(C`\-no_pragmas\*(C'\fR argument. |
| 138 |
.PP |
| 139 |
.Vb 1 |
| 140 |
\& use Test2::Bundle::Extended \-no_pragmas => 1; |
| 141 |
.Ve |
| 142 |
.SS STRICT |
| 143 |
.IX Subsection "STRICT" |
| 144 |
strict is turned on for you. You can disable this with the \f(CW\*(C`\-no_strict\*(C'\fR or |
| 145 |
\&\f(CW\*(C`\-no_pragmas\*(C'\fR import arguments: |
| 146 |
.PP |
| 147 |
.Vb 1 |
| 148 |
\& use Test2::Bundle::Extended \-no_strict => 1; |
| 149 |
.Ve |
| 150 |
.SS WARNINGS |
| 151 |
.IX Subsection "WARNINGS" |
| 152 |
warnings are turned on for you. You can disable this with the |
| 153 |
\&\f(CW\*(C`\-no_warnings\*(C'\fR or \f(CW\*(C`\-no_pragmas\*(C'\fR import arguments: |
| 154 |
.PP |
| 155 |
.Vb 1 |
| 156 |
\& use Test2::Bundle::Extended \-no_warnings => 1; |
| 157 |
.Ve |
| 158 |
.SS UTF8 |
| 159 |
.IX Subsection "UTF8" |
| 160 |
This is actually done via the Test2::Plugin::UTF8 plugin, see the |
| 161 |
"PLUGINS" section for details. |
| 162 |
.PP |
| 163 |
\&\fBNote:\fR \f(CW\*(C`\-no_pragmas => 1\*(C'\fR will turn off the entire plugin. |
| 164 |
.SH PLUGINS |
| 165 |
.IX Header "PLUGINS" |
| 166 |
.SS SRAND |
| 167 |
.IX Subsection "SRAND" |
| 168 |
See Test2::Plugin::SRand. |
| 169 |
.PP |
| 170 |
This will set the random seed to today's date. You can provide an alternate seed |
| 171 |
with the \f(CW\*(C`\-srand\*(C'\fR import option: |
| 172 |
.PP |
| 173 |
.Vb 1 |
| 174 |
\& use Test2::Bundle::Extended \-srand => 1234; |
| 175 |
.Ve |
| 176 |
.SS UTF8 |
| 177 |
.IX Subsection "UTF8" |
| 178 |
See Test2::Plugin::UTF8. |
| 179 |
.PP |
| 180 |
This will set the file, and all output handles (including formatter handles), to |
| 181 |
utf8. This will turn on the utf8 pragma for the current scope. |
| 182 |
.PP |
| 183 |
This can be disabled using the \f(CW\*(C`\-no_utf8 => 1\*(C'\fR or \f(CW\*(C`\-no_pragmas => 1\*(C'\fR |
| 184 |
import arguments. |
| 185 |
.PP |
| 186 |
.Vb 1 |
| 187 |
\& use Test2::Bundle::Extended \-no_utf8 => 1; |
| 188 |
.Ve |
| 189 |
.SS "EXIT SUMMARY" |
| 190 |
.IX Subsection "EXIT SUMMARY" |
| 191 |
See Test2::Plugin::ExitSummary. |
| 192 |
.PP |
| 193 |
This plugin has no configuration. |
| 194 |
.SH "API FUNCTIONS" |
| 195 |
.IX Header "API FUNCTIONS" |
| 196 |
See Test2::API for these |
| 197 |
.ie n .IP "$ctx = \fBcontext()\fR" 4 |
| 198 |
.el .IP "\f(CW$ctx\fR = \fBcontext()\fR" 4 |
| 199 |
.IX Item "$ctx = context()" |
| 200 |
.PD 0 |
| 201 |
.ie n .IP "$events = intercept { ... }" 4 |
| 202 |
.el .IP "\f(CW$events\fR = intercept { ... }" 4 |
| 203 |
.IX Item "$events = intercept { ... }" |
| 204 |
.PD |
| 205 |
.SH TOOLS |
| 206 |
.IX Header "TOOLS" |
| 207 |
.SS TARGET |
| 208 |
.IX Subsection "TARGET" |
| 209 |
See Test2::Tools::Target. |
| 210 |
.PP |
| 211 |
You can specify a target class with the \f(CW\*(C`\-target\*(C'\fR import argument. If you do |
| 212 |
not provide a target then \f(CW$CLASS\fR and \f(CWCLASS()\fR will not be imported. |
| 213 |
.PP |
| 214 |
.Vb 1 |
| 215 |
\& use Test2::Bundle::Extended \-target => \*(AqMy::Class\*(Aq; |
| 216 |
\& |
| 217 |
\& print $CLASS; # My::Class |
| 218 |
\& print CLASS(); # My::Class |
| 219 |
.Ve |
| 220 |
.PP |
| 221 |
Or you can specify names: |
| 222 |
.PP |
| 223 |
.Vb 1 |
| 224 |
\& use Test2::Bundle::Extended \-target => { pkg => \*(AqSome::Package\*(Aq }; |
| 225 |
\& |
| 226 |
\& pkg()\->xxx; # Call \*(Aqxxx\*(Aq on Some::Package |
| 227 |
\& $pkg\->xxx; # Same |
| 228 |
.Ve |
| 229 |
.ie n .IP $CLASS 4 |
| 230 |
.el .IP \f(CW$CLASS\fR 4 |
| 231 |
.IX Item "$CLASS" |
| 232 |
Package variable that contains the target class name. |
| 233 |
.ie n .IP "$class = \fBCLASS()\fR" 4 |
| 234 |
.el .IP "\f(CW$class\fR = \fBCLASS()\fR" 4 |
| 235 |
.IX Item "$class = CLASS()" |
| 236 |
Constant function that returns the target class name. |
| 237 |
.SS DEFER |
| 238 |
.IX Subsection "DEFER" |
| 239 |
See Test2::Tools::Defer. |
| 240 |
.ie n .IP "def $func => @args;" 4 |
| 241 |
.el .IP "def \f(CW$func\fR => \f(CW@args\fR;" 4 |
| 242 |
.IX Item "def $func => @args;" |
| 243 |
.PD 0 |
| 244 |
.IP \fBdo_def()\fR 4 |
| 245 |
.IX Item "do_def()" |
| 246 |
.PD |
| 247 |
.SS BASIC |
| 248 |
.IX Subsection "BASIC" |
| 249 |
See Test2::Tools::Basic. |
| 250 |
.ie n .IP "ok($bool, $name)" 4 |
| 251 |
.el .IP "ok($bool, \f(CW$name\fR)" 4 |
| 252 |
.IX Item "ok($bool, $name)" |
| 253 |
.PD 0 |
| 254 |
.IP pass($name) 4 |
| 255 |
.IX Item "pass($name)" |
| 256 |
.IP fail($name) 4 |
| 257 |
.IX Item "fail($name)" |
| 258 |
.IP diag($message) 4 |
| 259 |
.IX Item "diag($message)" |
| 260 |
.IP note($message) 4 |
| 261 |
.IX Item "note($message)" |
| 262 |
.ie n .IP "$todo = todo($reason)" 4 |
| 263 |
.el .IP "\f(CW$todo\fR = todo($reason)" 4 |
| 264 |
.IX Item "$todo = todo($reason)" |
| 265 |
.ie n .IP "todo $reason => sub { ... }" 4 |
| 266 |
.el .IP "todo \f(CW$reason\fR => sub { ... }" 4 |
| 267 |
.IX Item "todo $reason => sub { ... }" |
| 268 |
.ie n .IP "skip($reason, $count)" 4 |
| 269 |
.el .IP "skip($reason, \f(CW$count\fR)" 4 |
| 270 |
.IX Item "skip($reason, $count)" |
| 271 |
.IP plan($count) 4 |
| 272 |
.IX Item "plan($count)" |
| 273 |
.IP skip_all($reason) 4 |
| 274 |
.IX Item "skip_all($reason)" |
| 275 |
.IP \fBdone_testing()\fR 4 |
| 276 |
.IX Item "done_testing()" |
| 277 |
.IP bail_out($reason) 4 |
| 278 |
.IX Item "bail_out($reason)" |
| 279 |
.PD |
| 280 |
.SS COMPARE |
| 281 |
.IX Subsection "COMPARE" |
| 282 |
See Test2::Tools::Compare. |
| 283 |
.ie n .IP "is($got, $want, $name)" 4 |
| 284 |
.el .IP "is($got, \f(CW$want\fR, \f(CW$name\fR)" 4 |
| 285 |
.IX Item "is($got, $want, $name)" |
| 286 |
.PD 0 |
| 287 |
.ie n .IP "isnt($got, $do_not_want, $name)" 4 |
| 288 |
.el .IP "isnt($got, \f(CW$do_not_want\fR, \f(CW$name\fR)" 4 |
| 289 |
.IX Item "isnt($got, $do_not_want, $name)" |
| 290 |
.ie n .IP "like($got, qr/match/, $name)" 4 |
| 291 |
.el .IP "like($got, qr/match/, \f(CW$name\fR)" 4 |
| 292 |
.IX Item "like($got, qr/match/, $name)" |
| 293 |
.ie n .IP "unlike($got, qr/mismatch/, $name)" 4 |
| 294 |
.el .IP "unlike($got, qr/mismatch/, \f(CW$name\fR)" 4 |
| 295 |
.IX Item "unlike($got, qr/mismatch/, $name)" |
| 296 |
.ie n .IP "$check = match(qr/pattern/)" 4 |
| 297 |
.el .IP "\f(CW$check\fR = match(qr/pattern/)" 4 |
| 298 |
.IX Item "$check = match(qr/pattern/)" |
| 299 |
.ie n .IP "$check = mismatch(qr/pattern/)" 4 |
| 300 |
.el .IP "\f(CW$check\fR = mismatch(qr/pattern/)" 4 |
| 301 |
.IX Item "$check = mismatch(qr/pattern/)" |
| 302 |
.ie n .IP "$check = validator(sub { return $bool })" 4 |
| 303 |
.el .IP "\f(CW$check\fR = validator(sub { return \f(CW$bool\fR })" 4 |
| 304 |
.IX Item "$check = validator(sub { return $bool })" |
| 305 |
.ie n .IP "$check = hash { ... }" 4 |
| 306 |
.el .IP "\f(CW$check\fR = hash { ... }" 4 |
| 307 |
.IX Item "$check = hash { ... }" |
| 308 |
.ie n .IP "$check = array { ... }" 4 |
| 309 |
.el .IP "\f(CW$check\fR = array { ... }" 4 |
| 310 |
.IX Item "$check = array { ... }" |
| 311 |
.ie n .IP "$check = bag { ... }" 4 |
| 312 |
.el .IP "\f(CW$check\fR = bag { ... }" 4 |
| 313 |
.IX Item "$check = bag { ... }" |
| 314 |
.ie n .IP "$check = object { ... }" 4 |
| 315 |
.el .IP "\f(CW$check\fR = object { ... }" 4 |
| 316 |
.IX Item "$check = object { ... }" |
| 317 |
.ie n .IP "$check = meta { ... }" 4 |
| 318 |
.el .IP "\f(CW$check\fR = meta { ... }" 4 |
| 319 |
.IX Item "$check = meta { ... }" |
| 320 |
.ie n .IP "$check = number($num)" 4 |
| 321 |
.el .IP "\f(CW$check\fR = number($num)" 4 |
| 322 |
.IX Item "$check = number($num)" |
| 323 |
.ie n .IP "$check = string($str)" 4 |
| 324 |
.el .IP "\f(CW$check\fR = string($str)" 4 |
| 325 |
.IX Item "$check = string($str)" |
| 326 |
.ie n .IP "$check = check_isa($class_name)" 4 |
| 327 |
.el .IP "\f(CW$check\fR = check_isa($class_name)" 4 |
| 328 |
.IX Item "$check = check_isa($class_name)" |
| 329 |
.ie n .IP "$check = in_set(@things)" 4 |
| 330 |
.el .IP "\f(CW$check\fR = in_set(@things)" 4 |
| 331 |
.IX Item "$check = in_set(@things)" |
| 332 |
.ie n .IP "$check = not_in_set(@things)" 4 |
| 333 |
.el .IP "\f(CW$check\fR = not_in_set(@things)" 4 |
| 334 |
.IX Item "$check = not_in_set(@things)" |
| 335 |
.ie n .IP "$check = check_set(@things)" 4 |
| 336 |
.el .IP "\f(CW$check\fR = check_set(@things)" 4 |
| 337 |
.IX Item "$check = check_set(@things)" |
| 338 |
.ie n .IP "$check = item($thing)" 4 |
| 339 |
.el .IP "\f(CW$check\fR = item($thing)" 4 |
| 340 |
.IX Item "$check = item($thing)" |
| 341 |
.ie n .IP "$check = item($idx => $thing)" 4 |
| 342 |
.el .IP "\f(CW$check\fR = item($idx => \f(CW$thing\fR)" 4 |
| 343 |
.IX Item "$check = item($idx => $thing)" |
| 344 |
.ie n .IP "$check = field($name => $val)" 4 |
| 345 |
.el .IP "\f(CW$check\fR = field($name => \f(CW$val\fR)" 4 |
| 346 |
.IX Item "$check = field($name => $val)" |
| 347 |
.ie n .IP "$check = call($method => $expect)" 4 |
| 348 |
.el .IP "\f(CW$check\fR = call($method => \f(CW$expect\fR)" 4 |
| 349 |
.IX Item "$check = call($method => $expect)" |
| 350 |
.ie n .IP "$check = call_list($method => $expect)" 4 |
| 351 |
.el .IP "\f(CW$check\fR = call_list($method => \f(CW$expect\fR)" 4 |
| 352 |
.IX Item "$check = call_list($method => $expect)" |
| 353 |
.ie n .IP "$check = call_hash($method => $expect)" 4 |
| 354 |
.el .IP "\f(CW$check\fR = call_hash($method => \f(CW$expect\fR)" 4 |
| 355 |
.IX Item "$check = call_hash($method => $expect)" |
| 356 |
.ie n .IP "$check = prop($name => $expect)" 4 |
| 357 |
.el .IP "\f(CW$check\fR = prop($name => \f(CW$expect\fR)" 4 |
| 358 |
.IX Item "$check = prop($name => $expect)" |
| 359 |
.ie n .IP "$check = check($thing)" 4 |
| 360 |
.el .IP "\f(CW$check\fR = check($thing)" 4 |
| 361 |
.IX Item "$check = check($thing)" |
| 362 |
.ie n .IP "$check = T()" 4 |
| 363 |
.el .IP "\f(CW$check\fR = T()" 4 |
| 364 |
.IX Item "$check = T()" |
| 365 |
.ie n .IP "$check = F()" 4 |
| 366 |
.el .IP "\f(CW$check\fR = F()" 4 |
| 367 |
.IX Item "$check = F()" |
| 368 |
.ie n .IP "$check = D()" 4 |
| 369 |
.el .IP "\f(CW$check\fR = D()" 4 |
| 370 |
.IX Item "$check = D()" |
| 371 |
.ie n .IP "$check = \fBDF()\fR" 4 |
| 372 |
.el .IP "\f(CW$check\fR = \fBDF()\fR" 4 |
| 373 |
.IX Item "$check = DF()" |
| 374 |
.ie n .IP "$check = E()" 4 |
| 375 |
.el .IP "\f(CW$check\fR = E()" 4 |
| 376 |
.IX Item "$check = E()" |
| 377 |
.ie n .IP "$check = \fBDNE()\fR" 4 |
| 378 |
.el .IP "\f(CW$check\fR = \fBDNE()\fR" 4 |
| 379 |
.IX Item "$check = DNE()" |
| 380 |
.ie n .IP "$check = \fBFDNE()\fR" 4 |
| 381 |
.el .IP "\f(CW$check\fR = \fBFDNE()\fR" 4 |
| 382 |
.IX Item "$check = FDNE()" |
| 383 |
.ie n .IP "$check = U()" 4 |
| 384 |
.el .IP "\f(CW$check\fR = U()" 4 |
| 385 |
.IX Item "$check = U()" |
| 386 |
.ie n .IP "$check = L()" 4 |
| 387 |
.el .IP "\f(CW$check\fR = L()" 4 |
| 388 |
.IX Item "$check = L()" |
| 389 |
.ie n .IP "$check = exact_ref($ref)" 4 |
| 390 |
.el .IP "\f(CW$check\fR = exact_ref($ref)" 4 |
| 391 |
.IX Item "$check = exact_ref($ref)" |
| 392 |
.IP \fBend()\fR 4 |
| 393 |
.IX Item "end()" |
| 394 |
.IP \fBetc()\fR 4 |
| 395 |
.IX Item "etc()" |
| 396 |
.ie n .IP "filter_items { grep { ... } @_ }" 4 |
| 397 |
.el .IP "filter_items { grep { ... } \f(CW@_\fR }" 4 |
| 398 |
.IX Item "filter_items { grep { ... } @_ }" |
| 399 |
.ie n .IP "$check = event $type => ..." 4 |
| 400 |
.el .IP "\f(CW$check\fR = event \f(CW$type\fR => ..." 4 |
| 401 |
.IX Item "$check = event $type => ..." |
| 402 |
.ie n .IP "@checks = fail_events $type => ..." 4 |
| 403 |
.el .IP "\f(CW@checks\fR = fail_events \f(CW$type\fR => ..." 4 |
| 404 |
.IX Item "@checks = fail_events $type => ..." |
| 405 |
.PD |
| 406 |
.SS "CLASSIC COMPARE" |
| 407 |
.IX Subsection "CLASSIC COMPARE" |
| 408 |
See Test2::Tools::ClassicCompare. |
| 409 |
.ie n .IP "cmp_ok($got, $op, $want, $name)" 4 |
| 410 |
.el .IP "cmp_ok($got, \f(CW$op\fR, \f(CW$want\fR, \f(CW$name\fR)" 4 |
| 411 |
.IX Item "cmp_ok($got, $op, $want, $name)" |
| 412 |
.SS SUBTEST |
| 413 |
.IX Subsection "SUBTEST" |
| 414 |
See Test2::Tools::Subtest. |
| 415 |
.ie n .IP "subtest $name => sub { ... }" 4 |
| 416 |
.el .IP "subtest \f(CW$name\fR => sub { ... }" 4 |
| 417 |
.IX Item "subtest $name => sub { ... }" |
| 418 |
(Note: This is called \f(CWsubtest_buffered()\fR in the Tools module.) |
| 419 |
.SS CLASS |
| 420 |
.IX Subsection "CLASS" |
| 421 |
See Test2::Tools::Class. |
| 422 |
.ie n .IP "can_ok($thing, @methods)" 4 |
| 423 |
.el .IP "can_ok($thing, \f(CW@methods\fR)" 4 |
| 424 |
.IX Item "can_ok($thing, @methods)" |
| 425 |
.PD 0 |
| 426 |
.ie n .IP "isa_ok($thing, @classes)" 4 |
| 427 |
.el .IP "isa_ok($thing, \f(CW@classes\fR)" 4 |
| 428 |
.IX Item "isa_ok($thing, @classes)" |
| 429 |
.ie n .IP "DOES_ok($thing, @roles)" 4 |
| 430 |
.el .IP "DOES_ok($thing, \f(CW@roles\fR)" 4 |
| 431 |
.IX Item "DOES_ok($thing, @roles)" |
| 432 |
.PD |
| 433 |
.SS ENCODING |
| 434 |
.IX Subsection "ENCODING" |
| 435 |
See Test2::Tools::Encoding. |
| 436 |
.IP set_encoding($encoding) 4 |
| 437 |
.IX Item "set_encoding($encoding)" |
| 438 |
.SS EXPORTS |
| 439 |
.IX Subsection "EXPORTS" |
| 440 |
See Test2::Tools::Exports. |
| 441 |
.IP "imported_ok('function', '$scalar', ...)" 4 |
| 442 |
.IX Item "imported_ok('function', '$scalar', ...)" |
| 443 |
.PD 0 |
| 444 |
.IP "not_imported_ok('function', '$scalar', ...)" 4 |
| 445 |
.IX Item "not_imported_ok('function', '$scalar', ...)" |
| 446 |
.PD |
| 447 |
.SS REF |
| 448 |
.IX Subsection "REF" |
| 449 |
See Test2::Tools::Ref. |
| 450 |
.ie n .IP "ref_ok($ref, $type)" 4 |
| 451 |
.el .IP "ref_ok($ref, \f(CW$type\fR)" 4 |
| 452 |
.IX Item "ref_ok($ref, $type)" |
| 453 |
.PD 0 |
| 454 |
.ie n .IP "ref_is($got, $want)" 4 |
| 455 |
.el .IP "ref_is($got, \f(CW$want\fR)" 4 |
| 456 |
.IX Item "ref_is($got, $want)" |
| 457 |
.ie n .IP "ref_is_not($got, $do_not_want)" 4 |
| 458 |
.el .IP "ref_is_not($got, \f(CW$do_not_want\fR)" 4 |
| 459 |
.IX Item "ref_is_not($got, $do_not_want)" |
| 460 |
.PD |
| 461 |
.SS MOCK |
| 462 |
.IX Subsection "MOCK" |
| 463 |
See Test2::Tools::Mock. |
| 464 |
.ie n .IP "$control = mock ..." 4 |
| 465 |
.el .IP "\f(CW$control\fR = mock ..." 4 |
| 466 |
.IX Item "$control = mock ..." |
| 467 |
.PD 0 |
| 468 |
.ie n .IP "$bool = mocked($thing)" 4 |
| 469 |
.el .IP "\f(CW$bool\fR = mocked($thing)" 4 |
| 470 |
.IX Item "$bool = mocked($thing)" |
| 471 |
.PD |
| 472 |
.SS EXCEPTION |
| 473 |
.IX Subsection "EXCEPTION" |
| 474 |
See Test2::Tools::Exception. |
| 475 |
.ie n .IP "$exception = dies { ... }" 4 |
| 476 |
.el .IP "\f(CW$exception\fR = dies { ... }" 4 |
| 477 |
.IX Item "$exception = dies { ... }" |
| 478 |
.PD 0 |
| 479 |
.ie n .IP "$bool = lives { ... }" 4 |
| 480 |
.el .IP "\f(CW$bool\fR = lives { ... }" 4 |
| 481 |
.IX Item "$bool = lives { ... }" |
| 482 |
.ie n .IP "$bool = try_ok { ... }" 4 |
| 483 |
.el .IP "\f(CW$bool\fR = try_ok { ... }" 4 |
| 484 |
.IX Item "$bool = try_ok { ... }" |
| 485 |
.PD |
| 486 |
.SS WARNINGS |
| 487 |
.IX Subsection "WARNINGS" |
| 488 |
See Test2::Tools::Warnings. |
| 489 |
.ie n .IP "$count = warns { ... }" 4 |
| 490 |
.el .IP "\f(CW$count\fR = warns { ... }" 4 |
| 491 |
.IX Item "$count = warns { ... }" |
| 492 |
.PD 0 |
| 493 |
.ie n .IP "$warning = warning { ... }" 4 |
| 494 |
.el .IP "\f(CW$warning\fR = warning { ... }" 4 |
| 495 |
.IX Item "$warning = warning { ... }" |
| 496 |
.ie n .IP "$warnings_ref = warnings { ... }" 4 |
| 497 |
.el .IP "\f(CW$warnings_ref\fR = warnings { ... }" 4 |
| 498 |
.IX Item "$warnings_ref = warnings { ... }" |
| 499 |
.ie n .IP "$bool = no_warnings { ... }" 4 |
| 500 |
.el .IP "\f(CW$bool\fR = no_warnings { ... }" 4 |
| 501 |
.IX Item "$bool = no_warnings { ... }" |
| 502 |
.PD |
| 503 |
.SH SOURCE |
| 504 |
.IX Header "SOURCE" |
| 505 |
The source code repository for Test2\-Suite can be found at |
| 506 |
\&\fIhttps://github.com/Test\-More/Test2\-Suite/\fR. |
| 507 |
.SH MAINTAINERS |
| 508 |
.IX Header "MAINTAINERS" |
| 509 |
.IP "Chad Granum <[email protected]>" 4 |
| 510 |
.IX Item "Chad Granum <[email protected]>" |
| 511 |
.SH AUTHORS |
| 512 |
.IX Header "AUTHORS" |
| 513 |
.PD 0 |
| 514 |
.IP "Chad Granum <[email protected]>" 4 |
| 515 |
.IX Item "Chad Granum <[email protected]>" |
| 516 |
.PD |
| 517 |
.SH COPYRIGHT |
| 518 |
.IX Header "COPYRIGHT" |
| 519 |
Copyright 2018 Chad Granum <[email protected]>. |
| 520 |
.PP |
| 521 |
This program is free software; you can redistribute it and/or |
| 522 |
modify it under the same terms as Perl itself. |
| 523 |
.PP |
| 524 |
See \fIhttp://dev.perl.org/licenses/\fR |