1
0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2024-12-12 10:04:29 +02:00
opentelemetry-go/trace/context_test.go
Tyler Yahn 604b05cbcf
Store current Span instead of local and remote SpanContext in context.Context (#1731)
* Store Span instead of local/remote SpanContext in Context

Now that the SpanContext has a remote identifier, storing a Span's
SpanContext two separate ways in a Context (one for local another for
remote) is unnecessary and adds complication throughout the project when
determining heredity of a Span. This moves to storing the Span directly
in the Context uniformly (for both local and remote) as current Span. In
the process, it updates the getter/setter functionality the `trace`
package provides and replaces the distributed heredity logic throughout
the project with just using the current Span as the parent if it exists.

* Update trace/context.go

Co-authored-by: Anthony Mirabella <a9@aneurysm9.com>

* Assert propagators context remote state

Co-authored-by: Anthony Mirabella <a9@aneurysm9.com>
2021-03-29 08:55:44 -07:00

89 lines
2.3 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 trace // import "go.opentelemetry.io/otel/trace"
import (
"context"
"testing"
"github.com/stretchr/testify/assert"
)
type testSpan struct {
noopSpan
ID byte
Remote bool
}
func (s testSpan) SpanContext() SpanContext {
return SpanContext{
traceID: [16]byte{1},
spanID: [8]byte{s.ID},
remote: s.Remote,
}
}
var (
emptySpan = noopSpan{}
localSpan = testSpan{ID: 1, Remote: false}
remoteSpan = testSpan{ID: 1, Remote: true}
wrappedSpan = nonRecordingSpan{sc: remoteSpan.SpanContext()}
)
func TestSpanFromContext(t *testing.T) {
testCases := []struct {
name string
context context.Context
expectedSpan Span
}{
{
name: "empty context",
context: context.Background(),
expectedSpan: emptySpan,
},
{
name: "local span",
context: ContextWithSpan(context.Background(), localSpan),
expectedSpan: localSpan,
},
{
name: "remote span",
context: ContextWithSpan(context.Background(), remoteSpan),
expectedSpan: remoteSpan,
},
{
name: "wrapped remote span",
context: ContextWithRemoteSpanContext(context.Background(), remoteSpan.SpanContext()),
expectedSpan: wrappedSpan,
},
{
name: "wrapped local span becomes remote",
context: ContextWithRemoteSpanContext(context.Background(), localSpan.SpanContext()),
expectedSpan: wrappedSpan,
},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
assert.Equal(t, tc.expectedSpan, SpanFromContext(tc.context))
// Ensure SpanContextFromContext is just
// SpanFromContext(…).SpanContext().
assert.Equal(t, tc.expectedSpan.SpanContext(), SpanContextFromContext(tc.context))
})
}
}