Use patch helper to remove fields with patch

Signed-off-by: Danil-Grigorev <danil.grigorev@suse.com>

Author: Danil-Grigorev

internal/sync/client.go

@@ -20,9 +20,10 @@ import (
 	"context"
 	"fmt"
 
-	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/log"
+
+	"sigs.k8s.io/cluster-api/util/patch"
 )
 
 const fieldOwner = "capi-provider-operator"
@@ -39,28 +40,20 @@ func setKind(cl client.Client, obj client.Object) error {
 }
 
 // Patch will only patch mirror object in the cluster.
-func Patch(ctx context.Context, cl client.Client, obj client.Object, options ...client.PatchOption) error {
+func Patch(ctx context.Context, cl client.Client, helper *patch.Helper, obj client.Object) error {
 	log := log.FromContext(ctx)
 
-	obj.SetManagedFields(nil)
-
 	if err := setKind(cl, obj); err != nil {
 		return err
 	}
 
 	log.Info(fmt.Sprintf("Updating %s: %s", obj.GetObjectKind().GroupVersionKind().Kind, client.ObjectKeyFromObject(obj)))
 
-	patchOptions := []client.PatchOption{
-		client.FieldOwner(fieldOwner),
-	}
-	patchOptions = append(patchOptions, options...)
-
-	err := cl.Patch(ctx, obj, client.Merge, patchOptions...)
-	if apierrors.IsNotFound(err) {
+	if helper == nil {
 		return cl.Create(ctx, obj, []client.CreateOption{client.FieldOwner(fieldOwner)}...)
 	}
 
-	return err
+	return helper.Patch(ctx, obj)
 }
 
 // PatchStatus will only patch the status subresource of the provided object.

internal/sync/client_test.go

@@ -23,6 +23,7 @@ import (
 	"github.com/rancher/turtles/internal/sync"
 	corev1 "k8s.io/api/core/v1"
 
+	"sigs.k8s.io/cluster-api/util/patch"
 	. "sigs.k8s.io/controller-runtime/pkg/envtest/komega"
 
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -67,10 +68,13 @@ var _ = Describe("Core provider", func() {
 	})
 
 	It("Regular patch only updates the spec of the resource", func() {
+		helper, err := patch.NewHelper(capiProvider, testEnv.Client)
+		Expect(err).ToNot(HaveOccurred())
+
 		capiProvider.Spec.Name = "rke2"
 		capiProvider.Status.Phase = turtlesv1.Ready
 
-		Expect(sync.Patch(ctx, testEnv, capiProvider)).To(Succeed())
+		Expect(sync.Patch(ctx, testEnv, helper, capiProvider)).To(Succeed())
 		Eventually(Object(capiProvider)).Should(HaveField("Spec.Name", Equal("rke2")))
 		Eventually(Object(capiProvider)).Should(HaveField("Status.Phase", Equal(turtlesv1.Pending)))
 	})

internal/sync/core.go

@@ -26,6 +26,8 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/log"
 
+	"sigs.k8s.io/cluster-api/util/patch"
+
 	turtlesv1 "github.com/rancher/turtles/api/v1alpha1"
 )
 
@@ -34,6 +36,7 @@ type DefaultSynchronizer struct {
 	client      client.Client
 	Source      *turtlesv1.CAPIProvider
 	Destination client.Object
+	patcher     *patch.Helper
 }
 
 // NewDefaultSynchronizer returns a new instance of DefaultSynchronizer.
@@ -52,20 +55,25 @@ func (s *DefaultSynchronizer) Get(ctx context.Context) error {
 	objKey := client.ObjectKeyFromObject(s.Destination)
 	if err := s.client.Get(ctx, objKey, s.Destination); client.IgnoreNotFound(err) != nil {
 		log.Error(err, "Unable to get mirrored manifest: "+objKey.String())
+	} else if err == nil {
+		s.patcher, err = patch.NewHelper(s.Destination, s.client)
+		if err != nil {
+			return err
+		}
 	}
 
 	return nil
 }
 
 // Apply applies the destination object to the cluster.
-func (s *DefaultSynchronizer) Apply(ctx context.Context, reterr *error, options ...client.PatchOption) {
+func (s *DefaultSynchronizer) Apply(ctx context.Context, reterr *error) {
 	log := log.FromContext(ctx)
 	uid := s.Destination.GetUID()
 
 	setFinalizers(s.Destination)
 	setOwnerReference(s.Source, s.Destination)
 
-	if err := Patch(ctx, s.client, s.Destination, options...); err != nil {
+	if err := Patch(ctx, s.client, s.patcher, s.Destination); err != nil {
 		*reterr = kerrors.NewAggregate([]error{*reterr, err})
 		log.Error(*reterr, fmt.Sprintf("Unable to patch object: %s", *reterr))
 	}

internal/sync/interface.go

@@ -31,7 +31,7 @@ type Sync interface {
 	Template(source *turtlesv1.CAPIProvider) client.Object
 	Get(ctx context.Context) error
 	Sync(ctx context.Context) error
-	Apply(ctx context.Context, reterr *error, options ...client.PatchOption)
+	Apply(ctx context.Context, reterr *error)
 }
 
 // List contains a list of syncers to apply the syncing logic.

internal/sync/interface_test.go

@@ -42,7 +42,7 @@ func (m *MockSynchronizer) Sync(ctx context.Context) error {
 	return m.syncronizerr
 }
 
-func (m *MockSynchronizer) Apply(ctx context.Context, reterr *error, options ...client.PatchOption) {
+func (m *MockSynchronizer) Apply(ctx context.Context, reterr *error) {
 	*reterr = m.applyErr
 }
 

internal/sync/secret_mapper_sync.go

@@ -318,8 +318,8 @@ func (s *SecretMapperSync) Sync(ctx context.Context) error {
 
 // Apply performs SSA patch of the secret mapper resources, using different FieldOwner from default
 // to avoid collisions with patches performed by variable syncer on the same secret resource.
-func (s *SecretMapperSync) Apply(ctx context.Context, reterr *error, options ...client.PatchOption) {
-	s.DefaultSynchronizer.Apply(ctx, reterr, append(options, client.FieldOwner("secret-mapper-sync"))...)
+func (s *SecretMapperSync) Apply(ctx context.Context, reterr *error) {
+	s.DefaultSynchronizer.Apply(ctx, reterr)
 }
 
 // Into maps the secret keys from source secret data according to credentials map.