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

DESCRIPTION

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

METHODS

20       Test::Smoke::Reporter->new( %args )
21           [ Constructor | Public ]
22
23           Initialise a new object.
24
25       Test::Smoke::Reporter->config( $key[, $value] )
26           [ Accessor | Public ]
27
28           "config()" is an interface to the package lexical %CONFIG, which
29           holds all the default values for the "new()" arguments.
30
31           With the special key all_defaults this returns a reference to a
32           hash holding all the default values.
33
34       $self->read_parse( [$result_file] )
35           "read_parse()" reads the smokeresults file and parses it.
36
37       $self->_read( $nameorref )
38           "_read()" is a private method that handles the reading.
39
40           Reference to a SCALAR smokeresults are in $$nameorref
41           Reference to an ARRAY smokeresults are in @$nameorref
42           Reference to a GLOB smokeresults are read from the filehandle
43           Other values are taken as the filename for the smokeresults
44       $self->_parse( )
45           Interpret the contents of the logfile and prepare them for
46           processing, so report can be made.
47
48       $self->_post_process( )
49           "_post_process()" sets up the report for easy printing. It needs to
50           sort the buildenvironments, statusletters and test failures.
51
52       __rm_common_args( $cfg, \%common )
53           Removes the the arguments stored as keys in %common from $cfg.
54
55       $reporter->write_to_file( [$name] )
56           Write the "$self->report" to file. If name is ommitted it will use
57           "catfile( $self->{ddir}, $self->{rptfile} )".
58
59       $reporter->report( )
60           Return a string with the full report
61
62       $reporter->ccinfo( )
63           Return the string containing the C-compiler info.
64
65       $reporter->registered_patches()
66           Return a section with the locally applied patches (from
67           patchlevel.h).
68
69       $reporter->harness3_options
70           Show indication of the options used for "HARNESS_OPTIONS".
71
72       $reporter->user_skipped_tests( )
73           Show indication for the fact that the user requested to skip some
74           tests.
75
76       $reporter->ccmessages( )
77           Use a port of Jarkko's grepccerr script to report the compiler
78           messages.
79
80       $reporter->preamble( )
81           Returns the header of the report.
82
83       $reporter->smoke_matrix( )
84           "smoke_matrix()" returns a string with the result-letters and their
85           configs.
86
87       $reporter->summary( )
88           Return the PASS or FAIL(x) string.
89
90       $repoarter->has_test_failures( )
91           Returns true if "@{ $reporter->{_failures}".
92
93       $reporter->failures( )
94           report the failures (grouped by configurations).
95
96       $repoarter->has_todo_passed( )
97           Returns true if "@{ $reporter->{_todo_pasesd}".
98
99       $reporter->todo_passed( )
100           report the todo that passed (grouped by configurations).
101
102       $repoarter->has_mani_failures( )
103           Returns true if "@{ $reporter->{_mani}".
104
105       $reporter->mani_fail( )
106           report the MANIFEST failures.
107
108       $reporter->bldenv_legend( )
109           Returns a string with the legend for build-environments
110
111       $reporter->letter_legend( )
112           Returns a string with the legend for the letters in the matrix.
113

SEE ALSO

115       Test::Smoke::Smoker
116

118       (c) 2002-2003, All rights reserved.
119
120         * Abe Timmerman <abeltje@cpan.org>
121
122       This library is free software; you can redistribute it and/or modify it
123       under the same terms as Perl itself.
124
125       See:
126
127       ·   http://www.perl.com/perl/misc/Artistic.html
128
129       ·   http://www.gnu.org/copyleft/gpl.html
130
131       This program is distributed in the hope that it will be useful, but
132       WITHOUT ANY WARRANTY; without even the implied warranty of
133       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
134
135
136
137perl v5.12.1                      2010-01-20          Test::Smoke::Reporter(3)
Impressum