Skip to content

[chore] Clean up the naming convention to make it simpler to use a retriever #4493

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[chore] Clean up the naming convention to make it simpler to use a retriever #4493

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 13 additions & 18 deletions apis/v1beta1/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,20 +155,20 @@ func (c *Config) getRbacRulesForComponentKinds(logger logr.Logger, componentKind
var cfg AnyConfig
switch componentKind {
case KindReceiver:
retriever = receivers.ReceiverFor
retriever = receivers.GetParser
cfg = c.Receivers
case KindExporter:
retriever = exporters.ParserFor
retriever = exporters.GetParser
cfg = c.Exporters
case KindProcessor:
retriever = processors.ProcessorFor
retriever = processors.GetParser
if c.Processors == nil {
cfg = AnyConfig{}
} else {
cfg = *c.Processors
}
case KindExtension:
retriever = extensions.ParserFor
retriever = extensions.GetParser
if c.Extensions == nil {
cfg = AnyConfig{}
} else {
Expand All @@ -179,7 +179,6 @@ func (c *Config) getRbacRulesForComponentKinds(logger logr.Logger, componentKind
continue
}
for componentName := range enabledComponents[componentKind] {
// TODO: Clean up the naming here and make it simpler to use a retriever.
parser := retriever(componentName)
if parsedRules, err := parser.GetRBACRules(logger, cfg.Object[componentName]); err != nil {
return nil, err
Expand All @@ -200,23 +199,22 @@ func (c *Config) getPortsForComponentKinds(logger logr.Logger, componentKinds ..
var cfg AnyConfig
switch componentKind {
case KindReceiver:
retriever = receivers.ReceiverFor
retriever = receivers.GetParser
cfg = c.Receivers
case KindExporter:
retriever = exporters.ParserFor
retriever = exporters.GetParser
cfg = c.Exporters
case KindProcessor:
continue
case KindExtension:
retriever = extensions.ParserFor
retriever = extensions.GetParser
if c.Extensions == nil {
cfg = AnyConfig{}
} else {
cfg = *c.Extensions
}
}
for componentName := range enabledComponents[componentKind] {
// TODO: Clean up the naming here and make it simpler to use a retriever.
parser := retriever(componentName)
if parsedPorts, err := parser.Ports(logger, componentName, cfg.Object[componentName]); err != nil {
return nil, err
Expand All @@ -243,7 +241,7 @@ func (c *Config) getEnvironmentVariablesForComponentKinds(logger logr.Logger, co

switch componentKind {
case KindReceiver:
retriever = receivers.ReceiverFor
retriever = receivers.GetParser
cfg = c.Receivers
case KindExporter:
continue
Expand Down Expand Up @@ -282,7 +280,7 @@ func (c *Config) applyDefaultForComponentKinds(logger logr.Logger, componentKind
var cfg AnyConfig
switch componentKind {
case KindReceiver:
retriever = receivers.ReceiverFor
retriever = receivers.GetParser
cfg = c.Receivers
case KindExporter:
continue
Expand All @@ -292,7 +290,7 @@ func (c *Config) applyDefaultForComponentKinds(logger logr.Logger, componentKind
if c.Extensions == nil {
continue
}
retriever = extensions.ParserFor
retriever = extensions.GetParser
cfg = *c.Extensions
}
for componentName := range enabledComponents[componentKind] {
Expand Down Expand Up @@ -367,8 +365,7 @@ func (c *Config) GetLivenessProbe(logger logr.Logger) (*corev1.Probe, error) {

enabledComponents := c.GetEnabledComponents()
for componentName := range enabledComponents[KindExtension] {
// TODO: Clean up the naming here and make it simpler to use a retriever.
parser := extensions.ParserFor(componentName)
parser := extensions.GetParser(componentName)
if probe, err := parser.GetLivenessProbe(logger, c.Extensions.Object[componentName]); err != nil {
return nil, err
} else if probe != nil {
Expand All @@ -387,8 +384,7 @@ func (c *Config) GetReadinessProbe(logger logr.Logger) (*corev1.Probe, error) {

enabledComponents := c.GetEnabledComponents()
for componentName := range enabledComponents[KindExtension] {
// TODO: Clean up the naming here and make it simpler to use a retriever.
parser := extensions.ParserFor(componentName)
parser := extensions.GetParser(componentName)
if probe, err := parser.GetReadinessProbe(logger, c.Extensions.Object[componentName]); err != nil {
return nil, err
} else if probe != nil {
Expand All @@ -407,8 +403,7 @@ func (c *Config) GetStartupProbe(logger logr.Logger) (*corev1.Probe, error) {

enabledComponents := c.GetEnabledComponents()
for componentName := range enabledComponents[KindExtension] {
// TODO: Clean up the naming here and make it simpler to use a retriever.
parser := extensions.ParserFor(componentName)
parser := extensions.GetParser(componentName)
if probe, err := parser.GetStartupProbe(logger, c.Extensions.Object[componentName]); err != nil {
return nil, err
} else if probe != nil {
Expand Down
4 changes: 2 additions & 2 deletions internal/components/exporters/helpers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ var registry = map[string]components.Parser{
"prometheus": components.NewSinglePortParserBuilder("prometheus", 8888).MustBuild(),
}

// ParserFor returns a parser builder for the given exporter name.
func ParserFor(name string) components.Parser {
// GetParser returns a parser builder for the given exporter name.
func GetParser(name string) components.Parser {
if parser, ok := registry[components.ComponentType(name)]; ok {
return parser
}
Expand Down
10 changes: 5 additions & 5 deletions internal/components/exporters/helpers_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import (

func TestParserForReturns(t *testing.T) {
const testComponentName = "test"
parser := ParserFor(testComponentName)
parser := GetParser(testComponentName)
assert.Equal(t, "test", parser.ParserType())
assert.Equal(t, "__test", parser.ParserName())
ports, err := parser.Ports(logr.Discard(), testComponentName, map[string]interface{}{
Expand All @@ -28,7 +28,7 @@ func TestParserForReturns(t *testing.T) {
func TestCanRegister(t *testing.T) {
const testComponentName = "test"
registry[testComponentName] = components.NewSinglePortParserBuilder(testComponentName, 9000).MustBuild()
parser := ParserFor(testComponentName)
parser := GetParser(testComponentName)
assert.Equal(t, "test", parser.ParserType())
assert.Equal(t, "__test", parser.ParserName())
ports, err := parser.Ports(logr.Discard(), testComponentName, map[string]interface{}{})
Expand All @@ -52,7 +52,7 @@ func TestExporterComponentParsers(t *testing.T) {
})
t.Run("bad config errors", func(t *testing.T) {
// prepare
parser := ParserFor(tt.exporterName)
parser := GetParser(tt.exporterName)

// test throwing in pure junk
_, err := parser.Ports(logr.Discard(), tt.exporterName, func() {})
Expand All @@ -63,7 +63,7 @@ func TestExporterComponentParsers(t *testing.T) {

t.Run("assigns the expected port", func(t *testing.T) {
// prepare
parser := ParserFor(tt.exporterName)
parser := GetParser(tt.exporterName)

// test
ports, err := parser.Ports(logr.Discard(), tt.exporterName, map[string]interface{}{})
Expand All @@ -81,7 +81,7 @@ func TestExporterComponentParsers(t *testing.T) {

t.Run("allows port to be overridden", func(t *testing.T) {
// prepare
parser := ParserFor(tt.exporterName)
parser := GetParser(tt.exporterName)

// test
ports, err := parser.Ports(logr.Discard(), tt.exporterName, map[string]interface{}{
Expand Down
4 changes: 2 additions & 2 deletions internal/components/extensions/healthcheckv1_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ func TestHealthCheckV1Probe(t *testing.T) {

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
parser := ParserFor("health_check")
parser := GetParser("health_check")
got, err := parser.GetLivenessProbe(logr.Discard(), tt.args.config)
if !tt.wantErr(t, err, fmt.Sprintf("GetLivenessProbe(%v)", tt.args.config)) {
return
Expand Down Expand Up @@ -274,7 +274,7 @@ func TestHealthCheckV1AddressDefaulter(t *testing.T) {

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
parser := ParserFor("health_check")
parser := GetParser("health_check")
got, err := parser.GetDefaultConfig(logr.Discard(), tt.args.config)
if !tt.wantErr(t, err, fmt.Sprintf("GetDefaultConfig(%v)", tt.args.config)) {
return
Expand Down
4 changes: 2 additions & 2 deletions internal/components/extensions/helpers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ var registry = map[string]components.Parser{
MustBuild(),
}

// ParserFor returns a parser builder for the given exporter name.
func ParserFor(name string) components.Parser {
// GetParser returns a parser builder for the given exporter name.
func GetParser(name string) components.Parser {
if parser, ok := registry[components.ComponentType(name)]; ok {
return parser
}
Expand Down
10 changes: 5 additions & 5 deletions internal/components/extensions/helpers_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import (

func TestParserForReturns(t *testing.T) {
const testComponentName = "test"
parser := ParserFor(testComponentName)
parser := GetParser(testComponentName)
assert.Equal(t, "test", parser.ParserType())
assert.Equal(t, "__test", parser.ParserName())
ports, err := parser.Ports(logr.Discard(), testComponentName, map[string]interface{}{
Expand All @@ -28,7 +28,7 @@ func TestParserForReturns(t *testing.T) {
func TestCanRegister(t *testing.T) {
const testComponentName = "test"
registry[testComponentName] = components.NewSinglePortParserBuilder(testComponentName, 9000).MustBuild()
parser := ParserFor(testComponentName)
parser := GetParser(testComponentName)
assert.Equal(t, "test", parser.ParserType())
assert.Equal(t, "__test", parser.ParserName())
ports, err := parser.Ports(logr.Discard(), testComponentName, map[string]interface{}{})
Expand All @@ -52,7 +52,7 @@ func TestExtensionsComponentParsers(t *testing.T) {
})
t.Run("bad config errors", func(t *testing.T) {
// prepare
parser := ParserFor(tt.exporterName)
parser := GetParser(tt.exporterName)

// test throwing in pure junk
_, err := parser.Ports(logr.Discard(), tt.exporterName, func() {})
Expand All @@ -63,7 +63,7 @@ func TestExtensionsComponentParsers(t *testing.T) {

t.Run("assigns the expected port", func(t *testing.T) {
// prepare
parser := ParserFor(tt.exporterName)
parser := GetParser(tt.exporterName)

// test
ports, err := parser.Ports(logr.Discard(), tt.exporterName, map[string]interface{}{})
Expand All @@ -81,7 +81,7 @@ func TestExtensionsComponentParsers(t *testing.T) {

t.Run("allows port to be overridden", func(t *testing.T) {
// prepare
parser := ParserFor(tt.exporterName)
parser := GetParser(tt.exporterName)

// test
ports, err := parser.Ports(logr.Discard(), tt.exporterName, map[string]interface{}{
Expand Down
4 changes: 2 additions & 2 deletions internal/components/processors/helpers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ func IsRegistered(name string) bool {
return ok
}

// ProcessorFor returns a parser builder for the given exporter name.
func ProcessorFor(name string) components.Parser {
// GetParser returns a parser builder for the given exporter name.
func GetParser(name string) components.Parser {
if parser, ok := registry[components.ComponentType(name)]; ok {
return parser
}
Expand Down
8 changes: 4 additions & 4 deletions internal/components/processors/helpers_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ var logger = logf.Log.WithName("unit-tests")

func TestParserForReturns(t *testing.T) {
const testComponentName = "test"
parser := processors.ProcessorFor(testComponentName)
parser := processors.GetParser(testComponentName)
assert.Equal(t, "test", parser.ParserType())
assert.Equal(t, "__test", parser.ParserName())
ports, err := parser.Ports(logr.Discard(), testComponentName, map[string]interface{}{
Expand All @@ -32,7 +32,7 @@ func TestCanRegister(t *testing.T) {
const testComponentName = "test"
processors.Register(testComponentName, components.NewSinglePortParserBuilder(testComponentName, 9000).MustBuild())
assert.True(t, processors.IsRegistered(testComponentName))
parser := processors.ProcessorFor(testComponentName)
parser := processors.GetParser(testComponentName)
assert.Equal(t, "test", parser.ParserType())
assert.Equal(t, "__test", parser.ParserName())
ports, err := parser.Ports(logr.Discard(), testComponentName, map[string]interface{}{})
Expand All @@ -53,14 +53,14 @@ func TestDownstreamParsers(t *testing.T) {
t.Run(tt.processorName, func(t *testing.T) {
t.Run("builds successfully", func(t *testing.T) {
// test
parser := processors.ProcessorFor(tt.processorName)
parser := processors.GetParser(tt.processorName)

// verify
assert.Equal(t, tt.parserName, parser.ParserName())
})
t.Run("bad config errors", func(t *testing.T) {
// prepare
parser := processors.ProcessorFor(tt.processorName)
parser := processors.GetParser(tt.processorName)

// test throwing in pure junk
_, err := parser.Ports(logger, tt.processorName, func() {})
Expand Down
2 changes: 1 addition & 1 deletion internal/components/processors/k8sattribute_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ func TestGenerateK8SAttrRbacRules(t *testing.T) {
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
parser := processors.ProcessorFor("k8sattributes")
parser := processors.GetParser("k8sattributes")
got, err := parser.GetRBACRules(logger, tt.args.config)
if !tt.wantErr(t, err, fmt.Sprintf("GetRBACRules(%v)", tt.args.config)) {
return
Expand Down
2 changes: 1 addition & 1 deletion internal/components/processors/resourcedetection_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ func TestGenerateResourceDetectionRbacRules(t *testing.T) {
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
parser := processors.ProcessorFor("resourcedetection")
parser := processors.GetParser("resourcedetection")
got, err := parser.GetRBACRules(logger, tt.args.config)
if !tt.wantErr(t, err, fmt.Sprintf("GetRBACRules(%v)", tt.args.config)) {
return
Expand Down
4 changes: 2 additions & 2 deletions internal/components/receivers/helpers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ func IsRegistered(name string) bool {
return ok
}

// ReceiverFor returns a parser builder for the given exporter name.
func ReceiverFor(name string) components.Parser {
// GetParser returns a parser builder for the given exporter name.
func GetParser(name string) components.Parser {
if parser, ok := registry[components.ComponentType(name)]; ok {
return parser
}
Expand Down
8 changes: 4 additions & 4 deletions internal/components/receivers/multi_endpoint_receiver_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,13 +387,13 @@ func TestMultiEndpointReceiverParsers(t *testing.T) {
})

t.Run("is found by name", func(t *testing.T) {
p := receivers.ReceiverFor(tt.receiverName)
p := receivers.GetParser(tt.receiverName)
assert.Equal(t, tt.parserName, p.ParserName())
})

t.Run("bad config errors", func(t *testing.T) {
// prepare
parser := receivers.ReceiverFor(tt.receiverName)
parser := receivers.GetParser(tt.receiverName)

// test
_, err := parser.Ports(logger, tt.receiverName, []interface{}{"junk"})
Expand All @@ -403,7 +403,7 @@ func TestMultiEndpointReceiverParsers(t *testing.T) {
})
t.Run("good config, unknown protocol", func(t *testing.T) {
// prepare
parser := receivers.ReceiverFor(tt.receiverName)
parser := receivers.GetParser(tt.receiverName)

// test
_, err := parser.Ports(logger, tt.receiverName, map[string]interface{}{
Expand All @@ -418,7 +418,7 @@ func TestMultiEndpointReceiverParsers(t *testing.T) {
for _, kase := range tt.cases {
t.Run(kase.name, func(t *testing.T) {
// prepare
parser := receivers.ReceiverFor(tt.receiverName)
parser := receivers.GetParser(tt.receiverName)

// test
ports, err := parser.Ports(logger, tt.receiverName, kase.config)
Expand Down
6 changes: 3 additions & 3 deletions internal/components/receivers/scraper_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,15 @@ func TestScraperParsers(t *testing.T) {
t.Run(tt.receiverName, func(t *testing.T) {
t.Run("builds successfully", func(t *testing.T) {
// test
parser := receivers.ReceiverFor(tt.receiverName)
parser := receivers.GetParser(tt.receiverName)

// verify
assert.Equal(t, tt.parserName, parser.ParserName())
})

t.Run("default is nothing", func(t *testing.T) {
// prepare
parser := receivers.ReceiverFor(tt.receiverName)
parser := receivers.GetParser(tt.receiverName)

// test
ports, err := parser.Ports(logger, tt.receiverName, map[string]interface{}{})
Expand All @@ -71,7 +71,7 @@ func TestScraperParsers(t *testing.T) {

t.Run("always returns nothing", func(t *testing.T) {
// prepare
parser := receivers.ReceiverFor(tt.receiverName)
parser := receivers.GetParser(tt.receiverName)

// test
ports, err := parser.Ports(logger, tt.receiverName, map[string]interface{}{
Expand Down
Loading
Loading