Skip to content

Commit

Permalink
chore: unify finalizer
Browse files Browse the repository at this point in the history
  • Loading branch information
@tmilos77
tmilos77 committed Feb 3, 2025
1 parent ee13277 commit 04e4d2f
Show file tree
Hide file tree
Showing 102 changed files with 353 additions and 292 deletions.
2 changes: 1 addition & 1 deletion api/cloud-control/v1beta1/types.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ const (
)

const (
FinalizerName = "cloud-control.kyma-project.io/deletion-hook"
DO_NOT_USE_FinalizerName = "cloud-control.kyma-project.io/deletion-hook"
)
2 changes: 1 addition & 1 deletion api/cloud-resources/v1beta1/finalizer.go
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
package v1beta1

const (
Finalizer = "cloud-resources.kyma-project.io/deletion-hook"
DO_NOT_USE_Finalizer = "cloud-resources.kyma-project.io/deletion-hook"
)
5 changes: 5 additions & 0 deletions api/finalizer.go
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
package api

const (
CommonFinalizerDeletionHook = "cloud-manager.kyma-project.io/deletion-hook"
)
9 changes: 5 additions & 4 deletions internal/controller/cloud-control/iprange_azure_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package cloudcontrol

import (
"fmt"
"github.com/kyma-project/cloud-manager/api"

"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/privatedns/armprivatedns"
Expand Down Expand Up @@ -112,7 +113,7 @@ var _ = Describe("Feature: KCP IpRange for Azure", func() {
Eventually(LoadAndCheck).
WithArguments(infra.Ctx(), infra.KCP().Client(), kcpNetworkCm, NewObjActions()).
Should(Succeed())
added, err := composed.PatchObjAddFinalizer(infra.Ctx(), cloudcontrolv1beta1.FinalizerName, kcpNetworkCm, infra.KCP().Client())
added, err := composed.PatchObjAddFinalizer(infra.Ctx(), api.CommonFinalizerDeletionHook, kcpNetworkCm, infra.KCP().Client())
Expect(added).To(BeTrue())
Expect(err).NotTo(HaveOccurred())
})
Expand Down Expand Up @@ -156,7 +157,7 @@ var _ = Describe("Feature: KCP IpRange for Azure", func() {
Eventually(LoadAndCheck).
WithArguments(infra.Ctx(), infra.KCP().Client(), kcpVpcPeering, NewObjActions()).
Should(Succeed())
added, err := composed.PatchObjAddFinalizer(infra.Ctx(), cloudcontrolv1beta1.FinalizerName, kcpVpcPeering, infra.KCP().Client())
added, err := composed.PatchObjAddFinalizer(infra.Ctx(), api.CommonFinalizerDeletionHook, kcpVpcPeering, infra.KCP().Client())
Expect(added).To(BeTrue())
Expect(err).NotTo(HaveOccurred())
})
Expand Down Expand Up @@ -288,7 +289,7 @@ var _ = Describe("Feature: KCP IpRange for Azure", func() {
})

By("When KCP VpcPeering finalizer is removed", func() {
removed, err := composed.PatchObjRemoveFinalizer(infra.Ctx(), cloudcontrolv1beta1.FinalizerName, kcpVpcPeering, infra.KCP().Client())
removed, err := composed.PatchObjRemoveFinalizer(infra.Ctx(), api.CommonFinalizerDeletionHook, kcpVpcPeering, infra.KCP().Client())
Expect(removed).To(BeTrue())
Expect(err).NotTo(HaveOccurred())
})
Expand All @@ -307,7 +308,7 @@ var _ = Describe("Feature: KCP IpRange for Azure", func() {
})

By("When KCP CM Network finalizer is removed", func() {
removed, err := composed.PatchObjRemoveFinalizer(infra.Ctx(), cloudcontrolv1beta1.FinalizerName, kcpNetworkCm, infra.KCP().Client())
removed, err := composed.PatchObjRemoveFinalizer(infra.Ctx(), api.CommonFinalizerDeletionHook, kcpNetworkCm, infra.KCP().Client())
Expect(removed).To(BeTrue())
Expect(err).NotTo(HaveOccurred())
})
Expand Down
3 changes: 2 additions & 1 deletion internal/controller/cloud-control/network_azure_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package cloudcontrol
import (
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
"github.com/kyma-project/cloud-manager/api"
cloudcontrolv1beta1 "github.com/kyma-project/cloud-manager/api/cloud-control/v1beta1"
"github.com/kyma-project/cloud-manager/pkg/common"
azurecommon "github.com/kyma-project/cloud-manager/pkg/kcp/provider/azure/common"
Expand Down Expand Up @@ -55,7 +56,7 @@ var _ = Describe("Feature: KCP Azure managed Network", func() {
})

By("And Then KCP Network has finalizer", func() {
Expect(controllerutil.ContainsFinalizer(net, cloudcontrolv1beta1.FinalizerName)).To(BeTrue())
Expect(controllerutil.ContainsFinalizer(net, api.CommonFinalizerDeletionHook)).To(BeTrue())
})

By("And Then Network status reference is set", func() {
Expand Down
3 changes: 2 additions & 1 deletion internal/controller/cloud-control/network_reference_test.go
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package cloudcontrol

import (
"github.com/kyma-project/cloud-manager/api"
"time"

cloudcontrolv1beta1 "github.com/kyma-project/cloud-manager/api/cloud-control/v1beta1"
Expand Down Expand Up @@ -60,7 +61,7 @@ var _ = Describe("Feature: KCP Network reference", func() {
})

By("And Then Network has finalizer", func() {
Expect(controllerutil.ContainsFinalizer(net, cloudcontrolv1beta1.FinalizerName)).To(BeTrue())
Expect(controllerutil.ContainsFinalizer(net, api.CommonFinalizerDeletionHook)).To(BeTrue())
})

By("When Network is deleted", func() {
Expand Down
3 changes: 2 additions & 1 deletion internal/controller/cloud-control/nfsinstance_gcp_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package cloudcontrol

import (
"context"
"github.com/kyma-project/cloud-manager/api"
"time"

"github.com/kyma-project/cloud-manager/pkg/composed"
Expand Down Expand Up @@ -449,7 +450,7 @@ var _ = Describe("Feature: KCP NFSVolume for GCP", func() {
WithArguments(infra.Ctx(), infra.KCP().Client(), gcpNfsInstance).
Should(Succeed())
Eventually(func(ctx context.Context) error {
_, err := composed.PatchObjRemoveFinalizer(ctx, cloudcontrolv1beta1.FinalizerName, gcpNfsInstance, infra.KCP().Client())
_, err := composed.PatchObjRemoveFinalizer(ctx, api.CommonFinalizerDeletionHook, gcpNfsInstance, infra.KCP().Client())
return err
}).
WithContext(infra.Ctx()).
Expand Down
15 changes: 8 additions & 7 deletions internal/controller/cloud-control/nuke_controller_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package cloudcontrol

import (
"fmt"
"github.com/kyma-project/cloud-manager/api"
cloudcontrolv1beta1 "github.com/kyma-project/cloud-manager/api/cloud-control/v1beta1"
"github.com/kyma-project/cloud-manager/pkg/common"
"github.com/kyma-project/cloud-manager/pkg/common/actions/focal"
Expand Down Expand Up @@ -43,7 +44,7 @@ var _ = Describe("Feature: Cleanup orphan resources", func() {
kcpnetwork.Ignore.AddName(cmNetwork.Name)

Expect(CreateObj(infra.Ctx(), infra.KCP().Client(), cmNetwork,
AddFinalizer(cloudcontrolv1beta1.FinalizerName),
AddFinalizer(api.CommonFinalizerDeletionHook),
)).To(Succeed(), "failed creating cm network")
})

Expand All @@ -56,7 +57,7 @@ var _ = Describe("Feature: Cleanup orphan resources", func() {
Eventually(CreateKcpIpRange).
WithArguments(infra.Ctx(), infra.KCP().Client(), ipRange,
WithName(ipRangeName),
AddFinalizer(cloudcontrolv1beta1.FinalizerName),
AddFinalizer(api.CommonFinalizerDeletionHook),
WithKcpIpRangeNetwork(cmNetwork.Name),
WithScope(kymaName),
WithRemoteRef("foo"),
Expand All @@ -76,7 +77,7 @@ var _ = Describe("Feature: Cleanup orphan resources", func() {
kcpvpcpeering.Ignore.AddName(vpcPeering.Name)

Expect(CreateObj(infra.Ctx(), infra.KCP().Client(), vpcPeering,
AddFinalizer(cloudcontrolv1beta1.FinalizerName),
AddFinalizer(api.CommonFinalizerDeletionHook),
)).To(Succeed(), "failed creating VpcPeering")
})

Expand All @@ -88,7 +89,7 @@ var _ = Describe("Feature: Cleanup orphan resources", func() {

Expect(CreateRedisInstance(infra.Ctx(), infra.KCP().Client(), redisInstance,
WithName(redisInstanceName),
AddFinalizer(cloudcontrolv1beta1.FinalizerName),
AddFinalizer(api.CommonFinalizerDeletionHook),
WithRemoteRef("remote-redis"),
WithIpRange(ipRange.Name),
WithScope(kymaName),
Expand All @@ -106,12 +107,12 @@ var _ = Describe("Feature: Cleanup orphan resources", func() {

Expect(CreateNfsInstance(infra.Ctx(), infra.KCP().Client(), nfsInstance,
WithName(nfsInstanceName),
AddFinalizer(cloudcontrolv1beta1.FinalizerName),
AddFinalizer(api.CommonFinalizerDeletionHook),
WithRemoteRef("foo"),
WithScope(kymaName),
WithIpRange(ipRange.Name),
WithNfsInstanceAws(), // never mind it doesn't match Azure, won't be reconciled anyway
AddFinalizer(cloudcontrolv1beta1.FinalizerName),
AddFinalizer(api.CommonFinalizerDeletionHook),
)).To(Succeed(), "failed creating NfsInstance")
})

Expand Down Expand Up @@ -158,7 +159,7 @@ var _ = Describe("Feature: Cleanup orphan resources", func() {

for kind, obj := range resources {
By(fmt.Sprintf("When resource %s finalizer is removed", kind), func() {
removed, err := composed.PatchObjRemoveFinalizer(infra.Ctx(), cloudcontrolv1beta1.FinalizerName, obj, infra.KCP().Client())
removed, err := composed.PatchObjRemoveFinalizer(infra.Ctx(), api.CommonFinalizerDeletionHook, obj, infra.KCP().Client())
Expect(err).To(Succeed())
Expect(removed).To(BeTrue())
})
Expand Down
11 changes: 6 additions & 5 deletions internal/controller/cloud-control/nuke_gcp_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package cloudcontrol
import (
"context"
"fmt"
"github.com/kyma-project/cloud-manager/api"
cloudcontrolv1beta1 "github.com/kyma-project/cloud-manager/api/cloud-control/v1beta1"
"github.com/kyma-project/cloud-manager/pkg/common"
"github.com/kyma-project/cloud-manager/pkg/common/actions/focal"
Expand Down Expand Up @@ -51,7 +52,7 @@ var _ = Describe("Feature: Cleanup orphan resources", func() {
kcpnetwork.Ignore.AddName(cmNetwork.Name)

Expect(CreateObj(infra.Ctx(), infra.KCP().Client(), cmNetwork,
AddFinalizer(cloudcontrolv1beta1.FinalizerName),
AddFinalizer(api.CommonFinalizerDeletionHook),
)).To(Succeed(), "failed creating cm network")
})

Expand All @@ -64,7 +65,7 @@ var _ = Describe("Feature: Cleanup orphan resources", func() {
Eventually(CreateKcpIpRange).
WithArguments(infra.Ctx(), infra.KCP().Client(), ipRange,
WithName(ipRangeName),
AddFinalizer(cloudcontrolv1beta1.FinalizerName),
AddFinalizer(api.CommonFinalizerDeletionHook),
WithKcpIpRangeNetwork(cmNetwork.Name),
WithScope(kymaName),
WithRemoteRef("foo"),
Expand All @@ -81,12 +82,12 @@ var _ = Describe("Feature: Cleanup orphan resources", func() {

Expect(CreateNfsInstance(infra.Ctx(), infra.KCP().Client(), nfsInstance,
WithName(nfsInstanceName),
AddFinalizer(cloudcontrolv1beta1.FinalizerName),
AddFinalizer(api.CommonFinalizerDeletionHook),
WithRemoteRef("foo"),
WithScope(kymaName),
WithIpRange(ipRange.Name),
WithNfsInstanceGcp(scope.Spec.Region),
AddFinalizer(cloudcontrolv1beta1.FinalizerName),
AddFinalizer(api.CommonFinalizerDeletionHook),
)).To(Succeed(), "failed creating NfsInstance")
})

Expand Down Expand Up @@ -169,7 +170,7 @@ var _ = Describe("Feature: Cleanup orphan resources", func() {

for kind, obj := range resources {
By(fmt.Sprintf("When resource %s finalizer is removed", kind), func() {
removed, err := composed.PatchObjRemoveFinalizer(infra.Ctx(), cloudcontrolv1beta1.FinalizerName, obj, infra.KCP().Client())
removed, err := composed.PatchObjRemoveFinalizer(infra.Ctx(), api.CommonFinalizerDeletionHook, obj, infra.KCP().Client())
Expect(err).To(Succeed())
Expect(removed).To(BeTrue())
})
Expand Down
5 changes: 3 additions & 2 deletions internal/controller/cloud-control/scope_aws_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package cloudcontrol
import (
"fmt"
gardenerTypes "github.com/gardener/gardener/pkg/apis/core/v1beta1"
"github.com/kyma-project/cloud-manager/api"
cloudcontrolv1beta1 "github.com/kyma-project/cloud-manager/api/cloud-control/v1beta1"
cloudresourcesv1beta1 "github.com/kyma-project/cloud-manager/api/cloud-resources/v1beta1"
"github.com/kyma-project/cloud-manager/pkg/common"
Expand Down Expand Up @@ -122,7 +123,7 @@ var _ = Describe("Feature: KCP Scope AWS", func() {
Eventually(LoadAndCheck).
WithArguments(infra.Ctx(), infra.KCP().Client(), kymaCR, NewObjActions()).
Should(Succeed())
Expect(controllerutil.ContainsFinalizer(kymaCR, cloudcontrolv1beta1.FinalizerName)).
Expect(controllerutil.ContainsFinalizer(kymaCR, api.CommonFinalizerDeletionHook)).
To(BeTrue(), "expected Kyma CR to have finalizer, but it does not")
})

Expand Down Expand Up @@ -212,7 +213,7 @@ var _ = Describe("Feature: KCP Scope AWS", func() {
WithArguments(infra.Ctx(), infra.KCP().Client(), kymaCR, NewObjActions()).
Should(Succeed(), "failed reloading Kyma CR")

Expect(controllerutil.ContainsFinalizer(kymaCR, cloudcontrolv1beta1.FinalizerName)).
Expect(controllerutil.ContainsFinalizer(kymaCR, api.CommonFinalizerDeletionHook)).
To(BeFalse(), "expected Kyma CR not to have finalizer, but it still has it")
})

Expand Down
5 changes: 3 additions & 2 deletions internal/controller/cloud-control/scope_azure_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package cloudcontrol
import (
"fmt"
gardenerTypes "github.com/gardener/gardener/pkg/apis/core/v1beta1"
"github.com/kyma-project/cloud-manager/api"
cloudcontrolv1beta1 "github.com/kyma-project/cloud-manager/api/cloud-control/v1beta1"
cloudresourcesv1beta1 "github.com/kyma-project/cloud-manager/api/cloud-resources/v1beta1"
"github.com/kyma-project/cloud-manager/pkg/common"
Expand Down Expand Up @@ -122,7 +123,7 @@ var _ = Describe("Feature: KCP Scope Azure", func() {
Eventually(LoadAndCheck).
WithArguments(infra.Ctx(), infra.KCP().Client(), kymaCR, NewObjActions()).
Should(Succeed())
Expect(controllerutil.ContainsFinalizer(kymaCR, cloudcontrolv1beta1.FinalizerName)).
Expect(controllerutil.ContainsFinalizer(kymaCR, api.CommonFinalizerDeletionHook)).
To(BeTrue(), "expected Kyma CR to have finalizer, but it does not")
})

Expand Down Expand Up @@ -185,7 +186,7 @@ var _ = Describe("Feature: KCP Scope Azure", func() {
WithArguments(infra.Ctx(), infra.KCP().Client(), kymaCR, NewObjActions()).
Should(Succeed(), "failed reloading Kyma CR")

Expect(controllerutil.ContainsFinalizer(kymaCR, cloudcontrolv1beta1.FinalizerName)).
Expect(controllerutil.ContainsFinalizer(kymaCR, api.CommonFinalizerDeletionHook)).
To(BeFalse(), "expected Kyma CR not to have finalizer, but it still has it")
})

Expand Down
11 changes: 6 additions & 5 deletions internal/controller/cloud-control/vpcpeering_aws_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package cloudcontrol
import (
"errors"
"fmt"
"github.com/kyma-project/cloud-manager/api"

ec2Types "github.com/aws/aws-sdk-go-v2/service/ec2/types"
cloudcontrolv1beta1 "github.com/kyma-project/cloud-manager/api/cloud-control/v1beta1"
Expand Down Expand Up @@ -247,7 +248,7 @@ var _ = Describe("Feature: KCP VpcPeering", func() {
Eventually(LoadAndCheck).
WithArguments(infra.Ctx(), infra.KCP().Client(), kcpPeering,
NewObjActions(),
HaveFinalizer(cloudcontrolv1beta1.FinalizerName),
HaveFinalizer(api.CommonFinalizerDeletionHook),
HavingKcpVpcPeeringStatusIdNotEmpty(),
).Should(Succeed())
})
Expand Down Expand Up @@ -519,7 +520,7 @@ var _ = Describe("Feature: KCP VpcPeering", func() {
Eventually(LoadAndCheck).
WithArguments(infra.Ctx(), infra.KCP().Client(), kcpPeering,
NewObjActions(),
HaveFinalizer(cloudcontrolv1beta1.FinalizerName),
HaveFinalizer(api.CommonFinalizerDeletionHook),
HavingKcpVpcPeeringStatusIdNotEmpty(),
).Should(Succeed())
})
Expand Down Expand Up @@ -755,7 +756,7 @@ var _ = Describe("Feature: KCP VpcPeering", func() {
Eventually(LoadAndCheck).
WithArguments(infra.Ctx(), infra.KCP().Client(), localKcpNet,
NewObjActions(),
HaveFinalizer(cloudcontrolv1beta1.FinalizerName),
HaveFinalizer(api.CommonFinalizerDeletionHook),
HavingConditionTrue(cloudcontrolv1beta1.ConditionTypeReady),
).Should(Succeed())
})
Expand All @@ -776,7 +777,7 @@ var _ = Describe("Feature: KCP VpcPeering", func() {
Eventually(LoadAndCheck).
WithArguments(infra.Ctx(), infra.KCP().Client(), remoteKcpNet,
NewObjActions(),
HaveFinalizer(cloudcontrolv1beta1.FinalizerName),
HaveFinalizer(api.CommonFinalizerDeletionHook),
HavingConditionTrue(cloudcontrolv1beta1.ConditionTypeReady),
).Should(Succeed())
})
Expand All @@ -801,7 +802,7 @@ var _ = Describe("Feature: KCP VpcPeering", func() {
Eventually(LoadAndCheck).
WithArguments(infra.Ctx(), infra.KCP().Client(), kcpPeering,
NewObjActions(),
HaveFinalizer(cloudcontrolv1beta1.FinalizerName),
HaveFinalizer(api.CommonFinalizerDeletionHook),
HavingKcpVpcPeeringStatusIdNotEmpty(),
).Should(Succeed())
})
Expand Down
7 changes: 4 additions & 3 deletions internal/controller/cloud-control/vpcpeering_azure_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package cloudcontrol

import (
"errors"
"github.com/kyma-project/cloud-manager/api"

"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/network/armnetwork/v5"
cloudcontrolv1beta1 "github.com/kyma-project/cloud-manager/api/cloud-control/v1beta1"
Expand Down Expand Up @@ -217,14 +218,14 @@ var _ = Describe("Feature: KCP VpcPeering", func() {
Eventually(LoadAndCheck).
WithArguments(infra.Ctx(), infra.KCP().Client(), kcpPeering,
NewObjActions(),
HaveFinalizer(cloudcontrolv1beta1.FinalizerName),
HaveFinalizer(api.CommonFinalizerDeletionHook),
HavingConditionTrue(cloudcontrolv1beta1.ConditionTypeReady),
).
Should(Succeed())
})

By("And Then KCP VpcPeering has finalizer", func() {
Expect(controllerutil.ContainsFinalizer(kcpPeering, cloudcontrolv1beta1.FinalizerName)).
Expect(controllerutil.ContainsFinalizer(kcpPeering, api.CommonFinalizerDeletionHook)).
To(BeTrue())
})

Expand Down Expand Up @@ -413,7 +414,7 @@ var _ = Describe("Feature: KCP VpcPeering", func() {
Eventually(LoadAndCheck).
WithArguments(infra.Ctx(), infra.KCP().Client(), kcpPeering,
NewObjActions(),
HaveFinalizer(cloudcontrolv1beta1.FinalizerName),
HaveFinalizer(api.CommonFinalizerDeletionHook),
HavingConditionTrue(cloudcontrolv1beta1.ConditionTypeReady),
).
Should(Succeed())
Expand Down
Loading

0 comments on commit 04e4d2f

Please sign in to comment.