Test::Dependencies(3) Ensure that your Makefile.PL specifies all module dependencies

VERSION

Version 0.12

SYNOPSIS

In your t/00-dependencies.t:


use Test::Dependencies exclude =>
[qw/ Your::Namespace Some::Other::Namespace /];
ok_dependencies();

DESCRIPTION

Makes sure that all of the modules that are 'use'd are listed in the Makefile.PL as dependencies.

OPTIONS

You can pass options to the module via the 'use' line. The available options are:
exclude
Specifies the list of namespaces for which it is ok not to have specified dependencies.
style
Specifies the style of module usage checking to use. There are two valid values: ``light'' and ``heavy''. The default is heavy. The light style uses regular expressions to try and guess which modules are required. It is fast, but can get confused by here-docs, multi-line strings, data sections, etc. The heavy style actually compiles the file and asks perl which modules were used. It is slower than the light style, but much more accurate. If you have a very large project and you don't want to wait for the heavy style every time you run ``make test,'' you might want to try the light style or look into the overrides below.

Whether a style is specified or not, the style used can be overriden by the environment variable TDSTYLE. This is useful, for example, if you want the heavy style to be used normally, but don't want to take the time checking dependencies on your smoke test server.

Example usage:

  use Test::Dependencies
    exclude => ['Test::Dependencies'],
    style => 'light';

EXPORTED FUNCTIONS

ok_dependencies

This should be the only test called in the test file. It scans bin/ and lib/ for module usage and t/ for build usage. It will then test that all modules used are listed as required in Makefile.PL, all modules used in t/ are listed as build required, that all modules listed are actually used, and that modules that are listed are not in the core list.

AUTHORS

  • Jesse Vincent "<jesse at bestpractical.com>"
  • Alex Vandiver "<alexmv at bestpractical.com>"
  • Zev Benjamin "<zev at cpan.org>"

BUGS

  • Test::Dependencies does not track module version requirements.
  • Perl version for ``already in core'' test failures is hardcoded.

Please report any bugs or feature requests to "bug-test-dependencies at rt.cpan.org", or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Dependencies>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Test::Dependencies

You can also look for information at:

LICENCE AND COPYRIGHT

    Copyright (c) 2007, Best Practical Solutions, LLC. All rights reserved.
    This module is free software; you can redistribute it and/or modify it
    under the same terms as Perl itself. See perlartistic.
    DISCLAIMER OF WARRANTY
    BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
    FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
    OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
    PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
    EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
    WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
    ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
    YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
    NECESSARY SERVICING, REPAIR, OR CORRECTION.
    IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
    WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
    REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
    TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
    CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
    SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
    RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
    FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
    SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
    DAMAGES.