mirror of
https://github.com/hanzoai/telemetry.git
synced 2026-10-30 20:01:49 +00:00
aac1a8f39c
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description The `xconfmap.Validator` interface has existed in some form for a very long time now and is ready to be stabilized. Similarly, the `xconfmap.Validate` method has existed in it's current state for over a year and doesn't have any open issues I'm aware of. It should also be ready for stabilization. Many modules depend on `xconfmap` merely for the validation facilities (as can be seen by the go.mod diffs), so this will allow them to depend on only stable modules. --------- Co-authored-by: Alex Boten <[email protected]>
249 lines
8.0 KiB
Go
249 lines
8.0 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package otlpreceiver
|
|
|
|
import (
|
|
"path/filepath"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"go.opentelemetry.io/collector/component"
|
|
"go.opentelemetry.io/collector/config/configauth"
|
|
"go.opentelemetry.io/collector/config/configgrpc"
|
|
"go.opentelemetry.io/collector/config/confighttp"
|
|
"go.opentelemetry.io/collector/config/confignet"
|
|
"go.opentelemetry.io/collector/config/configoptional"
|
|
"go.opentelemetry.io/collector/config/configtls"
|
|
"go.opentelemetry.io/collector/confmap"
|
|
"go.opentelemetry.io/collector/confmap/confmaptest"
|
|
)
|
|
|
|
func TestUnmarshalDefaultConfig(t *testing.T) {
|
|
cm, err := confmaptest.LoadConf(filepath.Join("testdata", "default.yaml"))
|
|
require.NoError(t, err)
|
|
factory := NewFactory()
|
|
cfg := factory.CreateDefaultConfig()
|
|
require.NoError(t, cm.Unmarshal(&cfg))
|
|
expectedCfg := factory.CreateDefaultConfig().(*Config)
|
|
expectedCfg.Protocols.GRPC.GetOrInsertDefault()
|
|
expectedCfg.Protocols.HTTP.GetOrInsertDefault()
|
|
assert.Equal(t, expectedCfg, cfg)
|
|
}
|
|
|
|
func TestUnmarshalConfigOnlyGRPC(t *testing.T) {
|
|
cm, err := confmaptest.LoadConf(filepath.Join("testdata", "only_grpc.yaml"))
|
|
require.NoError(t, err)
|
|
factory := NewFactory()
|
|
cfg := factory.CreateDefaultConfig()
|
|
require.NoError(t, cm.Unmarshal(&cfg))
|
|
|
|
defaultOnlyGRPC := factory.CreateDefaultConfig().(*Config)
|
|
defaultOnlyGRPC.Protocols.GRPC.GetOrInsertDefault()
|
|
assert.Equal(t, defaultOnlyGRPC, cfg)
|
|
}
|
|
|
|
func TestUnmarshalConfigOnlyHTTP(t *testing.T) {
|
|
cm, err := confmaptest.LoadConf(filepath.Join("testdata", "only_http.yaml"))
|
|
require.NoError(t, err)
|
|
factory := NewFactory()
|
|
cfg := factory.CreateDefaultConfig()
|
|
require.NoError(t, cm.Unmarshal(&cfg))
|
|
|
|
defaultOnlyHTTP := factory.CreateDefaultConfig().(*Config)
|
|
defaultOnlyHTTP.Protocols.HTTP.GetOrInsertDefault()
|
|
assert.Equal(t, defaultOnlyHTTP, cfg)
|
|
}
|
|
|
|
func TestUnmarshalConfigOnlyHTTPNull(t *testing.T) {
|
|
cm, err := confmaptest.LoadConf(filepath.Join("testdata", "only_http_null.yaml"))
|
|
require.NoError(t, err)
|
|
factory := NewFactory()
|
|
cfg := factory.CreateDefaultConfig()
|
|
require.NoError(t, cm.Unmarshal(&cfg))
|
|
|
|
defaultOnlyHTTP := factory.CreateDefaultConfig().(*Config)
|
|
defaultOnlyHTTP.Protocols.HTTP.GetOrInsertDefault()
|
|
assert.Equal(t, defaultOnlyHTTP, cfg)
|
|
}
|
|
|
|
func TestUnmarshalConfigOnlyHTTPEmptyMap(t *testing.T) {
|
|
cm, err := confmaptest.LoadConf(filepath.Join("testdata", "only_http_empty_map.yaml"))
|
|
require.NoError(t, err)
|
|
factory := NewFactory()
|
|
cfg := factory.CreateDefaultConfig()
|
|
require.NoError(t, cm.Unmarshal(&cfg))
|
|
|
|
defaultOnlyHTTP := factory.CreateDefaultConfig().(*Config)
|
|
defaultOnlyHTTP.Protocols.HTTP.GetOrInsertDefault()
|
|
assert.Equal(t, defaultOnlyHTTP, cfg)
|
|
}
|
|
|
|
func TestUnmarshalConfig(t *testing.T) {
|
|
cm, err := confmaptest.LoadConf(filepath.Join("testdata", "config.yaml"))
|
|
require.NoError(t, err)
|
|
factory := NewFactory()
|
|
cfg := factory.CreateDefaultConfig()
|
|
require.NoError(t, cm.Unmarshal(&cfg))
|
|
assert.Equal(t,
|
|
&Config{
|
|
Protocols: Protocols{
|
|
GRPC: configoptional.Some(configgrpc.ServerConfig{
|
|
NetAddr: confignet.AddrConfig{
|
|
Endpoint: "localhost:4317",
|
|
Transport: confignet.TransportTypeTCP,
|
|
},
|
|
TLS: configoptional.Some(configtls.ServerConfig{
|
|
Config: configtls.Config{
|
|
CertFile: "test.crt",
|
|
KeyFile: "test.key",
|
|
},
|
|
}),
|
|
MaxRecvMsgSizeMiB: 32,
|
|
MaxConcurrentStreams: 16,
|
|
ReadBufferSize: 1024,
|
|
WriteBufferSize: 1024,
|
|
Keepalive: configoptional.Some(configgrpc.KeepaliveServerConfig{
|
|
ServerParameters: configoptional.Some(configgrpc.KeepaliveServerParameters{
|
|
MaxConnectionIdle: 11 * time.Second,
|
|
MaxConnectionAge: 12 * time.Second,
|
|
MaxConnectionAgeGrace: 13 * time.Second,
|
|
Time: 30 * time.Second,
|
|
Timeout: 5 * time.Second,
|
|
}),
|
|
EnforcementPolicy: configoptional.Some(configgrpc.KeepaliveEnforcementPolicy{
|
|
MinTime: 10 * time.Second,
|
|
PermitWithoutStream: true,
|
|
}),
|
|
}),
|
|
}),
|
|
HTTP: configoptional.Some(HTTPConfig{
|
|
ServerConfig: confighttp.ServerConfig{
|
|
NetAddr: confignet.AddrConfig{
|
|
Endpoint: "localhost:4318",
|
|
Transport: confignet.TransportTypeTCP,
|
|
},
|
|
Auth: configoptional.Some(confighttp.AuthConfig{
|
|
Config: configauth.Config{
|
|
AuthenticatorID: component.MustNewID("test"),
|
|
},
|
|
}),
|
|
TLS: configoptional.Some(configtls.ServerConfig{
|
|
Config: configtls.Config{
|
|
CertFile: "test.crt",
|
|
KeyFile: "test.key",
|
|
},
|
|
}),
|
|
CORS: configoptional.Some(confighttp.CORSConfig{
|
|
AllowedOrigins: []string{"https://*.test.com", "https://test.com"},
|
|
MaxAge: 7200,
|
|
}),
|
|
KeepAlivesEnabled: true,
|
|
},
|
|
TracesURLPath: "/traces",
|
|
MetricsURLPath: "/v2/metrics",
|
|
LogsURLPath: "/log/ingest",
|
|
}),
|
|
},
|
|
}, cfg)
|
|
}
|
|
|
|
func TestUnmarshalConfigUnix(t *testing.T) {
|
|
cm, err := confmaptest.LoadConf(filepath.Join("testdata", "uds.yaml"))
|
|
require.NoError(t, err)
|
|
factory := NewFactory()
|
|
cfg := factory.CreateDefaultConfig()
|
|
require.NoError(t, cm.Unmarshal(&cfg))
|
|
assert.Equal(t,
|
|
&Config{
|
|
Protocols: Protocols{
|
|
GRPC: configoptional.Some(configgrpc.ServerConfig{
|
|
NetAddr: confignet.AddrConfig{
|
|
Endpoint: "/tmp/grpc_otlp.sock",
|
|
Transport: confignet.TransportTypeUnix,
|
|
},
|
|
ReadBufferSize: 512 * 1024,
|
|
Keepalive: configoptional.Some(configgrpc.NewDefaultKeepaliveServerConfig()),
|
|
}),
|
|
HTTP: configoptional.Some(HTTPConfig{
|
|
ServerConfig: confighttp.ServerConfig{
|
|
NetAddr: confignet.AddrConfig{
|
|
Endpoint: "/tmp/http_otlp.sock",
|
|
Transport: confignet.TransportTypeUnix,
|
|
},
|
|
KeepAlivesEnabled: true,
|
|
},
|
|
TracesURLPath: defaultTracesURLPath,
|
|
MetricsURLPath: defaultMetricsURLPath,
|
|
LogsURLPath: defaultLogsURLPath,
|
|
}),
|
|
},
|
|
}, cfg)
|
|
}
|
|
|
|
// cspell:ignore htttp
|
|
func TestUnmarshalConfigTypoDefaultProtocol(t *testing.T) {
|
|
cm, err := confmaptest.LoadConf(filepath.Join("testdata", "typo_default_proto_config.yaml"))
|
|
require.NoError(t, err)
|
|
factory := NewFactory()
|
|
cfg := factory.CreateDefaultConfig()
|
|
assert.ErrorContains(t, cm.Unmarshal(&cfg), "'protocols' has invalid keys: htttp")
|
|
}
|
|
|
|
func TestUnmarshalConfigInvalidProtocol(t *testing.T) {
|
|
cm, err := confmaptest.LoadConf(filepath.Join("testdata", "bad_proto_config.yaml"))
|
|
require.NoError(t, err)
|
|
factory := NewFactory()
|
|
cfg := factory.CreateDefaultConfig()
|
|
assert.ErrorContains(t, cm.Unmarshal(&cfg), "'protocols' has invalid keys: thrift")
|
|
}
|
|
|
|
func TestUnmarshalConfigEmptyProtocols(t *testing.T) {
|
|
cm, err := confmaptest.LoadConf(filepath.Join("testdata", "bad_no_proto_config.yaml"))
|
|
require.NoError(t, err)
|
|
factory := NewFactory()
|
|
cfg := factory.CreateDefaultConfig()
|
|
require.NoError(t, cm.Unmarshal(&cfg))
|
|
assert.EqualError(t, confmap.Validate(cfg), "must specify at least one protocol when using the OTLP receiver")
|
|
}
|
|
|
|
func TestUnmarshalConfigInvalidSignalPath(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
testDataFn string
|
|
}{
|
|
{
|
|
name: "Invalid traces URL path",
|
|
testDataFn: "invalid_traces_path.yaml",
|
|
},
|
|
{
|
|
name: "Invalid metrics URL path",
|
|
testDataFn: "invalid_metrics_path.yaml",
|
|
},
|
|
{
|
|
name: "Invalid logs URL path",
|
|
testDataFn: "invalid_logs_path.yaml",
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
cm, err := confmaptest.LoadConf(filepath.Join("testdata", tt.testDataFn))
|
|
require.NoError(t, err)
|
|
factory := NewFactory()
|
|
cfg := factory.CreateDefaultConfig()
|
|
assert.ErrorContains(t, cm.Unmarshal(&cfg), "invalid HTTP URL path set for signal: parse \":invalid\": missing protocol scheme")
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestUnmarshalConfigEmpty(t *testing.T) {
|
|
factory := NewFactory()
|
|
cfg := factory.CreateDefaultConfig()
|
|
require.NoError(t, confmap.New().Unmarshal(&cfg))
|
|
assert.EqualError(t, confmap.Validate(cfg), "must specify at least one protocol when using the OTLP receiver")
|
|
}
|