You've already forked opentelemetry-go
mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2025-11-23 22:34:47 +02:00
Add baggage implementation based on the W3C and OpenTelemetry specification (#1967)
* Rename baggage context file * Initial baggage implementation * Initial tests * More tests * Update baggage context functionality * Add New method to baggage pkg * Update namedtracer example * URL encode baggage values * Refactor and use internal baggage pkg * Update OpenTracing bridge * Update baggage propagator * Fix lint and test errors * Add changes to changelog * Apply suggestions from code review * Rename testcase field per suggestion * Update test to verify last-one-wins semantics * Explicitly seed random numbers with static seed in tests * Parse Member key/value with string split * Add test for member parse with equal signs in value * Trim whitespaces for member key/value
This commit is contained in:
Tyler Yahn
GitHub
@@ -21,65 +21,101 @@ import (
|
||||
"testing"
|
||||
|
||||
"github.com/google/go-cmp/cmp"
|
||||
"github.com/stretchr/testify/assert"
|
||||
|
||||
"go.opentelemetry.io/otel/attribute"
|
||||
"go.opentelemetry.io/otel/internal/baggage"
|
||||
"go.opentelemetry.io/otel/baggage"
|
||||
"go.opentelemetry.io/otel/propagation"
|
||||
)
|
||||
|
||||
type property struct {
|
||||
Key, Value string
|
||||
}
|
||||
|
||||
type member struct {
|
||||
Key, Value string
|
||||
|
||||
Properties []property
|
||||
}
|
||||
|
||||
func (m member) Member(t *testing.T) baggage.Member {
|
||||
props := make([]baggage.Property, 0, len(m.Properties))
|
||||
for _, p := range m.Properties {
|
||||
p, err := baggage.NewKeyValueProperty(p.Key, p.Value)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
props = append(props, p)
|
||||
}
|
||||
|
||||
bMember, err := baggage.NewMember(m.Key, m.Value, props...)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
return bMember
|
||||
}
|
||||
|
||||
type members []member
|
||||
|
||||
func (m members) Baggage(t *testing.T) baggage.Baggage {
|
||||
bMembers := make([]baggage.Member, 0, len(m))
|
||||
for _, mem := range m {
|
||||
bMembers = append(bMembers, mem.Member(t))
|
||||
}
|
||||
bag, err := baggage.New(bMembers...)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
return bag
|
||||
}
|
||||
|
||||
func TestExtractValidBaggageFromHTTPReq(t *testing.T) {
|
||||
prop := propagation.TextMapPropagator(propagation.Baggage{})
|
||||
tests := []struct {
|
||||
name string
|
||||
header string
|
||||
wantKVs []attribute.KeyValue
|
||||
name string
|
||||
header string
|
||||
want members
|
||||
}{
|
||||
{
|
||||
name: "valid w3cHeader",
|
||||
header: "key1=val1,key2=val2",
|
||||
wantKVs: []attribute.KeyValue{
|
||||
attribute.String("key1", "val1"),
|
||||
attribute.String("key2", "val2"),
|
||||
want: members{
|
||||
{Key: "key1", Value: "val1"},
|
||||
{Key: "key2", Value: "val2"},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "valid w3cHeader with spaces",
|
||||
header: "key1 = val1, key2 =val2 ",
|
||||
wantKVs: []attribute.KeyValue{
|
||||
attribute.String("key1", "val1"),
|
||||
attribute.String("key2", "val2"),
|
||||
want: members{
|
||||
{Key: "key1", Value: "val1"},
|
||||
{Key: "key2", Value: "val2"},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "valid w3cHeader with properties",
|
||||
header: "key1=val1,key2=val2;prop=1",
|
||||
wantKVs: []attribute.KeyValue{
|
||||
attribute.String("key1", "val1"),
|
||||
attribute.String("key2", "val2;prop=1"),
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "valid header with url-escaped comma",
|
||||
header: "key1=val1,key2=val2%2Cval3",
|
||||
wantKVs: []attribute.KeyValue{
|
||||
attribute.String("key1", "val1"),
|
||||
attribute.String("key2", "val2,val3"),
|
||||
want: members{
|
||||
{Key: "key1", Value: "val1"},
|
||||
{
|
||||
Key: "key2",
|
||||
Value: "val2",
|
||||
Properties: []property{
|
||||
{Key: "prop", Value: "1"},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "valid header with an invalid header",
|
||||
header: "key1=val1,key2=val2,a,val3",
|
||||
wantKVs: []attribute.KeyValue{
|
||||
attribute.String("key1", "val1"),
|
||||
attribute.String("key2", "val2"),
|
||||
},
|
||||
want: members{},
|
||||
},
|
||||
{
|
||||
name: "valid header with no value",
|
||||
header: "key1=,key2=val2",
|
||||
wantKVs: []attribute.KeyValue{
|
||||
attribute.String("key1", ""),
|
||||
attribute.String("key2", "val2"),
|
||||
want: members{
|
||||
{Key: "key1", Value: ""},
|
||||
{Key: "key2", Value: "val2"},
|
||||
},
|
||||
},
|
||||
}
|
||||
@@ -91,27 +127,8 @@ func TestExtractValidBaggageFromHTTPReq(t *testing.T) {
|
||||
|
||||
ctx := context.Background()
|
||||
ctx = prop.Extract(ctx, propagation.HeaderCarrier(req.Header))
|
||||
gotBaggage := baggage.MapFromContext(ctx)
|
||||
wantBaggage := baggage.NewMap(baggage.MapUpdate{MultiKV: tt.wantKVs})
|
||||
if gotBaggage.Len() != wantBaggage.Len() {
|
||||
t.Errorf(
|
||||
"Got and Want Baggage are not the same size %d != %d",
|
||||
gotBaggage.Len(),
|
||||
wantBaggage.Len(),
|
||||
)
|
||||
}
|
||||
totalDiff := ""
|
||||
wantBaggage.Foreach(func(keyValue attribute.KeyValue) bool {
|
||||
val, _ := gotBaggage.Value(keyValue.Key)
|
||||
diff := cmp.Diff(keyValue, attribute.KeyValue{Key: keyValue.Key, Value: val}, cmp.AllowUnexported(attribute.Value{}))
|
||||
if diff != "" {
|
||||
totalDiff += diff + "\n"
|
||||
}
|
||||
return true
|
||||
})
|
||||
if totalDiff != "" {
|
||||
t.Errorf("Extract Tracecontext: %s: -got +want %s", tt.name, totalDiff)
|
||||
}
|
||||
expected := tt.want.Baggage(t)
|
||||
assert.Equal(t, expected, baggage.FromContext(ctx))
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -121,7 +138,7 @@ func TestExtractInvalidDistributedContextFromHTTPReq(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
header string
|
||||
hasKVs []attribute.KeyValue
|
||||
has members
|
||||
}{
|
||||
{
|
||||
name: "no key values",
|
||||
@@ -130,17 +147,31 @@ func TestExtractInvalidDistributedContextFromHTTPReq(t *testing.T) {
|
||||
{
|
||||
name: "invalid header with existing context",
|
||||
header: "header2",
|
||||
hasKVs: []attribute.KeyValue{
|
||||
attribute.String("key1", "val1"),
|
||||
attribute.String("key2", "val2"),
|
||||
has: members{
|
||||
{Key: "key1", Value: "val1"},
|
||||
{Key: "key2", Value: "val2"},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "empty header value",
|
||||
header: "",
|
||||
hasKVs: []attribute.KeyValue{
|
||||
attribute.String("key1", "val1"),
|
||||
attribute.String("key2", "val2"),
|
||||
has: members{
|
||||
{Key: "key1", Value: "val1"},
|
||||
{Key: "key2", Value: "val2"},
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "with properties",
|
||||
header: "key1=val1,key2=val2;prop=1",
|
||||
has: members{
|
||||
{Key: "key1", Value: "val1"},
|
||||
{
|
||||
Key: "key2",
|
||||
Value: "val2",
|
||||
Properties: []property{
|
||||
{Key: "prop", Value: "1"},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
@@ -150,26 +181,10 @@ func TestExtractInvalidDistributedContextFromHTTPReq(t *testing.T) {
|
||||
req, _ := http.NewRequest("GET", "http://example.com", nil)
|
||||
req.Header.Set("baggage", tt.header)
|
||||
|
||||
ctx := baggage.NewContext(context.Background(), tt.hasKVs...)
|
||||
wantBaggage := baggage.MapFromContext(ctx)
|
||||
expected := tt.has.Baggage(t)
|
||||
ctx := baggage.ContextWithBaggage(context.Background(), expected)
|
||||
ctx = prop.Extract(ctx, propagation.HeaderCarrier(req.Header))
|
||||
gotBaggage := baggage.MapFromContext(ctx)
|
||||
if gotBaggage.Len() != wantBaggage.Len() {
|
||||
t.Errorf(
|
||||
"Got and Want Baggage are not the same size %d != %d",
|
||||
gotBaggage.Len(),
|
||||
wantBaggage.Len(),
|
||||
)
|
||||
}
|
||||
totalDiff := ""
|
||||
wantBaggage.Foreach(func(keyValue attribute.KeyValue) bool {
|
||||
val, _ := gotBaggage.Value(keyValue.Key)
|
||||
diff := cmp.Diff(keyValue, attribute.KeyValue{Key: keyValue.Key, Value: val}, cmp.AllowUnexported(attribute.Value{}))
|
||||
if diff != "" {
|
||||
totalDiff += diff + "\n"
|
||||
}
|
||||
return true
|
||||
})
|
||||
assert.Equal(t, expected, baggage.FromContext(ctx))
|
||||
})
|
||||
}
|
||||
}
|
||||
@@ -178,62 +193,50 @@ func TestInjectBaggageToHTTPReq(t *testing.T) {
|
||||
propagator := propagation.Baggage{}
|
||||
tests := []struct {
|
||||
name string
|
||||
kvs []attribute.KeyValue
|
||||
mems members
|
||||
wantInHeader []string
|
||||
wantedLen int
|
||||
}{
|
||||
{
|
||||
name: "two simple values",
|
||||
kvs: []attribute.KeyValue{
|
||||
attribute.String("key1", "val1"),
|
||||
attribute.String("key2", "val2"),
|
||||
mems: members{
|
||||
{Key: "key1", Value: "val1"},
|
||||
{Key: "key2", Value: "val2"},
|
||||
},
|
||||
wantInHeader: []string{"key1=val1", "key2=val2"},
|
||||
},
|
||||
{
|
||||
name: "two values with escaped chars",
|
||||
kvs: []attribute.KeyValue{
|
||||
attribute.String("key1", "val1,val2"),
|
||||
attribute.String("key2", "val3=4"),
|
||||
name: "values with escaped chars",
|
||||
mems: members{
|
||||
{Key: "key2", Value: "val3=4"},
|
||||
},
|
||||
wantInHeader: []string{"key1=val1%2Cval2", "key2=val3%3D4"},
|
||||
wantInHeader: []string{"key2=val3%3D4"},
|
||||
},
|
||||
{
|
||||
name: "values of non-string types",
|
||||
kvs: []attribute.KeyValue{
|
||||
attribute.Bool("key1", true),
|
||||
attribute.Int("key2", 123),
|
||||
attribute.Int64("key3", 123),
|
||||
attribute.Float64("key4", 123.567),
|
||||
name: "with properties",
|
||||
mems: members{
|
||||
{Key: "key1", Value: "val1"},
|
||||
{
|
||||
Key: "key2",
|
||||
Value: "val2",
|
||||
Properties: []property{
|
||||
{Key: "prop", Value: "1"},
|
||||
},
|
||||
},
|
||||
},
|
||||
wantInHeader: []string{
|
||||
"key1=true",
|
||||
"key2=123",
|
||||
"key3=123",
|
||||
"key4=123.567",
|
||||
"key1=val1",
|
||||
"key2=val2;prop=1",
|
||||
},
|
||||
},
|
||||
}
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
req, _ := http.NewRequest("GET", "http://example.com", nil)
|
||||
ctx := baggage.ContextWithMap(context.Background(), baggage.NewMap(baggage.MapUpdate{MultiKV: tt.kvs}))
|
||||
ctx := baggage.ContextWithBaggage(context.Background(), tt.mems.Baggage(t))
|
||||
propagator.Inject(ctx, propagation.HeaderCarrier(req.Header))
|
||||
|
||||
gotHeader := req.Header.Get("baggage")
|
||||
wantedLen := len(strings.Join(tt.wantInHeader, ","))
|
||||
if wantedLen != len(gotHeader) {
|
||||
t.Errorf(
|
||||
"%s: Inject baggage incorrect length %d != %d.", tt.name, tt.wantedLen, len(gotHeader),
|
||||
)
|
||||
}
|
||||
for _, inHeader := range tt.wantInHeader {
|
||||
if !strings.Contains(gotHeader, inHeader) {
|
||||
t.Errorf(
|
||||
"%s: Inject baggage missing part of header: %s in %s", tt.name, inHeader, gotHeader,
|
||||
)
|
||||
}
|
||||
}
|
||||
got := strings.Split(req.Header.Get("baggage"), ",")
|
||||
assert.ElementsMatch(t, tt.wantInHeader, got)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user