Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 28 additions & 2 deletions internal/controller/cluster/object/syncer.go
Original file line number Diff line number Diff line change
Expand Up @@ -148,13 +148,39 @@ func (s *SSAResourceSyncer) needSSAFieldManagerUpgrade(accessor metav1.Object) b
}
mfes := accessor.GetManagedFields()
for _, mfe := range mfes {
if mfe.Operation == metav1.ManagedFieldsOperationUpdate && s.legacyCSAFieldManagers.Has(mfe.Manager) {
return true
if mfe.Operation != metav1.ManagedFieldsOperationUpdate || !s.legacyCSAFieldManagers.Has(mfe.Manager) {
continue
}
if mfe.Subresource == "status" {
continue
}
if isFinalizersOnlyManagedFieldsEntry(mfe) {
continue
}
return true
}
return false
}

func isFinalizersOnlyManagedFieldsEntry(mfe metav1.ManagedFieldsEntry) bool {
if mfe.FieldsV1 == nil || len(mfe.FieldsV1.Raw) == 0 {
return false
}
fields := map[string]any{}
if err := json.Unmarshal(mfe.FieldsV1.Raw, &fields); err != nil {
return false
}
if len(fields) != 1 {
return false
}
metadata, ok := fields["f:metadata"].(map[string]any)
if !ok || len(metadata) != 1 {
return false
}
_, ok = metadata["f:finalizers"].(map[string]any)
return ok
}

// maybeUpgradeFieldManagers upgrades managed field entries of the managed k8s resource
// to the SSA field owner.
func (s *SSAResourceSyncer) maybeUpgradeFieldManagers(ctx context.Context, obj *v1alpha2.Object) error {
Expand Down
80 changes: 80 additions & 0 deletions internal/controller/cluster/object/syncer_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
package object

import (
"testing"

metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/util/sets"
)

func TestNeedSSAFieldManagerUpgrade(t *testing.T) {
legacyManager := "crossplane-kubernetes-provider"
syncer := &SSAResourceSyncer{
legacyCSAFieldManagers: sets.New(legacyManager),
}

tests := []struct {
name string
fields []metav1.ManagedFieldsEntry
want bool
}{
{
name: "StatusOnlyUpdateIsIgnored",
fields: []metav1.ManagedFieldsEntry{
managedFieldsEntry(legacyManager, "status", `{"f:status":{".":{},"f:users":{}}}`),
},
want: false,
},
{
name: "FinalizersOnlyUpdateIsIgnored",
fields: []metav1.ManagedFieldsEntry{
managedFieldsEntry(legacyManager, "", `{"f:metadata":{"f:finalizers":{".":{},"v:\"in-use.crossplane.io\"":{}}}}`),
},
want: false,
},
{
name: "SpecUpdateTriggersUpgrade",
fields: []metav1.ManagedFieldsEntry{
managedFieldsEntry(legacyManager, "", `{"f:spec":{"f:credentials":{}}}`),
},
want: true,
},
{
name: "TopLevelDataUpdateTriggersUpgrade",
fields: []metav1.ManagedFieldsEntry{
managedFieldsEntry(legacyManager, "", `{"f:data":{"f:key":{}}}`),
},
want: true,
},
{
name: "NonLegacyManagerIsIgnored",
fields: []metav1.ManagedFieldsEntry{
managedFieldsEntry("other-manager", "", `{"f:spec":{"f:credentials":{}}}`),
},
want: false,
},
}

for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
obj := &unstructured.Unstructured{}
obj.SetManagedFields(tc.fields)
if got := syncer.needSSAFieldManagerUpgrade(obj); got != tc.want {
t.Fatalf("needSSAFieldManagerUpgrade() = %v, want %v", got, tc.want)
}
})
}
}

