首页 > 文章列表 > 测试依赖项初始化代码的管理技巧

测试依赖项初始化代码的管理技巧

501 2024-04-04
问题内容

我有一个日志包装器(在下面使用 logrus 实现),并且我正在使用这个包来记录我的应用程序。我执行此操作的方法是通过依赖项注入将记录器变量传递给每个所需的包。

在这里,当为每个包编写测试用例时,我必须编写一些代码来初始化记录器包。我们如何避免为每个使用记录器的包的测试用例编写初始化代码?

记录器/log.go

type logger interface {
    info(args ...interface{})
    infof(format string, keyvals ...any)
    infowithfields(fields map[string]interface{}, msg ...interface{})

    debug(args ...interface{})
    debugf(format string, keyvals ...any)
    debugwithfields(fields map[string]interface{}, msg ...interface{})
}

app_test.go

func setupLogrusLogger() (*bytes.Buffer, Logger) {
    buf := &bytes.Buffer{}
    logrusLogger := log.New()
    logrusLogger.Out = buf
    logrusLogger.Formatter = &log.JSONFormatter{}
    return buf, NewLogrusLogger(logrusLogger)
}

func TestSomething(t *testing.T) {
  // buf can be used to inspect what gets logged if required
  buf, logger := setupLogrusLogger()
  Something(logger)
}

在这里,对于每个使用记录器的包,我必须通过定义类似于 setuplogruslogger 的内容来初始化记录器。有什么方法可以避免为我正在为其编写测试的每个包单独编写此内容?


正确答案


导出依赖初始化函数并在非 _test.go 文件中声明,以便其他包可以导入并重用它。如果您想将测试逻辑与包的正常代码分开,您可以将初始化函数移动到提供测试实用程序的包中。

并且,只要您仅从 _test.go 文件(而不是普通文件)导入此类测试实用程序包,测试实用程序代码就不会使其进入实际程序的编译二进制文件中。

此类测试实用程序包的示例可以在标准库中找到:

net/http/httptest

包 httptest 提供了用于 HTTP 测试的实用程序。

net/internal/socktest

socktest 包提供了用于套接字测试的实用程序。

os/exec/internal/fdtest

包 fdtest 提供测试助手,用于跨 exec 使用文件描述符。

testing/quick

Package Quick 实现了实用函数来帮助进行黑盒测试。

testing/fstest

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

testing/iotest

iotest 包实现了主要用于测试的读取器和写入器。