Scroll to navigation

Test::Kwalitee(3pm) User Contributed Perl Documentation Test::Kwalitee(3pm)

NAME

  Test::Kwalitee - test the Kwalitee of a distribution before you release it

SYNOPSIS

  # in a separate test file
  use Test::More;
  eval { require Test::Kwalitee; Test::Kwalitee->import() };
  plan( skip_all => 'Test::Kwalitee not installed; skipping' ) if $@;

DESCRIPTION

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.

USAGE

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 and a user does not have "Test::Kwalitee" installed, nothing bad will happen.
To run only a handful of tests, pass their names to the module's "import()" method: 
  eval
  {
      require Test::Kwalitee;
      Test::Kwalitee->import( tests => [ qw( use_strict has_tests ) ] );
  };
To disable a test, pass its name with a leading minus ("-") to "import()": 
  eval
  {
      require Test::Kwalitee;
      Test::Kwalitee->import( tests =>
          [ qw( -has_test_pod -has_test_pod_coverage ) ]
      );
  };
As of version 1.00, the tests include:
•
extractable
 
Is the distribution extractable?
•
has_readme
 
Does the distribution have a README file?
•
have_manifest
 
Does the distribution have a MANIFEST?
•
have_meta_yml
 
Does the distribution have a META.yml file?
•
have_buildtool
 
Does the distribution have a build tool file?
•
have_changelog
 
Does the distribution have a changelog?
•
no_symlinks
 
Does the distribution have no symlinks?
•
have_tests
 
Does the distribution have tests?
•
proper_libs
 
Does the distribution have proper libs?
•
no_pod_errors
 
Does the distribution have no POD errors?
•
use_strict
 
Does the distribution files all use strict?
•
have_test_pod
 
Does the distribution have a POD test file?
•
have_test_pod_coverage
 
Does the distribution have a POD-coverage test file?

AUTHOR

chromatic, <chromatic at wgz dot org>
With thanks to CPANTS and Thomas Klausner, as well as test tester Chris Dolan.

BUGS

No known bugs.

COPYRIGHT

Copyright (c) 2005 - 2008, chromatic. Some rights reserved.
This module is free software; you can use, redistribute, and modify it under the same terms as Perl 5.8.x.
2009-08-19 perl v5.10.0