Test-Manifest-2.021/ 000755 000765 000024 00000000000 13274207751 014447 5 ustar 00brian staff 000000 000000 Test-Manifest-2.021/test_manifest_with_include 000644 000765 000024 00000000053 13274207750 021772 0 ustar 00brian staff 000000 000000 00load.t
;include t/include_in_manifest.txt Test-Manifest-2.021/LICENSE 000644 000765 000024 00000017405 13274207750 015462 0 ustar 00brian staff 000000 000000 The Test::Manifest module is licensed under the same terms as perl
itself, under the Artistic License 2.0.
Artistic License 2.0
Copyright (c) 2000-2006, The Perl Foundation.
http://www.perlfoundation.org/artistic_license_2_0
Preamble
This license establishes the terms under which a given free software
Package may be copied, modified, distributed, and/or redistributed.
The intent is that the Copyright Holder maintains some artistic
control over the development of that Package while still keeping the
Package available as open source and free software.
You are always permitted to make arrangements wholly outside of this
license directly with the Copyright Holder of a given Package. If the
terms of this license do not permit the full use that you propose to
make of the Package, you should contact the Copyright Holder and seek
a different licensing arrangement.
Definitions
"Copyright Holder" means the individual(s) or organization(s) named in
the copyright notice for the entire Package.
"Contributor" means any party that has contributed code or other
material to the Package, in accordance with the Copyright Holder's
procedures.
"You" and "your" means any person who would like to copy, distribute,
or modify the Package.
"Package" means the collection of files distributed by the Copyright
Holder, and derivatives of that collection and/or of those files. A
given Package may consist of either the Standard Version, or a
Modified Version.
"Distribute" means providing a copy of the Package or making it
accessible to anyone else, or in the case of a company or
organization, to others outside of your company or organization.
"Distributor Fee" means any fee that you charge for Distributing this
Package or providing support for this Package to another party. It
does not mean licensing fees.
"Standard Version" refers to the Package if it has not been modified,
or has been modified only in ways explicitly requested by the
Copyright Holder.
"Modified Version" means the Package, if it has been changed, and such
changes were not explicitly requested by the Copyright Holder.
"Original License" means this Artistic License as Distributed with the
Standard Version of the Package, in its current version or as it may
be modified by The Perl Foundation in the future.
"Source" form means the source code, documentation source, and
configuration files for the Package.
"Compiled" form means the compiled bytecode, object code, binary, or
any other form resulting from mechanical transformation or translation
of the Source form.
Permission for Use and Modification Without Distribution
(1) You are permitted to use the Standard Version and create and use
Modified Versions for any purpose without restriction, provided that
you do not Distribute the Modified Version.
Permissions for Redistribution of the Standard Version
(2) You may Distribute verbatim copies of the Source form of the
Standard Version of this Package in any medium without restriction,
either gratis or for a Distributor Fee, provided that you duplicate
all of the original copyright notices and associated disclaimers. At
your discretion, such verbatim copies may or may not include a
Compiled form of the Package.
(3) You may apply any bug fixes, portability changes, and other
modifications made available from the Copyright Holder. The resulting
Package will still be considered the Standard Version, and as such
will be subject to the Original License.
Distribution of Modified Versions of the Package as Source
(4) You may Distribute your Modified Version as Source (either gratis
or for a Distributor Fee, and with or without a Compiled form of the
Modified Version) provided that you clearly document how it differs
from the Standard Version, including, but not limited to, documenting
any non-standard features, executables, or modules, and provided that
you do at least ONE of the following:
(a) make the Modified Version available to the Copyright Holder of the
Standard Version, under the Original License, so that the Copyright
Holder may include your modifications in the Standard Version.
(b) ensure that installation of your Modified Version does not prevent
the user installing or running the Standard Version. In addition, the
Modified Version must bear a name that is different from the name of
the Standard Version.
(c) allow anyone who receives a copy of the Modified Version to make
the Source form of the Modified Version available to others under
(i) the Original License or
(ii) a license that permits the licensee to freely copy, modify and
redistribute the Modified Version using the same licensing terms that
apply to the copy that the licensee received, and requires that the
Source form of the Modified Version, and of any works derived from it,
be made freely available in that license fees are prohibited but
Distributor Fees are allowed.
Distribution of Compiled Forms of the Standard Version or Modified
Versions without the Source
(5) You may Distribute Compiled forms of the Standard Version without
the Source, provided that you include complete instructions on how to
get the Source of the Standard Version. Such instructions must be
valid at the time of your distribution. If these instructions, at any
time while you are carrying out such distribution, become invalid, you
must provide new instructions on demand or cease further distribution.
If you provide valid instructions or cease distribution within thirty
days after you become aware that the instructions are invalid, then
you do not forfeit any of your rights under this license.
(6) You may Distribute a Modified Version in Compiled form without the
Source, provided that you comply with Section 4 with respect to the
Source of the Modified Version.
Aggregating or Linking the Package
(7) You may aggregate the Package (either the Standard Version or
Modified Version) with other packages and Distribute the resulting
aggregation provided that you do not charge a licensing fee for the
Package. Distributor Fees are permitted, and licensing fees for other
components in the aggregation are permitted. The terms of this license
apply to the use and Distribution of the Standard or Modified Versions
as included in the aggregation.
(8) You are permitted to link Modified and Standard Versions with
other works, to embed the Package in a larger work of your own, or to
build stand-alone binary or bytecode versions of applications that
include the Package, and Distribute the result without restriction,
provided the result does not expose a direct interface to the Package.
Items That are Not Considered Part of a Modified Version
(9) Works (including, but not limited to, modules and scripts) that
merely extend or make use of the Package, do not, by themselves, cause
the Package to be a Modified Version. In addition, such works are not
considered parts of the Package itself, and are not subject to the
terms of this license.
General Provisions
(10) Any use, modification, and distribution of the Standard or
Modified Versions is governed by this Artistic License. By using,
modifying or distributing the Package, you accept this license. Do not
use, modify, or distribute the Package, if you do not accept this
license.
(11) If your Modified Version has been derived from a Modified Version
made by someone other than you, you are nevertheless required to
ensure that your Modified Version complies with the requirements of
this license.
(12) This license does not grant you the right to use any trademark,
service mark, tradename, or logo of the Copyright Holder.
(13) This license includes the non-exclusive, worldwide,
free-of-charge patent license to make, have made, use, offer to sell,
sell, import and otherwise transfer the Package with respect to any
patent claims licensable by the Copyright Holder that are necessarily
infringed by the Package. If you institute patent litigation
Test-Manifest-2.021/test_manifest_levels 000644 000765 000024 00000000307 13274207750 020610 0 ustar 00brian staff 000000 000000 # this is a comment, then a blank line
00load.t
01get_test_files.t 1
01make_test_manifest.t 2
leading_space.t 2.9
pod_coverage.t 1 # with a comment
trailing_space.t 3 # with a comment
99pod.t 3.1 Test-Manifest-2.021/Changes 000644 000765 000024 00000005624 13274207750 015750 0 ustar 00brian staff 000000 000000 Revision history for Perl module Test::Manifest
2.021 2018-05-08T02:47:56Z
* Clarify that it's the Artistic License 2.0
2.02_01 2016-06-07T20:39:40Z
* Start tracking down odd get_test_files failures.
2.02 - 2014-08-26
* Fix rt.cpan.org #98288: fix a spelling mistake
2.00_001 - 2013-07-11
* Switch back to Makefile.PL—so much simpler
2.00_01 - 2011-07-20
* Work with Module::Build by supplying a subclass.
1.23 - 2009-07-17
* Move everything to git and finally make a release
1.22_03 - 2008-07-29
* Fixed bug for missing file: previously the missing file
name was passed through to run_t_files, although without
the t/ added to its path. Test::Manifest should only
warn about and skip missing files.
1.22_02 - 2008-01-24
* File path and unlink fixes for VMS (RT #32061). Let's see if this works.
1.22_01 - 2008-01-06
* Changed test file names to only have one dot in them so they
work on VMS and ODS-2 file systems: RT #32061
* This is a test release.
1.22 - 2007-10-27
* distro cleanups after moving from CVS to SVN
1.21 - 2007-09-19
* [BUGFIX] getting rid of Test::More
1.17 - 2007-02-22
* Updated to Sourceforge's SVN repository
* Dist conforms to META 1.2 spec
* No feature changes, so no big hurry to upgrade
1.16 - 2006-08-29
* Added an experimental feature to grab file names from additional
files. Just specify which other files to grab file names from:
;include names_in_this_file.txt
See the docs for get_t_files().
* This is an experimental feature. This feature is experimental.
1.14 - 2005-03-26
* put paths together with File::Spec (so this should work on
Windows
* You can now define levels of testing with TEST_LEVEL (e.g.
make test TEST_LEVEL=2)
1.13 - 2005-03-19
* Added POD Coverage tests
* No more fooling with ExtUtils::* ---> put things in MY::* to
change behavior.
* If you are using Test::Manifest, you should upgrade and adjust
your Makefile.PL: the magic happens when Test::Manifest loads, so
you only need to load it. Ensure you require the right version:
eval "use Test::Manifest 1.13";
1.11 - 2004-09-25
* This is a release version. It's the same code as 0.95
* Some doc updates
0.95 - 2004-09-02
* Test::Manifest is now more tolerant of sloppiness. It strips leading
and trailing whitespace as it reads lines from test_manifest, and it
skips comment lines.
* If you already have Test::Manifest, you don't need to rush to get this
new version unless you have a problem with whitespace issues.
0.93 - 2004-02-20
* some minor tweaks for warnings, clarity
* docs show way to make Test::Manifest optional (should have thought
of it sooner)
0.92 - 2003-07-30
* Made tests run clean under warnings.
* Closed a file that failed when trying to delete it under
Windows. (Thanks Mike O'Regan)
* Added POD tests.
0.91 - 2002-12-11
* require ExtUtils::MakeMaker 6.x so the right run_tests is
available
0.9 - 2002-10-10
* removed as many dependencies as possible
Test-Manifest-2.021/MANIFEST 000644 000765 000024 00000000622 13274207750 015577 0 ustar 00brian staff 000000 000000 Changes
examples/README
INSTALL.SKIP
lib/Test/Manifest.pm
LICENSE
Makefile.PL
MANIFEST This list of files
MANIFEST.SKIP
META.json
META.yml
README.pod
t/00load.t
t/01get_test_files.t
t/01make_test_manifest.t
t/99pod.t
t/include.t
t/include_in_manifest.txt
t/leading_space.t
t/pod_coverage.t
t/test_manifest
t/trailing_space.t
test_manifest
test_manifest_levels
test_manifest_with_include
xt/changes.t
Test-Manifest-2.021/t/ 000755 000765 000024 00000000000 13274207751 014712 5 ustar 00brian staff 000000 000000 Test-Manifest-2.021/xt/ 000755 000765 000024 00000000000 13274207751 015102 5 ustar 00brian staff 000000 000000 Test-Manifest-2.021/README.pod 000644 000765 000024 00000007540 13274207750 016115 0 ustar 00brian staff 000000 000000 =pod
=encoding utf8
=for HTML 
=for HTML 
=for HTML 
=for HTML 
=for HTML 
=head1 The Test::Manifest module
This is the I for the L Perl module. You're probably
looking at this because you don't know where else to find what you're
looking for. Read this once and you might never have to read one again
for any Perl module.
=head2 Documentation
To read about L, look at the embedded documentation
in the module itself. Inside the distribution, you can format it
with L:
% perldoc lib/Test/Manifest.pm
If you have already installed the module, you can specify the module
name instead of the file location:
% perldoc Test::Manifest
You can read the documentation and inspect the meta data on one of the
CPAN web interfaces, such as L or
L:
=over 4
=item * L
=item * L
=back
The standard module documentation has example uses in the SYNOPSIS
section, but you can also look in the I directory (if it's
there), or look at the test files in I.
=head2 Installation
You can install this module with a CPAN client, which will resolve
and install the dependencies:
% cpan Test::Manifest
% cpanm Test::Manifest
You can also install directly from the distribution directory, which
will also install the dependencies:
% cpan .
% cpanm .
You could install just this module manually:
% perl Makefile.PL
% make
% make test
% make install
You probably don't want to do that unless you're fiddling with the
module and only want to run the tests without installing anything.
=head2 Source location
The meta data, such as the source repository and bug tracker, is in
I or the I files it creates. You can find that on
those CPAN web interfaces, but you can also look at files directly in
the source repository:
=over 4
=item * L
=back
If you find a problem, file a ticket in the L:
=over 4
=item * L
=back
=head2 Getting help
Although I'm happy to hear from module users in private email,
that's the best way for me to forget to do something.
Besides the issue trackers, you can find help at
L or
L, both of which have many
competent Perlers who can answer your question, almost in real time.
They might not know the particulars of this module, but they can help
you diagnose your problem.
You might like to read L.
=head2 Copyright and License
You should have received a I file, but the license is also noted
in the module files. About the only thing you can't do is pretend that
you wrote code that you didn't.
=head2 Good luck!
Enjoy,
brian d foy, bdfoy@cpan.org
=cut
Test-Manifest-2.021/MANIFEST.SKIP 000644 000765 000024 00000002046 13274207750 016346 0 ustar 00brian staff 000000 000000
#!start included /usr/local/perls/perl-5.18.1/lib/5.18.1/ExtUtils/MANIFEST.SKIP
# Avoid version control files.
\bRCS\b
\bCVS\b
\bSCCS\b
,v$
\B\.svn\b
\B\.git\b
\B\.gitignore\b
\b_darcs\b
\B\.cvsignore$
# Avoid VMS specific MakeMaker generated files
\bDescrip.MMS$
\bDESCRIP.MMS$
\bdescrip.mms$
# Avoid Makemaker generated and utility files.
\bMANIFEST\.bak
\bMakefile$
\bblib/
\bMakeMaker-\d
\bpm_to_blib\.ts$
\bpm_to_blib$
\bblibdirs\.ts$ # 6.18 through 6.25 generated this
# Avoid Module::Build generated and utility files.
\bBuild$
\b_build/
\bBuild.bat$
\bBuild.COM$
\bBUILD.COM$
\bbuild.com$
# Avoid temp and backup files.
~$
\.old$
\#$
\b\.#
\.bak$
\.tmp$
\.#
\.rej$
# Avoid OS-specific files/dirs
# Mac OSX metadata
\B\.DS_Store
# Mac OSX SMB mount metadata files
\B\._
# Avoid Devel::Cover and Devel::CoverX::Covered files.
\bcover_db\b
\bcovered\b
# Avoid MYMETA files
^MYMETA\.
#!end included /usr/local/perls/perl-5.18.1/lib/5.18.1/ExtUtils/MANIFEST.SKIP
\.travis\.yml
\.?appveyor.yml
\.releaserc
\.lwpcookies
Test-Manifest-.*
hacks/
Test-Manifest-2.021/examples/ 000755 000765 000024 00000000000 13274207751 016265 5 ustar 00brian staff 000000 000000 Test-Manifest-2.021/META.yml 000664 000765 000024 00000001523 13274207751 015723 0 ustar 00brian staff 000000 000000 ---
abstract: 'interact with a t/test_manifest file'
author:
- 'brian d foy '
build_requires:
Test::More: '0.94'
configure_requires:
ExtUtils::MakeMaker: '6.64'
File::Spec::Functions: '0'
dynamic_config: 1
generated_by: 'ExtUtils::MakeMaker version 7.24, CPAN::Meta::Converter version 2.150010'
license: artistic_2
meta-spec:
url: http://module-build.sourceforge.net/META-spec-v1.4.html
version: '1.4'
name: Test-Manifest
no_index:
directory:
- t
- inc
requires:
File::Spec: '0'
File::Spec::Functions: '0'
Test::Harness: '0'
perl: '5.008'
resources:
bugtracker: https://github.com/briandfoy/test-manifest/issues
homepage: https://github.com/briandfoy/test-manifest
repository: https://github.com/briandfoy/test-manifest.git
version: '2.021'
x_serialization_backend: 'CPAN::Meta::YAML version 0.018'
Test-Manifest-2.021/lib/ 000755 000765 000024 00000000000 13274207751 015215 5 ustar 00brian staff 000000 000000 Test-Manifest-2.021/Makefile.PL 000644 000765 000024 00000005262 13274207750 016425 0 ustar 00brian staff 000000 000000 package Test::Manifest;
use strict;
use warnings;
=encoding utf8
=head1 The build file for Test::Manifest
This build file is a modulino; it works as both a build script and
a module.
To build the distribution, run this file normally:
% perl Makefile.PL
But, it's more interesting than that. You can load it with C
and call C to get the data structure it passes to
C:
my $package = require '/path/to/Makefile.PL';
my $arguments = $package->arguments;
Note that C-ing a file makes an entry in C<%INC> for exactly
that name. If you try to C another file with the same name,
even from a different path, C thinks it has already loaded
the file. As such, I recommend you always require the full path to the
file.
The return value of the C is a package name (in this case,
the name of the main module. Use that to call the C method.
Even if this distribution needs a higher version of Perl, this bit
only needs v5.8. You can play with the data structure with a primitive
Perl.
=cut
use File::Spec::Functions qw(catfile);
my $module = __PACKAGE__;
( my $dist = $module ) =~ s/::/-/g;
my $github = 'https://github.com/briandfoy/test-manifest';
my $main_file = catfile( 'lib', split /::/, "$module.pm" );
my %WriteMakefile = (
'MIN_PERL_VERSION' => 5.008,
'NAME' => $module,
'AUTHOR' => 'brian d foy ',
'ABSTRACT_FROM' => $main_file,
'VERSION_FROM' => $main_file,
'LICENSE' => 'artistic_2',
'CONFIGURE_REQUIRES' => {
'ExtUtils::MakeMaker' => '6.64',
'File::Spec::Functions' => '0',
},
'BUILD_REQUIRES' => {
},
'TEST_REQUIRES' => {
'Test::More' => '0.94',
},
'PREREQ_PM' => {
'File::Spec::Functions' => '0',
'Test::Harness' => '0',
'File::Spec' => '0',
},
'META_MERGE' => {
'meta-spec' => { version => 2 },
resources => {
repository => {
type => 'git',
url => "$github.git",
web => $github,
},
bugtracker => {
web => "$github/issues",
},
homepage => $github,
},
},
clean => { FILES => "$dist-*" },
);
sub arguments { \%WriteMakefile }
do_it() unless caller;
sub do_it {
require File::Spec;
my $MM ='ExtUtils::MakeMaker';
my $MM_version =
eval{ "$MM " . $WriteMakefile{'CONFIGURE_REQUIRES'}{'ExtUtils::MakeMaker'} }
||
"$MM 6.64";
eval "use $MM_version; 1" or die "Could not load $MM_version: $@";
eval "use Test::Manifest 1.21"
if -e File::Spec->catfile( qw(t test_manifest) );
my $arguments = arguments();
my $minimum_perl = $arguments->{MIN_PERL_VERSION} || '5.008';
eval "require $minimum_perl;" or die $@;
WriteMakefile( %$arguments );
}
no warnings;
__PACKAGE__;
Test-Manifest-2.021/test_manifest 000644 000765 000024 00000000230 13274207750 017231 0 ustar 00brian staff 000000 000000 # this is a comment, then a blank line
00load.t
01get_test_files.t
01make_test_manifest.t
leading_space.t
trailing_space.t # comment at end of line Test-Manifest-2.021/INSTALL.SKIP 000644 000765 000024 00000000156 13274207750 016246 0 ustar 00brian staff 000000 000000 README\.pod
README.*
# things that might be in local directories after fooling
# around with them
\.DS_Store
Test-Manifest-2.021/META.json 000664 000765 000024 00000002763 13274207751 016102 0 ustar 00brian staff 000000 000000 {
"abstract" : "interact with a t/test_manifest file",
"author" : [
"brian d foy "
],
"dynamic_config" : 1,
"generated_by" : "ExtUtils::MakeMaker version 7.24, CPAN::Meta::Converter version 2.150010",
"license" : [
"artistic_2"
],
"meta-spec" : {
"url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec",
"version" : "2"
},
"name" : "Test-Manifest",
"no_index" : {
"directory" : [
"t",
"inc"
]
},
"prereqs" : {
"build" : {
"requires" : {}
},
"configure" : {
"requires" : {
"ExtUtils::MakeMaker" : "6.64",
"File::Spec::Functions" : "0"
}
},
"runtime" : {
"requires" : {
"File::Spec" : "0",
"File::Spec::Functions" : "0",
"Test::Harness" : "0",
"perl" : "5.008"
}
},
"test" : {
"requires" : {
"Test::More" : "0.94"
}
}
},
"release_status" : "stable",
"resources" : {
"bugtracker" : {
"web" : "https://github.com/briandfoy/test-manifest/issues"
},
"homepage" : "https://github.com/briandfoy/test-manifest",
"repository" : {
"type" : "git",
"url" : "https://github.com/briandfoy/test-manifest.git",
"web" : "https://github.com/briandfoy/test-manifest"
}
},
"version" : "2.021",
"x_serialization_backend" : "JSON::PP version 2.27400_02"
}
Test-Manifest-2.021/lib/Test/ 000755 000765 000024 00000000000 13274207751 016134 5 ustar 00brian staff 000000 000000 Test-Manifest-2.021/lib/Test/Manifest.pm 000644 000765 000024 00000025740 13274207750 020247 0 ustar 00brian staff 000000 000000 package Test::Manifest;
use strict;
use warnings;
no warnings;
use Exporter qw(import);
use Carp qw(carp);
use File::Spec::Functions qw(catfile);
our @EXPORT = qw(run_t_manifest);
our @EXPORT_OK = qw(get_t_files make_test_manifest manifest_name);
our $VERSION = '2.021';
my %SeenInclude = ();
my %SeenTest = ();
require 5.006;
sub MY::test_via_harness {
my($self, $perl, $tests) = @_;
return qq|\t$perl "-MTest::Manifest" | .
qq|"-e" "run_t_manifest(\$(TEST_VERBOSE), '\$(INST_LIB)', | .
qq|'\$(INST_ARCHLIB)', \$(TEST_LEVEL) )"\n|;
};
=encoding utf8
=head1 NAME
Test::Manifest - interact with a t/test_manifest file
=head1 SYNOPSIS
# in Makefile.PL
eval "use Test::Manifest 2.00";
# in Build.PL
my $class = do {
if( eval 'use Test::Manifest 2.00; 1' ) {
Test::Manifest->get_module_build_subclass;
}
else {
'Module::Build';
}
};
my $build = $class->new( ... )
# in the file t/test_manifest, list the tests you want
# to run in the order you want to run them
=head1 DESCRIPTION
C assumes that you want to run all of the F<.t> files
in the F directory in ASCII-betical order during C or
C<./Build test> unless you say otherwise. This leads to some
interesting naming schemes for test files to get them in the desired
order. These interesting names ossify when they get into source
control, and get even more interesting as more tests show up.
C overrides the default test file order. Instead of
running all of the F files in ASCII-betical order, it looks in
the F file to find out which tests you want to run
and the order in which you want to run them. It constructs the right
value for the build system to do the right thing.
In F, simply list the tests that you want to run.
Their order in the file is the order in which they run. You can
comment lines with a C<#>, just like in Perl, and C
will strip leading and trailing whitespace from each line. It also
checks that the specified file is actually in the F directory. If
the file does not exist, it does not put its name in the list of test
files to run and it will issue a warning.
Optionally, you can add a number after the test name in test_manifest
to define sets of tests. See C for more information.
=head2 ExtUtils::MakeMaker
To override the test order behaviour in C, C
inserts itself in the C step by providing its own
test runner. In C, all you have to do is load C
before you call C. To make it optional, load it in an eval:
eval "use Test::Manifest";
=head2 Module::Build
Overiding parts of C is tricker if you want to use the
subclassing mechanism and still make C optional. If you
can load C (version 2.00 or later), C can
create the subclass for you.
my $class = do {
if( eval 'use Test::Manifest 2.00; 1' ) {
Test::Manifest->get_module_build_subclass;
}
else {
'Module::Build' # if Test::Manifest isn't there
}
};
$class->new( ... );
$class->create_build_file;
This is a bit of a problem when you already have your own subclass.
C overrides C, so you can get just
that code to add to your own subclass code string:
my $code = eval 'use Test::Manifest 2.00; 1'
?
Test::Manifest->get_module_build_code_string
:
'';
my $class = Module::Build->subclass(
...,
code => "$code\n...your subclass code string...",
);
=head2 Class methods
=over 4
=item get_module_build_subclass
For C only.
Returns a C subclass that overrides C. If
you want to have your own C subclass and still use
C, you can get just the code string with
C.
=cut
sub get_module_build_subclass {
my( $class ) = @_;
require Module::Build;
my $class = Module::Build->subclass(
class => 'Test::Manifest::MB',
code => $class->get_module_build_code_string,
);
$class->log_info( "Using Test::Manifest $VERSION\n" );
$class;
}
=item get_module_build_code_string
For C only.
Returns the overridden C as Perl code in a string suitable
for the C key in Csubclass()>. You can add this to other
bits you are overriding or extending.
See C to see the base implementation.
=cut
sub get_module_build_code_string {
q{
sub find_test_files {
my $self = shift;
my $p = $self->{properties};
my( $level ) = grep { defined } (
$ENV{TEST_LEVEL},
$p->{ 'testlevel' },
0
);
$self->log_verbose( "Test level is $level\n" );
require Test::Manifest;
my @files = Test::Manifest::get_t_files( $level );
\@files;
}
}
}
=back
=head2 Functions
=over 4
=item run_t_manifest( TEST_VERBOSE, INST_LIB, INST_ARCHLIB, TEST_LEVEL )
For C only. You don't have to mess with this at the user
level.
Run all of the files in F through C
in the order they appear in the file. This is inserted automatically
eval "use Test::Manifest";
=cut
sub run_t_manifest {
require Test::Harness;
require File::Spec;
$Test::Harness::verbose = shift;
local @INC = @INC;
unshift @INC, map { File::Spec->rel2abs($_) } @_[0,1];
my( $level ) = $_[2] || 0;
print STDERR "Test::Manifest $VERSION\n"
if $Test::Harness::verbose;
print STDERR "Level is $level\n"
if $Test::Harness::verbose;
my @files = get_t_files( $level );
print STDERR "Test::Manifest::test_harness found [@files]\n"
if $Test::Harness::verbose;
Test::Harness::runtests( @files );
}
=item get_t_files( [LEVEL] )
In scalar context it returns a single string that you can use directly
in C. In list context it returns a list of the files it
found in F.
If a F file does not exist, C returns
nothing.
C warns you if it can't find F, or if
entries start with F. It skips blank lines, and strips Perl
style comments from the file.
Each line in F can have three parts: the test name,
the test level (a floating point number), and a comment. By default,
the test level is 1.
test_name.t 2 #Run this only for level 2 testing
Without an argument, C returns all the test files it
finds. With an argument that is true (so you can't use 0 as a level)
and is a number, it skips tests with a level greater than that
argument. You can then define sets of tests and choose a set to
run. For instance, you might create a set for end users, but also
add on a set for deeper testing for developers.
Experimentally, you can include a command to grab test names from
another file. The command starts with a C<;> to distinguish it
from a true filename. The filename (currently) is relative to the
current working directory, unlike the filenames, which are relative
to C. The filenames in the included are still relative to C.
;include t/file_with_other_test_names.txt
Also experimentally, you can stop C from reading
filenames with the C<;skip> directive. C will skip the
filenames up to the C<;unskip> directive (or end of file):
run_this1
;skip
skip_this
;unskip
run_this2
To select sets of tests, specify the level in the environment variable
C:
make test # run all tests no matter the level
make test TEST_LEVEL=2 # run all tests level 2 and below
Eventually this will end up as an option to F:
./Build test --testlevel=2 # Not yet supported
=cut
sub get_t_files {
my $upper_bound = shift;
print STDERR "# Test level is $upper_bound\n"
if $Test::Harness::verbose;
%SeenInclude = ();
%SeenTest = ();
my $Manifest = manifest_name();
carp( "$Manifest does not exist!" ) unless -e $Manifest;
my $result = _load_test_manifest( $Manifest, $upper_bound );
return unless defined $result;
my @tests = @{$result};
return wantarray ? @tests : join " ", @tests;
}
# Wrapper for loading test manifest files to support including other files
sub _load_test_manifest {
my $manifest = shift;
return unless open my( $fh ), '<', $manifest;
my $upper_bound = shift || 0;
my @tests = ();
LINE: while( <$fh> ) {
s/#.*//; s/^\s+//; s/\s+$//;
next unless $_;
my( $command, $arg ) = split /\s+/, $_, 2;
if( ';' eq substr( $command, 0, 1 ) ) {
if( $command eq ';include' ) {
my $result = _include_file( $arg, $., $upper_bound );
push @tests, @$result if defined $result;
next;
}
elsif( $command eq ';skip' ) {
while( <$fh> ) { last if m/^;unskip/ }
next LINE;
}
else {
croak( "Unknown directive: $command" );
}
}
my( $test, $level ) = ( $command, $arg );
$level = 1 unless defined $level;
next if( $upper_bound and $level > $upper_bound );
carp( "Bad value for test [$test] level [$level]\n".
"Level should be a floating-point number\n" )
unless $level =~ m/^\d+(?:.\d+)?$/;
carp( "test file begins with t/ [$test]" ) if m|^t/|;
if( -e catfile( "t", $test ) ) {
$test = catfile( "t", $test )
}
else {
carp( "test file [$test] does not exist! Skipping!" );
next;
}
# Make sure we don't include a test we've already seen
next if exists $SeenTest{$test};
$SeenTest{$test} = 1;
push @tests, $test;
}
close $fh;
return \@tests;
}
sub _include_file {
my( $file, $line, $upper_bound ) = @_;
print STDERR "# Including file $file at line $line\n"
if $Test::Harness::verbose;
unless( -e $file ) {
carp( "$file does not exist" ) ;
return;
}
if( exists $SeenInclude{$file} ) {
carp( "$file already loaded - skipping" ) ;
return;
}
$SeenInclude{$file} = $line;
my $result = _load_test_manifest( $file, $upper_bound );
return unless defined $result;
$result;
}
=item make_test_manifest()
Creates the test_manifest file in the t directory by reading the
contents of the F directory.
TO DO: specify tests in argument lists.
TO DO: specify files to skip.
=cut
sub make_test_manifest() {
carp( "t/ directory does not exist!" ) unless -d "t";
return unless open my( $fh ), '>', manifest_name();
my $count = 0;
while( my $file = glob("t/*.t") ) {
$file =~ s|^t/||;
print $fh "$file\n";
$count++;
}
close $fh;
return $count;
}
=item manifest_name()
Returns the name of the test manifest file, relative to F.
=cut
{
my $Manifest = catfile( "t", "test_manifest" );
sub manifest_name {
return $Manifest;
}
}
=back
=head1 SOURCE AVAILABILITY
This source is in Github:
http://github.com/briandfoy/test-manifest/
=head1 CREDITS
Matt Vanderpol suggested and supplied a patch for the C<;include>
feature.
Olivier Mengué supplied a documentation patch.
=head1 AUTHOR
brian d foy, C<< >>
=head1 COPYRIGHT AND LICENSE
Copyright © 2002-2018, brian d foy . All rights reserved.
This program is free software; you can redistribute it and/or modify
it under the terms of the Artistic License 2.0.
=cut
1;
Test-Manifest-2.021/examples/README 000644 000765 000024 00000000105 13274207750 017140 0 ustar 00brian staff 000000 000000 See the tests in the t/ directory for examples until I add some more. Test-Manifest-2.021/xt/changes.t 000644 000765 000024 00000000203 13274207750 016671 0 ustar 00brian staff 000000 000000 use Test::More;
eval 'use Test::CPAN::Changes';
plan skip_all => 'Test::CPAN::Changes required for this test' if $@;
changes_ok();
Test-Manifest-2.021/t/include_in_manifest.txt 000644 000765 000024 00000000033 13274207750 021445 0 ustar 00brian staff 000000 000000 99pod.t
01get_test_files.t
Test-Manifest-2.021/t/include.t 000644 000765 000024 00000001710 13274207750 016520 0 ustar 00brian staff 000000 000000 use strict;
use Test::More tests => 4;
use File::Copy qw(copy);
use File::Spec;
use Test::Manifest qw(get_t_files manifest_name);
ok( -e File::Spec->catfile( "t", "include_in_manifest.txt" ),
"Found file I'll include in test_manifest" );
ok( -e 'test_manifest_with_include',
"Found file that I'll copy to test_manifest" );
copy( 'test_manifest_with_include', manifest_name() );
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
my @expected_tests = map { File::Spec->catfile( "t", $_ ) } qw(
00load.t
99pod.t
01get_test_files.t
);
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
my $expected = join " ", @expected_tests;
my $string = get_t_files();
is( $string, $expected, "Single string version of tests is right" );
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
my @files = get_t_files();
is_deeply( \@files, \@expected_tests, "Array version of tests is right" );
Test-Manifest-2.021/t/00load.t 000644 000765 000024 00000000166 13274207750 016160 0 ustar 00brian staff 000000 000000 use Test::More tests => 1;
print "bail out! Test::Manifest could not compile.\n"
unless use_ok( "Test::Manifest" );
Test-Manifest-2.021/t/01get_test_files.t 000644 000765 000024 00000005324 13274207750 020243 0 ustar 00brian staff 000000 000000 use strict;
use Test::More 0.95;
use File::Copy qw(copy);
use File::Spec;
use Test::Manifest qw(get_t_files manifest_name);
my $expected = join " ", map { File::Spec->catfile( "t", $_ ) } qw(
00load.t 01get_test_files.t 01make_test_manifest.t
leading_space.t trailing_space.t
);
my @tests = split /\s+/, $expected;
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
subtest setup => sub {
my $in_name = 'test_manifest';
my $manifest_name = manifest_name();
open my $in, '<:utf8', $in_name or fail( "Could not read $in_name: $!" );
open my $out, '>:utf8', $manifest_name or fail( "Could not write $manifest_name: $!" );
print {$out} $_ while( <$in> );
ok( -e $in_name, "$in_name exists in top level directory" );
ok( -e $manifest_name, "$manifest_name exists" );
};
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
subtest scalar_version => sub {
my $string = get_t_files();
is( $string, $expected, "Single string version of tests is right" );
};
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
subtest array_version => sub {
my @array = get_t_files();
foreach my $i ( 0 .. $#array ) {
is( $array[$i], $tests[$i], "Test file $i has expected name" );
}
};
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
subtest remove_manifest => sub {
local $SIG{__WARN__} = sub { 1 };
if( $^O eq 'VMS' ) { # http://perldoc.perl.org/perlvms.html#unlink-LIST
1 while ( unlink manifest_name() );
}
else {
unlink manifest_name();
}
-e manifest_name() ?
fail( "test_manifest still around after unlink!" ) :
pass( "test_manifest unlinked" ) ;
my $string = get_t_files();
ok( ! $string, "Nothing returned when test_manifest does not exist (scalar)" );
my @array = get_t_files();
ok( ! $string, "Nothing returned when test_manifest does not exist (list)" );
};
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
subtest levels => sub {
local $Test::Harness::verbose = 1;
copy( 'test_manifest_levels', manifest_name() );
my @expected = (
[ qw( 00load.t 01get_test_files.t 01make_test_manifest.t
leading_space.t pod_coverage.t trailing_space.t 99pod.t ) ],
[ qw( 00load.t 01get_test_files.t pod_coverage.t) ],
[ qw( 00load.t 01get_test_files.t 01make_test_manifest.t
pod_coverage.t ) ],
[ qw( 00load.t 01get_test_files.t 01make_test_manifest.t
leading_space.t pod_coverage.t trailing_space.t ) ],
);
foreach my $level ( 0 .. 3 ) {
my $string = get_t_files( $level );
my $expected = join ' ', map { File::Spec->catfile( 't', $_ ) }
@{ $expected[$level] };
is( $string, $expected, "Level $level version of tests is right" );
}
};
done_testing();
Test-Manifest-2.021/t/trailing_space.t 000644 000765 000024 00000000105 13274207750 020056 0 ustar 00brian staff 000000 000000 use Test::More tests => 1;
pass( 'this file must exist for tests' );
Test-Manifest-2.021/t/leading_space.t 000644 000765 000024 00000000105 13274207750 017650 0 ustar 00brian staff 000000 000000 use Test::More tests => 1;
pass( 'this file must exist for tests' );
Test-Manifest-2.021/t/99pod.t 000644 000765 000024 00000000201 13274207750 016033 0 ustar 00brian staff 000000 000000 use Test::More;
eval "use Test::Pod 1.00";
plan skip_all => "Test::Pod 1.00 required for testing POD" if $@;
all_pod_files_ok();
Test-Manifest-2.021/t/test_manifest 000644 000765 000024 00000000230 13274207750 017474 0 ustar 00brian staff 000000 000000 # this is a comment, then a blank line
00load.t
01get_test_files.t
01make_test_manifest.t
leading_space.t
trailing_space.t # comment at end of line Test-Manifest-2.021/t/pod_coverage.t 000644 000765 000024 00000000306 13274207750 017532 0 ustar 00brian staff 000000 000000 use Test::More;
eval "use Test::Pod::Coverage";
if( $@ )
{
plan skip_all => "Test::Pod::Coverage required for testing POD";
}
else
{
plan tests => 1;
pod_coverage_ok( "Test::Manifest" );
}
Test-Manifest-2.021/t/01make_test_manifest.t 000644 000765 000024 00000001154 13274207750 021102 0 ustar 00brian staff 000000 000000 use Test::More 0.98;
use Test::Manifest qw(make_test_manifest manifest_name);
my $test_manifest = manifest_name();
diag( "manifest name is $test_manifest" );
subtest remove_manifest => sub {
if($^O eq 'VMS') { # http://perldoc.perl.org/perlvms.html#unlink-LIST
state $n = 0;
$n++ while ( $n < 10 && unlink $test_manifest );
}
else {
unlink $test_manifest;
}
ok( ! -e $test_manifest, "$test_manifest does not exist" );
};
subtest make_manifest => sub {
my $count = make_test_manifest();
diag( "count of test files is $count" );
ok( -e $test_manifest, "$test_manifest exists" );
};
done_testing();