/ 
Test-Compile-0.05
River stage three • 93 direct dependents • 160 total dependents
/ Test::Compile

NAME

Test::Compile - check whether Perl module files compile correctly

SYNOPSIS

Test::Compile lets you check the validity of a Perl module file, and report its results in standard Test::Simple fashion.

BEGIN {
    use Test::Compile tests => $num_tests;
    pm_file_ok($file, "Valid Perl module file");
}

It's probably a good idea to run this in a BEGIN block. The examples below omit it for clarity.

Module authors can include the following in a t/00_compile.t file and have Test::Compile automatically find and check all Perl module files in a module distribution:

use Test::More;
eval "use Test::Compile 1.00";
Test::More->builder->BAIL_OUT(
    "Test::Compile 1.00 required for testing compilation") if $@;
all_pm_files_ok();

You can also specify a list of files to check, using the all_pm_files() function supplied:

use strict;
use Test::More;
eval "use Test::Compile 1.00";
Test::More->builder->BAIL_OUT(
    "Test::Compile 1.00 required for testing compilation") if $@;
my @pmdirs = qw(blib script);
all_pm_files_ok(all_pm_files(@pmdirs));

Or even (if you're running under Apache::Test):

use strict;
use Test::More;
eval "use Test::Compile 1.00";
Test::More->builder->BAIL_OUT(
    "Test::Compile 1.00 required for testing compilation") if $@;

my @pmdirs = qw(blib script);
use File::Spec::Functions qw(catdir updir);
all_pm_files_ok(
    all_pm_files( map { catdir updir, $_ } @pmdirs )
);

Why do the examples use BAIL_OUT() instead of skip_all()? Because testing whether a module compiles is important. skip_all() is ok to use with Test::Pod, because if the pod is malformed the program is still going to run. But checking whether a module even compiles is something else. Test::Compile should be mandatory, not optional.

DESCRIPTION

Check Perl module files for errors or warnings in a test file.

FUNCTIONS

pm_file_ok(FILENAME[, TESTNAME ])

pm_file_ok() will okay the test if the Perl module compiles correctly.

When it fails, pm_file_ok() will show any compilation errors as diagnostics.

The optional second argument TESTNAME is the name of the test. If it is omitted, pm_file_ok() chooses a default test name "Compile test for FILENAME".

all_pm_files_ok([@files/@directories])

Checks all the files in @files for compilation. It runs all_pm_files() on each file/directory, and calls the plan() function for you (one test for each function), so you can't have already called plan.

If @files is empty or not passed, the function finds all Perl module files in the blib directory if it exists, or the lib directory if not. A Perl module file is one that ends with .pm.

If you're testing a module, just make a t/00_compile.t:

use Test::More;
eval "use Test::Compile 1.00";
plan skip_all => "Test::Compile 1.00 required for testing compilation"
  if $@;
all_pm_files_ok();

Returns true if all Perl module files are ok, or false if any fail.

Or you could just let Module::Install::StandardTests do all the work for you.

all_pm_files([@dirs])

Returns a list of all the perl module files - that is, files ending in .pm - in $dir and in directories below. If no directories are passed, it defaults to blib if blib exists, or else lib if not. Skips any files in CVS or .svn directories.

The order of the files returned is machine-dependent. If you want them sorted, you'll have to sort them yourself.

TAGS

If you talk about this module in blogs, on del.icio.us or anywhere else, please use the testcompile tag.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-test-compile@rt.cpan.org, or through the web interface at http://rt.cpan.org.

INSTALLATION

See perlmodinstall for information and options on installing Perl modules.

AVAILABILITY

The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit <http://www.perl.com/CPAN/> to find a CPAN site near you. Or see <http://www.perl.com/CPAN/authors/id/M/MA/MARCEL/>.

AUTHOR

Marcel Grünauer, <marcel@cpan.org>

COPYRIGHT AND LICENSE

Copyright 2007 by Marcel Grünauer

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.