如何为 REST 服务生成代码覆盖率

Question

我想获得用 Go 编写的 REST 服务的测试覆盖率。我通过 goroutine 生成 REST 服务，然后使用 REST 客户端发出 HTTP 请求，并查看 HTTP 响应。 测试成功通过，但 go test -cover 返回 0% 的测试覆盖率。 有没有办法获得 go lang REST 服务中使用的所有包的实际测试覆盖率。

我的测试文件： main_test.go

import (
    "testing"
)

// Test started when the test binary is started. Only calls main.
func TestSystem(t *testing.T) {
    go main()    // Spinning up the go lang REST server in a separate go routine.
    http.Post("https://localhost/do_something")
}

我的输出：

go test -cover  main_test.go
ok      command-line-arguments  0.668s  coverage: 0.0% of statements 

Answer 1

前言

这不可能是涵盖所有情况的完整答案。

这是试图解释如何从 OP 解释的内容中获得零覆盖率。

测试自己

测试成功通过，但 go test -cover 返回 0% 的测试覆盖率。

1. 使用go main() 内部Test-function 启动服务
2. 尝试http.Post 提供服务而不检查错误并且响应不是nil
3. 测试期间没有恐慌，因此测试通过

测试中的问题

1. 不保证服务在http.Post 尝试之前实际启动
2. http.Post 的结果未被检查

第一个问题：

• 坏/脏解决方案：在go main() 之后添加time.Sleep
• 良好/干净的解决方案：仪器服务具有某种信号/监控服务循环已启动

第二个问题：

看看这样的测试函数：

func TestPost(t *testing.T) {
    var b bytes.Buffer
    http.Post("http:/inexistent.com/inexistent-url", "", &b)
    t.Log("No problems!")
}

此测试将始终通过。因为它只测试不存在恐慌。

为了让这个测试更正确：

func TestPost(t *testing.T) {
    var b bytes.Buffer
    if _, err:= http.Post("http:/inexistent.com/inexistent-url", "", &b); err!=nil{
    t.Errorf("http.Post : %v", err)
}

建议

1. 查看http.Post结果
2. 检查测试服务是否实际启动

Answer 2

感谢大家的回复。 我可以通过-coverpkg 获得覆盖。 不知道究竟是什么解决了下面的问题是@Flimzy 建议的对我有用的几个更改 1. 将 REST 服务器初始化代码从 main 移至函数。然后在测试用例中启动 REST 服务器，并通过向通道发送消息来优雅地终止它

    channel := make(chan error) // create a channel will listen for error
    go func(channel chan error) {
        inithandler.InitRestServer(channel, )
        _ = <-channel // terminate the channel
    }(channel)
http.Post("https://localhost/do_something") // call the endpoint and resp verification
.
.
channel <- errors.New("stop")

使用 -coverpkg 触发测试

go test main_test.go -cover -coverpkg ./...

Answer 3

不管根本原因是什么，我认为这里的一般方法存在问题。

我建议你在这里测试的一些东西不是你的代码，你不应该打扰。你不需要其实测试http协议和http包吧？

所以我过去处理这个问题的方式是将我想要测试的有意义的代码从 http 处理程序函数中分离出来。 http 处理程序应该只负责验证输入，调用实际业务逻辑，然后格式化输出。

以这种方式分解代码后，您可以直接从测试中调用有意义的函数。您的 http 处理程序函数应该非常简单，以至于没有任何 bug 潜伏的地方。

不要寻求 100% 的测试覆盖率。测试什么是重要的。