feat(subroutine): implement finalizer for Deployment subroutine

On-behalf-of: @SAP angel.kafazov@sap.com
Signed-off-by: Angel Kafazov <akafazov@cst-bg.net>

Author: akafazov

pkg/subroutines/deployment.go

@@ -50,12 +50,38 @@ func (r *DeploymentSubroutine) GetName() string {
 	return DeploymentSubroutineName
 }
 
-func (r *DeploymentSubroutine) Finalize(_ context.Context, _ runtimeobject.RuntimeObject) (ctrl.Result, errors.OperatorError) {
+// DeploymentSubroutineFinalizer ensures cleanup of FluxCD resources managed by this subroutine.
+const DeploymentSubroutineFinalizer = "platform-mesh.core.platform-mesh.io/deployment-finalizer"
+
+func (r *DeploymentSubroutine) Finalize(ctx context.Context, _ runtimeobject.RuntimeObject) (ctrl.Result, errors.OperatorError) {
+	log := logger.LoadLoggerFromContext(ctx).ChildLogger("subroutine", r.GetName())
+
+	// Delete FluxCD Resource
+	resource := &unstructured.Unstructured{}
+	resource.SetGroupVersionKind(schema.GroupVersionKind{Group: "delivery.ocm.software", Version: "v1alpha1", Kind: "Resource"})
+	resource.SetName("platform-mesh-operator-components")
+	resource.SetNamespace("default")
+	if err := r.client.Delete(ctx, resource); err != nil && !kerrors.IsNotFound(err) {
+		log.Warn().Err(err).Msg("Failed to delete Resource during finalize")
+		return ctrl.Result{}, errors.NewOperatorError(err, false, true)
+	}
+
+	// Delete FluxCD HelmRelease
+	release := &unstructured.Unstructured{}
+	release.SetGroupVersionKind(schema.GroupVersionKind{Group: "helm.toolkit.fluxcd.io", Version: "v2", Kind: "HelmRelease"})
+	release.SetName("platform-mesh-operator-components")
+	release.SetNamespace("default")
+	if err := r.client.Delete(ctx, release); err != nil && !kerrors.IsNotFound(err) {
+		log.Warn().Err(err).Msg("Failed to delete HelmRelease during finalize")
+		return ctrl.Result{}, errors.NewOperatorError(err, false, true)
+	}
+
+	// If we reach here, both objects are deleted or did not exist. The controller will remove our finalizer.
 	return ctrl.Result{}, nil
 }
 
 func (r *DeploymentSubroutine) Finalizers() []string { // coverage-ignore
-	return []string{}
+	return []string{DeploymentSubroutineFinalizer}
 }
 
 func (r *DeploymentSubroutine) Process(ctx context.Context, runtimeObj runtimeobject.RuntimeObject) (ctrl.Result, errors.OperatorError) {

pkg/subroutines/deployment_test.go

@@ -8,8 +8,10 @@ import (
 	"github.com/stretchr/testify/mock"
 	"github.com/stretchr/testify/suite"
 	apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
+	kerrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
+	"k8s.io/apimachinery/pkg/runtime/schema"
 	"k8s.io/apimachinery/pkg/types"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
@@ -20,6 +22,7 @@ import (
 
 	"github.com/platform-mesh/platform-mesh-operator/api/v1alpha1"
 	"github.com/platform-mesh/platform-mesh-operator/internal/config"
+	ctrl "sigs.k8s.io/controller-runtime"
 )
 
 type DeployTestSuite struct {
@@ -154,3 +157,37 @@ func (s *DeployTestSuite) Test_applyReleaseWithValues() {
 	s.Assert().NoError(err, "ApplyReleaseWithValues should not return an error")
 
 }
+
+func (s *DeployTestSuite) Test_Finalize_DeletesFluxObjects() {
+	ctx := context.TODO()
+
+	// mock deletions
+	s.clientMock.EXPECT().Delete(mock.Anything, mock.MatchedBy(func(obj client.Object) bool {
+		u := obj.(*unstructured.Unstructured)
+		gvk := u.GroupVersionKind()
+		return gvk.Group == "delivery.ocm.software" && gvk.Version == "v1alpha1" && gvk.Kind == "Resource" && u.GetName() == "platform-mesh-operator-components" && u.GetNamespace() == "default"
+	})).Return(nil).Once()
+
+	s.clientMock.EXPECT().Delete(mock.Anything, mock.MatchedBy(func(obj client.Object) bool {
+		u := obj.(*unstructured.Unstructured)
+		gvk := u.GroupVersionKind()
+		return gvk.Group == "helm.toolkit.fluxcd.io" && gvk.Version == "v2" && gvk.Kind == "HelmRelease" && u.GetName() == "platform-mesh-operator-components" && u.GetNamespace() == "default"
+	})).Return(nil).Once()
+
+	// asserts
+	res, opErr := s.testObj.Finalize(ctx, &v1alpha1.PlatformMesh{})
+	s.Require().Nil(opErr)
+	s.Require().Equal(ctrl.Result{}, res)
+}
+
+func (s *DeployTestSuite) Test_Finalize_AlreadyDeleted() {
+	ctx := context.TODO()
+
+	// mock deletions with NotFound errors
+	s.clientMock.EXPECT().Delete(mock.Anything, mock.Anything).Return(kerrors.NewNotFound(schema.GroupResource{Group: "delivery.ocm.software", Resource: "Resource"}, "platform-mesh-operator-components")).Once()
+	s.clientMock.EXPECT().Delete(mock.Anything, mock.Anything).Return(kerrors.NewNotFound(schema.GroupResource{Group: "helm.toolkit.fluxcd.io", Resource: "HelmRelease"}, "platform-mesh-operator-components")).Once()
+
+	res, opErr := s.testObj.Finalize(ctx, &v1alpha1.PlatformMesh{})
+	s.Require().Nil(opErr)
+	s.Require().Equal(ctrl.Result{}, res)
+}