mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
Stephan BehnkeandGitHub
4db423e1bb
## What changed? Introduces `common/testing/await`, a polling-based test helper that replaces testify's `Eventually` / `EventuallyWithT`. ## Why? From the [package doc](https://github.com/temporalio/temporal/blob/stephanos/all-require/common/testing/await/await.go): ``` Improvements over testify's eventually functions: - Misuse detection: accidentally using the real *testing.T (e.g. s.T() or suite assertion methods) instead of the callback's collect T is a common mistake. This package detects it and fails with a clear message. - Safer bool predicates: unlike testify's Eventually, [RequireTrue] only accepts func() bool, so returning false is the sole retry signal. If the predicate accidentally marks the real test failed, it reports that immediately instead of polling until timeout. - Timeout-aware callbacks: callbacks receive a context derived from the parent context and canceled when the await timeout or test deadline is reached, so RPCs and blocking waits can exit instead of continuing after the retry window has expired. - Panic propagation: if the condition panics (e.g. nil dereference), the panic is propagated immediately rather than being silently swallowed or retried until timeout. See https:github.com/stretchr/testify/issues/1810 - Bounded goroutine lifetime: each attempt completes before the next starts, avoiding the overlapping-attempt data races and "panic: Fail in goroutine after Test has completed" crashes seen with testify's Eventually. See https:github.com/stretchr/testify/issues/1611 - Deadlock detection: a condition that ignores t.Context() is abandoned after a grace period, producing a clear "does it honor t.Context()?" failure instead of hanging until go test -timeout. - Condition always runs: testify's Eventually can fail without ever running the condition due to a timer/ticker race with short timeouts. This package runs the condition immediately on the first iteration. See https://github.com/stretchr/testify/issues/1652 ``` The upstream fix ([testify#1657](https://github.com/stretchr/testify/pull/1657)) aims to address several of these but has been open since Oct 2024 without merging. ## How did you test it? - [ ] built - [ ] run locally and tested manually - [x] covered by existing tests - [x] added new unit test(s) - [ ] added new functional test(s) ## Potential risks The biggest downside is that it adds more code that we own. But apart from any unknown bugs, this package should rarely/never change.
37 lines
1.3 KiB
Go
37 lines
1.3 KiB
Go
package await
|
|
|
|
import (
|
|
"fmt"
|
|
"testing"
|
|
"time"
|
|
|
|
"go.temporal.io/server/common/testing/testcontext"
|
|
)
|
|
|
|
const requireTrueMisuseHint = "do not use test assertions inside the predicate - return false to retry or use await.Require for assertions"
|
|
|
|
// RequireTrue runs `condition` repeatedly until it returns true, or until the
|
|
// timeout expires. The timeout is capped at the test's deadline, if one is set.
|
|
//
|
|
// Use [RequireTrue] for simple local predicates only. Do not use assertions or
|
|
// side effects in the predicate - use [Require] for these.
|
|
func RequireTrue(tb testing.TB, condition func() bool, timeout, pollInterval time.Duration) {
|
|
tb.Helper()
|
|
run(testcontext.New(tb), tb, func(t *T) {
|
|
if !condition() {
|
|
t.Fail()
|
|
}
|
|
}, timeout, pollInterval, "", "RequireTrue", requireTrueMisuseHint, false)
|
|
}
|
|
|
|
// RequireTruef is like [RequireTrue] but accepts a format string that is included
|
|
// in the failure message when the condition is not satisfied before the timeout.
|
|
func RequireTruef(tb testing.TB, condition func() bool, timeout, pollInterval time.Duration, msg string, args ...any) {
|
|
tb.Helper()
|
|
run(testcontext.New(tb), tb, func(t *T) {
|
|
if !condition() {
|
|
t.Fail()
|
|
}
|
|
}, timeout, pollInterval, fmt.Sprintf(msg, args...), "RequireTruef", requireTrueMisuseHint, false)
|
|
}
|