


CPANPLUS::InternaPerlRProgrammers CPANPLUS::Internals::Report(3p)


NAME
       CPANPLUS::Internals::Report -  send test reports to
       http://testers.cpan.org

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

         ### set custom mx host, shouldn't 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
   $bool = $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.

   $bool = $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.

   @list = $cb->_query_report( module => $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:










perl v5.10.1                2009-10-12                          1





CPANPLUS::InternaPerlRProgrammers CPANPLUS::Internals::Report(3p)


                 {
                   '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).

   $bool = $cb->_send_report( module => $modobj, buffer =>
       $make_output, failed => BOOL, [save => BOOL, address =>
       $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



perl v5.10.1                2009-10-12                          2





CPANPLUS::InternaPerlRProgrammers CPANPLUS::Internals::Report(3p)


           to, rather than a simple boolean 'TRUE'.

           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


































perl v5.10.1                2009-10-12                          3


