1CPANPLUS::Internals::RepPoerrtl(3Pprmo)grammers ReferenCcPeANGPuLiUdSe::Internals::Report(3pm)
2
6 CPANPLUS::Internals::Report
7
9 ### enable test reporting
10 $cb->configure_object->set_conf( cpantest => 1 );
11 ### set custom mx host, shouldn't normally be needed
13 $cb->configure_object->set_conf( cpantest_mx => 'smtp.example.com' );
14
16 This module provides all the functionality to send test reports to
17 "http://testers.cpan.org" using the "Test::Reporter" module.
18 All methods will be called automatically if you have "CPANPLUS"
20 configured to enable test reporting (see the "SYNOPSIS").
21
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 $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 @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 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 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 {
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 The status of the test can be one of the following: UNKNOWN, PASS, FAIL
78 or NA (not applicable).
79 $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 It takes the following options:
88 module
90 The module object of this particular distribution
91 buffer
93 The output buffer from the 'make/make test' process
94 failed
96 Boolean indicating if the 'make/make test' went wrong
97 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 Defaults to false.
104 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 Defaults to "cpan-testers@perl.org".
110 verbose
112 Boolean indicating on whether or not to be verbose.
113 Defaults to your configuration settings
115 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 Defaults to your configuration settings
122perl v5.12.4 2011-06-07 CPANPLUS::Internals::Report(3pm)