Debian Codegraph @

upstream/debian-unstable/man3/App::Prove::State::Result::Test.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (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 .\"
57 .IX Title "App::Prove::State::Result::Test 3perl"
58 .TH App::Prove::State::Result::Test 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 App::Prove::State::Result::Test \- Individual test results.
65 .SH VERSION
66 .IX Header "VERSION"
67 Version 3.48
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 The \f(CW\*(C`prove\*(C'\fR command supports a \f(CW\*(C`\-\-state\*(C'\fR option that instructs it to
71 store persistent state across runs. This module encapsulates the results for a
72 single test.
73 .SH SYNOPSIS
74 .IX Header "SYNOPSIS"
75 .Vb 2
76 \& # Re\-run failed tests
77 \& $ prove \-\-state=failed,save \-rbv
78 .Ve
79 .SH METHODS
80 .IX Header "METHODS"
81 .SS "Class Methods"
82 .IX Subsection "Class Methods"
83 \fR\f(CI\*(C`new\*(C'\fR\fI\fR
84 .IX Subsection "new"
85 .SS "Instance Methods"
86 .IX Subsection "Instance Methods"
87 \fR\f(CI\*(C`name\*(C'\fR\fI\fR
88 .IX Subsection "name"
89 .PP
90 The name of the test. Usually a filename.
91 .PP
92 \fR\f(CI\*(C`elapsed\*(C'\fR\fI\fR
93 .IX Subsection "elapsed"
94 .PP
95 The total elapsed times the test took to run, in seconds from the epoch..
96 .PP
97 \fR\f(CI\*(C`generation\*(C'\fR\fI\fR
98 .IX Subsection "generation"
99 .PP
100 The number for the "generation" of the test run. The first generation is 1
101 (one) and subsequent generations are 2, 3, etc.
102 .PP
103 \fR\f(CI\*(C`last_pass_time\*(C'\fR\fI\fR
104 .IX Subsection "last_pass_time"
105 .PP
106 The last time the test program passed, in seconds from the epoch.
107 .PP
108 Returns \f(CW\*(C`undef\*(C'\fR if the program has never passed.
109 .PP
110 \fR\f(CI\*(C`last_fail_time\*(C'\fR\fI\fR
111 .IX Subsection "last_fail_time"
112 .PP
113 The last time the test suite failed, in seconds from the epoch.
114 .PP
115 Returns \f(CW\*(C`undef\*(C'\fR if the program has never failed.
116 .PP
117 \fR\f(CI\*(C`mtime\*(C'\fR\fI\fR
118 .IX Subsection "mtime"
119 .PP
120 Returns the mtime of the test, in seconds from the epoch.
121 .PP
122 \fR\f(CI\*(C`raw\*(C'\fR\fI\fR
123 .IX Subsection "raw"
124 .PP
125 Returns a hashref of raw test data, suitable for serialization by YAML.
126 .PP
127 \fR\f(CI\*(C`result\*(C'\fR\fI\fR
128 .IX Subsection "result"
129 .PP
130 Currently, whether or not the test suite passed with no 'problems' (such as
131 TODO passed).
132 .PP
133 \fR\f(CI\*(C`run_time\*(C'\fR\fI\fR
134 .IX Subsection "run_time"
135 .PP
136 The total time it took for the test to run, in seconds. If \f(CW\*(C`Time::HiRes\*(C'\fR is
137 available, it will have finer granularity.
138 .PP
139 \fR\f(CI\*(C`num_todo\*(C'\fR\fI\fR
140 .IX Subsection "num_todo"
141 .PP
142 The number of tests with TODO directives.
143 .PP
144 \fR\f(CI\*(C`sequence\*(C'\fR\fI\fR
145 .IX Subsection "sequence"
146 .PP
147 The order in which this test was run for the given test suite result.
148 .PP
149 \fR\f(CI\*(C`total_passes\*(C'\fR\fI\fR
150 .IX Subsection "total_passes"
151 .PP
152 The number of times the test has passed.
153 .PP
154 \fR\f(CI\*(C`total_failures\*(C'\fR\fI\fR
155 .IX Subsection "total_failures"
156 .PP
157 The number of times the test has failed.
158 .PP
159 \fR\f(CI\*(C`parser\*(C'\fR\fI\fR
160 .IX Subsection "parser"
161 .PP
162 The underlying parser object. This is useful if you need the full
163 information for the test program.