testutil

Documentation

Overview

Package testutil provides test-only helpers for integration scenarios and OpenTelemetry assertions.

Index

• func RequireNetworkIntegration(t testing.TB)
• func WriteArtifact(t testing.TB, name string, content []byte)
• type OTelRecorder
  • func InstallOTelRecorder(t testing.TB) *OTelRecorder
  • func (r *OTelRecorder) FindLog(body string) (RecordedLog, bool)
  • func (r *OTelRecorder) FindSpan(name string) (RecordedSpan, bool)
• type RecordedLog
• type RecordedSpan

Functions

func RequireNetworkIntegration

func RequireNetworkIntegration(t testing.TB)

RequireNetworkIntegration marks the test as a network integration scenario and skips it unless the dedicated env flag is enabled.

func WriteArtifact

func WriteArtifact(t testing.TB, name string, content []byte)

WriteArtifact stores a test artifact when the current Go version exposes ArtifactDir.

Types

type OTelRecorder

type OTelRecorder struct {
	// contains filtered or unexported fields
}

OTelRecorder captures OpenTelemetry spans and logs for assertion in tests.

func InstallOTelRecorder

func InstallOTelRecorder(t testing.TB) *OTelRecorder

InstallOTelRecorder sets up a global OpenTelemetry recorder for the duration of the test. It replaces the global tracer and logger providers and restores them during test cleanup.

func (*OTelRecorder) FindLog

func (r *OTelRecorder) FindLog(body string) (RecordedLog, bool)

FindLog searches for a captured log by its body content.

func (*OTelRecorder) FindSpan

func (r *OTelRecorder) FindSpan(name string) (RecordedSpan, bool)

FindSpan searches for a captured span by name.

type RecordedLog

type RecordedLog struct {
	Body    string
	TraceID trace.TraceID
	SpanID  trace.SpanID
}

RecordedLog represents a log entry captured during testing.

type RecordedSpan

type RecordedSpan struct {
	Name       string
	TraceID    trace.TraceID
	SpanID     trace.SpanID
	ParentSpan trace.SpanID
}

RecordedSpan represents a span captured during testing.