chore(lifecycle-operator): make evaluationhandler injectable in Keptn…

…AppVersionController (keptn#2402)
geoffrey1330 · Nov 6, 2023 · a060859 · a060859
1 parent 69817bd
commit a060859
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 29 deletions.
diff --git a/lifecycle-operator/controllers/lifecycle/keptnappversion/controller.go b/lifecycle-operator/controllers/lifecycle/keptnappversion/controller.go
@@ -25,6 +25,7 @@ import (
 	klcv1alpha3 "github.com/keptn/lifecycle-toolkit/lifecycle-operator/apis/lifecycle/v1alpha3"
 	apicommon "github.com/keptn/lifecycle-toolkit/lifecycle-operator/apis/lifecycle/v1alpha3/common"
 	controllercommon "github.com/keptn/lifecycle-toolkit/lifecycle-operator/controllers/common"
+	"github.com/keptn/lifecycle-toolkit/lifecycle-operator/controllers/common/evaluation"
 	"github.com/keptn/lifecycle-toolkit/lifecycle-operator/controllers/common/telemetry"
 	controllererrors "github.com/keptn/lifecycle-toolkit/lifecycle-operator/controllers/errors"
 	"go.opentelemetry.io/otel"
@@ -47,11 +48,12 @@ const traceComponentName = "keptn/lifecycle-operator/appversion"
 type KeptnAppVersionReconciler struct {
 	Scheme *runtime.Scheme
 	client.Client
-	Log           logr.Logger
-	EventSender   controllercommon.IEvent
-	TracerFactory telemetry.TracerFactory
-	Meters        apicommon.KeptnMeters
-	SpanHandler   telemetry.ISpanHandler
+	Log               logr.Logger
+	EventSender       controllercommon.IEvent
+	TracerFactory     telemetry.TracerFactory
+	Meters            apicommon.KeptnMeters
+	SpanHandler       telemetry.ISpanHandler
+	EvaluationHandler evaluation.IEvaluationHandler
 }
 
 // +kubebuilder:rbac:groups=lifecycle.keptn.sh,resources=keptnappversions,verbs=get;list;watch;create;update;patch;delete

diff --git a/lifecycle-operator/controllers/lifecycle/keptnappversion/controller_test.go b/lifecycle-operator/controllers/lifecycle/keptnappversion/controller_test.go
@@ -11,6 +11,8 @@ import (
 	apicommon "github.com/keptn/lifecycle-toolkit/lifecycle-operator/apis/lifecycle/v1alpha3/common"
 	lfcv1alpha4 "github.com/keptn/lifecycle-toolkit/lifecycle-operator/apis/lifecycle/v1alpha4"
 	controllercommon "github.com/keptn/lifecycle-toolkit/lifecycle-operator/controllers/common"
+	"github.com/keptn/lifecycle-toolkit/lifecycle-operator/controllers/common/evaluation"
+	evalfake "github.com/keptn/lifecycle-toolkit/lifecycle-operator/controllers/common/evaluation/fake"
 	"github.com/keptn/lifecycle-toolkit/lifecycle-operator/controllers/common/fake"
 	"github.com/stretchr/testify/require"
 	"go.opentelemetry.io/otel"
@@ -296,6 +298,11 @@ func setupReconciler(objs ...client.Object) (*KeptnAppVersionReconciler, chan st
 		TracerFactory: tf,
 		SpanHandler:   spanRecorder,
 		Meters:        controllercommon.InitAppMeters(),
+		EvaluationHandler: &evalfake.MockEvaluationHandler{
+			ReconcileEvaluationsFunc: func(ctx context.Context, phaseCtx context.Context, reconcileObject client.Object, evaluationCreateAttributes evaluation.CreateEvaluationAttributes) ([]lfcv1alpha3.ItemStatus, apicommon.StatusSummary, error) {
+				return []lfcv1alpha3.ItemStatus{}, apicommon.StatusSummary{}, nil
+			},
+		},
 	}
 	return r, recorder.Events, spanRecorder
 }

diff --git a/lifecycle-operator/controllers/lifecycle/keptnappversion/reconcile_prepostevaluation.go b/lifecycle-operator/controllers/lifecycle/keptnappversion/reconcile_prepostevaluation.go
@@ -11,21 +11,13 @@ import (
 )
 
 func (r *KeptnAppVersionReconciler) reconcilePrePostEvaluation(ctx context.Context, phaseCtx context.Context, appVersion *klcv1alpha3.KeptnAppVersion, checkType apicommon.CheckType) (apicommon.KeptnState, error) {
-	evaluationHandler := evaluation.EvaluationHandler{
-		Client:      r.Client,
-		EventSender: r.EventSender,
-		Log:         r.Log,
-		Tracer:      r.getTracer(),
-		Scheme:      r.Scheme,
-		SpanHandler: r.SpanHandler,
-	}
 
 	evaluationCreateAttributes := evaluation.CreateEvaluationAttributes{
 		SpanName:  fmt.Sprintf(apicommon.CreateAppEvalSpanName, checkType),
 		CheckType: checkType,
 	}
 
-	newStatus, state, err := evaluationHandler.ReconcileEvaluations(ctx, phaseCtx, appVersion, evaluationCreateAttributes)
+	newStatus, state, err := r.EvaluationHandler.ReconcileEvaluations(ctx, phaseCtx, appVersion, evaluationCreateAttributes)
 	if err != nil {
 		return apicommon.StateUnknown, err
 	}

diff --git a/lifecycle-operator/main.go b/lifecycle-operator/main.go
@@ -300,13 +300,14 @@ func main() {
 	appVersionLogger := ctrl.Log.WithName("KeptnAppVersion Controller").V(env.KeptnAppVersionControllerLogLevel)
 	appVersionRecorder := mgr.GetEventRecorderFor("keptnappversion-controller")
 	appVersionReconciler := &keptnappversion.KeptnAppVersionReconciler{
-		Client:        mgr.GetClient(),
-		Scheme:        mgr.GetScheme(),
-		Log:           appVersionLogger,
-		EventSender:   controllercommon.NewEventMultiplexer(appVersionLogger, appVersionRecorder, ceClient),
-		TracerFactory: telemetry.GetOtelInstance(),
-		Meters:        keptnMeters,
-		SpanHandler:   spanHandler,
+		Client:            mgr.GetClient(),
+		Scheme:            mgr.GetScheme(),
+		Log:               appVersionLogger,
+		EventSender:       controllercommon.NewEventMultiplexer(appVersionLogger, appVersionRecorder, ceClient),
+		TracerFactory:     telemetry.GetOtelInstance(),
+		Meters:            keptnMeters,
+		SpanHandler:       spanHandler,
+		EvaluationHandler: evaluationHandler,
 	}
 	if err = (appVersionReconciler).SetupWithManager(mgr); err != nil {
 		setupLog.Error(err, "unable to create controller", "controller", "KeptnAppVersion")

diff --git a/lifecycle-operator/test/component/appversion/appversion_suite_test.go b/lifecycle-operator/test/component/appversion/appversion_suite_test.go
@@ -8,6 +8,7 @@ import (
 
 	controllercommon "github.com/keptn/lifecycle-toolkit/lifecycle-operator/controllers/common"
 	"github.com/keptn/lifecycle-toolkit/lifecycle-operator/controllers/common/config"
+	"github.com/keptn/lifecycle-toolkit/lifecycle-operator/controllers/common/evaluation"
 	"github.com/keptn/lifecycle-toolkit/lifecycle-operator/controllers/common/telemetry"
 	"github.com/keptn/lifecycle-toolkit/lifecycle-operator/controllers/lifecycle/keptnappversion"
 	"github.com/keptn/lifecycle-toolkit/lifecycle-operator/test/component/common"
@@ -34,23 +35,36 @@ var (
 	spanRecorder *sdktest.SpanRecorder
 )
 
-const KeptnNamespace = "keptnlifecycle"
+const (
+	KeptnNamespace     = "keptnlifecycle"
+	traceComponentName = "keptn/lifecycle-operator/appversion"
+)
 
 var _ = BeforeSuite(func() {
 	var readyToStart chan struct{}
 	ctx, k8sManager, tracer, spanRecorder, k8sClient, readyToStart = common.InitSuite()
 
+	tracerFactory := &common.TracerFactory{Tracer: tracer}
+	EvaluationHandler := evaluation.NewEvaluationHandler(
+		k8sManager.GetClient(),
+		controllercommon.NewK8sSender(k8sManager.GetEventRecorderFor("test-appversion-controller")),
+		GinkgoLogr,
+		tracerFactory.GetTracer(traceComponentName),
+		k8sManager.GetScheme(),
+		&telemetry.SpanHandler{})
+
 	config.Instance().SetDefaultNamespace(KeptnNamespace)
 
 	// //setup controllers here
 	controller := &keptnappversion.KeptnAppVersionReconciler{
-		Client:        k8sManager.GetClient(),
-		Scheme:        k8sManager.GetScheme(),
-		EventSender:   controllercommon.NewK8sSender(k8sManager.GetEventRecorderFor("test-appversion-controller")),
-		Log:           GinkgoLogr,
-		Meters:        common.InitKeptnMeters(),
-		SpanHandler:   &telemetry.SpanHandler{},
-		TracerFactory: &common.TracerFactory{Tracer: tracer},
+		Client:            k8sManager.GetClient(),
+		Scheme:            k8sManager.GetScheme(),
+		EventSender:       controllercommon.NewK8sSender(k8sManager.GetEventRecorderFor("test-appversion-controller")),
+		Log:               GinkgoLogr,
+		Meters:            common.InitKeptnMeters(),
+		SpanHandler:       &telemetry.SpanHandler{},
+		TracerFactory:     tracerFactory,
+		EvaluationHandler: EvaluationHandler,
 	}
 	Eventually(controller.SetupWithManager(k8sManager)).WithTimeout(30 * time.Second).WithPolling(time.Second).Should(Succeed())
 	close(readyToStart)