1CPANPLUS::Internals::ReUpsoerrt(C3o)ntributed Perl DocumCePnAtNaPtLiUoSn::Internals::Report(3)
2
3
4

NAME

6       CPANPLUS::Internals::Report - internals for sending test reports
7

SYNOPSIS

9         ### enable test reporting
10         $cb->configure_object->set_conf( cpantest => 1 );
11
12         ### set custom mx host, shouldn't normally be needed
13         $cb->configure_object->set_conf( cpantest_mx => 'smtp.example.com' );
14

DESCRIPTION

16       This module provides all the functionality to send test reports to
17       "http://testers.cpan.org" using the "Test::Reporter" module.
18
19       All methods will be called automatically if you have "CPANPLUS"
20       configured to enable test reporting (see the "SYNOPSIS").
21

METHODS

23   $bool = $cb->_have_query_report_modules
24       This function checks if all the required modules are here for querying
25       reports. It returns true and loads them if they are, or returns false
26       otherwise.
27
28   $bool = $cb->_have_send_report_modules
29       This function checks if all the required modules are here for sending
30       reports. It returns true and loads them if they are, or returns false
31       otherwise.
32
33   @list = $cb->_query_report( module => $modobj, [all_versions => BOOL,
34       verbose => BOOL] )
35       This function queries the CPAN testers database at
36       http://testers.cpan.org/ for test results of specified module objects,
37       module names or distributions.
38
39       The optional argument "all_versions" controls whether all versions of a
40       given distribution should be grabbed.  It defaults to false (fetching
41       only reports for the current version).
42
43       Returns the a list with the following data structures (for CPANPLUS
44       version 0.042) on success, or false on failure. The contents of the
45       data structure depends on what http://testers.cpan.org returns, but
46       generally looks like this:
47
48                 {
49                   'grade' => 'PASS',
50                   'dist' => 'CPANPLUS-0.042',
51                   'platform' => 'i686-pld-linux-thread-multi'
52                   'details' => 'http://nntp.x.perl.org/group/perl.cpan.testers/98316'
53                   ...
54                 },
55                 {
56                   'grade' => 'PASS',
57                   'dist' => 'CPANPLUS-0.042',
58                   'platform' => 'i686-linux-thread-multi'
59                   'details' => 'http://nntp.x.perl.org/group/perl.cpan.testers/99416'
60                   ...
61                 },
62                 {
63                   'grade' => 'FAIL',
64                   'dist' => 'CPANPLUS-0.042',
65                   'platform' => 'cygwin-multi-64int',
66                   'details' => 'http://nntp.x.perl.org/group/perl.cpan.testers/99371'
67                   ...
68                 },
69                 {
70                   'grade' => 'FAIL',
71                   'dist' => 'CPANPLUS-0.042',
72                   'platform' => 'i586-linux',
73                   'details' => 'http://nntp.x.perl.org/group/perl.cpan.testers/99396'
74                   ...
75                 },
76
77       The status of the test can be one of the following: UNKNOWN, PASS, FAIL
78       or NA (not applicable).
79
80   $bool = $cb->_send_report( module => $modobj, buffer => $make_output,
81       failed => BOOL, [save => BOOL, address => $email_to, verbose => BOOL,
82       force => BOOL]);
83       This function sends a testers report to "cpan-testers@perl.org" for a
84       particular distribution.  It returns true on success, and false on
85       failure.
86
87       It takes the following options:
88
89       module
90           The module object of this particular distribution
91
92       buffer
93           The output buffer from the 'make/make test' process
94
95       failed
96           Boolean indicating if the 'make/make test' went wrong
97
98       save
99           Boolean indicating if the report should be saved locally instead of
100           mailed out. If provided, this function will return the location the
101           report was saved to, rather than a simple boolean 'TRUE'.
102
103           Defaults to false.
104
105       address
106           The email address to mail the report for. You should never need to
107           override this, but it might be useful for debugging purposes.
108
109           Defaults to "cpan-testers@perl.org".
110
111       verbose
112           Boolean indicating on whether or not to be verbose.
113
114           Defaults to your configuration settings
115
116       force
117           Boolean indicating whether to force the sending, even if the max
118           amount of reports for fails have already been reached, or if you
119           may already have sent it before.
120
121           Defaults to your configuration settings
122
123
124
125perl v5.34.0                      2022-01-20    CPANPLUS::Internals::Report(3)
Impressum