CPANPL...:Report(3pm)

💖 CPANPLUS::Internals::Report — the tea ☕

okay bestie, so this is CPANPLUS::Internals::Report, from the CPANPL...:Report(3pm) corner of your friendly neighbourhood Perl docs (User Contributed Perl Documentation, if we're being formal, which we are not 💅).

✨ NAME ✨

CPANPLUS::Internals::Report — internals for sending test reports 🧚

---

🌸 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 is literally the whole entire girlboss toolkit for sending test reports over to http://testers.cpan.org, and it does it by using the Test::Reporter module. 🫶

And here's the cute part: every single method in here gets called automatically if you've got CPANPLUS configured to enable test reporting (peep the SYNOPSIS above, it's giving instructions ✨).

---

👑 METHODS 👑

$bool = $cb->_have_query_report_modules

Checks if all the required modules are actually here for querying reports. If they are, it returns true and loads them up for you. If not? Returns false, no drama. 💀

$bool = $cb->_have_send_report_modules

Same vibe, different job — checks if all the required modules are here for sending reports. True means it loads them, false means nope. 🌈

$cb->_query_report

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

This one queries the CPAN testers database at http://testers.cpan.org/ for test results of whatever module objects, module names or distributions you hand it. 🔍

The optional argument all_versions controls whether all versions of a given distribution get grabbed. It defaults to false — meaning it only fetches reports for the current version, bestie. ⭐

On success it returns a list with the following data structures (for CPANPLUS version 0.042), or false on failure. What's actually inside depends on what http://testers.cpan.org hands back, but generally it 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). 🎀

$cb->_send_report

$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. Returns true on success, false on failure. Periodt. 💅

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 you pass it, this function returns the location the report was saved 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.

---

💖 that's the whole page, bestie. go forth and report those tests.

kisses, this was CPANPL...:Report(3pm) as documented for perl v5.40.1, dated 2025-03-01. iykyk ✨🦋👑