DOC HOME SITE MAP MAN PAGES GNU INFO SEARCH
 

Test::Portability::Files



NAME

Test::Portability::Files - Check file names portability


VERSION

Version 0.05


SYNOPSIS

    use Test::More;
    eval "use Test::Portability::Files";
    plan skip_all => "Test::Portability::Files required for testing filenames portability" if $@;
    options(all_tests => 1);  # to be hyper-strict
    run_tests();


DESCRIPTION

This module is used to check the portability across operating systems of the names of the files present in the distribution of a module. The tests use the advices given in Files and Filesystems in the perlport manpage. The author of a distribution can select which tests to execute.

To use this module, simply copy the code from the synopsis in a test file named t/portfs.t for example, and add it to your MANIFEST. You can delete the call to options() to enable only most common tests.

By default, not all tests are enabled because some are judged too cumbersome to be practical, especially since some of the most limited platforms (like MS-DOS) seem to be no longer supported. Here are the default options:

To change any option, please see options().


EXPORT

The following functions are exported:


FUNCTIONS

options()

Set the module options, in particular, select which tests to execute. Expects a hash.

General options

Tests

Example

    options(use_file_find => 1, all_tests => 1);

selects all tests and runs them against all files found using File::Find.

test_name_portability()

Test the portability of the given file name.

run_tests()

Execute the tests selected by options().


SEE ALSO

the perlport manpage


AUTHOR

Sébastien Aperghis-Tramoni, <sebastien@aperghis.net>


BUGS

Please report any bugs or feature requests to bug-test-portability-files@rt.cpan.org, or through the web interface at http://rt.cpan.org. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.


COPYRIGHT & LICENSE

Copyright 2004 Sébastien Aperghis-Tramoni, All Rights Reserved.

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