1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
26 .\" Set up some character translations and predefined strings. \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote. | will give a
29 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
37 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD. Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
57 . tm Index:\\$1\t\\n%\t"\\$2"
63 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear. Run. Save yourself. No user-serviceable parts.
70 . \" fudge factors for nroff and troff
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102 . \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 . \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
129 .\" ========================================================================
131 .IX Title "TAP::Parser::Result::Test 3"
132 .TH TAP::Parser::Result::Test 3 "2009-05-05" "perl v5.8.7" "User Contributed Perl Documentation"
134 TAP::Parser::Result::Test \- Test result token.
139 .IX Header "DESCRIPTION"
140 This is a subclass of TAP::Parser::Result. A token of this class will be
141 returned if a test line is encountered.
147 .SH "OVERRIDDEN METHODS"
148 .IX Header "OVERRIDDEN METHODS"
149 This class is the workhorse of the TAP::Parser system. Most \s-1TAP\s0 lines will
150 be test lines and if \f(CW\*(C`$result\->is_test\*(C'\fR, then you have a bunch of methods
152 .Sh "Instance Methods"
153 .IX Subsection "Instance Methods"
154 \fI\f(CI\*(C`ok\*(C'\fI\fR
158 \& my $ok = $result\->ok;
161 Returns the literal text of the \f(CW\*(C`ok\*(C'\fR or \f(CW\*(C`not ok\*(C'\fR status.
163 \fI\f(CI\*(C`number\*(C'\fI\fR
164 .IX Subsection "number"
167 \& my $test_number = $result\->number;
170 Returns the number of the test, even if the original \s-1TAP\s0 output did not supply
173 \fI\f(CI\*(C`description\*(C'\fI\fR
174 .IX Subsection "description"
177 \& my $description = $result\->description;
180 Returns the description of the test, if any. This is the portion after the
181 test number but before the directive.
183 \fI\f(CI\*(C`directive\*(C'\fI\fR
184 .IX Subsection "directive"
187 \& my $directive = $result\->directive;
190 Returns either \f(CW\*(C`TODO\*(C'\fR or \f(CW\*(C`SKIP\*(C'\fR if either directive was present for a test
193 \fI\f(CI\*(C`explanation\*(C'\fI\fR
194 .IX Subsection "explanation"
197 \& my $explanation = $result\->explanation;
200 If a test had either a \f(CW\*(C`TODO\*(C'\fR or \f(CW\*(C`SKIP\*(C'\fR directive, this method will return
201 the accompanying explantion, if present.
204 \& not ok 17 \- 'Pigs can fly' # TODO not enough acid
207 For the above line, the explanation is \fInot enough acid\fR.
209 \fI\f(CI\*(C`is_ok\*(C'\fI\fR
210 .IX Subsection "is_ok"
213 \& if ( $result\->is_ok ) { ... }
216 Returns a boolean value indicating whether or not the test passed. Remember
217 that for \s-1TODO\s0 tests, the test always passes.
219 If the test is unplanned, this method will always return false. See
220 \&\f(CW\*(C`is_unplanned\*(C'\fR.
222 \fI\f(CI\*(C`is_actual_ok\*(C'\fI\fR
223 .IX Subsection "is_actual_ok"
226 \& if ( $result\->is_actual_ok ) { ... }
229 Returns a boolean value indicating whether or not the test passed, regardless
230 of its \s-1TODO\s0 status.
232 \fI\f(CI\*(C`actual_passed\*(C'\fI\fR
233 .IX Subsection "actual_passed"
235 Deprecated. Please use \f(CW\*(C`is_actual_ok\*(C'\fR instead.
237 \fI\f(CI\*(C`todo_passed\*(C'\fI\fR
238 .IX Subsection "todo_passed"
241 \& if ( $test\->todo_passed ) {
242 \& # test unexpectedly succeeded
246 If this is a \s-1TODO\s0 test and an 'ok' line, this method returns true.
247 Otherwise, it will always return false (regardless of passing status on
250 This is used to track which tests unexpectedly succeeded.
252 \fI\f(CI\*(C`todo_failed\*(C'\fI\fR
253 .IX Subsection "todo_failed"
256 \& # deprecated in favor of 'todo_passed'. This method was horribly misnamed.
259 This was a badly misnamed method. It indicates which \s-1TODO\s0 tests unexpectedly
260 succeeded. Will now issue a warning and call \f(CW\*(C`todo_passed\*(C'\fR.
262 \fI\f(CI\*(C`has_skip\*(C'\fI\fR
263 .IX Subsection "has_skip"
266 \& if ( $result\->has_skip ) { ... }
269 Returns a boolean value indicating whether or not this test has a \s-1SKIP\s0
272 \fI\f(CI\*(C`has_todo\*(C'\fI\fR
273 .IX Subsection "has_todo"
276 \& if ( $result\->has_todo ) { ... }
279 Returns a boolean value indicating whether or not this test has a \s-1TODO\s0
282 \fI\f(CI\*(C`as_string\*(C'\fI\fR
283 .IX Subsection "as_string"
286 \& print $result\->as_string;
289 This method prints the test as a string. It will probably be similar, but
290 not necessarily identical, to the original test line. Directives are
291 capitalized, some whitespace may be trimmed and a test number will be added if
292 it was not present in the original line. If you need the original text of the
293 test line, use the \f(CW\*(C`raw\*(C'\fR method.
295 \fI\f(CI\*(C`is_unplanned\*(C'\fI\fR
296 .IX Subsection "is_unplanned"
299 \& if ( $test\->is_unplanned ) { ... }
300 \& $test\->is_unplanned(1);
303 If a test number is greater than the number of planned tests, this method will
304 return true. Unplanned tests will \fIalways\fR return false for \f(CW\*(C`is_ok\*(C'\fR,
305 regardless of whether or not the test \f(CW\*(C`has_todo\*(C'\fR.
307 Note that if tests have a trailing plan, it is not possible to set this
308 property for unplanned tests as we do not know it's unplanned until the plan