File::HomeDir::Test (3)

Leading comments

Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/File::HomeDir::Test.3pm".)

NAME

File::HomeDir::Test - Prevent the accidental creation of user-owned files during testing

SYNOPSIS

  use Test::More test => 1;
  use File::HomeDir::Test;
  use File::HomeDir;

DESCRIPTION

File::HomeDir::Test is a File::HomeDir driver intended for use in the test scripts of modules or applications that write files into user-owned directories.

It is designed to prevent the pollution of user directories with files that are not part of the application install itself, but were created during testing. These files can leak state information from the tests into the run-time usage of an application, and on Unix systems also prevents tests (which may be executed as root via sudo) from writing files which cannot later be modified or removed by the regular user.

SUPPORT

See the support section of the main File::HomeDir documentation.

AUTHOR

Adam Kennedy <adamk@cpan.org>

COPYRIGHT

Copyright 2005 - 2011 Adam Kennedy.

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

The full text of the license can be found in the

file included with this module.