在Go中无需睡眠即可测试异步结果

Z时代
2024-01-10
分类：问答

我的代码中有很多组件具有持久的go例程，这些例程可以侦听事件以触发操作。在大多数情况下，没有理由（测试之外）让他们在完成该操作后发回通知。

但是，我的单元测试正在使用sleep等待这些异步任务完成：

// Send notification event.
mock.devices <- []sparkapi.Device{deviceA, deviceFuncs, deviceRefresh}
// Wait for go-routine to process event.
time.Sleep(time.Microsecond)
// Check that no refresh method was called.
c.Check(mock.actionArgs, check.DeepEquals, mockFunctionCall{})

这似乎是坏事，但我无法提出一种更好的解决方案，该解决方案不会在非测试使用中增加不合理的开销。有没有我错过的合理解决方案？

回答：

Soheil Hassas

Yeganeh的解决方案通常是一个好方法，或者至少是类似的方法。但它是一个变化的API，它可以创建一些开销调用者（虽然不多;调用方不具有

传递一个Done信道，如果主叫方并不需要它）。就是说，在某些情况下，您不需要那种ACK系统。

我强烈建议测试包Gomega解决此类问题。它旨在与Ginkgo一起使用，但可以单独使用。它通过Consistently和Eventually匹配器提供了出色的异步支持。

也就是说，尽管Gomega在非BDD测试系统上运行良好（并且可以很好地集成到中testing），但这是一件相当大的事情，可以成为一项承诺。如果只需要一个，就可以编写自己的版本的断言。不过，我建议您遵循Gomega的方法，该方法是轮询而不是单次睡眠（仍然处于睡眠状态；如果不重新设计API，则无法解决此问题）。

这是在测试中注意事项的方法。您可以创建一个辅助函数，例如：

http://play.golang.org/p/qpdEOsWYh0

const iterations = 10
const interval = time.Millisecond
func Consistently(f func()) {
    for i := 0; i < iterations; i++ {
        f() // Assuming here that `f()` panics on failure
        time.Sleep(interval)
    }
}
mock.devices <- []sparkapi.Device{deviceA, deviceFuncs, deviceRefresh}
Consistently(c.Check(mock.actionArgs, check.DeepEquals, mockFunctionCall{}))

显然，您可以调整迭代次数和间隔以适应您的需求。（Gomega使用1秒钟的超时时间，每10毫秒轮询一次。）

任何实施的弊端Consistently是，无论超时如何，每次测试运行都要吃掉它。但是，实际上没有办法解决。您必须确定足够长的时间才能“不发生”。如果可能的话，最好将您的测试转为检查Eventually，因为这样可以更快地成功。

Eventually有点复杂，因为您需要使用它recover来赶上恐慌，直到成功为止，但这还算不错。像这样：

func Eventually(f func()) {
    for i := 0; i < iterations; i++ {
        if !panics(f) {
            return
        }
        time.Sleep(interval)
    }
    panic("FAILED")
}
func panics(f func()) (success bool) {
    defer func() {
        if e := recover(); e != nil {
            success = true
        }
    }()
    f()
    return
}