On 2015-01-26 22:10:39, TURNERJW wrote:
Show quoted text> On Mon Jan 26 01:35:05 2015, SREZIC wrote:
> > On 2015-01-24 12:49:21, TURNERJW wrote:
> > > On Fri Jun 24 09:33:35 2011, cacack wrote:
> > > > I'm guessing I have Test::Pod::Coverage installed from another
> > > > module.
> > > > So with that installed and the t/pod-coverage.t included,
> > > > T::P::C
> > > > will
> > > > fail unless all modules have documentation.
> > > >
> > > > -Chris
> > > >
> > > > On Tue Jun 21 23:10:58 2011, TURNERJW wrote:
> > > > > what causes/does it take to fix this - I've never had this pbm.
> > > > >
> > > > > --- On Wed, 6/15/11, Chris via RT <bug-Net-xFTP@rt.cpan.org>
> > > > > wrote:
> > > > >
> > > > > > From: Chris via RT <bug-Net-xFTP@rt.cpan.org>
> > > > > > Subject: [rt.cpan.org #68833] Build fails due to Pod coverage
> > > > > > To:
> > > > > > Date: Wednesday, June 15, 2011, 1:11 PM
> > > > > > Wed Jun 15 14:11:24 2011: Request
> > > > > > 68833 was acted upon.
> > > > > > Transaction: Ticket created by cacack
> > > > > > Queue: Net-xFTP
> > > > > > Subject: Build fails due to Pod
> > > > > > coverage
> > > > > > Broken in: 0.45
> > > > > > Severity: Unimportant
> > > > > > Owner: Nobody
> > > > > > Requestors: chris@theclonchs.com
> > > > > > Status: new
> > > > > > Ticket <URL:
> > > > > >
https://rt.cpan.org/Ticket/Display.html?id=68833 >
> > > > > >
> > > > > >
> > > > > > Meant to post this with the prior version, but installation
> > > > > > will not
> > > > > > happen without force due to missing pod's.
> > > > > >
> > > > > > Running make test
> > > > > > PERL_DL_NONLAZY=1 /opt/perl-5.10.1/bin/perl
> > > > > > "-MExtUtils::Command::MM"
> > > > > > "-e" "test_harness(0, 'blib/lib', 'blib/arch')" t/*.t
> > > > > > t/00-load.t ....... 1/1 # Testing Net::xFTP 0.45, Perl
> > > > > > 5.010001,
> > > > > > /opt/perl-5.10.1/bin/perl
> > > > > > t/00-load.t ....... ok
> > > > > > t/pod-coverage.t .. 1/9
> > > > > > # Failed test 'Pod coverage on
> > > > > > Net::xFTP_FTP'
> > > > > > # at
> > > > > > /opt/perl-5.10.1/lib/site_perl/5.10.1/Test/Pod/Coverage.pm
> > > > > > line 126.
> > > > > > # Net::xFTP_FTP: couldn't find pod
> > > > > >
> > > > > > # Failed test 'Pod coverage on
> > > > > > Net::xFTP_LOCAL'
> > > > > > # at
> > > > > > /opt/perl-5.10.1/lib/site_perl/5.10.1/Test/Pod/Coverage.pm
> > > > > > line 126.
> > > > > > # Net::xFTP_LOCAL: couldn't find pod
> > > > > >
> > > > > > # Failed test 'Pod coverage on
> > > > > > Net::xFTP_FSP'
> > > > > > # at
> > > > > > /opt/perl-5.10.1/lib/site_perl/5.10.1/Test/Pod/Coverage.pm
> > > > > > line 126.
> > > > > > # Net::xFTP_FSP: couldn't find pod
> > > > > >
> > > > > > # Failed test 'Pod coverage on
> > > > > > Net::xFTP_SFTP'
> > > > > > # at
> > > > > > /opt/perl-5.10.1/lib/site_perl/5.10.1/Test/Pod/Coverage.pm
> > > > > > line 126.
> > > > > > # Net::xFTP_SFTP: couldn't find pod
> > > > > >
> > > > > > # Failed test 'Pod coverage on
> > > > > > Net::xFTP_FTPSSL'
> > > > > > # at
> > > > > > /opt/perl-5.10.1/lib/site_perl/5.10.1/Test/Pod/Coverage.pm
> > > > > > line 126.
> > > > > > # Net::xFTP_FTPSSL: couldn't find pod
> > > > > >
> > > > > > # Failed test 'Pod coverage on
> > > > > > Net::xFTP_OpenSSH'
> > > > > > # at
> > > > > > /opt/perl-5.10.1/lib/site_perl/5.10.1/Test/Pod/Coverage.pm
> > > > > > line 126.
> > > > > > # Net::xFTP_OpenSSH: couldn't find pod
> > > > > >
> > > > > > # Failed test 'Pod coverage on
> > > > > > Net::xFTP_Foreign'
> > > > > > # at
> > > > > > /opt/perl-5.10.1/lib/site_perl/5.10.1/Test/Pod/Coverage.pm
> > > > > > line 126.
> > > > > > # Net::xFTP_Foreign: couldn't find pod
> > > > > > t/pod-coverage.t .. 8/9
> > > > > > # Failed test 'Pod coverage on Net::xFTP'
> > > > > > # at
> > > > > > /opt/perl-5.10.1/lib/site_perl/5.10.1/Test/Pod/Coverage.pm
> > > > > > line 126.
> > > > > > # Coverage for Net::xFTP is 83.3%, with 1 naked
> > > > > > subroutine:
> > > > > > # haveModule
> > > > > >
> > > > > > # Failed test 'Pod coverage on
> > > > > > Net::xFTP_SSH2'
> > > > > > # at
> > > > > > /opt/perl-5.10.1/lib/site_perl/5.10.1/Test/Pod/Coverage.pm
> > > > > > line 126.
> > > > > > # Net::xFTP_SSH2: couldn't find pod
> > > > > > # Looks like you failed 9 tests of 9.
> > > > > > t/pod-coverage.t .. Dubious, test returned 9 (wstat 2304,
> > > > > > 0x900)
> > > > > > Failed 9/9 subtests
> > > > > > t/pod.t ........... ok
> > > > > >
> > > > > > Test Summary Report
> > > > > > -------------------
> > > > > > t/pod-coverage.t (Wstat: 2304 Tests: 9 Failed: 9)
> > > > > > Failed tests: 1-9
> > > > > > Non-zero exit status: 9
> > > > > > Files=3, Tests=19, 1 wallclock secs ( 0.03 usr
> > > > > > 0.03 sys + 0.68 cusr
> > > > > > 0.08 csys = 0.82 CPU)
> > > > > > Result: FAIL
> > > > > > Failed 1/3 test programs. 9/19 subtests failed.
> > > > > > make: *** [test_dynamic] Error 255
> > > > > >
> > > > > >
> > > >
> > > >
> > >
> > >
> > > I'm not going to sit and add POD to every submodule. I thought a/b
> > > copying the main module pod to each, but decided against, since I
> > > may
> > > wish to change it at some point. My suggestion - use "--force".
> >
> > This is the wrong answer. A user should never have to use "force".
> >
>
> @Slaven: Ouch, that hurt coming from a leader of perl development
> such as yourself, for whom I have the upmost respect! You've caught
> me in a moment of excess laziness, arrogance, and hubris! Therefore I
> will reopen this bug and attempt to properly and promptly resolve it.
> I've never installed Test::Pod::Coverage and am afraid to do so now
> due to what the OP described as happening to him, since I do not wish
> to be subjected to that degree of "nannyism" (IMO) myself as being
> barred from installing future CPAN modules that lack full POD! Not
> withstanding, I do fully recognize the need to PROPERLY DOCUMENT code
> I release to others to enable them to utilize it fully, as I attempted
> to do in the user-facing module of this code.
>
> Looking at the docs for Test::Pod::Coverage, it appears that this may
> be easily fixable by adding the following t/pod-coverage.t test file,
> and POD documentation for the missing function "haveModule()":
>
> use Test::More;
> eval "use Test::Pod::Coverage";
> plan skip_all => "Test::Pod::Coverage required for testing pod
> coverage" if $@;
>
> plan tests => 1;
> pod_coverage_ok( 'Net::xFTP_FTP');
> pod_coverage_ok( 'Net::xFTP_LOCAL');
> pod_coverage_ok( 'Net::xFTP_SFTP');
> pod_coverage_ok( 'Net::xFTP_FTPSSL');
> pod_coverage_ok( 'Net::xFTP_OpenSSH');
> pod_coverage_ok( 'Net::xFTP_Foreign');
> pod_coverage_ok( 'Net::xFTP_SSH2');
>
> Do you have any other suggestions or comments on resolving this issue?
> Otherwise, I will release v. 0.51 with the above fixes.
Actually, I never use Test::Pod::Coverage myself, and there's also no obligation to have such a test in a CPAN distribution. So deleting this test is a valid solution. Another solution would be to mark this test as author-only, e.g. by moving it to an xt/ subdirectory, or by adding this line to the test:
plan skip_all => 'Author test. Set $ENV{AUTHOR_TESTING} to a true value to run.' unless $ENV{AUTHOR_TESTING};
It's only important that a forced installation should not be the default way to install a CPAN distribution.
As for your fix: probably you have to adjust the plan, I think that every pod_coverage_ok() generates one test case. Or just write "plan 'no_plan'" if you don't want to do the counting.
Regards,
Slaven
