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
55       sort 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->write_to_file( [$name] )
68       Write the "$self->report" to file. If name is omitted it will use
69       "catfile( $self->{ddir}, $self->{rptfile} )".
70
71   $reporter->smokedb_data()
72       Transport the report to the gateway. The transported data will also be
73       stored locally in the file mktest.jsn
74
75   $reporter->report( )
76       Return a string with the full report
77
78   $reporter->_get_usernote()
79       Return $self->{user_note} if exists.
80
81       Check if "$self->{un_file}" exists, and read contents into
82       "$self->{user_note}".
83
84   $reporter->ccinfo( )
85       Return the string containing the C-compiler info.
86
87   $reporter->registered_patches()
88       Return a section with the locally applied patches (from patchlevel.h).
89
90   $reporter->harness3_options
91       Show indication of the options used for "HARNESS_OPTIONS".
92
93   $reporter->user_skipped_tests( )
94       Show indication for the fact that the user requested to skip some
95       tests.
96
97   $reporter->ccmessages( )
98       Use a port of Jarkko's grepccerr script to report the compiler
99       messages.
100
101   $reporter->nonfatalmessages( )
102       Find failures worth reporting that won't cause tests to fail
103
104   $reporter->preamble( )
105       Returns the header of the report.
106
107   $reporter->smoke_matrix( )
108       "smoke_matrix()" returns a string with the result-letters and their
109       configs.
110
111   $reporter->summary( )
112       Return the PASS or FAIL(x) string.
113
114   $reporter->has_test_failures( )
115       Returns true if "@{ $reporter->{_failures}".
116
117   $reporter->failures( )
118       report the failures (grouped by configurations).
119
120   $reporter->has_todo_passed( )
121       Returns true if "@{ $reporter->{_todo_pasesd}".
122
123   $reporter->todo_passed( )
124       report the todo that passed (grouped by configurations).
125
126   $reporter->has_mani_failures( )
127       Returns true if "@{ $reporter->{_mani}".
128
129   $reporter->mani_fail( )
130       report the MANIFEST failures.
131
132   $reporter->bldenv_legend( )
133       Returns a string with the legend for build-environments
134
135   $reporter->letter_legend( )
136       Returns a string with the legend for the letters in the matrix.
137
138   $reporter->signature()
139       Returns the signature for the e-mail message (starting with dash dash
140       space newline) and some version numbers.
141

COPYRIGHT

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

NAME

SYNOPSIS

DESCRIPTION

METHODS

SEE ALSO

COPYRIGHT