.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "TAP::Parser::Result::Test 3perl"
.TH TAP::Parser::Result::Test 3perl 2024-05-30 "perl v5.38.2" "Perl Programmers Reference Guide"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
TAP::Parser::Result::Test \- Test result token.
.SH VERSION
.IX Header "VERSION"
Version 3.44
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is a subclass of TAP::Parser::Result.  A token of this class will be
returned if a test line is encountered.
.PP
.Vb 2
\& 1..1
\& ok 1 \- woo hooo!
.Ve
.SH "OVERRIDDEN METHODS"
.IX Header "OVERRIDDEN METHODS"
This class is the workhorse of the TAP::Parser system.  Most TAP lines will
be test lines and if \f(CW\*(C`$result\->is_test\*(C'\fR, then you have a bunch of methods
at your disposal.
.SS "Instance Methods"
.IX Subsection "Instance Methods"
\fR\f(CI\*(C`ok\*(C'\fR\fI\fR
.IX Subsection "ok"
.PP
.Vb 1
\&  my $ok = $result\->ok;
.Ve
.PP
Returns the literal text of the \f(CW\*(C`ok\*(C'\fR or \f(CW\*(C`not ok\*(C'\fR status.
.PP
\fR\f(CI\*(C`number\*(C'\fR\fI\fR
.IX Subsection "number"
.PP
.Vb 1
\&  my $test_number = $result\->number;
.Ve
.PP
Returns the number of the test, even if the original TAP output did not supply
that number.
.PP
\fR\f(CI\*(C`description\*(C'\fR\fI\fR
.IX Subsection "description"
.PP
.Vb 1
\&  my $description = $result\->description;
.Ve
.PP
Returns the description of the test, if any.  This is the portion after the
test number but before the directive.
.PP
\fR\f(CI\*(C`directive\*(C'\fR\fI\fR
.IX Subsection "directive"
.PP
.Vb 1
\&  my $directive = $result\->directive;
.Ve
.PP
Returns either \f(CW\*(C`TODO\*(C'\fR or \f(CW\*(C`SKIP\*(C'\fR if either directive was present for a test
line.
.PP
\fR\f(CI\*(C`explanation\*(C'\fR\fI\fR
.IX Subsection "explanation"
.PP
.Vb 1
\&  my $explanation = $result\->explanation;
.Ve
.PP
If a test had either a \f(CW\*(C`TODO\*(C'\fR or \f(CW\*(C`SKIP\*(C'\fR directive, this method will return
the accompanying explanation, if present.
.PP
.Vb 1
\&  not ok 17 \- \*(AqPigs can fly\*(Aq # TODO not enough acid
.Ve
.PP
For the above line, the explanation is \fInot enough acid\fR.
.PP
\fR\f(CI\*(C`is_ok\*(C'\fR\fI\fR
.IX Subsection "is_ok"
.PP
.Vb 1
\&  if ( $result\->is_ok ) { ... }
.Ve
.PP
Returns a boolean value indicating whether or not the test passed.  Remember
that for TODO tests, the test always passes.
.PP
If the test is unplanned, this method will always return false.  See
\&\f(CW\*(C`is_unplanned\*(C'\fR.
.PP
\fR\f(CI\*(C`is_actual_ok\*(C'\fR\fI\fR
.IX Subsection "is_actual_ok"
.PP
.Vb 1
\&  if ( $result\->is_actual_ok ) { ... }
.Ve
.PP
Returns a boolean value indicating whether or not the test passed, regardless
of its TODO status.
.PP
\fR\f(CI\*(C`actual_passed\*(C'\fR\fI\fR
.IX Subsection "actual_passed"
.PP
Deprecated.  Please use \f(CW\*(C`is_actual_ok\*(C'\fR instead.
.PP
\fR\f(CI\*(C`todo_passed\*(C'\fR\fI\fR
.IX Subsection "todo_passed"
.PP
.Vb 3
\&  if ( $test\->todo_passed ) {
\&     # test unexpectedly succeeded
\&  }
.Ve
.PP
If this is a TODO test and an 'ok' line, this method returns true.
Otherwise, it will always return false (regardless of passing status on
non-todo tests).
.PP
This is used to track which tests unexpectedly succeeded.
.PP
\fR\f(CI\*(C`todo_failed\*(C'\fR\fI\fR
.IX Subsection "todo_failed"
.PP
.Vb 1
\&  # deprecated in favor of \*(Aqtodo_passed\*(Aq.  This method was horribly misnamed.
.Ve
.PP
This was a badly misnamed method.  It indicates which TODO tests unexpectedly
succeeded.  Will now issue a warning and call \f(CW\*(C`todo_passed\*(C'\fR.
.PP
\fR\f(CI\*(C`has_skip\*(C'\fR\fI\fR
.IX Subsection "has_skip"
.PP
.Vb 1
\&  if ( $result\->has_skip ) { ... }
.Ve
.PP
Returns a boolean value indicating whether or not this test has a SKIP
directive.
.PP
\fR\f(CI\*(C`has_todo\*(C'\fR\fI\fR
.IX Subsection "has_todo"
.PP
.Vb 1
\&  if ( $result\->has_todo ) { ... }
.Ve
.PP
Returns a boolean value indicating whether or not this test has a TODO
directive.
.PP
\fR\f(CI\*(C`as_string\*(C'\fR\fI\fR
.IX Subsection "as_string"
.PP
.Vb 1
\&  print $result\->as_string;
.Ve
.PP
This method prints the test as a string.  It will probably be similar, but
not necessarily identical, to the original test line.  Directives are
capitalized, some whitespace may be trimmed and a test number will be added if
it was not present in the original line.  If you need the original text of the
test line, use the \f(CW\*(C`raw\*(C'\fR method.
.PP
\fR\f(CI\*(C`is_unplanned\*(C'\fR\fI\fR
.IX Subsection "is_unplanned"
.PP
.Vb 2
\&  if ( $test\->is_unplanned ) { ... }
\&  $test\->is_unplanned(1);
.Ve
.PP
If a test number is greater than the number of planned tests, this method will
return true.  Unplanned tests will \fIalways\fR return false for \f(CW\*(C`is_ok\*(C'\fR,
regardless of whether or not the test \f(CW\*(C`has_todo\*(C'\fR.
.PP
Note that if tests have a trailing plan, it is not possible to set this
property for unplanned tests as we do not know it's unplanned until the plan
is reached:
.PP
.Vb 5
\&  print <<\*(AqEND\*(Aq;
\&  ok 1
\&  ok 2
\&  1..1
\&  END
.Ve