mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
Stephan BehnkeandGitHub
1b8f1c95d6
## What changed? Adds a new package `testing/testcontext` for creating and managing test `context.Context`s. No behavior change expected/intended. ## Why? tl;dr encapsulating the test context behavior and decouple from TestEnv Bigger picture: Right now the test context behavior is coupled to TestEnv; and legacy suites use `testcore.NewContext()`. That served us well so far, but it's suboptimal. A test context should be available outside of TestEnv and `tests/` package; ie unit and integration tests can also benefit it. ## How did you test it? - [ ] built - [ ] run locally and tested manually - [ ] covered by existing tests - [x] added new unit test(s) - [ ] added new functional test(s)
47 lines
1.5 KiB
Go
47 lines
1.5 KiB
Go
package testcore
|
|
|
|
import (
|
|
"context"
|
|
"testing"
|
|
|
|
"go.temporal.io/server/common/headers"
|
|
"go.temporal.io/server/common/rpc"
|
|
"go.temporal.io/server/common/testing/testcontext"
|
|
)
|
|
|
|
type versionHeadersContextKey struct{}
|
|
|
|
// NewContext creates a context with default 90-second timeout and RPC headers.
|
|
//
|
|
// NOTE: If you're using testcore.NewEnv, you can use env.Context() directly - it already
|
|
// includes RPC headers. This function is primarily for legacy tests or creating standalone
|
|
// contexts outside of the TestEnv framework.
|
|
//
|
|
// If a parent context is provided, the returned context will be canceled when
|
|
// either the timeout expires OR the parent is canceled.
|
|
func NewContext(parent ...context.Context) context.Context {
|
|
if len(parent) > 0 && parent[0] != nil {
|
|
// Create RPC context derived from parent
|
|
ctx, _ := rpc.NewContextFromParentWithTimeoutAndVersionHeaders(
|
|
parent[0],
|
|
defaultTestTimeout,
|
|
)
|
|
return ctx
|
|
}
|
|
|
|
// Create standalone RPC context
|
|
ctx, _ := rpc.NewContextWithTimeoutAndVersionHeaders(defaultTestTimeout)
|
|
return ctx
|
|
}
|
|
|
|
// setupTestTimeoutWithContext creates a context that will be canceled on timeout,
|
|
// and reports the timeout error during cleanup. Returns a context that tests can
|
|
// use to be interrupted when timeout occurs. The context includes RPC version headers.
|
|
func setupTestTimeoutWithContext(t *testing.T) context.Context {
|
|
t.Helper()
|
|
return testcontext.New(
|
|
t,
|
|
testcontext.WithContextDecorator(versionHeadersContextKey{}, headers.SetVersions),
|
|
)
|
|
}
|