Test-Manifest-1.23/0000755000076500000240000000000011230030340013062 5ustar brianstaffTest-Manifest-1.23/Changes0000644000076500000240000000533311230030336014366 0ustar brianstaff1.22_03 - Tue Jul 29 21:14:49 2008 * 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.23 - Fri Jul 17 03:04:38 2009 * Move everything to git and finally make a release 1.22_02 - Thu Jan 24 06:13:13 2008 * File path and unlink fixes for VMS (RT #32061). Let's see if this works. 1.22_01 - Sun Jan 6 14:18:46 2008 * 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 - Sat Oct 27 21:24:10 2007 * distro cleanups after moving from CVS to SVN 1.21 - Wed Sep 19 19:45:27 2007 * [BUGFIX] getting rid of Test::More 1.17 - Thu Feb 22 13:20:23 2007 * Updated to Sourceforge's SVN repository * Dist conforms to META 1.2 spec * No feature changes, so no big hurry to upgrade 1.16 - Tue Aug 29 17:43:16 2006 * 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 - Sat Mar 26 20:55:45 2005 * 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 - Sat Mar 19 12:36:04 2005 * 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 - Sat Sep 25 18:43:38 2004 * This is a release version. It's the same code as 0.95 * Some doc updates 0.95 - Thu Sep 2 15:59:26 2004 * 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 - Fri Feb 20 15:18:23 2004 * some minor tweaks for warnings, clarity * docs show way to make Test::Manifest optional (should have thought of it sooner) 0.92 - Wed Jul 30 14:10:00 2003 * 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 - Wed Dec 11 00:48:55 2002 * require ExtUtils::MakeMaker 6.x so the right run_tests is available 0.9 - Thu Oct 10 00:27:13 EDT 2002 + removed as many dependencies as possible Test-Manifest-1.23/examples/0000755000076500000240000000000011230030337014706 5ustar brianstaffTest-Manifest-1.23/examples/README0000644000076500000240000000010511230030336015561 0ustar brianstaffSee the tests in the t/ directory for examples until I add some more.Test-Manifest-1.23/lib/0000755000076500000240000000000011230030337013636 5ustar brianstaffTest-Manifest-1.23/lib/Manifest.pm0000644000076500000240000001771211230030336015751 0ustar brianstaffpackage Test::Manifest; use strict; use warnings; no warnings; use base qw(Exporter); use vars qw(@EXPORT_OK @EXPORT $VERSION); use Carp qw(carp); use File::Spec::Functions qw(catfile); @EXPORT = qw(run_t_manifest); @EXPORT_OK = qw(get_t_files make_test_manifest manifest_name); $VERSION = '1.23'; my $Manifest = catfile( "t", "test_manifest" ); 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|; }; =head1 NAME Test::Manifest - interact with a t/test_manifest file =head1 SYNOPSIS # in Makefile.PL eval "use Test::Manifest"; # in the file t/test_manifest, list the tests you want # to run =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 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. C overrides the default behaviour by replacing the test_via_harness target in the Makefile. Instead of running at 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 MakeMaker 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 Functions =over 4 =item 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"; =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 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 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 Test::Manifest from reading filenames with the C<;skip> directive. Test::Harness 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 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 =cut sub get_t_files { my $upper_bound = shift; print STDERR "# Test level is $upper_bound\n" if $Test::Harness::verbose; %SeenInclude = (); %SeenTest = (); 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/|; $test = catfile( "t", $test ) if -e catfile( "t", $test ); unless( -e $test ) { 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 t 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"; 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 t/ =cut sub manifest_name { return $Manifest; } =back =head1 SOURCE AVAILABILITY This source is in Github: http://github.com/briandfoy/Test-Manifest/tree/master =head1 CREDITS Matt Vanderpol suggested and supplied a patch for the ;include feature. =head1 AUTHOR brian d foy, C<< >> =head1 COPYRIGHT AND LICENSE Copyright (c) 2002-2009 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. =cut 1; Test-Manifest-1.23/LICENSE0000644000076500000240000000007711230030336014100 0ustar brianstaffYou can use Test::Manifest under the same terms as Perl itself.Test-Manifest-1.23/Makefile.PL0000644000076500000240000000103211230030336015035 0ustar brianstaffuse ExtUtils::MakeMaker; require 5.006; WriteMakefile ( 'NAME' => 'Test::Manifest', 'ABSTRACT' => 'interact with a t/test_manifest file', 'VERSION_FROM' => 'lib/Manifest.pm', 'LICENSE' => 'perl', 'AUTHOR' => 'brian d foy ', 'PREREQ_PM' => { 'Test::More' => '0', 'ExtUtils::MakeMaker' => '6.03', }, 'PM' => { 'lib/Manifest.pm' => '$(INST_LIBDIR)/Manifest.pm', }, 'MAN3PODS' => {}, clean => { FILES => 'Test-Manifest-* t/test_manifest' }, ); Test-Manifest-1.23/MANIFEST0000644000076500000240000000061511230030340014215 0ustar brianstaffChanges examples/README lib/Manifest.pm LICENSE Makefile.PL MANIFEST This list of files README 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/trailing_space.t test_manifest test_manifest_levels test_manifest_with_include META.yml Module meta-data (added by MakeMaker) Test-Manifest-1.23/META.yml0000664000076500000240000000111511230030340014333 0ustar brianstaff--- #YAML:1.0 name: Test-Manifest version: 1.23 abstract: interact with a t/test_manifest file author: - brian d foy license: perl distribution_type: module configure_requires: ExtUtils::MakeMaker: 0 build_requires: ExtUtils::MakeMaker: 0 requires: ExtUtils::MakeMaker: 6.03 Test::More: 0 no_index: directory: - t - inc generated_by: ExtUtils::MakeMaker version 6.50 meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: 1.4 Test-Manifest-1.23/README0000644000076500000240000000074111230030336013751 0ustar brianstaffYou can install this using in the usual Perl fashion: perl Makefile.PL make make test make install The documentation is in the module file. Once you install the file, you can read it with perldoc. perldoc Test::Manifest If you want to read it before you install it, you can use perldoc directly on the module file. perldoc lib/Manifest.pm This module is also in Github http://github.com/briandfoy/Test-Manifest/tree/master Enjoy, brian d foy, bdfoy@cpan.org Test-Manifest-1.23/t/0000755000076500000240000000000011230030337013333 5ustar brianstaffTest-Manifest-1.23/t/00load.t0000644000076500000240000000016611230030336014601 0ustar brianstaffuse Test::More tests => 1; print "bail out! Test::Manifest could not compile.\n" unless use_ok( "Test::Manifest" ); Test-Manifest-1.23/t/01get_test_files.t0000644000076500000240000000423311230030336016662 0ustar brianstaffuse strict; use Test::More tests => 13; use File::Copy qw(copy); use File::Spec; use Test::Manifest qw(get_t_files manifest_name); copy( 'test_manifest', 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; my $string = get_t_files(); is( $string, $expected, "Single string version of tests is right" ); # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # my @array = get_t_files(); foreach my $i ( 0 .. $#array ) { is( $array[$i], $tests[$i], "Test file $i has expected name" ); } # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # { 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)" ); } # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # { local $Test::Harness::verbose = 1; copy( 'test_manifest_levels', manifest_name() ); my @expected = ( [] ); $expected[1] = [ qw( 00load.t 01get_test_files.t pod_coverage.t) ]; $expected[2] = [ qw( 00load.t 01get_test_files.t 01make_test_manifest.t pod_coverage.t ) ]; $expected[3] = [ qw( 00load.t 01get_test_files.t 01make_test_manifest.t leading_space.t pod_coverage.t trailing_space.t ) ]; $expected[0] = [ qw( 00load.t 01get_test_files.t 01make_test_manifest.t leading_space.t pod_coverage.t trailing_space.t 99pod.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" ); } } Test-Manifest-1.23/t/01make_test_manifest.t0000644000076500000240000000064111230030336017523 0ustar brianstaffuse Test::More tests => 2; use Test::Manifest qw(make_test_manifest); my $test_manifest = File::Spec->catfile( qw(t test_manifest) ); if($^O eq 'VMS') # http://perldoc.perl.org/perlvms.html#unlink-LIST { 1 while ( unlink $test_manifest ); } else { unlink $test_manifest; } ok( ! -e $test_manifest, 'test_manifest does not exit' ); make_test_manifest(); ok( -e $test_manifest, 'test_manifest exists' ); Test-Manifest-1.23/t/99pod.t0000644000076500000240000000020111230030336014454 0ustar brianstaffuse 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-1.23/t/include.t0000644000076500000240000000171411230030336015145 0ustar brianstaffuse 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-1.23/t/include_in_manifest.txt0000644000076500000240000000003211230030336020065 0ustar brianstaff99pod.t 01get_test_files.tTest-Manifest-1.23/t/leading_space.t0000644000076500000240000000010411230030336016270 0ustar brianstaffuse Test::More tests => 1; pass( 'this file must exist for tests' );Test-Manifest-1.23/t/pod_coverage.t0000644000076500000240000000031411230030336016152 0ustar brianstaffuse 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-1.23/t/trailing_space.t0000644000076500000240000000010411230030336016476 0ustar brianstaffuse Test::More tests => 1; pass( 'this file must exist for tests' );Test-Manifest-1.23/test_manifest0000644000076500000240000000023011230030336015652 0ustar brianstaff# 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 lineTest-Manifest-1.23/test_manifest_levels0000644000076500000240000000030711230030336017231 0ustar brianstaff# 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-1.23/test_manifest_with_include0000644000076500000240000000005311230030336020413 0ustar brianstaff00load.t ;include t/include_in_manifest.txt