mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2025-05-13 21:56:48 +02:00
3a9c80c56f
* Provide conformance tests for tracers The test harness may be used to ensure that a given tracer behaves according to the expectations set by the API. * Add `ToMatchError` matcher * Use DeepEqual to compare unknown types in matchers Unlike basic `==`/`!=`, `reflect.DeepEqual` can compare arbitrary types (e.g., `[]string` to `[]string`) * Use struct instead of string for test context key
291 lines
7.2 KiB
Go
291 lines
7.2 KiB
Go
// Copyright 2019, OpenTelemetry Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package testharness
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"testing"
|
|
|
|
"go.opentelemetry.io/api/core"
|
|
"go.opentelemetry.io/api/trace"
|
|
"go.opentelemetry.io/internal/matchers"
|
|
)
|
|
|
|
type Harness struct {
|
|
t *testing.T
|
|
}
|
|
|
|
func NewHarness(t *testing.T) *Harness {
|
|
return &Harness{
|
|
t: t,
|
|
}
|
|
}
|
|
|
|
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.Tracer()).ToEqual(subject)
|
|
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(core.EmptySpanContext())
|
|
e.Expect(trace.CurrentSpan(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("records the span if specified", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
e := matchers.NewExpecter(t)
|
|
subject := subjectFactory()
|
|
|
|
_, span := subject.Start(context.Background(), "span", trace.WithRecord())
|
|
|
|
e.Expect(span.IsRecording()).ToBeTrue()
|
|
})
|
|
|
|
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("propagates a parent's trace ID through `ChildOf`", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
e := matchers.NewExpecter(t)
|
|
subject := subjectFactory()
|
|
|
|
_, parent := subject.Start(context.Background(), "parent")
|
|
_, child := subject.Start(context.Background(), "child", trace.ChildOf(parent.SpanContext()))
|
|
|
|
psc := parent.SpanContext()
|
|
csc := child.SpanContext()
|
|
|
|
e.Expect(csc.TraceID).ToEqual(psc.TraceID)
|
|
e.Expect(csc.SpanID).NotToEqual(psc.SpanID)
|
|
})
|
|
|
|
t.Run("propagates a parent's trace ID through `FollowsFrom`", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
e := matchers.NewExpecter(t)
|
|
subject := subjectFactory()
|
|
|
|
_, parent := subject.Start(context.Background(), "parent")
|
|
_, child := subject.Start(context.Background(), "child", trace.FollowsFrom(parent.SpanContext()))
|
|
|
|
psc := parent.SpanContext()
|
|
csc := child.SpanContext()
|
|
|
|
e.Expect(csc.TraceID).ToEqual(psc.TraceID)
|
|
e.Expect(csc.SpanID).NotToEqual(psc.SpanID)
|
|
})
|
|
})
|
|
|
|
h.t.Run("#WithSpan", func(t *testing.T) {
|
|
t.Run("returns nil if the body does not return an error", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
e := matchers.NewExpecter(t)
|
|
subject := subjectFactory()
|
|
|
|
err := subject.WithSpan(context.Background(), "test", func(ctx context.Context) error {
|
|
return nil
|
|
})
|
|
|
|
e.Expect(err).ToBeNil()
|
|
})
|
|
|
|
t.Run("propagates the error from the body if the body errors", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
e := matchers.NewExpecter(t)
|
|
subject := subjectFactory()
|
|
|
|
expectedErr := errors.New("test error")
|
|
|
|
err := subject.WithSpan(context.Background(), "test", func(ctx context.Context) error {
|
|
return expectedErr
|
|
})
|
|
|
|
e.Expect(err).ToMatchError(expectedErr)
|
|
})
|
|
|
|
t.Run("propagates the original context to the body", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
e := matchers.NewExpecter(t)
|
|
subject := subjectFactory()
|
|
|
|
ctxKey := testCtxKey{}
|
|
ctxValue := "ctx value"
|
|
ctx := context.WithValue(context.Background(), ctxKey, ctxValue)
|
|
|
|
var actualCtx context.Context
|
|
|
|
err := subject.WithSpan(ctx, "test", func(ctx context.Context) error {
|
|
actualCtx = ctx
|
|
|
|
return nil
|
|
})
|
|
|
|
e.Expect(err).ToBeNil()
|
|
|
|
e.Expect(actualCtx.Value(ctxKey)).ToEqual(ctxValue)
|
|
})
|
|
|
|
t.Run("stores a span containing the expected properties on the context provided to the body function", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
e := matchers.NewExpecter(t)
|
|
subject := subjectFactory()
|
|
|
|
var span trace.Span
|
|
|
|
err := subject.WithSpan(context.Background(), "test", func(ctx context.Context) error {
|
|
span = trace.CurrentSpan(ctx)
|
|
|
|
return nil
|
|
})
|
|
|
|
e.Expect(err).ToBeNil()
|
|
|
|
e.Expect(span).NotToBeNil()
|
|
|
|
e.Expect(span.Tracer()).ToEqual(subject)
|
|
e.Expect(span.SpanContext().IsValid()).ToBeTrue()
|
|
})
|
|
|
|
t.Run("starts spans with unique trace and span IDs", func(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
e := matchers.NewExpecter(t)
|
|
subject := subjectFactory()
|
|
|
|
var span1 trace.Span
|
|
var span2 trace.Span
|
|
|
|
err := subject.WithSpan(context.Background(), "span1", func(ctx context.Context) error {
|
|
span1 = trace.CurrentSpan(ctx)
|
|
|
|
return nil
|
|
})
|
|
|
|
e.Expect(err).ToBeNil()
|
|
|
|
err = subject.WithSpan(context.Background(), "span2", func(ctx context.Context) error {
|
|
span2 = trace.CurrentSpan(ctx)
|
|
|
|
return nil
|
|
})
|
|
|
|
e.Expect(err).ToBeNil()
|
|
|
|
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")
|
|
|
|
var child trace.Span
|
|
|
|
err := subject.WithSpan(ctx, "child", func(ctx context.Context) error {
|
|
child = trace.CurrentSpan(ctx)
|
|
|
|
return nil
|
|
})
|
|
|
|
e.Expect(err).ToBeNil()
|
|
|
|
psc := parent.SpanContext()
|
|
csc := child.SpanContext()
|
|
|
|
e.Expect(csc.TraceID).ToEqual(psc.TraceID)
|
|
e.Expect(csc.SpanID).NotToEqual(psc.SpanID)
|
|
})
|
|
})
|
|
}
|
|
|
|
type testCtxKey struct{}
|