/usr/share/perl5/Test/Compile.pm is in libtest-compile-perl 0.24-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 | package Test::Compile;
use 5.006;
use warnings;
use strict;
use UNIVERSAL::require;
use Test::Compile::Internal;
our $VERSION = '0.24';
my $Test = Test::Compile::Internal->new();
_verbose(1);
=head1 NAME
Test::Compile - Check whether Perl files compile correctly.
=head1 SYNOPSIS
use Test::Compile;
all_pm_files_ok();
=head1 DESCRIPTION
C<Test::Compile> lets you check the whether your perl modules and scripts
compile properly, and report its results in standard C<Test::Simple> fashion.
The basic usage - as shown above, will find all pm files and test that they
all compile.
You can explicitly specify the list of directories to check, using
the C<all_pm_files()> function supplied:
my @pmdirs = qw(blib script);
all_pm_files_ok(all_pm_files(@pmdirs));
=cut
sub import {
my $self = shift;
my $caller = caller;
for my $func (
qw(
pm_file_ok pl_file_ok all_pm_files all_pl_files all_pm_files_ok
all_pl_files_ok
)
) {
no strict 'refs';
*{ $caller . "::" . $func } = \&$func;
}
$Test->exported_to($caller);
$Test->plan(@_);
}
=head1 FUNCTIONS
=over 4
=item C<all_pm_files_ok(@files)>
Checks all the perl module files it can find for compilation errors.
It uses C<all_pm_files(@files)> to find the perl module files.
It also calls the C<plan()> function for you (one test for each module), so
you can't have already called C<plan>. Unfortunately, this also means
you can't use this function with C<all_pl_files_ok()>. If this is a problem
you should really be using L<Test::Compile::Internal>.
Returns true if all Perl module files are ok, or false if any fail.
Module authors can include the following in a F<t/00_compile.t> file
and have C<Test::Compile> automatically find and check all Perl module files
in a module distribution:
#!perl -w
use strict;
use warnings;
use Test::More;
eval "use Test::Compile";
Test::More->builder->BAIL_OUT(
"Test::Compile required for testing compilation") if $@;
all_pm_files_ok();
=cut
sub all_pm_files_ok {
my @files = @_ ? @_ : all_pm_files();
$Test->plan(tests => scalar @files);
my $ok = 1;
for (@files) {
pm_file_ok($_) or undef $ok;
}
$ok;
}
=item C<all_pl_files_ok(@files)>
Checks all the perl script files it can find for compilation errors.
It uses C<all_pl_files(@files)> to find the perl script files.
It also calls the C<plan()> function for you (one test for each script), so
you can't have already called C<plan>. Unfortunately, this also means
you can't use this function with C<all_pm_files_ok()>. If this is a problem
you should really be using L<Test::Compile::Internal>.
Returns true if all Perl script files are ok, or false if any fail.
Module authors can include the following in a F<t/00_compile_scripts.t> file
and have C<Test::Compile> automatically find and check all Perl script files
in a module distribution:
#!perl -w
use strict;
use warnings;
use Test::More;
eval "use Test::Compile";
plan skip_all => "Test::Compile required for testing compilation"
if $@;
all_pl_files_ok();
=cut
sub all_pl_files_ok {
my @files = @_ ? @_ : all_pl_files();
$Test->skip_all("no pl files found") unless @files;
$Test->plan(tests => scalar @files);
my $ok = 1;
for (@files) {
pl_file_ok($_) or undef $ok;
}
$ok;
}
=item C<pm_file_ok($filename,$testname)>
C<pm_file_ok()> will okay the test if $filename compiles as a perl module.
The optional second argument C<$testname> is the name of the test. If it is
omitted, C<pm_file_ok()> chooses a default test name C<Compile test for
$filename>.
=cut
sub pm_file_ok {
my ($file,$name) = @_;
$name ||= "Compile test for $file";
my $ok = $Test->pm_file_compiles($file);
$Test->ok($ok, $name);
$Test->diag("$file does not compile") unless $ok;
return $ok;
}
=item C<pl_file_ok($filename,$testname)>
C<pl_file_ok()> will okay the test if $filename compiles as a perl script. You
need to give the path to the script relative to this distribution's base
directory. So if you put your scripts in a 'top-level' directory called script
the argument would be C<script/filename>.
The optional second argument C<$testname> is the name of the test. If it is
omitted, C<pl_file_ok()> chooses a default test name C<Compile test for
$filename>.
=cut
sub pl_file_ok {
my ($file,$name) = @_;
$name ||= "Compile test for $file";
# don't "use Devel::CheckOS" because Test::Compile is included by
# Module::Install::StandardTests, and we don't want to have to ship
# Devel::CheckOS with M::I::T as well.
if (Devel::CheckOS->require) {
# Exclude VMS because $^X doesn't work. In general perl is a symlink to
# perlx.y.z but VMS stores symlinks differently...
unless (Devel::CheckOS::os_is('OSFeatures::POSIXShellRedirection')
and Devel::CheckOS::os_isnt('VMS')) {
$Test->skip('Test not compatible with your OS');
return;
}
}
my $ok = $Test->pl_file_compiles($file);
$Test->ok($ok, $name);
$Test->diag("$file does not compile") unless $ok;
return $ok;
}
=item C<all_pm_files(@dirs)>
Returns a list of all the perl module files - that is, files ending in F<.pm>
- in I<@dirs> and in directories below. If no directories are passed, it
defaults to F<blib> if F<blib> exists, or else F<lib> if not. Skips any files
in C<CVS> or C<.svn> directories.
The order of the files returned is machine-dependent. If you want them
sorted, you'll have to sort them yourself.
=cut
sub all_pm_files {
return $Test->all_pm_files(@_);
}
=item C<all_pl_files(@dirs)>
Returns a list of all the perl script files - that is, files ending in F<.pl>
or with no extension. Directory arguments are searched recursively . If
I<@dirs> is undefined, it defaults to F<script> if F<script> exists, or else
F<bin> if F<bin> exists. Skips any files in C<CVS> or C<.svn> directories.
The order of the files returned is machine-dependent. If you want them
sorted, you'll have to sort them yourself.
=back
=cut
sub all_pl_files {
return $Test->all_pl_files(@_);
}
sub _verbose {
return $Test->verbose(@_);
}
1;
=head1 AUTHORS
Sagar R. Shah C<< <srshah@cpan.org> >>,
Marcel GrE<uuml>nauer, C<< <marcel@cpan.org> >>,
Evan Giles, C<< <egiles@cpan.org> >>
=head1 COPYRIGHT AND LICENSE
Copyright 2007-2013 by the authors.
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=head1 SEE ALSO
L<Test::Compile::Internal> provides an object oriented interface to the
Test::Compile functionality.
L<Test::Strict> proveds functions to ensure your perl files comnpile, with
added bonus that it will check you have used strict in all your files.
L<Test::LoadAllModules> just handles modules, not script files, but has more
fine-grained control.
=cut
|