.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 turned on, 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 "Test::Unit::Result 3pm"
.TH Test::Unit::Result 3pm "2015-12-30" "perl v5.22.1" "User Contributed Perl Documentation"
.\" 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"
Test::Unit::Result \- unit testing framework helper class
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
This class is not intended to be used directly
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class is used by the framework to record the results of tests,
which will throw an instance of a subclass of Test::Unit::Exception in
case of errors or failures.
.PP
To achieve this, this class gets called with a test case as argument.
It will call this test case's run method back and catch any exceptions
thrown.
.PP
It could be argued that Test::Unit::Result is the heart of the
PerlUnit framework, since TestCase classes vary, and you can use one
of several Test::Unit::TestRunners, but we always gather the results
in a Test::Unit::Result object.
.PP
This is the quintessential call tree of the communication needed to
record the results of a given test:
.PP
.Vb 10
\&    $aTestCase\->run() {
\&        # creates result
\&        $aTestResult\->run($aTestCase) { 
\&            # catches exception and records it
\&            $aTestCase\->run_bare() {
\&                # runs test method inside eval
\&                $aTestCase\->run_test() {
\&                    # calls method $aTestCase\->name() 
\&                    # and propagates exception
\&                    # method will call Assert::assert() 
\&                    # to cause failure if test fails on 
\&                    # test assertion
\&                    # it finds this because $aTestCase is\-a Assert
\&                }
\&            }
\&        }
\&    }
.Ve
.PP
Note too that, in the presence of Test::Unit::TestSuites, this call
tree can get a little more convoluted, but if you bear the above in
mind it should be apparent what's going on.
.SH "AUTHOR"
.IX Header "AUTHOR"
Copyright (c) 2000\-2002, 2005 the PerlUnit Development Team
(see Test::Unit or the \fI\s-1AUTHORS\s0\fR file included in this
distribution).
.PP
All rights reserved. This program is free software; you can
redistribute it and/or modify it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
Test::Unit::Assert
.IP "\(bu" 4
Test::Unit::TestCase
.IP "\(bu" 4
Test::Unit::Exception