mirror of
https://github.com/hanzoai/telemetry.git
synced 2026-10-30 20:01:49 +00:00
Andrew WilkinsandGitHub
41b6628e07
#### Description Add support for iterating over the client metadata keys. At the moment it is only possible to get the values for a known key, which makes it impossible to inspect metadata keys without prior knowledge of all possible keys, e.g. as described in https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/39157. #### Link to tracking issue Closes https://github.com/open-telemetry/opentelemetry-collector/issues/12804 #### Testing Trivial addition, added unit tests. #### Documentation N/A
101 lines
2.3 KiB
Go
101 lines
2.3 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
// Package client contains generic representations of clients connecting to
|
|
// different receivers
|
|
package client
|
|
|
|
import (
|
|
"context"
|
|
"net"
|
|
"slices"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestNewContext(t *testing.T) {
|
|
testCases := []struct {
|
|
name string
|
|
cl Info
|
|
}{
|
|
{
|
|
name: "valid client",
|
|
cl: Info{
|
|
Addr: &net.IPAddr{
|
|
IP: net.IPv4(1, 2, 3, 4),
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "nil client",
|
|
cl: Info{},
|
|
},
|
|
}
|
|
for _, tt := range testCases {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
ctx := NewContext(context.Background(), tt.cl)
|
|
assert.Equal(t, ctx.Value(ctxKey{}), tt.cl)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestFromContext(t *testing.T) {
|
|
testCases := []struct {
|
|
name string
|
|
input context.Context
|
|
expected Info
|
|
}{
|
|
{
|
|
name: "context with client",
|
|
input: context.WithValue(context.Background(), ctxKey{}, Info{
|
|
Addr: &net.IPAddr{
|
|
IP: net.IPv4(1, 2, 3, 4),
|
|
},
|
|
}),
|
|
expected: Info{
|
|
Addr: &net.IPAddr{
|
|
IP: net.IPv4(1, 2, 3, 4),
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "context without client",
|
|
input: context.Background(),
|
|
expected: Info{},
|
|
},
|
|
{
|
|
name: "context with something else in the key",
|
|
input: context.WithValue(context.Background(), ctxKey{}, "unexpected!"),
|
|
expected: Info{},
|
|
},
|
|
}
|
|
for _, tt := range testCases {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
assert.Equal(t, tt.expected, FromContext(tt.input))
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestMetadata(t *testing.T) {
|
|
source := map[string][]string{"test-key": {"test-val"}, "TEST-KEY-2": {"test-val"}}
|
|
md := NewMetadata(source)
|
|
assert.Equal(t, []string{"test-key", "test-key-2"}, slices.Sorted(md.Keys()))
|
|
assert.Equal(t, []string{"test-val"}, md.Get("test-key"))
|
|
assert.Equal(t, []string{"test-val"}, md.Get("test-KEY")) // case insensitive lookup
|
|
assert.Equal(t, []string{"test-val"}, md.Get("test-key-2")) // case insensitive lookup
|
|
|
|
// test if copy. In regular use, source cannot change
|
|
val := md.Get("test-key")
|
|
source["test-key"][0] = "abc"
|
|
assert.Equal(t, []string{"test-val"}, val)
|
|
|
|
assert.Empty(t, md.Get("non-existent-key"))
|
|
}
|
|
|
|
func TestUninstantiatedMetadata(t *testing.T) {
|
|
i := Info{}
|
|
assert.Empty(t, slices.Collect(i.Metadata.Keys()))
|
|
assert.Empty(t, i.Metadata.Get("test"))
|
|
}
|