Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🐛 Fix manifestwork and appliedmanifestwork unsync issue #636

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
71 changes: 71 additions & 0 deletions pkg/work/helper/helper_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import (
"k8s.io/apimachinery/pkg/types"
fakedynamic "k8s.io/client-go/dynamic/fake"
clienttesting "k8s.io/client-go/testing"
"k8s.io/utils/diff"

workapiv1 "open-cluster-management.io/api/work/v1"

Expand Down Expand Up @@ -669,3 +670,73 @@ func TestBuildResourceMeta(t *testing.T) {
})
}
}

func TestFindUntrackedResources(t *testing.T) {
cases := []struct {
name string
appliedResources []workapiv1.AppliedManifestResourceMeta
newAppliedResources []workapiv1.AppliedManifestResourceMeta
expectedUntrackedResources []workapiv1.AppliedManifestResourceMeta
}{
{
name: "no resource untracked",
appliedResources: nil,
newAppliedResources: []workapiv1.AppliedManifestResourceMeta{
{Version: "v1", ResourceIdentifier: workapiv1.ResourceIdentifier{Group: "g1", Resource: "r1", Namespace: "ns1", Name: "n1"}},
},
expectedUntrackedResources: nil,
},
{
name: "some of original resources untracked",
appliedResources: []workapiv1.AppliedManifestResourceMeta{
{Version: "v1", ResourceIdentifier: workapiv1.ResourceIdentifier{Group: "g1", Resource: "r1", Namespace: "ns1", Name: "n1"}},
{Version: "v2", ResourceIdentifier: workapiv1.ResourceIdentifier{Group: "g2", Resource: "r2", Namespace: "ns2", Name: "n2"}},
},
newAppliedResources: []workapiv1.AppliedManifestResourceMeta{
{Version: "v2", ResourceIdentifier: workapiv1.ResourceIdentifier{Group: "g2", Resource: "r2", Namespace: "ns2", Name: "n2"}},
{Version: "v3", ResourceIdentifier: workapiv1.ResourceIdentifier{Group: "g3", Resource: "r3", Namespace: "ns3", Name: "n3"}},
},
expectedUntrackedResources: []workapiv1.AppliedManifestResourceMeta{
{Version: "v1", ResourceIdentifier: workapiv1.ResourceIdentifier{Group: "g1", Resource: "r1", Namespace: "ns1", Name: "n1"}},
},
},
{
name: "all original resources untracked",
appliedResources: []workapiv1.AppliedManifestResourceMeta{
{Version: "v1", ResourceIdentifier: workapiv1.ResourceIdentifier{Group: "g1", Resource: "r1", Namespace: "ns1", Name: "n1"}},
{Version: "v2", ResourceIdentifier: workapiv1.ResourceIdentifier{Group: "g2", Resource: "r2", Namespace: "ns2", Name: "n2"}},
},
newAppliedResources: []workapiv1.AppliedManifestResourceMeta{
{Version: "v3", ResourceIdentifier: workapiv1.ResourceIdentifier{Group: "g3", Resource: "r3", Namespace: "ns3", Name: "n3"}},
{Version: "v4", ResourceIdentifier: workapiv1.ResourceIdentifier{Group: "g4", Resource: "r4", Namespace: "ns4", Name: "n4"}},
},
expectedUntrackedResources: []workapiv1.AppliedManifestResourceMeta{
{Version: "v1", ResourceIdentifier: workapiv1.ResourceIdentifier{Group: "g1", Resource: "r1", Namespace: "ns1", Name: "n1"}},
{Version: "v2", ResourceIdentifier: workapiv1.ResourceIdentifier{Group: "g2", Resource: "r2", Namespace: "ns2", Name: "n2"}},
},
},
{
name: "changing version of original resources does not make it untracked",
appliedResources: []workapiv1.AppliedManifestResourceMeta{
{Version: "v1", ResourceIdentifier: workapiv1.ResourceIdentifier{Group: "g1", Resource: "r1", Namespace: "ns1", Name: "n1"}},
{Version: "v2", ResourceIdentifier: workapiv1.ResourceIdentifier{Group: "g2", Resource: "r2", Namespace: "ns2", Name: "n2"}},
},
newAppliedResources: []workapiv1.AppliedManifestResourceMeta{
{Version: "v2", ResourceIdentifier: workapiv1.ResourceIdentifier{Group: "g1", Resource: "r1", Namespace: "ns1", Name: "n1"}},
{Version: "v4", ResourceIdentifier: workapiv1.ResourceIdentifier{Group: "g4", Resource: "r4", Namespace: "ns4", Name: "n4"}},
},
expectedUntrackedResources: []workapiv1.AppliedManifestResourceMeta{
{Version: "v2", ResourceIdentifier: workapiv1.ResourceIdentifier{Group: "g2", Resource: "r2", Namespace: "ns2", Name: "n2"}},
},
},
}

for _, c := range cases {
t.Run(c.name, func(t *testing.T) {
actual := FindUntrackedResources(c.appliedResources, c.newAppliedResources)
if !reflect.DeepEqual(actual, c.expectedUntrackedResources) {
t.Errorf(diff.ObjectDiff(actual, c.expectedUntrackedResources))
}
})
}
}
25 changes: 25 additions & 0 deletions pkg/work/helper/helpers.go
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,31 @@ func MergeStatusConditions(conditions []metav1.Condition, newConditions []metav1
return merged
}

// FindUntrackedResources returns applied resources which are no longer tracked by manifestwork
// API version should be ignored when checking if a resource is no longer tracked by a manifestwork.
// This is because we treat resources of same GroupResource but different version equivalent.
// It also compares UID of the appliedResources to identify the untracked appliedResources because
// 1. The UID should keep the same for resources with different versions.
// 2. The UID in the newAppliedResources is always the latest updated one. The only possibility that UID
// in appliedResources differs from what in newAppliedResources is that this resource is recreated.
// Its UID in appliedResources is invalid hence recording it as untracked applied resource and delete it is safe.
func FindUntrackedResources(appliedResources, newAppliedResources []workapiv1.AppliedManifestResourceMeta) []workapiv1.AppliedManifestResourceMeta {
var untracked []workapiv1.AppliedManifestResourceMeta

resourceIndex := map[workapiv1.ResourceIdentifier]struct{}{}
for _, resource := range newAppliedResources {
resourceIndex[resource.ResourceIdentifier] = struct{}{}
}

for _, resource := range appliedResources {
if _, ok := resourceIndex[resource.ResourceIdentifier]; !ok {
untracked = append(untracked, resource)
}
}

return untracked
}

// DeleteAppliedResources deletes all given applied resources and returns those pending for finalization
// If the uid recorded in resources is different from what we get by client, ignore the deletion.
func DeleteAppliedResources(
Expand Down

This file was deleted.

Loading
Loading