Debian Codegraph @

upstream/mageia-cauldron/man3pm/App::Prove::State::Result::Test.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "App::Prove::State::Result::Test 3pm"
61 .TH App::Prove::State::Result::Test 3pm 2025-06-24 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 App::Prove::State::Result::Test \- Individual test results.
68 .SH VERSION
69 .IX Header "VERSION"
70 Version 3.50
71 .SH DESCRIPTION
72 .IX Header "DESCRIPTION"
73 The \f(CW\*(C`prove\*(C'\fR command supports a \f(CW\*(C`\-\-state\*(C'\fR option that instructs it to
74 store persistent state across runs. This module encapsulates the results for a
75 single test.
76 .SH SYNOPSIS
77 .IX Header "SYNOPSIS"
78 .Vb 2
79 \& # Re\-run failed tests
80 \& $ prove \-\-state=failed,save \-rbv
81 .Ve
82 .SH METHODS
83 .IX Header "METHODS"
84 .SS "Class Methods"
85 .IX Subsection "Class Methods"
86 \fR\f(CI\*(C`new\*(C'\fR\fI\fR
87 .IX Subsection "new"
88 .SS "Instance Methods"
89 .IX Subsection "Instance Methods"
90 \fR\f(CI\*(C`name\*(C'\fR\fI\fR
91 .IX Subsection "name"
92 .PP
93 The name of the test. Usually a filename.
94 .PP
95 \fR\f(CI\*(C`elapsed\*(C'\fR\fI\fR
96 .IX Subsection "elapsed"
97 .PP
98 The total elapsed times the test took to run, in seconds from the epoch..
99 .PP
100 \fR\f(CI\*(C`generation\*(C'\fR\fI\fR
101 .IX Subsection "generation"
102 .PP
103 The number for the "generation" of the test run. The first generation is 1
104 (one) and subsequent generations are 2, 3, etc.
105 .PP
106 \fR\f(CI\*(C`last_pass_time\*(C'\fR\fI\fR
107 .IX Subsection "last_pass_time"
108 .PP
109 The last time the test program passed, in seconds from the epoch.
110 .PP
111 Returns \f(CW\*(C`undef\*(C'\fR if the program has never passed.
112 .PP
113 \fR\f(CI\*(C`last_fail_time\*(C'\fR\fI\fR
114 .IX Subsection "last_fail_time"
115 .PP
116 The last time the test suite failed, in seconds from the epoch.
117 .PP
118 Returns \f(CW\*(C`undef\*(C'\fR if the program has never failed.
119 .PP
120 \fR\f(CI\*(C`mtime\*(C'\fR\fI\fR
121 .IX Subsection "mtime"
122 .PP
123 Returns the mtime of the test, in seconds from the epoch.
124 .PP
125 \fR\f(CI\*(C`raw\*(C'\fR\fI\fR
126 .IX Subsection "raw"
127 .PP
128 Returns a hashref of raw test data, suitable for serialization by YAML.
129 .PP
130 \fR\f(CI\*(C`result\*(C'\fR\fI\fR
131 .IX Subsection "result"
132 .PP
133 Currently, whether or not the test suite passed with no \*(Aqproblems\*(Aq (such as
134 TODO passed).
135 .PP
136 \fR\f(CI\*(C`run_time\*(C'\fR\fI\fR
137 .IX Subsection "run_time"
138 .PP
139 The total time it took for the test to run, in seconds. If \f(CW\*(C`Time::HiRes\*(C'\fR is
140 available, it will have finer granularity.
141 .PP
142 \fR\f(CI\*(C`num_todo\*(C'\fR\fI\fR
143 .IX Subsection "num_todo"
144 .PP
145 The number of tests with TODO directives.
146 .PP
147 \fR\f(CI\*(C`sequence\*(C'\fR\fI\fR
148 .IX Subsection "sequence"
149 .PP
150 The order in which this test was run for the given test suite result.
151 .PP
152 \fR\f(CI\*(C`total_passes\*(C'\fR\fI\fR
153 .IX Subsection "total_passes"
154 .PP
155 The number of times the test has passed.
156 .PP
157 \fR\f(CI\*(C`total_failures\*(C'\fR\fI\fR
158 .IX Subsection "total_failures"
159 .PP
160 The number of times the test has failed.
161 .PP
162 \fR\f(CI\*(C`parser\*(C'\fR\fI\fR
163 .IX Subsection "parser"
164 .PP
165 The underlying parser object. This is useful if you need the full
166 information for the test program.