You've already forked opentelemetry-go
mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2025-08-10 22:31:50 +02:00
Remove harness from internaltest and add doc template (#6599)
Remove harness.go from internaltest and create doc.go for package documentation. Fixes #6522 --------- Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
This commit is contained in:
Stoo Johnston
GitHub
@@ -8,7 +8,7 @@ package internal // import "go.opentelemetry.io/otel/internal"
|
||||
//go:generate gotmpl --body=./shared/matchers/expecter.go.tmpl "--data={}" --out=matchers/expecter.go
|
||||
//go:generate gotmpl --body=./shared/matchers/temporal_matcher.go.tmpl "--data={}" --out=matchers/temporal_matcher.go
|
||||
|
||||
//go:generate gotmpl --body=./shared/internaltest/harness.go.tmpl "--data={\"matchersImportPath\": \"go.opentelemetry.io/otel/internal/matchers\"}" --out=internaltest/harness.go
|
||||
//go:generate gotmpl --body=./shared/internaltest/doc.go.tmpl "--data={}" --out=internaltest/doc.go
|
||||
//go:generate gotmpl --body=./shared/internaltest/text_map_carrier.go.tmpl "--data={}" --out=internaltest/text_map_carrier.go
|
||||
//go:generate gotmpl --body=./shared/internaltest/text_map_carrier_test.go.tmpl "--data={}" --out=internaltest/text_map_carrier_test.go
|
||||
//go:generate gotmpl --body=./shared/internaltest/text_map_propagator.go.tmpl "--data={}" --out=internaltest/text_map_propagator.go
|
||||
|
||||
8
internal/internaltest/doc.go
Normal file
8
internal/internaltest/doc.go
Normal file
@@ -0,0 +1,8 @@
|
||||
// Code created by gotmpl. DO NOT MODIFY.
|
||||
// source: internal/shared/internaltest/doc.go.tmpl
|
||||
|
||||
// Copyright The OpenTelemetry Authors
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
// Package internaltest provides testing functionality.
|
||||
package internaltest // import "go.opentelemetry.io/otel/internal/internaltest"
|
||||
@@ -1,335 +0,0 @@
|
||||
// Code created by gotmpl. DO NOT MODIFY.
|
||||
// source: internal/shared/internaltest/harness.go.tmpl
|
||||
|
||||
// Copyright The OpenTelemetry Authors
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
// Package internaltest provides testing functionality.
|
||||
package internaltest // import "go.opentelemetry.io/otel/internal/internaltest"
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"strconv"
|
||||
"sync"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"go.opentelemetry.io/otel/attribute"
|
||||
"go.opentelemetry.io/otel/codes"
|
||||
"go.opentelemetry.io/otel/internal/matchers"
|
||||
"go.opentelemetry.io/otel/trace"
|
||||
)
|
||||
|
||||
// Harness is a testing harness used to test implementations of the
|
||||
// OpenTelemetry API.
|
||||
type Harness struct {
|
||||
t *testing.T
|
||||
}
|
||||
|
||||
// NewHarness returns an instantiated *Harness using t.
|
||||
func NewHarness(t *testing.T) *Harness {
|
||||
return &Harness{
|
||||
t: t,
|
||||
}
|
||||
}
|
||||
|
||||
// TestTracerProvider runs validation tests for an implementation of the OpenTelemetry
|
||||
// TracerProvider API.
|
||||
func (h *Harness) TestTracerProvider(subjectFactory func() trace.TracerProvider) {
|
||||
h.t.Run("#Start", func(t *testing.T) {
|
||||
t.Run("allow creating an arbitrary number of TracerProvider instances", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
e := matchers.NewExpecter(t)
|
||||
|
||||
tp1 := subjectFactory()
|
||||
tp2 := subjectFactory()
|
||||
|
||||
e.Expect(tp1).NotToEqual(tp2)
|
||||
})
|
||||
t.Run("all methods are safe to be called concurrently", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
runner := func(tp trace.TracerProvider) <-chan struct{} {
|
||||
done := make(chan struct{})
|
||||
go func(tp trace.TracerProvider) {
|
||||
var wg sync.WaitGroup
|
||||
for i := 0; i < 20; i++ {
|
||||
wg.Add(1)
|
||||
go func(name, version string) {
|
||||
_ = tp.Tracer(name, trace.WithInstrumentationVersion(version))
|
||||
wg.Done()
|
||||
}(fmt.Sprintf("tracer %d", i%5), strconv.Itoa(i))
|
||||
}
|
||||
wg.Wait()
|
||||
done <- struct{}{}
|
||||
}(tp)
|
||||
return done
|
||||
}
|
||||
|
||||
matchers.NewExpecter(t).Expect(func() {
|
||||
// Run with multiple TracerProvider to ensure they encapsulate
|
||||
// their own Tracers.
|
||||
tp1 := subjectFactory()
|
||||
tp2 := subjectFactory()
|
||||
|
||||
done1 := runner(tp1)
|
||||
done2 := runner(tp2)
|
||||
|
||||
<-done1
|
||||
<-done2
|
||||
}).NotToPanic()
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
// TestTracer runs validation tests for an implementation of the OpenTelemetry
|
||||
// Tracer API.
|
||||
func (h *Harness) TestTracer(subjectFactory func() trace.Tracer) {
|
||||
h.t.Run("#Start", func(t *testing.T) {
|
||||
t.Run("propagates the original context", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
e := matchers.NewExpecter(t)
|
||||
subject := subjectFactory()
|
||||
|
||||
ctxKey := testCtxKey{}
|
||||
ctxValue := "ctx value"
|
||||
ctx := context.WithValue(context.Background(), ctxKey, ctxValue)
|
||||
|
||||
ctx, _ = subject.Start(ctx, "test")
|
||||
|
||||
e.Expect(ctx.Value(ctxKey)).ToEqual(ctxValue)
|
||||
})
|
||||
|
||||
t.Run("returns a span containing the expected properties", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
e := matchers.NewExpecter(t)
|
||||
subject := subjectFactory()
|
||||
|
||||
_, span := subject.Start(context.Background(), "test")
|
||||
|
||||
e.Expect(span).NotToBeNil()
|
||||
|
||||
e.Expect(span.SpanContext().IsValid()).ToBeTrue()
|
||||
})
|
||||
|
||||
t.Run("stores the span on the provided context", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
e := matchers.NewExpecter(t)
|
||||
subject := subjectFactory()
|
||||
|
||||
ctx, span := subject.Start(context.Background(), "test")
|
||||
|
||||
e.Expect(span).NotToBeNil()
|
||||
e.Expect(span.SpanContext()).NotToEqual(trace.SpanContext{})
|
||||
e.Expect(trace.SpanFromContext(ctx)).ToEqual(span)
|
||||
})
|
||||
|
||||
t.Run("starts spans with unique trace and span IDs", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
e := matchers.NewExpecter(t)
|
||||
subject := subjectFactory()
|
||||
|
||||
_, span1 := subject.Start(context.Background(), "span1")
|
||||
_, span2 := subject.Start(context.Background(), "span2")
|
||||
|
||||
sc1 := span1.SpanContext()
|
||||
sc2 := span2.SpanContext()
|
||||
|
||||
e.Expect(sc1.TraceID()).NotToEqual(sc2.TraceID())
|
||||
e.Expect(sc1.SpanID()).NotToEqual(sc2.SpanID())
|
||||
})
|
||||
|
||||
t.Run("propagates a parent's trace ID through the context", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
e := matchers.NewExpecter(t)
|
||||
subject := subjectFactory()
|
||||
|
||||
ctx, parent := subject.Start(context.Background(), "parent")
|
||||
_, child := subject.Start(ctx, "child")
|
||||
|
||||
psc := parent.SpanContext()
|
||||
csc := child.SpanContext()
|
||||
|
||||
e.Expect(csc.TraceID()).ToEqual(psc.TraceID())
|
||||
e.Expect(csc.SpanID()).NotToEqual(psc.SpanID())
|
||||
})
|
||||
|
||||
t.Run("ignores parent's trace ID when new root is requested", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
e := matchers.NewExpecter(t)
|
||||
subject := subjectFactory()
|
||||
|
||||
ctx, parent := subject.Start(context.Background(), "parent")
|
||||
_, child := subject.Start(ctx, "child", trace.WithNewRoot())
|
||||
|
||||
psc := parent.SpanContext()
|
||||
csc := child.SpanContext()
|
||||
|
||||
e.Expect(csc.TraceID()).NotToEqual(psc.TraceID())
|
||||
e.Expect(csc.SpanID()).NotToEqual(psc.SpanID())
|
||||
})
|
||||
|
||||
t.Run("propagates remote parent's trace ID through the context", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
e := matchers.NewExpecter(t)
|
||||
subject := subjectFactory()
|
||||
|
||||
_, remoteParent := subject.Start(context.Background(), "remote parent")
|
||||
parentCtx := trace.ContextWithRemoteSpanContext(context.Background(), remoteParent.SpanContext())
|
||||
_, child := subject.Start(parentCtx, "child")
|
||||
|
||||
psc := remoteParent.SpanContext()
|
||||
csc := child.SpanContext()
|
||||
|
||||
e.Expect(csc.TraceID()).ToEqual(psc.TraceID())
|
||||
e.Expect(csc.SpanID()).NotToEqual(psc.SpanID())
|
||||
})
|
||||
|
||||
t.Run("ignores remote parent's trace ID when new root is requested", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
e := matchers.NewExpecter(t)
|
||||
subject := subjectFactory()
|
||||
|
||||
_, remoteParent := subject.Start(context.Background(), "remote parent")
|
||||
parentCtx := trace.ContextWithRemoteSpanContext(context.Background(), remoteParent.SpanContext())
|
||||
_, child := subject.Start(parentCtx, "child", trace.WithNewRoot())
|
||||
|
||||
psc := remoteParent.SpanContext()
|
||||
csc := child.SpanContext()
|
||||
|
||||
e.Expect(csc.TraceID()).NotToEqual(psc.TraceID())
|
||||
e.Expect(csc.SpanID()).NotToEqual(psc.SpanID())
|
||||
})
|
||||
|
||||
t.Run("all methods are safe to be called concurrently", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
e := matchers.NewExpecter(t)
|
||||
tracer := subjectFactory()
|
||||
|
||||
ctx, parent := tracer.Start(context.Background(), "span")
|
||||
|
||||
runner := func(tp trace.Tracer) <-chan struct{} {
|
||||
done := make(chan struct{})
|
||||
go func(tp trace.Tracer) {
|
||||
var wg sync.WaitGroup
|
||||
for i := 0; i < 20; i++ {
|
||||
wg.Add(1)
|
||||
go func(name string) {
|
||||
defer wg.Done()
|
||||
_, child := tp.Start(ctx, name)
|
||||
|
||||
psc := parent.SpanContext()
|
||||
csc := child.SpanContext()
|
||||
|
||||
e.Expect(csc.TraceID()).ToEqual(psc.TraceID())
|
||||
e.Expect(csc.SpanID()).NotToEqual(psc.SpanID())
|
||||
}(fmt.Sprintf("span %d", i))
|
||||
}
|
||||
wg.Wait()
|
||||
done <- struct{}{}
|
||||
}(tp)
|
||||
return done
|
||||
}
|
||||
|
||||
e.Expect(func() {
|
||||
done := runner(tracer)
|
||||
|
||||
<-done
|
||||
}).NotToPanic()
|
||||
})
|
||||
})
|
||||
|
||||
h.testSpan(subjectFactory)
|
||||
}
|
||||
|
||||
func (h *Harness) testSpan(tracerFactory func() trace.Tracer) {
|
||||
methods := map[string]func(span trace.Span){
|
||||
"#End": func(span trace.Span) {
|
||||
span.End()
|
||||
},
|
||||
"#AddEvent": func(span trace.Span) {
|
||||
span.AddEvent("test event")
|
||||
},
|
||||
"#AddEventWithTimestamp": func(span trace.Span) {
|
||||
span.AddEvent("test event", trace.WithTimestamp(time.Now().Add(1*time.Second)))
|
||||
},
|
||||
"#SetStatus": func(span trace.Span) {
|
||||
span.SetStatus(codes.Error, "internal")
|
||||
},
|
||||
"#SetName": func(span trace.Span) {
|
||||
span.SetName("new name")
|
||||
},
|
||||
"#SetAttributes": func(span trace.Span) {
|
||||
span.SetAttributes(attribute.String("key1", "value"), attribute.Int("key2", 123))
|
||||
},
|
||||
}
|
||||
mechanisms := map[string]func() trace.Span{
|
||||
"Span created via Tracer#Start": func() trace.Span {
|
||||
tracer := tracerFactory()
|
||||
_, subject := tracer.Start(context.Background(), "test")
|
||||
|
||||
return subject
|
||||
},
|
||||
"Span created via span.TracerProvider()": func() trace.Span {
|
||||
ctx, spanA := tracerFactory().Start(context.Background(), "span1")
|
||||
|
||||
_, spanB := spanA.TracerProvider().Tracer("second").Start(ctx, "span2")
|
||||
return spanB
|
||||
},
|
||||
}
|
||||
|
||||
for mechanismName, mechanism := range mechanisms {
|
||||
h.t.Run(mechanismName, func(t *testing.T) {
|
||||
for methodName, method := range methods {
|
||||
t.Run(methodName, func(t *testing.T) {
|
||||
t.Run("is thread-safe", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
span := mechanism()
|
||||
|
||||
wg := &sync.WaitGroup{}
|
||||
wg.Add(2)
|
||||
|
||||
go func() {
|
||||
defer wg.Done()
|
||||
|
||||
method(span)
|
||||
}()
|
||||
|
||||
go func() {
|
||||
defer wg.Done()
|
||||
|
||||
method(span)
|
||||
}()
|
||||
|
||||
wg.Wait()
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
t.Run("#End", func(t *testing.T) {
|
||||
t.Run("can be called multiple times", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
span := mechanism()
|
||||
|
||||
span.End()
|
||||
span.End()
|
||||
})
|
||||
})
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
type testCtxKey struct{}
|
||||
8
internal/shared/internaltest/doc.go.tmpl
Normal file
8
internal/shared/internaltest/doc.go.tmpl
Normal file
@@ -0,0 +1,8 @@
|
||||
// Code created by gotmpl. DO NOT MODIFY.
|
||||
// source: internal/shared/internaltest/doc.go.tmpl
|
||||
|
||||
// Copyright The OpenTelemetry Authors
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
// Package internaltest provides testing functionality.
|
||||
package internaltest
|
||||
@@ -4,7 +4,6 @@
|
||||
// Copyright The OpenTelemetry Authors
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
// Package internaltest provides testing functionality.
|
||||
package internaltest
|
||||
|
||||
import (
|
||||
|
||||
@@ -8,6 +8,7 @@ package internal // import "go.opentelemetry.io/otel/sdk/internal"
|
||||
//go:generate gotmpl --body=../../internal/shared/matchers/expecter.go.tmpl "--data={}" --out=matchers/expecter.go
|
||||
//go:generate gotmpl --body=../../internal/shared/matchers/temporal_matcher.go.tmpl "--data={}" --out=matchers/temporal_matcher.go
|
||||
|
||||
//go:generate gotmpl --body=../../internal/shared/internaltest/doc.go.tmpl "--data={}" --out=internaltest/doc.go
|
||||
//go:generate gotmpl --body=../../internal/shared/internaltest/env.go.tmpl "--data={}" --out=internaltest/env.go
|
||||
//go:generate gotmpl --body=../../internal/shared/internaltest/env_test.go.tmpl "--data={}" --out=internaltest/env_test.go
|
||||
//go:generate gotmpl --body=../../internal/shared/internaltest/errors.go.tmpl "--data={}" --out=internaltest/errors.go
|
||||
|
||||
8
sdk/internal/internaltest/doc.go
Normal file
8
sdk/internal/internaltest/doc.go
Normal file
@@ -0,0 +1,8 @@
|
||||
// Code created by gotmpl. DO NOT MODIFY.
|
||||
// source: internal/shared/internaltest/doc.go.tmpl
|
||||
|
||||
// Copyright The OpenTelemetry Authors
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
// Package internaltest provides testing functionality.
|
||||
package internaltest // import "go.opentelemetry.io/otel/sdk/internal/internaltest"
|
||||
@@ -4,7 +4,6 @@
|
||||
// Copyright The OpenTelemetry Authors
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
// Package internaltest provides testing functionality.
|
||||
package internaltest // import "go.opentelemetry.io/otel/sdk/internal/internaltest"
|
||||
|
||||
import (
|
||||
|
||||
Reference in New Issue
Block a user