1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
.\" -*- 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 "App::Prove::State::Result::Test 3perl"
.TH App::Prove::State::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
App::Prove::State::Result::Test \- Individual test results.
.SH VERSION
.IX Header "VERSION"
Version 3.44
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \f(CW\*(C`prove\*(C'\fR command supports a \f(CW\*(C`\-\-state\*(C'\fR option that instructs it to
store persistent state across runs. This module encapsulates the results for a
single test.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\& # Re\-run failed tests
\& $ prove \-\-state=failed,save \-rbv
.Ve
.SH METHODS
.IX Header "METHODS"
.SS "Class Methods"
.IX Subsection "Class Methods"
\fR\f(CI\*(C`new\*(C'\fR\fI\fR
.IX Subsection "new"
.SS "Instance Methods"
.IX Subsection "Instance Methods"
\fR\f(CI\*(C`name\*(C'\fR\fI\fR
.IX Subsection "name"
.PP
The name of the test. Usually a filename.
.PP
\fR\f(CI\*(C`elapsed\*(C'\fR\fI\fR
.IX Subsection "elapsed"
.PP
The total elapsed times the test took to run, in seconds from the epoch..
.PP
\fR\f(CI\*(C`generation\*(C'\fR\fI\fR
.IX Subsection "generation"
.PP
The number for the "generation" of the test run. The first generation is 1
(one) and subsequent generations are 2, 3, etc.
.PP
\fR\f(CI\*(C`last_pass_time\*(C'\fR\fI\fR
.IX Subsection "last_pass_time"
.PP
The last time the test program passed, in seconds from the epoch.
.PP
Returns \f(CW\*(C`undef\*(C'\fR if the program has never passed.
.PP
\fR\f(CI\*(C`last_fail_time\*(C'\fR\fI\fR
.IX Subsection "last_fail_time"
.PP
The last time the test suite failed, in seconds from the epoch.
.PP
Returns \f(CW\*(C`undef\*(C'\fR if the program has never failed.
.PP
\fR\f(CI\*(C`mtime\*(C'\fR\fI\fR
.IX Subsection "mtime"
.PP
Returns the mtime of the test, in seconds from the epoch.
.PP
\fR\f(CI\*(C`raw\*(C'\fR\fI\fR
.IX Subsection "raw"
.PP
Returns a hashref of raw test data, suitable for serialization by YAML.
.PP
\fR\f(CI\*(C`result\*(C'\fR\fI\fR
.IX Subsection "result"
.PP
Currently, whether or not the test suite passed with no 'problems' (such as
TODO passed).
.PP
\fR\f(CI\*(C`run_time\*(C'\fR\fI\fR
.IX Subsection "run_time"
.PP
The total time it took for the test to run, in seconds. If \f(CW\*(C`Time::HiRes\*(C'\fR is
available, it will have finer granularity.
.PP
\fR\f(CI\*(C`num_todo\*(C'\fR\fI\fR
.IX Subsection "num_todo"
.PP
The number of tests with TODO directives.
.PP
\fR\f(CI\*(C`sequence\*(C'\fR\fI\fR
.IX Subsection "sequence"
.PP
The order in which this test was run for the given test suite result.
.PP
\fR\f(CI\*(C`total_passes\*(C'\fR\fI\fR
.IX Subsection "total_passes"
.PP
The number of times the test has passed.
.PP
\fR\f(CI\*(C`total_failures\*(C'\fR\fI\fR
.IX Subsection "total_failures"
.PP
The number of times the test has failed.
.PP
\fR\f(CI\*(C`parser\*(C'\fR\fI\fR
.IX Subsection "parser"
.PP
The underlying parser object. This is useful if you need the full
information for the test program.
|
