local-lib5/man/man3/App::Prove::State.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 3"
 132 .TH App::Prove::State 3 "2009-05-05" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 App::Prove::State \- State storage for the \f(CW\*(C`prove\*(C'\fR command.
 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 implements that state
 142 and the operations that may be performed on it.
 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 Accepts a hashref with the following key/value pairs:
 157 .ie n .IP "* ""store""" 4
 158 .el .IP "* \f(CWstore\fR" 4
 159 .IX Item "store"
 160 The filename of the data store holding the data that App::Prove::State reads.
 161 .ie n .IP "* ""extension"" (optional)" 4
 162 .el .IP "* \f(CWextension\fR (optional)" 4
 163 .IX Item "extension (optional)"
 164 The test name extension.  Defaults to \f(CW\*(C`.t\*(C'\fR.
 165 .ie n .IP "* ""result_class"" (optional)" 4
 166 .el .IP "* \f(CWresult_class\fR (optional)" 4
 167 .IX Item "result_class (optional)"
 168 The name of the \f(CW\*(C`result_class\*(C'\fR.  Defaults to \f(CW\*(C`App::Prove::State::Result\*(C'\fR.
 169 .ie n .Sh """result_class"""
 170 .el .Sh "\f(CWresult_class\fP"
 171 .IX Subsection "result_class"
 172 Getter/setter for the name of the class used for tracking test results.  This
 173 class should either subclass from \f(CW\*(C`App::Prove::State::Result\*(C'\fR or provide an
 174 identical interface.
 175 .ie n .Sh """extension"""
 176 .el .Sh "\f(CWextension\fP"
 177 .IX Subsection "extension"
 178 Get or set the extension files must have in order to be considered
 179 tests. Defaults to '.t'.
 180 .ie n .Sh """results"""
 181 .el .Sh "\f(CWresults\fP"
 182 .IX Subsection "results"
 183 Get the results of the last test run.  Returns a \f(CW\*(C`result_class()\*(C'\fR instance.
 184 .ie n .Sh """commit"""
 185 .el .Sh "\f(CWcommit\fP"
 186 .IX Subsection "commit"
 187 Save the test results. Should be called after all tests have run.
 188 .Sh "Instance Methods"
 189 .IX Subsection "Instance Methods"
 190 \fI\f(CI\*(C`apply_switch\*(C'\fI\fR
 191 .IX Subsection "apply_switch"
 192 .PP
 193 .Vb 1
 194 \& $self\->apply_switch('failed,save');
 195 .Ve
 196 .PP
 197 Apply a list of switch options to the state, updating the internal
 198 object state as a result. Nothing is returned.
 199 .PP
 200 Diagnostics:
 201     \- \*(L"Illegal state option: \f(CW%s\fR\*(R"
 202 .ie n .IP """last""" 4
 203 .el .IP "\f(CWlast\fR" 4
 204 .IX Item "last"
 205 Run in the same order as last time
 206 .ie n .IP """failed""" 4
 207 .el .IP "\f(CWfailed\fR" 4
 208 .IX Item "failed"
 209 Run only the failed tests from last time
 210 .ie n .IP """passed""" 4
 211 .el .IP "\f(CWpassed\fR" 4
 212 .IX Item "passed"
 213 Run only the passed tests from last time
 214 .ie n .IP """all""" 4
 215 .el .IP "\f(CWall\fR" 4
 216 .IX Item "all"
 217 Run all tests in normal order
 218 .ie n .IP """hot""" 4
 219 .el .IP "\f(CWhot\fR" 4
 220 .IX Item "hot"
 221 Run the tests that most recently failed first
 222 .ie n .IP """todo""" 4
 223 .el .IP "\f(CWtodo\fR" 4
 224 .IX Item "todo"
 225 Run the tests ordered by number of todos.
 226 .ie n .IP """slow""" 4
 227 .el .IP "\f(CWslow\fR" 4
 228 .IX Item "slow"
 229 Run the tests in slowest to fastest order.
 230 .ie n .IP """fast""" 4
 231 .el .IP "\f(CWfast\fR" 4
 232 .IX Item "fast"
 233 Run test tests in fastest to slowest order.
 234 .ie n .IP """new""" 4
 235 .el .IP "\f(CWnew\fR" 4
 236 .IX Item "new"
 237 Run the tests in newest to oldest order.
 238 .ie n .IP """old""" 4
 239 .el .IP "\f(CWold\fR" 4
 240 .IX Item "old"
 241 Run the tests in oldest to newest order.
 242 .ie n .IP """save""" 4
 243 .el .IP "\f(CWsave\fR" 4
 244 .IX Item "save"
 245 Save the state on exit.
 246 .PP
 247 \fI\f(CI\*(C`get_tests\*(C'\fI\fR
 248 .IX Subsection "get_tests"
 249 .PP
 250 Given a list of args get the names of tests that should run
 251 .PP
 252 \fI\f(CI\*(C`observe_test\*(C'\fI\fR
 253 .IX Subsection "observe_test"
 254 .PP
 255 Store the results of a test.
 256 .PP
 257 \fI\f(CI\*(C`save\*(C'\fI\fR
 258 .IX Subsection "save"
 259 .PP
 260 Write the state to a file.
 261 .PP
 262 \fI\f(CI\*(C`load\*(C'\fI\fR
 263 .IX Subsection "load"
 264 .PP
 265 Load the state from a file