Test::Virtual::Filesystem - Validate a filesystem
use Test::Virtual::Filesystem;
Test::Virtual::Filesystem->new('/path/to/test')->runtests;
or with more customization:
use Test::Virtual::Filesystem;
my $test = Test::Virtual::Filesystem->new('/path/to/test');
$test->test_xattr(1);
$test->test_chown(1);
$test->test_atime(1);
$test->runtests;
Copyright 2007 Chris Dolan, cdolan@cpan.org
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
If you are creating a filesystem, say via Fuse or Filesys::Virtual, you need a fairly mundane set of tests to try out lots of typical filesystem operations. This package attempts to accumulate a bunch of those tests to make it easier for you to test your filesystem.
Every time we add a new test to this suite, we annotate it with a version number. If client code specifies an expected version number (say, 1.10) and it's running against a newer version or this module (say, 1.20) then any newer test will be marked as a TODO test. That way if the test fails, it won't regress published code that used to work.
This policy will allow us to continue adding new filesystem tests without worrying about breaking existing CPAN modules.
This test class needs a more complete suite of test cases. In particular, tests are needed for the following filesystem features:
extended attributes (xattr)
multiple symlinks
recursive symlinks
hardlinks
a/u/ctime
nlink
chown
deep directories
very full directories
large files
binary files
files with awkward characters: EOF, NUL
non-ASCII filenames (maybe constructor should specify the encoding?)
permissions
special file types (fifos, sockets, character and block devices, etc)
file locking
threading and re-entrancy
truncate
binmode
eof
fileno
seek/rewinddir, tell/telldir
read, sysread, syswrite
async I/O?
Any help writing tests (or adapting tests from existing suites) will be appreciated!
This is a subclass of Test::Class. All methods from that class are available, particularly runtests().
Create a new test which will operate on files contained within the specified mount directory. WARNING: any and all files and folders in that mount directory will be deleted!
The supported options are:
mountdirThis required property indicates where tests should run.
compatibleSpecify a Test::Virtual::Filesystem version number that is known to work. If the actual Test::Virtual::Filesystem version number is greater, then any test cases added after the specified compatible version are considered TODO tests. See Test::More for details about TODO tests.
Invoked just before then end of new(). This exists solely for subclassing convenience. This implementation does nothing.
The following accessor/mutator methods exist to turn on/off various features. they all behave in usual Perl fashion: with no argument, they return the current value. With one argument, they set the current value and return void.
Turns on all the tests. Default false.
Default false.
Default true. If set false, it also sets atime, ctime and utime false.
Default false.
Default true.
Default true.
Default false.
Default true. If set false, it also sets fifo false.
Default false. AKA named pipes.
Default true, except $^O eq 'MSWin32' where it defaults to false.
Default true.
Default true.
Default false.
Runs before every test to prepare a directory for testing.
Runs after every test to clean up the test directory so the next test will have a clean workspace.
A subroutine attribute used to flag the Test::Virtual::Filesystem version number when that test was introduced. It's used like this:
sub open_nonexistent_file : Tests(1) : Introduced('0.02') {
ok(!open(my $f, '<', '/tmp/no_such_file'));
}
This is a subroutine attribute to specify one or more features used in the test. The features should be listed as a comma-separated list:
sub symlink_create : Tests(1) : Features('symlink') {
ok(symlink($src, $dest));
}
sub symlink_permissions : Tests(2) : Features('symlink, permissions') {
ok(symlink($src, $dest));
ok(-w $dest);
}
Subfeatures must be separated from their parent features by a /. For example:
sub atime_utime_set : Tests(1) : Features('time/atime, time/utime') {
my $now = time;
ok(utime($now, $now, $file));
}
Look at the source code for new() to see the supported features and subfeatures. The test_* methods above describe the all the features, but in those methods the subfeature names are flattened.
Chris Dolan, cdolan@cpan.org
