Remove single-field configs

kyma-project · Dec 6, 2024 · f28e9e1 · f28e9e1
1 parent 03be612
commit f28e9e1
Show file tree

Hide file tree

Showing 12 changed files with 74 additions and 85 deletions.
diff --git a/controllers/telemetry/logpipeline_controller.go b/controllers/telemetry/logpipeline_controller.go
@@ -200,17 +200,13 @@ func configureFluentBitReconciler(client client.Client, config LogPipelineContro
 
 //nolint:unparam // error is always nil: An error could be returned after implementing the IstioStatusChecker (TODO)
 func configureOtelReconciler(client client.Client, config LogPipelineControllerConfig, _ *prober.LogPipelineProber) (*logpipelineotel.Reconciler, error) {
-	otelConfig := logpipelineotel.Config{
-		TelemetryNamespace: config.TelemetryNamespace,
-	}
-
 	pipelineValidator := &logpipelineotel.Validator{
 		// TODO: Add validators
 	}
 
 	otelReconciler := logpipelineotel.New(
 		client,
-		otelConfig,
+		config.TelemetryNamespace,
 		otelcollector.NewLogGatewayApplierDeleter(config.OTelCollectorImage, config.TelemetryNamespace, config.LogGatewayPriorityClassName),
 		&gateway.Builder{Reader: client},
 		&workloadstatus.DeploymentProber{Client: client},

diff --git a/controllers/telemetry/metricpipeline_controller.go b/controllers/telemetry/metricpipeline_controller.go
@@ -111,14 +111,10 @@ func NewMetricPipelineController(client client.Client, reconcileTriggerChan <-ch
 
 	gatewayConfigBuilder := &gateway.Builder{Reader: client}
 
-	reconcilerConfig := metricpipeline.Config{
-		ModuleVersion:      config.ModuleVersion,
-		TelemetryNamespace: config.TelemetryNamespace,
-	}
-
 	reconciler := metricpipeline.New(
 		client,
-		reconcilerConfig,
+		config.TelemetryNamespace,
+		config.ModuleVersion,
 		otelcollector.NewMetricAgentApplierDeleter(config.OTelCollectorImage, config.TelemetryNamespace, config.MetricAgentPriorityClassName),
 		agentConfigBuilder,
 		&workloadstatus.DaemonSetProber{Client: client},

diff --git a/controllers/telemetry/tracepipeline_controller.go b/controllers/telemetry/tracepipeline_controller.go
@@ -99,13 +99,9 @@ func NewTracePipelineController(client client.Client, reconcileTriggerChan <-cha
 		return nil, err
 	}
 
-	reconcilerConfig := tracepipeline.Config{
-		TelemetryNamespace: config.TelemetryNamespace,
-	}
-
 	reconciler := tracepipeline.New(
 		client,
-		reconcilerConfig,
+		config.TelemetryNamespace,
 		flowHealthProber,
 		otelcollector.NewTraceGatewayApplierDeleter(config.OTelCollectorImage, config.TelemetryNamespace, config.TraceGatewayPriorityClassName),
 		&gateway.Builder{Reader: client},

diff --git a/internal/reconciler/logpipeline/otel/reconciler.go b/internal/reconciler/logpipeline/otel/reconciler.go
@@ -25,10 +25,6 @@ import (
 
 const defaultReplicaCount int32 = 2
 
-type Config struct {
-	TelemetryNamespace string
-}
-
 type GatewayConfigBuilder interface {
 	Build(ctx context.Context, pipelines []telemetryv1alpha1.LogPipeline) (*gateway.Config, otlpexporter.EnvVars, error)
 }
@@ -47,7 +43,7 @@ var _ logpipeline.LogPipelineReconciler = &Reconciler{}
 type Reconciler struct {
 	client.Client
 
-	config Config
+	telemetryNamespace string
 
 	// Dependencies
 	gatewayApplierDeleter GatewayApplierDeleter
@@ -59,7 +55,7 @@ type Reconciler struct {
 
 func New(
 	client client.Client,
-	config Config,
+	telemetryNamespace string,
 	gatewayApplierDeleter GatewayApplierDeleter,
 	gatewayConfigBuilder GatewayConfigBuilder,
 	gatewayProber commonstatus.Prober,
@@ -68,7 +64,7 @@ func New(
 ) *Reconciler {
 	return &Reconciler{
 		Client:                client,
-		config:                config,
+		telemetryNamespace:    telemetryNamespace,
 		gatewayApplierDeleter: gatewayApplierDeleter,
 		gatewayConfigBuilder:  gatewayConfigBuilder,
 		gatewayProber:         gatewayProber,

diff --git a/internal/reconciler/logpipeline/otel/reconciler_test.go b/internal/reconciler/logpipeline/otel/reconciler_test.go
@@ -32,9 +32,7 @@ func TestReconcile(t *testing.T) {
 	overridesHandlerStub := &logpipelinemocks.OverridesHandler{}
 	overridesHandlerStub.On("LoadOverrides", context.Background()).Return(&overrides.Config{}, nil)
 
-	testConfig := Config{
-		TelemetryNamespace: "default",
-	}
+	telemetryNamespace := "default"
 
 	t.Run("log gateway probing failed", func(t *testing.T) {
 		pipeline := testutils.NewLogPipelineBuilder().WithName("pipeline").WithOTLPOutput().Build()
@@ -61,7 +59,7 @@ func TestReconcile(t *testing.T) {
 
 		sut := New(
 			fakeClient,
-			testConfig,
+			telemetryNamespace,
 			gatewayApplierDeleterMock,
 			gatewayConfigBuilderMock,
 			gatewayProberStub,
@@ -109,7 +107,7 @@ func TestReconcile(t *testing.T) {
 
 		sut := New(
 			fakeClient,
-			testConfig,
+			telemetryNamespace,
 			gatewayApplierDeleterMock,
 			gatewayConfigBuilderMock,
 			gatewayProberStub,
@@ -157,7 +155,7 @@ func TestReconcile(t *testing.T) {
 
 		sut := New(
 			fakeClient,
-			testConfig,
+			telemetryNamespace,
 			gatewayApplierDeleterMock,
 			gatewayConfigBuilderMock,
 			gatewayProberStub,

diff --git a/internal/reconciler/logpipeline/otel/status.go b/internal/reconciler/logpipeline/otel/status.go
@@ -50,7 +50,7 @@ func (r *Reconciler) updateStatus(ctx context.Context, pipelineName string) erro
 
 func (r *Reconciler) setGatewayHealthyCondition(ctx context.Context, pipeline *telemetryv1alpha1.LogPipeline) {
 	condition := commonstatus.GetGatewayHealthyCondition(ctx,
-		r.gatewayProber, types.NamespacedName{Name: otelcollector.LogGatewayName, Namespace: r.config.TelemetryNamespace},
+		r.gatewayProber, types.NamespacedName{Name: otelcollector.LogGatewayName, Namespace: r.telemetryNamespace},
 		r.errToMessageConverter,
 		commonstatus.SignalTypeLogs)
 	condition.ObservedGeneration = pipeline.Generation

diff --git a/internal/reconciler/metricpipeline/reconciler.go b/internal/reconciler/metricpipeline/reconciler.go
@@ -28,11 +28,6 @@ import (
 
 const defaultReplicaCount int32 = 2
 
-type Config struct {
-	ModuleVersion      string
-	TelemetryNamespace string
-}
-
 type AgentConfigBuilder interface {
 	Build(pipelines []telemetryv1alpha1.MetricPipeline, options agent.BuildOptions) *agent.Config
 }
@@ -71,7 +66,9 @@ type IstioStatusChecker interface {
 type Reconciler struct {
 	client.Client
 
-	config Config
+	telemetryNamespace string
+	// TODO(skhalash): introduce an embed pkg exposing the module version set by go build
+	moduleVersion string
 
 	agentApplierDeleter   AgentApplierDeleter
 	agentConfigBuilder    AgentConfigBuilder
@@ -89,7 +86,8 @@ type Reconciler struct {
 
 func New(
 	client client.Client,
-	config Config,
+	telemetryNamespace string,
+	moduleVersion string,
 	agentApplierDeleter AgentApplierDeleter,
 	agentConfigBuilder AgentConfigBuilder,
 	agentProber commonstatus.Prober,
@@ -105,7 +103,8 @@ func New(
 ) *Reconciler {
 	return &Reconciler{
 		Client:                client,
-		config:                config,
+		telemetryNamespace:    telemetryNamespace,
+		moduleVersion:         moduleVersion,
 		agentApplierDeleter:   agentApplierDeleter,
 		agentConfigBuilder:    agentConfigBuilder,
 		agentProber:           agentProber,
@@ -244,8 +243,8 @@ func isMetricAgentRequired(pipeline *telemetryv1alpha1.MetricPipeline) bool {
 
 func (r *Reconciler) reconcileMetricGateway(ctx context.Context, pipeline *telemetryv1alpha1.MetricPipeline, allPipelines []telemetryv1alpha1.MetricPipeline) error {
 	collectorConfig, collectorEnvVars, err := r.gatewayConfigBuilder.Build(ctx, allPipelines, gateway.BuildOptions{
-		GatewayNamespace:            r.config.TelemetryNamespace,
-		InstrumentationScopeVersion: r.config.ModuleVersion,
+		GatewayNamespace:            r.telemetryNamespace,
+		InstrumentationScopeVersion: r.moduleVersion,
 	})
 
 	if err != nil {
@@ -290,8 +289,8 @@ func (r *Reconciler) reconcileMetricAgents(ctx context.Context, pipeline *teleme
 	agentConfig := r.agentConfigBuilder.Build(allPipelines, agent.BuildOptions{
 		IstioEnabled:                isIstioActive,
 		IstioCertPath:               otelcollector.IstioCertPath,
-		InstrumentationScopeVersion: r.config.ModuleVersion,
-		AgentNamespace:              r.config.TelemetryNamespace,
+		InstrumentationScopeVersion: r.moduleVersion,
+		AgentNamespace:              r.telemetryNamespace,
 	})
 
 	agentConfigYAML, err := yaml.Marshal(agentConfig)

diff --git a/internal/reconciler/metricpipeline/reconciler_test.go b/internal/reconciler/metricpipeline/reconciler_test.go
@@ -46,9 +46,8 @@ func TestReconcile(t *testing.T) {
 
 	istioStatusCheckerStub := &stubs.IstioStatusChecker{IsActive: false}
 
-	testConfig := Config{
-		TelemetryNamespace: "default",
-	}
+	telemetryNamespace := "default"
+	moduleVersion := "1.0.0"
 
 	t.Run("metric gateway deployment is not ready", func(t *testing.T) {
 		pipeline := testutils.NewMetricPipelineBuilder().Build()
@@ -81,7 +80,8 @@ func TestReconcile(t *testing.T) {
 
 		sut := New(
 			fakeClient,
-			testConfig,
+			telemetryNamespace,
+			moduleVersion,
 			&mocks.AgentApplierDeleter{},
 			&mocks.AgentConfigBuilder{},
 			agentProberStub,
@@ -141,7 +141,8 @@ func TestReconcile(t *testing.T) {
 
 		sut := New(
 			fakeClient,
-			testConfig,
+			telemetryNamespace,
+			moduleVersion,
 			&mocks.AgentApplierDeleter{},
 			&mocks.AgentConfigBuilder{},
 			agentProberStub,
@@ -201,7 +202,8 @@ func TestReconcile(t *testing.T) {
 
 		sut := New(
 			fakeClient,
-			testConfig,
+			telemetryNamespace,
+			moduleVersion,
 			&mocks.AgentApplierDeleter{},
 			&mocks.AgentConfigBuilder{},
 			agentProberStub,
@@ -267,7 +269,8 @@ func TestReconcile(t *testing.T) {
 
 		sut := New(
 			fakeClient,
-			testConfig,
+			telemetryNamespace,
+			moduleVersion,
 			agentApplierDeleterMock,
 			agentConfigBuilderMock,
 			agentProberStub,
@@ -335,7 +338,8 @@ func TestReconcile(t *testing.T) {
 
 		sut := New(
 			fakeClient,
-			testConfig,
+			telemetryNamespace,
+			moduleVersion,
 			agentApplierDeleterMock,
 			agentConfigBuilderMock,
 			agentProberStub,
@@ -403,7 +407,8 @@ func TestReconcile(t *testing.T) {
 
 		sut := New(
 			fakeClient,
-			testConfig,
+			telemetryNamespace,
+			moduleVersion,
 			agentApplierDeleterMock,
 			agentConfigBuilderMock,
 			agentProberStub,
@@ -472,7 +477,8 @@ func TestReconcile(t *testing.T) {
 
 		sut := New(
 			fakeClient,
-			testConfig,
+			telemetryNamespace,
+			moduleVersion,
 			&mocks.AgentApplierDeleter{},
 			&mocks.AgentConfigBuilder{},
 			agentProberStub,
@@ -535,7 +541,8 @@ func TestReconcile(t *testing.T) {
 
 		sut := New(
 			fakeClient,
-			testConfig,
+			telemetryNamespace,
+			moduleVersion,
 			agentApplierDeleterMock,
 			&mocks.AgentConfigBuilder{},
 			agentProberStub,
@@ -599,7 +606,8 @@ func TestReconcile(t *testing.T) {
 
 		sut := New(
 			fakeClient,
-			testConfig,
+			telemetryNamespace,
+			moduleVersion,
 			&mocks.AgentApplierDeleter{},
 			&mocks.AgentConfigBuilder{},
 			agentProberStub,
@@ -761,7 +769,8 @@ func TestReconcile(t *testing.T) {
 				errToMsg := &conditions.ErrorToMessageConverter{}
 				sut := New(
 					fakeClient,
-					testConfig,
+					telemetryNamespace,
+					moduleVersion,
 					&mocks.AgentApplierDeleter{},
 					&mocks.AgentConfigBuilder{},
 					agentProberStub,
@@ -905,7 +914,8 @@ func TestReconcile(t *testing.T) {
 
 				sut := New(
 					fakeClient,
-					testConfig,
+					telemetryNamespace,
+					moduleVersion,
 					agentApplierDeleterMock,
 					&mocks.AgentConfigBuilder{},
 					agentProberStub,
@@ -990,7 +1000,8 @@ func TestReconcile(t *testing.T) {
 
 		sut := New(
 			fakeClient,
-			testConfig,
+			telemetryNamespace,
+			moduleVersion,
 			&mocks.AgentApplierDeleter{},
 			&mocks.AgentConfigBuilder{},
 			agentProberStub,
@@ -1060,7 +1071,8 @@ func TestReconcile(t *testing.T) {
 
 		sut := New(
 			fakeClient,
-			testConfig,
+			telemetryNamespace,
+			moduleVersion,
 			&mocks.AgentApplierDeleter{},
 			&mocks.AgentConfigBuilder{},
 			agentProberStub,
@@ -1134,7 +1146,8 @@ func TestReconcile(t *testing.T) {
 
 		sut := New(
 			fakeClient,
-			testConfig,
+			telemetryNamespace,
+			moduleVersion,
 			agentApplierDeleterMock,
 			&mocks.AgentConfigBuilder{},
 			agentProberStub,
@@ -1259,7 +1272,8 @@ func TestReconcile(t *testing.T) {
 
 				sut := Reconciler{
 					Client:                fakeClient,
-					config:                testConfig,
+					telemetryNamespace:    telemetryNamespace,
+					moduleVersion:         moduleVersion,
 					agentConfigBuilder:    agentConfigBuilderMock,
 					gatewayConfigBuilder:  gatewayConfigBuilderMock,
 					agentApplierDeleter:   agentApplierDeleterMock,

diff --git a/internal/reconciler/metricpipeline/status.go b/internal/reconciler/metricpipeline/status.go
@@ -61,7 +61,7 @@ func (r *Reconciler) setAgentHealthyCondition(ctx context.Context, pipeline *tel
 	if isMetricAgentRequired(pipeline) {
 		condition = commonstatus.GetAgentHealthyCondition(ctx,
 			r.agentProber,
-			types.NamespacedName{Name: otelcollector.MetricAgentName, Namespace: r.config.TelemetryNamespace},
+			types.NamespacedName{Name: otelcollector.MetricAgentName, Namespace: r.telemetryNamespace},
 			r.errToMsgConverter,
 			commonstatus.SignalTypeMetrics)
 	}
@@ -72,7 +72,7 @@ func (r *Reconciler) setAgentHealthyCondition(ctx context.Context, pipeline *tel
 
 func (r *Reconciler) setGatewayHealthyCondition(ctx context.Context, pipeline *telemetryv1alpha1.MetricPipeline) {
 	condition := commonstatus.GetGatewayHealthyCondition(ctx,
-		r.gatewayProber, types.NamespacedName{Name: otelcollector.MetricGatewayName, Namespace: r.config.TelemetryNamespace},
+		r.gatewayProber, types.NamespacedName{Name: otelcollector.MetricGatewayName, Namespace: r.telemetryNamespace},
 		r.errToMsgConverter,
 		commonstatus.SignalTypeMetrics)
 	condition.ObservedGeneration = pipeline.Generation