对 Go 单元测试中的 2 个错误进行对比

在 Go 单元测试中，比较两个错误通常需要考虑避免 lint 警告和生成与 reflect.DeepEqual 类似的结果。可以使用 cmp 包中的 cmp.equal 函数，搭配 cmpopts.equateerrors 选项，或 errors 包中的 errors.is 函数进行比较。但这些方法可能产生与 reflect.DeepEqual 不同的结果。对于需要在测试中宽松确认错误与特定内容匹配的情况，可以使用字符串包含或 cmp.diff 搭配 cmpopts.ignorefields 忽略导致问题字段的方法。

我遇到了如下问题：编写单元测试时比较 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）。 如何在没有来自 go lint 警告的情况下比较 2 个错误并生成类似 reflect.deepequal 的结果 谢谢

正确答案

根据您编写测试的方式，您可能依赖 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 而不是 file not found），我们只需在错误消息中搜索字符串即可：

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

我发现有用的是使用 cmp.diff 和 cmpopts.ignorefields 来忽略导致问题的具体错误字段，然后我只需使用 string.contains 或我认为合适的任何内容来检查错误。

事情是这样的：

if diff := cmp.Diff(expected, got, cmpopts.IgnoreFields(expected, "ErrorField")); diff != "" { 
          // found diff not including the error
}

现在只检查它们自己的错误，仅此而已。

是的，我知道你已经标记了一个解决方案，但也许它会对某人有所帮助:)

理论要掌握，实操不能落！以上关于《对 Go 单元测试中的 2 个错误进行对比》的详细介绍，大家都掌握了吧！如果想要继续提升自己的能力，那么就来关注golang学习网公众号吧！