Test::Smoke::Reporter(3pm)

1Test::Smoke::Reporter(3U)ser Contributed Perl DocumentatiToenst::Smoke::Reporter(3)
2
3
4

NAME

6       Test::Smoke::Reporter - OO interface for handling the testresults
7       (mktest.out)
8

SYNOPSIS

10           use Test::Smoke;
11           use Test::Smoke::Reporter;
12
13           my $reporter = Test::Smoke::Reporter->new( %args );
14           $reporter->write_to_file;
15           $reporter->transport( $url );
16

DESCRIPTION

18       Handle the parsing of the mktest.out file.
19

METHODS

21   Test::Smoke::Reporter->new( %args )
22       [ Constructor | Public ]
23
24       Initialise a new object.
25
26   $reporter->verbose()
27       Accessor to the "v" attribute.
28
29   Test::Smoke::Reporter->config( $key[, $value] )
30       [ Accessor | Public ]
31
32       config() is an interface to the package lexical %CONFIG, which holds
33       all the default values for the new() arguments.
34
35       With the special key all_defaults this returns a reference to a hash
36       holding all the default values.
37
38   $self->read_parse( [$result_file] )
39       read_parse() reads the smokeresults file and parses it.
40
41   $self->_read( $nameorref )
42       _read() is a private method that handles the reading.
43
44       Reference to a SCALAR smokeresults are in $$nameorref
45       Reference to an ARRAY smokeresults are in @$nameorref
46       Reference to a GLOB smokeresults are read from the filehandle
47       Other values are taken as the filename for the smokeresults
48
49   $self->_parse( )
50       Interpret the contents of the outfile and prepare them for processing,
51       so report can be made.
52
53   $self->_post_process( )
54       _post_process() sets up the report for easy printing. It needs to sort
55       the buildenvironments, statusletters and test failures.
56
57   __posixdate($time)
58       Returns "strftime("%F %T %z")".
59
60   __rm_common_args( $cfg, \%common )
61       Removes the the arguments stored as keys in %common from $cfg.
62
63   $reporter->get_logfile()
64       Return the contents of "$self->{lfile}" either by reading the file or
65       returning the cached version.
66
67   $reporter->get_outfile()
68       Return the contents of "$self->{outfile}" either by reading the file or
69       returning the cached version.
70
71   $reporter->write_to_file( [$name] )
72       Write the "$self->report" to file. If name is omitted it will use
73       "catfile( $self->{ddir}, $self->{rptfile} )".
74
75   $reporter->smokedb_data()
76       Transport the report to the gateway. The transported data will also be
77       stored locally in the file mktest.jsn
78
79   $reporter->report( )
80       Return a string with the full report
81
82   $reporter->_get_usernote()
83       Return $self->{user_note} if exists.
84
85       Check if "$self->{un_file}" exists, and read contents into
86       "$self->{user_note}".
87
88   $reporter->ccinfo( )
89       Return the string containing the C-compiler info.
90
91   $reporter->registered_patches()
92       Return a section with the locally applied patches (from patchlevel.h).
93
94   $reporter->harness3_options
95       Show indication of the options used for "HARNESS_OPTIONS".
96
97   $reporter->user_skipped_tests( )
98       Show indication for the fact that the user requested to skip some
99       tests.
100
101   $reporter->ccmessages( )
102       Use a port of Jarkko's grepccerr script to report the compiler
103       messages.
104
105   $reporter->nonfatalmessages( )
106       Find failures worth reporting that won't cause tests to fail
107
108   $reporter->preamble( )
109       Returns the header of the report.
110
111   $reporter->smoke_matrix( )
112       smoke_matrix() returns a string with the result-letters and their
113       configs.
114
115   $reporter->summary( )
116       Return the PASS or FAIL(x) string.
117
118   $reporter->has_test_failures( )
119       Returns true if "@{ $reporter->{_failures}".
120
121   $reporter->failures( )
122       report the failures (grouped by configurations).
123
124   $reporter->has_todo_passed( )
125       Returns true if "@{ $reporter->{_todo_pasesd}".
126
127   $reporter->todo_passed( )
128       report the todo that passed (grouped by configurations).
129
130   $reporter->has_mani_failures( )
131       Returns true if "@{ $reporter->{_mani}".
132
133   $reporter->mani_fail( )
134       report the MANIFEST failures.
135
136   $reporter->bldenv_legend( )
137       Returns a string with the legend for build-environments
138
139   $reporter->letter_legend( )
140       Returns a string with the legend for the letters in the matrix.
141
142   $reporter->signature()
143       Returns the signature for the e-mail message (starting with dash dash
144       space newline) and some version numbers.
145

COPYRIGHT

150       (c) 2002-2012, All rights reserved.
151
152         * Abe Timmerman <abeltje@cpan.org>
153         * H.Merijn Brand <hmbrand@cpan.org>
154
155       This library is free software; you can redistribute it and/or modify it
156       under the same terms as Perl itself.
157
158       See:
159
160       •   http://www.perl.com/perl/misc/Artistic.html
161
162       •   http://www.gnu.org/copyleft/gpl.html
163
164       This program is distributed in the hope that it will be useful, but
165       WITHOUT ANY WARRANTY; without even the implied warranty of
166       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
167
168
169
170perl v5.38.0                      2023-07-21          Test::Smoke::Reporter(3)

NAME

SYNOPSIS

DESCRIPTION

METHODS

SEE ALSO

COPYRIGHT