Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Test2::Todo.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::Todo 3pm"
61 .TH Test2::Todo 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::Todo \- TODO extension for Test2.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 This is an object that lets you create and manage TODO states for tests. This
71 is an extension, not a plugin or a tool. This library can be used by plugins
72 and tools to manage todo states.
73 .PP
74 If you simply want to write a todo test then you should look at the \f(CW\*(C`todo\*(C'\fR
75 function provided by Test2::Tools::Basic.
76 .SH SYNOPSIS
77 .IX Header "SYNOPSIS"
78 .Vb 1
79 \& use Test2::Todo;
80 \&
81 \& # Start the todo
82 \& my $todo = Test2::Todo\->new(reason => \*(AqFix later\*(Aq);
83 \&
84 \& # Will be considered todo, so suite still passes
85 \& ok(0, "oops");
86 \&
87 \& # End the todo
88 \& $todo\->end;
89 \&
90 \& # TODO has ended, this test will actually fail.
91 \& ok(0, "oops");
92 .Ve
93 .SH "CONSTRUCTION OPTIONS"
94 .IX Header "CONSTRUCTION OPTIONS"
95 .IP "reason (required)" 4
96 .IX Item "reason (required)"
97 The reason for the todo, this can be any defined value.
98 .IP "hub (optional)" 4
99 .IX Item "hub (optional)"
100 The hub to which the TODO state should be applied. If none is provided then the
101 current global hub is used.
102 .SH "INSTANCE METHODS"
103 .IX Header "INSTANCE METHODS"
104 .ie n .IP $todo\->end 4
105 .el .IP \f(CW$todo\fR\->end 4
106 .IX Item "$todo->end"
107 End the todo state.
108 .SH "CLASS METHODS"
109 .IX Header "CLASS METHODS"
110 .ie n .IP "$count = Test2::Todo\->hub_in_todo($hub)" 4
111 .el .IP "\f(CW$count\fR = Test2::Todo\->hub_in_todo($hub)" 4
112 .IX Item "$count = Test2::Todo->hub_in_todo($hub)"
113 If the hub has any todo objects this will return the total number of them. If
114 the hub has no todo objects it will return 0.
115 .SH "OTHER NOTES"
116 .IX Header "OTHER NOTES"
117 .SS "How it works"
118 .IX Subsection "How it works"
119 When an instance is created a filter sub is added to the Test2::Hub. This
120 filter will set the \f(CW\*(C`todo\*(C'\fR and \f(CW\*(C`diag_todo\*(C'\fR attributes on all events as they
121 come in. When the instance is destroyed, or \f(CWend()\fR is called, the filter is
122 removed.
123 .PP
124 When a new hub is pushed (such as when a subtest is started) the new hub will
125 inherit the filter, but it will only set \f(CW\*(C`diag_todo\*(C'\fR, it will not set \f(CW\*(C`todo\*(C'\fR
126 on events in child hubs.
127 .ie n .SS "$todo\->end is called at destruction"
128 .el .SS "\f(CW$todo\fP\->end is called at destruction"
129 .IX Subsection "$todo->end is called at destruction"
130 If your \f(CW$todo\fR object falls out of scope and gets garbage collected, the todo
131 will end.
132 .SS "Can I use multiple instances?"
133 .IX Subsection "Can I use multiple instances?"
134 Yes. The most recently created one that is still active will win.
135 .SH SOURCE
136 .IX Header "SOURCE"
137 The source code repository for Test2\-Suite can be found at
138 \&\fIhttps://github.com/Test\-More/test\-more/\fR.
139 .SH MAINTAINERS
140 .IX Header "MAINTAINERS"
141 .IP "Chad Granum <[email protected]>" 4
142 .IX Item "Chad Granum <[email protected]>"
143 .SH AUTHORS
144 .IX Header "AUTHORS"
145 .IP "Chad Granum <[email protected]>" 4
146 .IX Item "Chad Granum <[email protected]>"
147 .SH COPYRIGHT
148 .IX Header "COPYRIGHT"
149 Copyright Chad Granum <[email protected]>.
150 .PP
151 This program is free software; you can redistribute it and/or
152 modify it under the same terms as Perl itself.
153 .PP
154 See \fIhttp://dev.perl.org/licenses/\fR