Manifest(3) User Contributed Perl Documentation Manifest(3)NAMETest::Manifest - interact with a t/test_manifest file
SYNOPSIS
# in Makefile.PL
eval "use Test::Manifest";
# in the file t/test_manifest, list the tests you want
# to run
DESCRIPTION
Test::Harness assumes that you want to run all of the .t files in the
t/ directory in ascii-betical order during "make test" unless you say
otherwise. This leads to some interesting naming schemes for test
files to get them in the desired order. This interesting names ossify
when they get into source control, and get even more interesting as
more tests show up.
Test::Manifest overrides the default behaviour by replacing the
test_via_harness target in the Makefile. Instead of running at the
t/*.t files in ascii-betical order, it looks in the t/test_manifest
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 MakeMaker to do
the right thing.
In t/test_manifest, 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 #, just like in Perl, and Test::Manifest will strip
leading and trailing whitespace from each line. It also checks that
the specified file is actually in the t/ directory. If the file does
not exist, it does not put its name in the list of test files to run.
Optionally, you can add a number after the test name in test_manifest
to define sets of tests. See get_t_files() for more information.
Functions
run_t_manifest( TEST_VERBOSE, INST_LIB, INST_ARCHLIB, TEST_LEVEL )
Run all of the files in t/test_manifest through
Test::Harness:runtests in the order they appear in the file.
eval "use Test::Manifest";
get_t_files( [LEVEL] )
In scalar context it returns a single string that you can use
directly in WriteMakefile(). In list context it returns a list of
the files it found in t/test_manifest.
If a t/test_manifest file does not exist, get_t_files() returns
nothing.
get_t_files() warns you if it can't find t/test_manifest, or if
entries start with "t/". It skips blank lines, and strips Perl
style comments from the file.
Each line in t/test_manifest 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, get_t_files() 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 ";" to distinguish it from
a true filename. The filename (currently) is relative to the
current working directory, unlike the filenames, which are relative
to "t/". The filenames in the included are still relative to "t/".
;include t/file_with_other_test_names.txt
Also experimentally, you can stop Test::Manifest from reading
filenames with the ";skip" directive. Test::Harness will skip the
filenames up to the ";unskip" directive (or end of file)
run_this1
;skip
skip_this
;unskip
run_this2
To select sets of tests, specify the level in the variable
TEST_LEVEL during `make test`.
make test # run all tests no matter the level
make test TEST_LEVEL=2 # run all tests level 2 and below
make_test_manifest()
Creates the test_manifest file in the t directory by reading the
contents of the t directory.
TO DO: specify tests in argument lists.
TO DO: specify files to skip.
manifest_name()
Returns the name of the test manifest file, relative to t/
SOURCE AVAILABILITY
This source is part of a SourceForge project which always has the
latest sources in CVS, as well as all of the previous releases.
http://sourceforge.net/projects/brian-d-foy/
If, for some reason, I disappear from the world, one of the other
members of the project can shepherd this module appropriately.
CREDITS
Matt Vanderpol suggested and supplied a patch for the ;include feature.
AUTHOR
brian d foy, "<bdfoy@cpan.org>"
COPYRIGHT AND LICENSE
Copyright (c) 2002-2007 brian d foy. All rights reserved.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
perl v5.14.1 2007-10-28 Manifest(3)
