testctx

Overview ¶

Package testctx provides a generic wrapper around Go's testing types that enables context propagation and middleware-based test configuration. It allows for structured test suites with OpenTelemetry tracing, timeouts, and other context-aware features while maintaining compatibility with standard Go testing patterns.

The core type TB[Type] is a generic wrapper around testing.TB implementations that preserves all the familiar testing.T and testing.B methods while adding context management. Two concrete types are provided for convenience:

testctx.T = TB[*testing.T]  // For standard tests
testctx.B = TB[*testing.B]  // For benchmarks

The package provides two main entry points to integrate with Go's testing machinery:

testctx.Run()   // For running test suites
testctx.Bench() // For running benchmark suites

Example usage for a hypothetical suite named "Module":

var testCtx = context.Background()

func TestModule(t *testing.T) {
    testctx.Run(testCtx, t, ModuleSuite{}, TestMiddleware()...)
}

func BenchmarkModule(b *testing.B) {
    testctx.Bench(testCtx, b, ModuleSuite{}, BenchMiddleware()...)
}

The generic Middleware[Type] system allows for writing test configuration code that works across both test and benchmark contexts. Some middlewares like WithOTelTracing and WithOTelLogging are generic and work with both types, while others like WithParallel are specialized for specific test types.

Test methods in suites receive a context.Context and either a *testctx.T or *testctx.B, which implement all the familiar methods from testing.T/testing.B:

type ModuleSuite struct{}

func (s ModuleSuite) TestSomething(ctx context.Context, t *testctx.T) {
    t.Run("subtest", func(ctx context.Context, t *testctx.T) {
        // Use context for deadlines, tracing, etc
        // Use t.Fatal, t.Error, etc as normal
    })
}