func managedFieldsEntry(manager, subresource, raw string) metav1.ManagedFieldsEntry {
return metav1.ManagedFieldsEntry{
Manager: manager,
Operation: metav1.ManagedFieldsOperationUpdate,
Subresource: subresource,
FieldsType: "FieldsV1",
FieldsV1: &metav1.FieldsV1{
Raw: []byte(raw),
},
}
}
30 changes: 28 additions & 2 deletions internal/controller/namespaced/object/syncer.go
Original file line number Diff line number Diff line change
Expand Up @@ -148,13 +148,39 @@ func (s *SSAResourceSyncer) needSSAFieldManagerUpgrade(accessor metav1.Object) b
}
mfes := accessor.GetManagedFields()
for _, mfe := range mfes {
if mfe.Operation == metav1.ManagedFieldsOperationUpdate && s.legacyCSAFieldManagers.Has(mfe.Manager) {
return true
if mfe.Operation != metav1.ManagedFieldsOperationUpdate || !s.legacyCSAFieldManagers.Has(mfe.Manager) {
continue
}
if mfe.Subresource == "status" {
continue
}
if isFinalizersOnlyManagedFieldsEntry(mfe) {
continue
}
return true
}
return false
}

func isFinalizersOnlyManagedFieldsEntry(mfe metav1.ManagedFieldsEntry) bool {
if mfe.FieldsV1 == nil || len(mfe.FieldsV1.Raw) == 0 {
return false
}
fields := map[string]any{}
if err := json.Unmarshal(mfe.FieldsV1.Raw, &fields); err != nil {
return false
}
if len(fields) != 1 {
return false
}
metadata, ok := fields["f:metadata"].(map[string]any)
if !ok || len(metadata) != 1 {
return false
}
_, ok = metadata["f:finalizers"].(map[string]any)
return ok
}

// maybeUpgradeFieldManagers upgrades managed field entries of the managed k8s resource
// to the SSA field owner.
func (s *SSAResourceSyncer) maybeUpgradeFieldManagers(ctx context.Context, obj *v1alpha1.Object) error {
Expand Down
80 changes: 80 additions & 0 deletions internal/controller/namespaced/object/syncer_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
package object

import (
"testing"

metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/util/sets"
)

func TestNeedSSAFieldManagerUpgrade(t *testing.T) {
legacyManager := "crossplane-kubernetes-provider"
syncer := &SSAResourceSyncer{
legacyCSAFieldManagers: sets.New(legacyManager),
}

tests := []struct {
name string
fields []metav1.ManagedFieldsEntry
want bool
}{
{
name: "StatusOnlyUpdateIsIgnored",
fields: []metav1.ManagedFieldsEntry{
managedFieldsEntry(legacyManager, "status", `{"f:status":{".":{},"f:users":{}}}`),
},
want: false,
},
{
name: "FinalizersOnlyUpdateIsIgnored",
fields: []metav1.ManagedFieldsEntry{
managedFieldsEntry(legacyManager, "", `{"f:metadata":{"f:finalizers":{".":{},"v:\"in-use.crossplane.io\"":{}}}}`),
},
want: false,
},
{
name: "SpecUpdateTriggersUpgrade",
fields: []metav1.ManagedFieldsEntry{
managedFieldsEntry(legacyManager, "", `{"f:spec":{"f:credentials":{}}}`),
},
want: true,
},
{
name: "TopLevelDataUpdateTriggersUpgrade",
fields: []metav1.ManagedFieldsEntry{
managedFieldsEntry(legacyManager, "", `{"f:data":{"f:key":{}}}`),
},
want: true,
},
{
name: "NonLegacyManagerIsIgnored",
fields: []metav1.ManagedFieldsEntry{
managedFieldsEntry("other-manager", "", `{"f:spec":{"f:credentials":{}}}`),
},
want: false,
},
}

for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
obj := &unstructured.Unstructured{}
obj.SetManagedFields(tc.fields)
if got := syncer.needSSAFieldManagerUpgrade(obj); got != tc.want {
t.Fatalf("needSSAFieldManagerUpgrade() = %v, want %v", got, tc.want)
}
})
}
}

func managedFieldsEntry(manager, subresource, raw string) metav1.ManagedFieldsEntry {
return metav1.ManagedFieldsEntry{
Manager: manager,
Operation: metav1.ManagedFieldsOperationUpdate,
Subresource: subresource,
FieldsType: "FieldsV1",
FieldsV1: &metav1.FieldsV1{
Raw: []byte(raw),
},
}
}