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]>
109 lines
2.5 KiB
Go
109 lines
2.5 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package service
|
|
|
|
import (
|
|
"errors"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"go.opentelemetry.io/collector/component"
|
|
"go.opentelemetry.io/collector/confmap"
|
|
"go.opentelemetry.io/collector/pipeline"
|
|
"go.opentelemetry.io/collector/service/extensions"
|
|
"go.opentelemetry.io/collector/service/pipelines"
|
|
)
|
|
|
|
func TestConfigValidate(t *testing.T) {
|
|
testCases := []struct {
|
|
name string // test case name (also file name containing config yaml)
|
|
cfgFn func() *Config
|
|
expected error
|
|
}{
|
|
{
|
|
name: "valid",
|
|
cfgFn: generateConfig,
|
|
expected: nil,
|
|
},
|
|
{
|
|
name: "valid-telemetry-config",
|
|
cfgFn: func() *Config {
|
|
cfg := generateConfig()
|
|
cfg.Telemetry = fakeTelemetryConfig{Invalid: false}
|
|
return cfg
|
|
},
|
|
expected: nil,
|
|
},
|
|
{
|
|
name: "duplicate-processor-reference",
|
|
cfgFn: func() *Config {
|
|
cfg := generateConfig()
|
|
pipe := cfg.Pipelines[pipeline.NewID(pipeline.SignalTraces)]
|
|
pipe.Processors = append(pipe.Processors, pipe.Processors...)
|
|
return cfg
|
|
},
|
|
expected: errors.New(`references processor "nop" multiple times`),
|
|
},
|
|
{
|
|
name: "invalid-telemetry-config",
|
|
cfgFn: func() *Config {
|
|
cfg := generateConfig()
|
|
cfg.Telemetry = fakeTelemetryConfig{Invalid: true}
|
|
return cfg
|
|
},
|
|
expected: errors.New("telemetry: invalid config"),
|
|
},
|
|
}
|
|
|
|
for _, tt := range testCases {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
cfg := tt.cfgFn()
|
|
err := confmap.Validate(cfg)
|
|
if tt.expected != nil {
|
|
assert.ErrorContains(t, err, tt.expected.Error())
|
|
} else {
|
|
assert.NoError(t, err)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestConfmapMarshalConfig(t *testing.T) {
|
|
conf := confmap.New()
|
|
|
|
require.NoError(t, conf.Marshal(Config{
|
|
Telemetry: fakeTelemetryConfig{},
|
|
}))
|
|
assert.Equal(t, map[string]any{
|
|
"pipelines": map[string]any(nil),
|
|
"telemetry": map[string]any{"invalid": false},
|
|
}, conf.ToStringMap())
|
|
}
|
|
|
|
func generateConfig() *Config {
|
|
return &Config{
|
|
Extensions: extensions.Config{component.MustNewID("nop")},
|
|
Pipelines: pipelines.Config{
|
|
pipeline.NewID(pipeline.SignalTraces): {
|
|
Receivers: []component.ID{component.MustNewID("nop")},
|
|
Processors: []component.ID{component.MustNewID("nop")},
|
|
Exporters: []component.ID{component.MustNewID("nop")},
|
|
},
|
|
},
|
|
}
|
|
}
|
|
|
|
type fakeTelemetryConfig struct {
|
|
Invalid bool `mapstructure:"invalid"`
|
|
}
|
|
|
|
func (cfg fakeTelemetryConfig) Validate() error {
|
|
if cfg.Invalid {
|
|
return errors.New("invalid config")
|
|
}
|
|
return nil
|
|
}
|