比较 Go 单元测试中的 2 个错误

Question

我遇到了如下问题：编写单元测试时比较 2 个错误

package main

import (
    "errors"
    "fmt"
    "reflect"
    
    "github.com/google/go-cmp/cmp"
    "github.com/google/go-cmp/cmp/cmpopts"
)

func main() {
    er1 := errors.New("database name is not exists")
    er2 := errors.New("database name is not exists")
    
    result1 := reflect.DeepEqual(er1, er2)
    fmt.Println("reflect: ", result1)
    
    result2 := cmp.Equal(er1, er2, cmpopts.EquateErrors())
    fmt.Println("compare: ", result2)
    
    result3 := errors.Is(er1, er2)
    fmt.Println("errorIs: ", result3)
}

上面代码的输出是：

reflect:  true
compare:  false
errorIs:  false

我想比较 2 个错误，这reflect.DeepEqual(er1, er2)是我应用的第一种方法，此方法产生我想要的输出，但此方法有一个警告go lint：

avoid using reflect.DeepEqual with errorsdeepequalerrors

经过谷歌搜索，有人告诉我一些方法：

• 使用cmp包进行比较：cmp.Equal(er1, er2, cmpopts.EquateErrors())
• 使用errors包来比较：errors.Is(er1, er2)

但是上述两种方法都不能产生与第一种方法相同的结果（使用reflect.DeepEqual）。我如何在没有警告的情况下比较两个错误并产生像 Tksgo lint这样的结果reflect.DeepEqual

Answer 1

根据您编写测试的方式，您可能会依赖reflect.DeepEqual()并忽略 linter 警告；
缺点是：您开始依赖于您返回的错误的内部结构。

在我们编写的测试代码中，我们使用以下模式之一：

• 大多数时候，我们只是将误差与 ; 进行比较nil；
• 在某些情况下，我们的函数返回预定义的错误值，并且我们测试这些特定值：

package pkg

var ErrUnboltedGizmo = errors.New("gizmo is unbolted")

// in test functions, depending on the case :
if err == pkg.ErrUnboltedGizmo { ...
// or :
if errors.Is(err, pkg.ErrUnboltedGizmo) { ...

• 当我们的生产代码要求发现特定错误时（常见的用例是io.EOF），我们编写代码来尽职地包装该已知错误，并使用errors.Is()（在生产代码和测试代码中），
• 当仅在测试中需要松散地确认错误与某些内容匹配而不是其他内容（例如 :Parse error和 not File not found）时，我们只需在错误消息中搜索字符串：

if err == nil || !strings.Contains(err.Error(), "database name is not exists") {
    t.Errorf("unexpected error : %s", err)
}