GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  CPANPLUS::INTERNALS::REPORT (3)

.ds Aq ’

NAME

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

CONTENTS

SYNOPSIS



  ### enable test reporting
  $cb->configure_object->set_conf( cpantest => 1 );

  ### set custom mx host, shouldnt normally be needed
  $cb->configure_object->set_conf( cpantest_mx => smtp.example.com );



DESCRIPTION

This module provides all the functionality to send test reports to http://testers.cpan.org using the Test::Reporter module.

All methods will be called automatically if you have CPANPLUS configured to enable test reporting (see the SYNOPSIS).

METHODS

CW$bool = CW$cb->_have_query_report_modules

This function checks if all the required modules are here for querying reports. It returns true and loads them if they are, or returns false otherwise.

CW$bool = CW$cb->_have_send_report_modules

This function checks if all the required modules are here for sending reports. It returns true and loads them if they are, or returns false otherwise.

CW@list = CW$cb->_query_report( module => CW$modobj, [all_versions => BOOL, verbose => BOOL] )

This function queries the CPAN testers database at http://testers.cpan.org/ for test results of specified module objects, module names or distributions.

The optional argument all_versions controls whether all versions of a given distribution should be grabbed. It defaults to false (fetching only reports for the current version).

Returns the a list with the following data structures (for CPANPLUS version 0.042) on success, or false on failure. The contents of the data structure depends on what http://testers.cpan.org returns, but generally looks like this:



          {
            grade => PASS,
            dist => CPANPLUS-0.042,
            platform => i686-pld-linux-thread-multi
            details => http://nntp.x.perl.org/group/perl.cpan.testers/98316
            ...
          },
          {
            grade => PASS,
            dist => CPANPLUS-0.042,
            platform => i686-linux-thread-multi
            details => http://nntp.x.perl.org/group/perl.cpan.testers/99416
            ...
          },
          {
            grade => FAIL,
            dist => CPANPLUS-0.042,
            platform => cygwin-multi-64int,
            details => http://nntp.x.perl.org/group/perl.cpan.testers/99371
            ...
          },
          {
            grade => FAIL,
            dist => CPANPLUS-0.042,
            platform => i586-linux,
            details => http://nntp.x.perl.org/group/perl.cpan.testers/99396
            ...
          },



The status of the test can be one of the following: UNKNOWN, PASS, FAIL or NA (not applicable).

CW$bool = CW$cb->_send_report( module => CW$modobj, buffer => CW$make_output, failed => BOOL, [save => BOOL, address => CW$email_to, verbose => BOOL, force => BOOL]);

This function sends a testers report to cpan-testers@perl.org for a particular distribution. It returns true on success, and false on failure.

It takes the following options:
module The module object of this particular distribution
buffer The output buffer from the ’make/make test’ process
failed Boolean indicating if the ’make/make test’ went wrong
save Boolean indicating if the report should be saved locally instead of mailed out. If provided, this function will return the location the report was saved to, rather than a simple booleanTRUE’.

Defaults to false.

address The email address to mail the report for. You should never need to override this, but it might be useful for debugging purposes.

Defaults to cpan-testers@perl.org.

verbose Boolean indicating on whether or not to be verbose.

Defaults to your configuration settings

force Boolean indicating whether to force the sending, even if the max amount of reports for fails have already been reached, or if you may already have sent it before.

Defaults to your configuration settings

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 CPANPLUS::INTERNALS::REPORT (3) 2015-10-15

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.