Go中怎么测试文件系统？（附示例代码）

本篇文章给大家分享《Go中怎么测试文件系统？（附示例代码）》，覆盖了Golang的常见基础知识，其实一个语言的全部知识点一篇文章是不可能说完的，但希望通过这些问题，让读者对自己的掌握程度有一定的认识(B 数)，从而弥补自己的不足，更好的掌握它。

问题内容

我正在尝试为将与文件系统交互的函数编写单元测试，并且我希望能够在测试期间模拟文件系统。

[下面的代码是这个](https://stackoverflow.com/questions/16742331/how-to-mock-abstract- filesystem-in-go)问题的答案，您可以在其中创建一个文件系统接口以在测试期间使用，但我是 Go 新手，正在努力弄清楚如何使用它。

有人可以提供一个如何在测试中使用这个接口的例子吗？

var fs fileSystem = osFS{}

type fileSystem interface {
    Open(name string) (file, error)
    Stat(name string) (os.FileInfo, error)
}

type file interface {
    io.Closer
    io.Reader
    io.ReaderAt
    io.Seeker
    Stat() (os.FileInfo, error)
}

// osFS implements fileSystem using the local disk.
type osFS struct{}

func (osFS) Open(name string) (file, error)        { return os.Open(name) }
func (osFS) Stat(name string) (os.FileInfo, error) { return os.Stat(name) }

正确答案

一件重要的事情你不能忘记：你只能模拟文件系统，如果与文件系统交互的代码通过上述文件系统接口filesystem（更改，例如传递的参数）。fs``filesystem``fs

让我们看看这样一个示例函数：

func getSize(name string) (int64, error) {
    stat, err := fs.Stat(name)
    if err != nil {
        return 0, err
    }
    return stat.Size(), nil
}

这个简单getSize()的函数返回由其名称指定的文件的大小，如果filesystem.Stat()失败则返回错误（返回错误）。

现在让我们编写一些完全涵盖此getSize()功能的单元测试。

我们需要什么

我们需要一个 , 的模拟版本filesystem，以便它实际上不与文件系统交互，但在filesystem调用 的方法时返回合理的数据（filesystem.Stat()在我们的例子中）。为了最简单的模拟filesystem（或任何接口），我们将嵌入filesystem我们的mockedFS，因此我们“继承”它的所有方法，我们只需要模拟可测试代码实际使用的内容。请注意，调用其他方法会导致运行时恐慌，因为我们不会真正给nil这个嵌入的一个合理的、非值的filesystem，但为了测试，它是不需要的。

由于filesystem返回一个值os.FileInfo（除了一个错误），它是一个接口（并且它的实现不是从os包中导出的），我们还需要模拟os.FileInfo. 这将是mockedFileInfo，我们将非常类似于模拟filesystem：我们将嵌入接口类型os.FileInfo，所以实际上我们只需要实现，因为这是可测试函数FileInfo.Size()调用的唯一方法。getSize()

准备/设置模拟文件系统

一旦我们有了模拟类型，我们就必须设置它们。由于getSize()使用全局fs变量与文件系统进行交互，我们需要为mockedFS这个全局fs变量分配一个我们的值。在这样做之前，建议保存它的旧值，并在我们完成测试后正确恢复旧值：“清理”。

由于我们完全想要测试getSize()（包括错误情况），因此我们mockedFS拥有控制它是否应该返回错误的能力，以及告诉它在我们不想要任何错误时返回什么的能力。

在进行测试时，我们可以操纵 的“状态”mockedFS以使其行为符合我们的需要。

和测试（ing）代码

废话不多说，完整的测试代码：

type mockedFS struct {
    // Embed so we only need to "override" what is used by testable functions
    osFS

    reportErr  bool  // Tells if this mocked FS should return error in our tests
    reportSize int64 // Tells what size should Stat() report in our test
}

type mockedFileInfo struct {
    // Embed this so we only need to add methods used by testable functions
    os.FileInfo
    size int64
}

func (m mockedFileInfo) Size() int64 { return m.size }

func (m mockedFS) Stat(name string) (os.FileInfo, error) {
    if m.reportErr {
        return nil, os.ErrNotExist
    }
    return mockedFileInfo{size: m.reportSize}, nil
}

func TestGetSize(t *testing.T) {
    oldFs := fs
    // Create and "install" mocked fs:
    mfs := &mockedFS{}
    fs = mfs
    // Make sure fs is restored after this test:
    defer func() {
        fs = oldFs
    }()

    // Test when filesystem.Stat() reports error:
    mfs.reportErr = true
    if _, err := getSize("hello.go"); err == nil {
        t.Error("Expected error, but err is nil!")
    }

    // Test when no error and size is returned:
    mfs.reportErr = false
    mfs.reportSize = 123
    if size, err := getSize("hello.go"); err != nil {
        t.Errorf("Expected no error, got: %v", err)
    } else if size != 123 {
        t.Errorf("Expected size %d, got: %d", 123, size)
    }
}

今天带大家了解了golang的相关知识，希望对你有所帮助；关于Golang的技术知识我们会一点点深入介绍，欢迎大家关注golang学习网公众号，一起学习编程~