Test::Kwalitee - Test the Kwalitee of a distribution before you release it
version 1.19
# in a separate test file BEGIN { unless ($ENV{RELEASE_TESTING}) { use Test::More; plan(skip_all => 'these tests are for release candidate testing'); } } use Test::Kwalitee;
Kwalitee is an automatically-measurable gauge of how good your software is. That's very different from quality, which a computer really can't measure in a general sense. (If you can, you've solved a hard problem in computer science.)
In the world of the CPAN, the CPANTS project (CPAN Testing Service; also a funny acronym on its own) measures Kwalitee with several metrics. If you plan to release a distribution to the CPAN -- or even within your own organization -- testing its Kwalitee before creating a release can help you improve your quality as well.
Test::Kwalitee and a short test file will do this for you automatically.
Test::Kwalitee
Create a test file as shown in the synopsis. Run it. It will run all of the potential Kwalitee tests on the current distribution, if possible. If any fail, it will report those as regular diagnostics.
If you ship this test, it will not run for anyone else, because of the RELEASE_TESTING guard. (You can omit this guard if you move the test to xt/release/, which is not run automatically by other users.)
RELEASE_TESTING
To run only a handful of tests, pass their names to the module in the test argument (either in the use directive, or when calling import directly):
test
use
import
use Test::Kwalitee tests => [ qw( use_strict has_tests ) ];
To disable a test, pass its name with a leading minus (-):
-
use Test::Kwalitee tests => [ qw( -use_strict has_readme ));
The list of each available metric currently available on your system can be obtained with the kwalitee-metrics command (with descriptions, if you pass --verbose or -v, but as of Test::Kwalitee 1.19 and Module::CPANTS::Analyse 0.93_01, the tests include:
kwalitee-metrics
--verbose
-v
has_abstract_in_pod
Does the main module have a =head1 NAME section with a short description of the distribution?
=head1 NAME
has_buildtool
Does the distribution have a build tool file?
has_changelog
Does the distribution have a changelog?
has_humanreadable_license
Is there a LICENSE section in documentation, and/or a LICENSE file present?
LICENSE
has_license_in_source_file
Is there license information in any of the source files?
has_manifest
Does the distribution have a MANIFEST?
has_meta_yml
Does the distribution have a META.yml file?
has_readme
Does the distribution have a README file?
has_tests
Does the distribution have tests?
metayml_conforms_to_known_spec
Does META.yml conform to any recognised META.yml specification? (For specs see http://module-build.sourceforge.net/META-spec-current.html)
metayml_is_parsable
Can the META.yml be parsed?
no_broken_auto_install
Is the distribution using an old version of Module::Install? Versions of Module::Install prior to 0.89 do not detect correctly that CPAN/CPANPLUS shell is used.
CPAN
CPANPLUS
no_broken_module_install
Does the distribution use an obsolete version of Module::Install? Versions of Module::Install prior to 0.61 might not work on some systems at all. Additionally if the Makefile.PL uses the auto_install() feature, you need at least version 0.64. Also, 1.04 is known to be broken.
auto_install()
no_symlinks
Does the distribution have no symlinks?
use_strict
Does the distribution files all use strict?
With thanks to CPANTS and Thomas Klausner, as well as test tester Chris Dolan.
kwalitee-metrics (in this distribution)
Module::CPANTS::Analyse
App::CPANTS::Lint
Test::Kwalitee::Extra
Dist::Zilla::Plugin::Test::Kwalitee
chromatic <chromatic@wgz.org>
Karen Etheridge <ether@cpan.org>
This software is copyright (c) 2005 by chromatic.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
David Steinbrunner <dsteinbrunner@pobox.com>
Gavin Sherlock <sherlock@cpan.org>
Kenichi Ishigaki <ishigaki@cpan.org>
Nathan Haigh <nathanhaigh@ukonline.co.uk>
Zoffix Znet <cpan@zoffix.com>
To install Test::Kwalitee, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Test::Kwalitee
CPAN shell
perl -MCPAN -e shell install Test::Kwalitee
For more information on module installation, please visit the detailed CPAN module installation guide.