fstest

原文：https://pkg.go.dev/testing/fstest@go1.23.0

Package fstest implements support for testing implementations and users of file systems.

​ fstest包实现了用于测试文件系统实现和用户的支持。

常量

This section is empty.

变量

This section is empty.

函数

func TestFS

1

func TestFS(fsys fs.FS, expected ...string) error

TestFS tests a file system implementation. It walks the entire tree of files in fsys, opening and checking that each file behaves correctly. 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.

​ TestFS函数测试文件系统实现。它遍历fsys中的所有文件树，打开并检查每个文件是否正确。它还检查文件系统至少包含所需的文件。特殊情况是，如果没有列出所需的文件，则fsys必须为空。否则，fsys必须至少包含所列出的文件；它也可以包含其他文件。fsys的内容不能与TestFS函数并发更改。

If TestFS finds any misbehaviors, it returns an error reporting all of them. The error text spans multiple lines, one per detected misbehavior.

​ 如果TestFS函数发现任何不良行为，它将返回一个报告所有不良行为的错误。错误文本跨多行，每行报告一个检测到的不良行为。

Typical usage inside a test is:

​ 在测试内部的典型用法是：

1
2
3

if err := fstest.TestFS(myFS, "file/that/should/be/present"); err != nil {
	t.Fatal(err)
}

类型

type MapFS

1

type MapFS map[string]*MapFile

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 or directories they represent.

​ MapFS是一个简单的内存文件系统，用于测试，表示为从路径名(Open的参数)到有关它们所表示的文件或目录的信息的映射。

The map need not include parent directories for files contained in the map; those will be synthesized if needed. But a directory can still be included by setting the MapFile.Mode’s ModeDir bit; this may be necessary for detailed control over the directory’s FileInfo or to create an empty directory.

​ 该映射不必包括包含在映射中的文件的父目录；如果需要，这些父目录将被合成。但是，可以通过设置MapFile.Mode的ModeDir位来包括目录；这可能是对目录的FileInfo进行详细控制或创建空目录所必需的。

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 concurrently with changes to the map, which would be a race. Another implication is that opening or reading a directory requires iterating over the entire map, so a MapFS should typically be used with not more than a few hundred entries or directory reads.

​ 文件系统操作直接从映射中读取，因此可以通过编辑映射来更改文件系统。一个含义是文件系统操作不能与对映射的更改同时运行，这将导致竞争。另一个含义是打开或读取目录需要迭代整个映射，因此MapFS通常应仅用于少于几百个条目或目录读取的情况。

(MapFS) Glob

1

func (fsys MapFS) Glob(pattern string) ([]string, error)

(MapFS) Open

1

func (fsys MapFS) Open(name string) (fs.File, error)

Open opens the named file.

(MapFS) ReadDir

1

func (fsys MapFS) ReadDir(name string) ([]fs.DirEntry, error)

(MapFS) ReadFile

1

func (fsys MapFS) ReadFile(name string) ([]byte, error)

(MapFS) Stat

1

func (fsys MapFS) Stat(name string) (fs.FileInfo, error)

(MapFS) Sub

1

func (fsys MapFS) Sub(dir string) (fs.FS, error)

type MapFile

1
2
3
4
5
6

type MapFile struct {
	Data    []byte      // file content
	Mode    fs.FileMode // FileInfo.Mode
	ModTime time.Time   // FileInfo.ModTime
	Sys     any         // FileInfo.Sys
}

A MapFile describes a single file in a MapFS.

​ MapFile描述MapFS中的单个文件。