package fstest
import "testing/fstest"
fstest 包实现对文件系统实现和用户的测试支持。
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
Functions
func TestFS
func TestFS(fsys fs.FS, expected ...string) error
TestFS 测试一个文件系统实现。 它会遍历 fsys 中的整个文件树, 打开并检查每个文件的行为是否正确。 不会跟随符号链接, 但如果文件系统实现了 fs.ReadLinkFS, 则会检查它们的 Lstat 值。 它还会检查文件系统至少包含预期的文件。 作为一种特殊情况,如果未列出任何预期文件,则 fsys 必须为空。 否则,fsys 必须至少包含所列出的文件;它也可以包含其他文件。 fsys 的内容不得在 TestFS 运行时并发更改。
如果 TestFS 发现任何不当行为,它会返回第一个错误或 一个错误列表。可使用 errors.Is 或 errors.AsType 进行检查。
在测试中的典型用法是:
if err := fstest.TestFS(myFS, "file/that/should/be/present"); err != nil {
t.Fatal(err)
}
Types
type MapFS
type MapFS map[string]*MapFile
MapFS 是一个用于测试的简单内存文件系统, 表示为从路径名(Open 的参数)到 其所代表的文件、目录或符号链接信息的映射。
映射无需包含映射内文件的父目录; 这些父目录会在需要时被合成。 但通过设置 MapFile.Mode 的 fs.ModeDir 位仍可包含一个目录; 这对于对目录的 fs.FileInfo 进行详细控制 或创建一个空目录可能是必要的。
文件系统操作直接读取该映射, 因此可以按需编辑映射来更改文件系统。 一个推论是:文件系统操作不得与映射的更改 并发运行,否则会产生数据竞争。 另一个推论是:打开或读取目录需要 遍历整个映射,因此 MapFS 通常应仅用于 不超过几百个条目或目录读取的场景。
func (MapFS) Glob
func (fsys MapFS) Glob(pattern string) ([]string, error)
func (MapFS) Lstat
func (fsys MapFS) Lstat(name string) (fs.FileInfo, error)
Lstat 返回描述指定名称文件的 FileInfo。 如果该文件是符号链接,则返回的 FileInfo 描述该符号链接。 Lstat 不尝试跟随该链接。
func (MapFS) Open
func (fsys MapFS) Open(name string) (fs.File, error)
Open 在跟随任何符号链接后打开指定名称的文件。
func (MapFS) ReadDir
func (fsys MapFS) ReadDir(name string) ([]fs.DirEntry, error)
func (MapFS) ReadFile
func (fsys MapFS) ReadFile(name string) ([]byte, error)
func (MapFS) ReadLink
func (fsys MapFS) ReadLink(name string) (string, error)
ReadLink 返回指定名称符号链接的目标。
func (MapFS) Stat
func (fsys MapFS) Stat(name string) (fs.FileInfo, error)
func (MapFS) Sub
func (fsys MapFS) Sub(dir string) (fs.FS, error)
type MapFile
type MapFile struct { Data []byte // 文件内容或符号链接目标 Mode fs.FileMode // fs.FileInfo.Mode ModTime time.Time // fs.FileInfo.ModTime Sys any // fs.FileInfo.Sys }
MapFile 描述 MapFS 中的单个文件。