mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-04 09:43:23 +02:00
49359495c7
* Simplify trace_context tests Refactor the propagation/trace_context tests to be targeted at testing the propagator functionality only and remove extraneous dependencies. Fix the TraceContext Inject method from injecting the tracestate header if no value exists. * Add changes to changelog
354 lines
9.4 KiB
Go
354 lines
9.4 KiB
Go
// Copyright The 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 propagation_test
|
|
|
|
import (
|
|
"context"
|
|
"net/http"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"go.opentelemetry.io/otel/propagation"
|
|
"go.opentelemetry.io/otel/trace"
|
|
)
|
|
|
|
var (
|
|
traceparent = http.CanonicalHeaderKey("traceparent")
|
|
tracestate = http.CanonicalHeaderKey("tracestate")
|
|
|
|
prop = propagation.TraceContext{}
|
|
)
|
|
|
|
type testcase struct {
|
|
name string
|
|
header http.Header
|
|
sc trace.SpanContext
|
|
}
|
|
|
|
func TestExtractValidTraceContext(t *testing.T) {
|
|
stateStr := "key1=value1,key2=value2"
|
|
state, err := trace.ParseTraceState(stateStr)
|
|
require.NoError(t, err)
|
|
|
|
tests := []testcase{
|
|
{
|
|
name: "not sampled",
|
|
header: http.Header{
|
|
traceparent: []string{"00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00"},
|
|
},
|
|
sc: trace.NewSpanContext(trace.SpanContextConfig{
|
|
TraceID: traceID,
|
|
SpanID: spanID,
|
|
Remote: true,
|
|
}),
|
|
},
|
|
{
|
|
name: "sampled",
|
|
header: http.Header{
|
|
traceparent: []string{"00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01"},
|
|
},
|
|
sc: trace.NewSpanContext(trace.SpanContextConfig{
|
|
TraceID: traceID,
|
|
SpanID: spanID,
|
|
TraceFlags: trace.FlagsSampled,
|
|
Remote: true,
|
|
}),
|
|
},
|
|
{
|
|
name: "valid tracestate",
|
|
header: http.Header{
|
|
traceparent: []string{"00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00"},
|
|
tracestate: []string{stateStr},
|
|
},
|
|
sc: trace.NewSpanContext(trace.SpanContextConfig{
|
|
TraceID: traceID,
|
|
SpanID: spanID,
|
|
TraceState: state,
|
|
Remote: true,
|
|
}),
|
|
},
|
|
{
|
|
name: "invalid tracestate perserves traceparent",
|
|
header: http.Header{
|
|
traceparent: []string{"00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00"},
|
|
tracestate: []string{"invalid$@#=invalid"},
|
|
},
|
|
sc: trace.NewSpanContext(trace.SpanContextConfig{
|
|
TraceID: traceID,
|
|
SpanID: spanID,
|
|
Remote: true,
|
|
}),
|
|
},
|
|
{
|
|
name: "future version not sampled",
|
|
header: http.Header{
|
|
traceparent: []string{"02-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00"},
|
|
},
|
|
sc: trace.NewSpanContext(trace.SpanContextConfig{
|
|
TraceID: traceID,
|
|
SpanID: spanID,
|
|
Remote: true,
|
|
}),
|
|
},
|
|
{
|
|
name: "future version sampled",
|
|
header: http.Header{
|
|
traceparent: []string{"02-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01"},
|
|
},
|
|
sc: trace.NewSpanContext(trace.SpanContextConfig{
|
|
TraceID: traceID,
|
|
SpanID: spanID,
|
|
TraceFlags: trace.FlagsSampled,
|
|
Remote: true,
|
|
}),
|
|
},
|
|
{
|
|
name: "future version sample bit set",
|
|
header: http.Header{
|
|
traceparent: []string{"02-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-09"},
|
|
},
|
|
sc: trace.NewSpanContext(trace.SpanContextConfig{
|
|
TraceID: traceID,
|
|
SpanID: spanID,
|
|
TraceFlags: trace.FlagsSampled,
|
|
Remote: true,
|
|
}),
|
|
},
|
|
{
|
|
name: "future version sample bit not set",
|
|
header: http.Header{
|
|
traceparent: []string{"02-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-08"},
|
|
},
|
|
sc: trace.NewSpanContext(trace.SpanContextConfig{
|
|
TraceID: traceID,
|
|
SpanID: spanID,
|
|
Remote: true,
|
|
}),
|
|
},
|
|
{
|
|
name: "future version additional data",
|
|
header: http.Header{
|
|
traceparent: []string{"02-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00-XYZxsf09"},
|
|
},
|
|
sc: trace.NewSpanContext(trace.SpanContextConfig{
|
|
TraceID: traceID,
|
|
SpanID: spanID,
|
|
Remote: true,
|
|
}),
|
|
},
|
|
{
|
|
name: "B3 format ending in dash",
|
|
header: http.Header{
|
|
traceparent: []string{"00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00-"},
|
|
},
|
|
sc: trace.NewSpanContext(trace.SpanContextConfig{
|
|
TraceID: traceID,
|
|
SpanID: spanID,
|
|
Remote: true,
|
|
}),
|
|
},
|
|
{
|
|
name: "future version B3 format ending in dash",
|
|
header: http.Header{
|
|
traceparent: []string{"03-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00-"},
|
|
},
|
|
sc: trace.NewSpanContext(trace.SpanContextConfig{
|
|
TraceID: traceID,
|
|
SpanID: spanID,
|
|
Remote: true,
|
|
}),
|
|
},
|
|
}
|
|
|
|
for _, tc := range tests {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
ctx := context.Background()
|
|
ctx = prop.Extract(ctx, propagation.HeaderCarrier(tc.header))
|
|
assert.Equal(t, tc.sc, trace.SpanContextFromContext(ctx))
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestExtractInvalidTraceContextFromHTTPReq(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
header string
|
|
}{
|
|
{
|
|
name: "wrong version length",
|
|
header: "0000-00000000000000000000000000000000-0000000000000000-01",
|
|
},
|
|
{
|
|
name: "wrong trace ID length",
|
|
header: "00-ab00000000000000000000000000000000-cd00000000000000-01",
|
|
},
|
|
{
|
|
name: "wrong span ID length",
|
|
header: "00-ab000000000000000000000000000000-cd0000000000000000-01",
|
|
},
|
|
{
|
|
name: "wrong trace flag length",
|
|
header: "00-ab000000000000000000000000000000-cd00000000000000-0100",
|
|
},
|
|
{
|
|
name: "bogus version",
|
|
header: "qw-00000000000000000000000000000000-0000000000000000-01",
|
|
},
|
|
{
|
|
name: "bogus trace ID",
|
|
header: "00-qw000000000000000000000000000000-cd00000000000000-01",
|
|
},
|
|
{
|
|
name: "bogus span ID",
|
|
header: "00-ab000000000000000000000000000000-qw00000000000000-01",
|
|
},
|
|
{
|
|
name: "bogus trace flag",
|
|
header: "00-ab000000000000000000000000000000-cd00000000000000-qw",
|
|
},
|
|
{
|
|
name: "upper case version",
|
|
header: "A0-00000000000000000000000000000000-0000000000000000-01",
|
|
},
|
|
{
|
|
name: "upper case trace ID",
|
|
header: "00-AB000000000000000000000000000000-cd00000000000000-01",
|
|
},
|
|
{
|
|
name: "upper case span ID",
|
|
header: "00-ab000000000000000000000000000000-CD00000000000000-01",
|
|
},
|
|
{
|
|
name: "upper case trace flag",
|
|
header: "00-ab000000000000000000000000000000-cd00000000000000-A1",
|
|
},
|
|
{
|
|
name: "zero trace ID and span ID",
|
|
header: "00-00000000000000000000000000000000-0000000000000000-01",
|
|
},
|
|
{
|
|
name: "trace-flag unused bits set",
|
|
header: "00-ab000000000000000000000000000000-cd00000000000000-09",
|
|
},
|
|
{
|
|
name: "missing options",
|
|
header: "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7",
|
|
},
|
|
{
|
|
name: "empty options",
|
|
header: "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-",
|
|
},
|
|
}
|
|
|
|
empty := trace.SpanContext{}
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
h := http.Header{traceparent: []string{tt.header}}
|
|
ctx := context.Background()
|
|
ctx = prop.Extract(ctx, propagation.HeaderCarrier(h))
|
|
|
|
// Failure to extract needs to result in no SpanContext being set.
|
|
// This cannot be directly measured, but we can check that an
|
|
// zero-value SpanContext is returned from SpanContextFromContext.
|
|
assert.Equal(t, empty, trace.SpanContextFromContext(ctx))
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestInjectValidTraceContext(t *testing.T) {
|
|
stateStr := "key1=value1,key2=value2"
|
|
state, err := trace.ParseTraceState(stateStr)
|
|
require.NoError(t, err)
|
|
|
|
tests := []testcase{
|
|
{
|
|
name: "not sampled",
|
|
header: http.Header{
|
|
traceparent: []string{"00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00"},
|
|
},
|
|
sc: trace.NewSpanContext(trace.SpanContextConfig{
|
|
TraceID: traceID,
|
|
SpanID: spanID,
|
|
Remote: true,
|
|
}),
|
|
},
|
|
{
|
|
name: "sampled",
|
|
header: http.Header{
|
|
traceparent: []string{"00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01"},
|
|
},
|
|
sc: trace.NewSpanContext(trace.SpanContextConfig{
|
|
TraceID: traceID,
|
|
SpanID: spanID,
|
|
TraceFlags: trace.FlagsSampled,
|
|
Remote: true,
|
|
}),
|
|
},
|
|
{
|
|
name: "unsupported trace flag bits dropped",
|
|
header: http.Header{
|
|
traceparent: []string{"00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01"},
|
|
},
|
|
sc: trace.NewSpanContext(trace.SpanContextConfig{
|
|
TraceID: traceID,
|
|
SpanID: spanID,
|
|
TraceFlags: 0xff,
|
|
Remote: true,
|
|
}),
|
|
},
|
|
{
|
|
name: "with tracestate",
|
|
header: http.Header{
|
|
traceparent: []string{"00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00"},
|
|
tracestate: []string{stateStr},
|
|
},
|
|
sc: trace.NewSpanContext(trace.SpanContextConfig{
|
|
TraceID: traceID,
|
|
SpanID: spanID,
|
|
TraceState: state,
|
|
Remote: true,
|
|
}),
|
|
},
|
|
}
|
|
|
|
for _, tc := range tests {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
ctx := context.Background()
|
|
ctx = trace.ContextWithRemoteSpanContext(ctx, tc.sc)
|
|
|
|
h := http.Header{}
|
|
prop.Inject(ctx, propagation.HeaderCarrier(h))
|
|
assert.Equal(t, tc.header, h)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestInvalidSpanContextDropped(t *testing.T) {
|
|
invalidSC := trace.SpanContext{}
|
|
require.False(t, invalidSC.IsValid())
|
|
ctx := trace.ContextWithRemoteSpanContext(context.Background(), invalidSC)
|
|
|
|
header := http.Header{}
|
|
propagation.TraceContext{}.Inject(ctx, propagation.HeaderCarrier(header))
|
|
assert.Equal(t, "", header.Get("traceparent"), "injected invalid SpanContext")
|
|
}
|
|
|
|
func TestTraceContextFields(t *testing.T) {
|
|
expected := []string{"traceparent", "tracestate"}
|
|
assert.Equal(t, expected, propagation.TraceContext{}.Fields())
|
|
}
|