local-lib5/man/man3/App::Prove::State::Result.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  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<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  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
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  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.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  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
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  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'
 101 .\}
 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 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "App::Prove::State::Result 3"
 132 .TH App::Prove::State::Result 3 "2009-05-05" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 App::Prove::State::Result \- Individual test suite results.
 135 .SH "VERSION"
 136 .IX Header "VERSION"
 137 Version 3.17
 138 .SH "DESCRIPTION"
 139 .IX Header "DESCRIPTION"
 140 The \f(CW\*(C`prove\*(C'\fR command supports a \f(CW\*(C`\-\-state\*(C'\fR option that instructs it to
 141 store persistent state across runs. This module encapsulates the results for a
 142 single test suite run.
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 2
 146 \&    # Re\-run failed tests
 147 \&    $ prove \-\-state=fail,save \-rbv
 148 .Ve
 149 .SH "METHODS"
 150 .IX Header "METHODS"
 151 .Sh "Class Methods"
 152 .IX Subsection "Class Methods"
 153 \fI\f(CI\*(C`new\*(C'\fI\fR
 154 .IX Subsection "new"
 155 .PP
 156 .Vb 4
 157 \&    my $result = App::Prove::State::Result\->new({
 158 \&        generation => $generation,
 159 \&        tests      => \e%tests,
 160 \&    });
 161 .Ve
 162 .PP
 163 Returns a new \f(CW\*(C`App::Prove::State::Result\*(C'\fR instance.
 164 .ie n .Sh """state_version"""
 165 .el .Sh "\f(CWstate_version\fP"
 166 .IX Subsection "state_version"
 167 Returns the current version of state storage.
 168 .ie n .Sh """test_class"""
 169 .el .Sh "\f(CWtest_class\fP"
 170 .IX Subsection "test_class"
 171 Returns the name of the class used for tracking individual tests.  This class
 172 should either subclass from \f(CW\*(C`App::Prove::State::Result::Test\*(C'\fR or provide an
 173 identical interface.
 174 .PP
 175 \fI\f(CI\*(C`generation\*(C'\fI\fR
 176 .IX Subsection "generation"
 177 .PP
 178 Getter/setter for the \*(L"generation\*(R" of the test suite run. The first
 179 generation is 1 (one) and subsequent generations are 2, 3, etc.
 180 .PP
 181 \fI\f(CI\*(C`last_run_time\*(C'\fI\fR
 182 .IX Subsection "last_run_time"
 183 .PP
 184 Getter/setter for the time of the test suite run.
 185 .PP
 186 \fI\f(CI\*(C`tests\*(C'\fI\fR
 187 .IX Subsection "tests"
 188 .PP
 189 Returns the tests for a given generation. This is a hashref or a hash,
 190 depending on context called. The keys to the hash are the individual
 191 test names and the value is a hashref with various interesting values.
 192 Each k/v pair might resemble something like this:
 193 .PP
 194 .Vb 11
 195 \& 't/foo.t' => {
 196 \&    elapsed        => '0.0428488254547119',
 197 \&    gen            => '7',
 198 \&    last_pass_time => '1219328376.07815',
 199 \&    last_result    => '0',
 200 \&    last_run_time  => '1219328376.07815',
 201 \&    last_todo      => '0',
 202 \&    mtime          => '1191708862',
 203 \&    seq            => '192',
 204 \&    total_passes   => '6',
 205 \&  }
 206 .Ve
 207 .PP
 208 \fI\f(CI\*(C`test\*(C'\fI\fR
 209 .IX Subsection "test"
 210 .PP
 211 .Vb 1
 212 \& my $test = $result\->test('t/customer/create.t');
 213 .Ve
 214 .PP
 215 Returns an individual \f(CW\*(C`App::Prove::State::Result::Test\*(C'\fR instance for the
 216 given test name (usually the filename).  Will return a new
 217 \&\f(CW\*(C`App::Prove::State::Result::Test\*(C'\fR instance if the name is not found.
 218 .PP
 219 \fI\f(CI\*(C`test_names\*(C'\fI\fR
 220 .IX Subsection "test_names"
 221 .PP
 222 Returns an list of test names, sorted by run order.
 223 .PP
 224 \fI\f(CI\*(C`remove\*(C'\fI\fR
 225 .IX Subsection "remove"
 226 .PP
 227 .Vb 2
 228 \& $result\->remove($test_name);            # remove the test
 229 \& my $test = $result\->test($test_name);   # fatal error
 230 .Ve
 231 .PP
 232 Removes a given test from results.  This is a no-op if the test name is not
 233 found.
 234 .PP
 235 \fI\f(CI\*(C`num_tests\*(C'\fI\fR
 236 .IX Subsection "num_tests"
 237 .PP
 238 Returns the number of tests for a given test suite result.
 239 .PP
 240 \fI\f(CI\*(C`raw\*(C'\fI\fR
 241 .IX Subsection "raw"
 242 .PP
 243 Returns a hashref of raw results, suitable for serialization by \s-1YAML\s0.