1CPANPLUS::Internals::ReUpsoerrt(C3o)ntributed Perl DocumCePnAtNaPtLiUoSn::Internals::Report(3)
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" config‐
20 ured 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
26 reports. It returns true and loads them if they are, or returns false
27 otherwise.
28 $bool = $cb->_have_send_report_modules
30 This function checks if all the required modules are here for sending
32 reports. It returns true and loads them if they are, or returns false
33 otherwise.
34 @list = $cb->_query_report( module => $modobj, [all_versions => BOOL,
36 verbose => BOOL] )
37 This function queries the CPAN testers database at
39 http://testers.cpan.org/ for test results of specified module objects,
40 module names or distributions.
41 The optional argument "all_versions" controls whether all versions of a
43 given distribution should be grabbed. It defaults to false (fetching
44 only reports for the current version).
45 Returns the a list with the following data structures (for CPANPLUS
47 version 0.042) on success, or false on failure:
48 {
50 'grade' => 'PASS',
51 'dist' => 'CPANPLUS-0.042',
52 'platform' => 'i686-pld-linux-thread-multi'
53 },
54 {
55 'grade' => 'PASS',
56 'dist' => 'CPANPLUS-0.042',
57 'platform' => 'i686-linux-thread-multi'
58 },
59 {
60 'grade' => 'FAIL',
61 'dist' => 'CPANPLUS-0.042',
62 'platform' => 'cygwin-multi-64int',
63 'details' => 'http://nntp.x.perl.org/group/perl.cpan.testers/99371'
64 },
65 {
66 'grade' => 'FAIL',
67 'dist' => 'CPANPLUS-0.042',
68 'platform' => 'i586-linux',
69 'details' => 'http://nntp.x.perl.org/group/perl.cpan.testers/99396'
70 },
71 The status of the test can be one of the following: UNKNOWN, PASS, FAIL
73 or NA (not applicable).
74 $bool = $cb->_send_report( module => $modobj, buffer => $make_output,
76 failed => BOOL, [save => BOOL, address => $email_to, dontcc => BOOL,
77 verbose => BOOL, force => BOOL]);
78 This function sends a testers report to "cpan-testers@perl.org" for a
80 particular distribution. It returns true on success, and false on
81 failure.
82 It takes the following options:
84 module
86 The module object of this particular distribution
87 buffer
89 The output buffer from the 'make/make test' process
90 failed
92 Boolean indicating if the 'make/make test' went wrong
93 save
95 Boolean indicating if the report should be saved locally instead of
96 mailed out. If provided, this function will return the location the
97 report was saved to, rather than a simple boolean 'TRUE'.
98 Defaults to false.
100 address
102 The email address to mail the report for. You should never need to
103 override this, but it might be useful for debugging purposes.
104 Defaults to "cpan-testers@perl.org".
106 dontcc
108 Boolean indicating whether or not we should Cc: the author. If
109 false, previous error reports are inspected and checked if the
110 author should be mailed. If set to true, these tests are skipped
111 and the author is definitely not Cc:'d. You should probably not
112 change this setting.
113 Defaults to false.
115 verbose
117 Boolean indicating on whether or not to be verbose.
118 Defaults to your configuration settings
120 force
122 Boolean indicating whether to force the sending, even if the max
123 amount of reports for fails have already been reached, or if you
124 may already have sent it before.
125 Defaults to your configuration settings
127perl v5.8.8 2007-03-31 CPANPLUS::Internals::Report(3)