Debian Codegraph @

upstream/mageia-cauldron/man3pm/Test2::Tools::Warnings.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::Tools::Warnings 3pm"
61 .TH Test2::Tools::Warnings 3pm 2025-06-24 "perl v5.42.0" "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::Tools::Warnings \- Tools to verify warnings.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 This is a collection of tools that can be used to test code that issues
71 warnings.
72 .SH SYNOPSIS
73 .IX Header "SYNOPSIS"
74 .Vb 1
75 \& use Test2::Tools::Warnings qw/warns warning warnings no_warnings/;
76 \&
77 \& ok(warns { warn \*(Aqa\*(Aq }, "the code warns");
78 \& ok(!warns { 1 }, "The code does not warn");
79 \& is(warns { warn \*(Aqa\*(Aq; warn \*(Aqb\*(Aq }, 2, "got 2 warnings");
80 \&
81 \& ok(no_warnings { ... }, "code did not warn");
82 \&
83 \& like(
84 \& warning { warn \*(Aqxxx\*(Aq },
85 \& qr/xxx/,
86 \& "Got expected warning"
87 \& );
88 \&
89 \& is(
90 \& warnings { warn "a\en"; warn "b\en" },
91 \& [
92 \& "a\en",
93 \& "b\en",
94 \& ],
95 \& "Got 2 specific warnings"
96 \& );
97 .Ve
98 .SH EXPORTS
99 .IX Header "EXPORTS"
100 All subs are exported by default.
101 .ie n .IP "$count = warns { ... }" 4
102 .el .IP "\f(CW$count\fR = warns { ... }" 4
103 .IX Item "$count = warns { ... }"
104 Returns the count of warnings produced by the block. This will always return 0,
105 or a positive integer.
106 .ie n .IP "$warning = warning { ... }" 4
107 .el .IP "\f(CW$warning\fR = warning { ... }" 4
108 .IX Item "$warning = warning { ... }"
109 Returns the first warning generated by the block. If the block produces more
110 than one warning, they will all be shown as notes, and an actual warning will tell
111 you about it.
112 .ie n .IP "$warnings_ref = warnings { ... }" 4
113 .el .IP "\f(CW$warnings_ref\fR = warnings { ... }" 4
114 .IX Item "$warnings_ref = warnings { ... }"
115 Returns an arrayref with all the warnings produced by the block. This will
116 always return an array reference. If there are no warnings, this will return an
117 empty array reference.
118 .ie n .IP "$bool = no_warnings { ... }" 4
119 .el .IP "\f(CW$bool\fR = no_warnings { ... }" 4
120 .IX Item "$bool = no_warnings { ... }"
121 Return true if the block has no warnings. Returns false if there are warnings.
122 .SH SOURCE
123 .IX Header "SOURCE"
124 The source code repository for Test2\-Suite can be found at
125 \&\fIhttps://github.com/Test\-More/test\-more/\fR.
126 .SH MAINTAINERS
127 .IX Header "MAINTAINERS"
128 .IP "Chad Granum <[email protected]>" 4
129 .IX Item "Chad Granum <[email protected]>"
130 .SH AUTHORS
131 .IX Header "AUTHORS"
132 .IP "Chad Granum <[email protected]>" 4
133 .IX Item "Chad Granum <[email protected]>"
134 .SH COPYRIGHT
135 .IX Header "COPYRIGHT"
136 Copyright Chad Granum <[email protected]>.
137 .PP
138 This program is free software; you can redistribute it and/or
139 modify it under the same terms as Perl itself.
140 .PP
141 See \fIhttp://dev.perl.org/licenses/\fR