在 golang 单元测试中模拟特定的错误类型答案

【问题标题】：Mocking specific error types in golang unit tests在 golang 单元测试中模拟特定的错误类型
【发布时间】：2020-12-03 23:24:50
【问题描述】：

我一直致力于处理一些 golang 函数中的软故障，并希望为各种故障场景创建一些单元测试。例如，一些检查包括：

        switch err := err.(type) {
        case net.Error:
                if err.(net.Error).Temporary() || err.(net.Error).Timeout() {
                        ...
                }
        case *url.Error:
                if err, ok := err.Err.(net.Error); ok && err.Timeout() {
                        ...
                }
        case *net.OpError:
                if syscallErr, ok := err.Err.(*os.SyscallError); ok {
                        if syscallErr.Err == syscall.ECONNRESET {
                                ...
                        }
                }
        ...

我相信我只需要我的模拟函数来返回与这些条件兼容的错误。我看到 net.Error、net.OpError、url.Error 和 os.SyscallError 类型已导出。但是，我找不到任何人构造 net.Error 值并返回它的示例——人们投入了大量工作来创建一个以各种方式失败的外部进程，但没有返回带有 Timeout 函数的 net.Error 的示例返回真。

同样，我找不到任何包装不是由 fmt.Errorf 产生的错误的示例，因此我不确定在不使用基本内置错误类型时是否涉及更多的错误。Wrap()。

【问题讨论】：

标签： unit-testing go testing mocking

【解决方案1】：

https://golang.org/pkg/net/#Error 是一个接口，定义Timeout 和Temporary 会很简单，因为它们只是返回bool。

package main

import(
        "fmt"
        "net"
)

type mockNetError struct {
        temporary bool
        timeout bool
}

func (e *mockNetError)Error() string {
        return fmt.Sprintf("mockNetworkError: timeout %b, temporary %b", e.timeout, e.temporary)
}

func (e *mockNetError)Temporary() bool{
        return e.temporary
}

func (e *mockNetError)Timeout() bool{
        return e.timeout
}
func main() {
        var err error = new(mockNetError)
        if nerr, ok := err.(net.Error); ok {
                fmt.Println("It was a network error! %s", nerr.Error())
        }
}

但是，因为net.Error 是一个接口类型，err.(type) 永远不会返回它。在我的代码中，我断言它可能满足该接口，这与询问它是否是err 接口中的值的类型不同。

您在net 中提到的其他错误不是接口（尽管它们确实满足net.Error）。

https://blog.golang.org/go1.13-errors 谈论错误包装在 go 中的工作原理。

约定而不是更改：包含另一个错误的错误可能会实现返回底层错误的 Unwrap 方法。

%w 的原因几乎总是如此，因为人们几乎总是在错误中添加额外的 text。

事实上，net.OsError 是一个错误示例，可以通过提供 Unwrap() 方法来包装另一个错误。

如果你想创建这样的错误，只需：

fmt.Println(net.OpError{
   Op: "mock", 
   Net: "mock",
   Source: &net.TCPAddr{IP: net.ParseIP("127.0.0.1"), Port: 1234 },                
   Addr: &net.TCPAddr{IP: net.ParseIP("127.0.0.1"), Port: 12340 },
   Err: fmt.Errorf("Mock net.OpError"),
})

【讨论】：

从技术上讲，这些测试替身不是模拟，而是存根/伪造，并且比模拟更适合测试。

【解决方案2】：

基于 Daniel Farrell 的回答，我发现了一个模拟 os.SyscallError 的示例，该示例深埋在适用于 Golang 的 AWS 开发工具包中。把它们放在一起，我们得到了：

return nil, &net.OpError{
                Op:     "mock",
                Net:    "mock",
                Source: &net.TCPAddr{IP: net.ParseIP("127.0.0.1"), Port: 1234},
                Addr:   &net.TCPAddr{IP: net.ParseIP("127.0.0.1"), Port: 12340},
                Err:    &os.SyscallError{Syscall: "read", Err: syscall.ECONNRESET},
               }

【讨论】：