fstest
packagestandard libraryThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Overview¶
Package fstest implements support for testing implementations and users of file systems.
Index¶
- func TestFS(fsys fs.FS, expected ...string) error
- type MapFS
- func (fsys MapFS) Glob(pattern string) ([]string, error)
- func (fsys MapFS) Lstat(name string) (fs.FileInfo, error)
- func (fsys MapFS) Open(name string) (fs.File, error)
- func (fsys MapFS) ReadDir(name string) ([]fs.DirEntry, error)
- func (fsys MapFS) ReadFile(name string) ([]byte, error)
- func (fsys MapFS) ReadLink(name string) (string, error)
- func (fsys MapFS) Stat(name string) (fs.FileInfo, error)
- func (fsys MapFS) Sub(dir string) (fs.FS, error)
- type MapFile
Constants¶
This section is empty.
Variables¶
This section is empty.
Functions¶
funcTestFS¶
TestFS tests a file system implementation.It walks the entire tree of files in fsys,opening and checking that each file behaves correctly.Symbolic links are not followed,but their Lstat values are checkedif the file system implementsfs.ReadLinkFS.It also checks that the file system contains at least the expected files.As a special case, if no expected files are listed, fsys must be empty.Otherwise, fsys must contain at least the listed files; it can also contain others.The contents of fsys must not change concurrently with TestFS.
If TestFS finds any misbehaviors, it returns either the first error or alist of errors. Useerrors.Is orerrors.As to inspect.
Typical usage inside a test is:
if err := fstest.TestFS(myFS, "file/that/should/be/present"); err != nil {t.Fatal(err)}
Types¶
typeMapFS¶
A MapFS is a simple in-memory file system for use in tests,represented as a map from path names (arguments to Open)to information about the files, directories, or symbolic links they represent.
The map need not include parent directories for files containedin the map; those will be synthesized if needed.But a directory can still be included by setting the [MapFile.Mode]'sfs.ModeDir bit;this may be necessary for detailed control over the directory'sfs.FileInfoor to create an empty directory.
File system operations read directly from the map,so that the file system can be changed by editing the map as needed.An implication is that file system operations must not run concurrentlywith changes to the map, which would be a race.Another implication is that opening or reading a directory requiresiterating over the entire map, so a MapFS should typically be used with not morethan a few hundred entries or directory reads.
func (MapFS)Lstat¶added ingo1.25.0
Lstat returns a FileInfo describing the named file.If the file is a symbolic link, the returned FileInfo describes the symbolic link.Lstat makes no attempt to follow the link.