Debian Codegraph @

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