-
Notifications
You must be signed in to change notification settings - Fork 318
fix: detect manual changes on CRDs and CRs with three-way-merge #923
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
Open
yxxhero
wants to merge
4
commits into
master
Choose a base branch
from
fix/cr-three-way-merge
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+362
−2
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
115630c
fix: detect manual changes on CRDs and CRs with three-way-merge
yxxhero 6610be9
test: add tests for three-way merge with unstructured objects
yxxhero a460e71
fix: properly detect drift when chart unchanged for unstructured objects
yxxhero efb7e0a
fix: correct comment direction in three-way merge logic
yxxhero File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,320 @@ | ||
| package manifest | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| "k8s.io/apimachinery/pkg/api/meta" | ||
| "k8s.io/apimachinery/pkg/apis/meta/v1/unstructured" | ||
| "k8s.io/apimachinery/pkg/runtime" | ||
| "k8s.io/apimachinery/pkg/runtime/schema" | ||
| "k8s.io/apimachinery/pkg/types" | ||
| "k8s.io/cli-runtime/pkg/resource" | ||
| ) | ||
|
|
||
| // TestCreatePatchForUnstructured tests the three-way merge implementation for unstructured objects (CRDs, CRs). | ||
| // This tests the fix for issue #917 where manual changes to CRs were not being detected. | ||
| func TestCreatePatchForUnstructured(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| original runtime.Object | ||
| current runtime.Object | ||
| target *resource.Info | ||
|
Comment on lines
+18
to
+22
|
||
| expectedChange bool | ||
| description string | ||
| }{ | ||
| { | ||
| name: "CR with manual annotation in current (chart doesn't change anything)", | ||
| original: &unstructured.Unstructured{ | ||
| Object: map[string]interface{}{ | ||
| "apiVersion": "keda.sh/v1alpha1", | ||
| "kind": "ScaledObject", | ||
| "metadata": map[string]interface{}{ | ||
| "name": "test-so", | ||
| "namespace": "default", | ||
| }, | ||
| "spec": map[string]interface{}{ | ||
| "maxReplicaCount": 10, | ||
| }, | ||
| }, | ||
| }, | ||
| current: &unstructured.Unstructured{ | ||
| Object: map[string]interface{}{ | ||
| "apiVersion": "keda.sh/v1alpha1", | ||
| "kind": "ScaledObject", | ||
| "metadata": map[string]interface{}{ | ||
| "name": "test-so", | ||
| "namespace": "default", | ||
| "annotations": map[string]interface{}{ | ||
| "manual-change": "true", | ||
| }, | ||
| }, | ||
| "spec": map[string]interface{}{ | ||
| "maxReplicaCount": 10, | ||
| }, | ||
| }, | ||
| }, | ||
| target: &resource.Info{ | ||
| Mapping: &meta.RESTMapping{ | ||
| GroupVersionKind: schema.GroupVersionKind{ | ||
| Group: "keda.sh", | ||
| Version: "v1alpha1", | ||
| Kind: "ScaledObject", | ||
| }, | ||
| }, | ||
| Object: &unstructured.Unstructured{ | ||
| Object: map[string]interface{}{ | ||
| "apiVersion": "keda.sh/v1alpha1", | ||
| "kind": "ScaledObject", | ||
| "metadata": map[string]interface{}{ | ||
| "name": "test-so", | ||
| "namespace": "default", | ||
| }, | ||
| "spec": map[string]interface{}{ | ||
| "maxReplicaCount": 10, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| expectedChange: true, | ||
| description: "Manual annotation that is not in chart will cause diff to remove it (JSON merge patch semantics)", | ||
| }, | ||
| { | ||
| name: "CR with no manual changes", | ||
| original: &unstructured.Unstructured{ | ||
| Object: map[string]interface{}{ | ||
| "apiVersion": "keda.sh/v1alpha1", | ||
| "kind": "ScaledObject", | ||
| "metadata": map[string]interface{}{ | ||
| "name": "test-so", | ||
| "namespace": "default", | ||
| }, | ||
| "spec": map[string]interface{}{ | ||
| "maxReplicaCount": 10, | ||
| }, | ||
| }, | ||
| }, | ||
| current: &unstructured.Unstructured{ | ||
| Object: map[string]interface{}{ | ||
| "apiVersion": "keda.sh/v1alpha1", | ||
| "kind": "ScaledObject", | ||
| "metadata": map[string]interface{}{ | ||
| "name": "test-so", | ||
| "namespace": "default", | ||
| }, | ||
| "spec": map[string]interface{}{ | ||
| "maxReplicaCount": 10, | ||
| }, | ||
| }, | ||
| }, | ||
| target: &resource.Info{ | ||
| Mapping: &meta.RESTMapping{ | ||
| GroupVersionKind: schema.GroupVersionKind{ | ||
| Group: "keda.sh", | ||
| Version: "v1alpha1", | ||
| Kind: "ScaledObject", | ||
| }, | ||
| }, | ||
| Object: &unstructured.Unstructured{ | ||
| Object: map[string]interface{}{ | ||
| "apiVersion": "keda.sh/v1alpha1", | ||
| "kind": "ScaledObject", | ||
| "metadata": map[string]interface{}{ | ||
| "name": "test-so", | ||
| "namespace": "default", | ||
| }, | ||
| "spec": map[string]interface{}{ | ||
| "maxReplicaCount": 10, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| expectedChange: false, | ||
| description: "No changes should result in empty patch", | ||
| }, | ||
| { | ||
| name: "CR with chart change and manual change on different fields", | ||
| original: &unstructured.Unstructured{ | ||
| Object: map[string]interface{}{ | ||
| "apiVersion": "keda.sh/v1alpha1", | ||
| "kind": "ScaledObject", | ||
| "metadata": map[string]interface{}{ | ||
| "name": "test-so", | ||
| "namespace": "default", | ||
| }, | ||
| "spec": map[string]interface{}{ | ||
| "maxReplicaCount": 10, | ||
| "minReplicaCount": 1, | ||
| }, | ||
| }, | ||
| }, | ||
| current: &unstructured.Unstructured{ | ||
| Object: map[string]interface{}{ | ||
| "apiVersion": "keda.sh/v1alpha1", | ||
| "kind": "ScaledObject", | ||
| "metadata": map[string]interface{}{ | ||
| "name": "test-so", | ||
| "namespace": "default", | ||
| }, | ||
| "spec": map[string]interface{}{ | ||
| "maxReplicaCount": 30, | ||
| "minReplicaCount": 2, | ||
| }, | ||
| }, | ||
| }, | ||
| target: &resource.Info{ | ||
| Mapping: &meta.RESTMapping{ | ||
| GroupVersionKind: schema.GroupVersionKind{ | ||
| Group: "keda.sh", | ||
| Version: "v1alpha1", | ||
| Kind: "ScaledObject", | ||
| }, | ||
| }, | ||
| Object: &unstructured.Unstructured{ | ||
| Object: map[string]interface{}{ | ||
| "apiVersion": "keda.sh/v1alpha1", | ||
| "kind": "ScaledObject", | ||
| "metadata": map[string]interface{}{ | ||
| "name": "test-so", | ||
| "namespace": "default", | ||
| }, | ||
| "spec": map[string]interface{}{ | ||
| "maxReplicaCount": 20, | ||
| "minReplicaCount": 1, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| expectedChange: true, | ||
| description: "Chart changes maxReplicaCount, manual changes minReplicaCount - should merge", | ||
| }, | ||
| { | ||
| name: "CR with field unchanged in chart but modified in live state (issue #917)", | ||
| original: &unstructured.Unstructured{ | ||
| Object: map[string]interface{}{ | ||
| "apiVersion": "keda.sh/v1alpha1", | ||
| "kind": "ScaledObject", | ||
| "metadata": map[string]interface{}{ | ||
| "name": "test-so", | ||
| "namespace": "default", | ||
| }, | ||
| "spec": map[string]interface{}{ | ||
| "maxReplicaCount": 10, | ||
| }, | ||
| }, | ||
| }, | ||
| current: &unstructured.Unstructured{ | ||
| Object: map[string]interface{}{ | ||
| "apiVersion": "keda.sh/v1alpha1", | ||
| "kind": "ScaledObject", | ||
| "metadata": map[string]interface{}{ | ||
| "name": "test-so", | ||
| "namespace": "default", | ||
| }, | ||
| "spec": map[string]interface{}{ | ||
| "maxReplicaCount": 30, | ||
| }, | ||
| }, | ||
| }, | ||
| target: &resource.Info{ | ||
| Mapping: &meta.RESTMapping{ | ||
| GroupVersionKind: schema.GroupVersionKind{ | ||
| Group: "keda.sh", | ||
| Version: "v1alpha1", | ||
| Kind: "ScaledObject", | ||
| }, | ||
| }, | ||
| Object: &unstructured.Unstructured{ | ||
| Object: map[string]interface{}{ | ||
| "apiVersion": "keda.sh/v1alpha1", | ||
| "kind": "ScaledObject", | ||
| "metadata": map[string]interface{}{ | ||
| "name": "test-so", | ||
| "namespace": "default", | ||
| }, | ||
| "spec": map[string]interface{}{ | ||
| "maxReplicaCount": 10, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| expectedChange: true, | ||
| description: "Field maxReplicaCount is 10 in both original and target, but 30 in current - should detect drift", | ||
| }, | ||
| { | ||
| name: "CR with chart overriding manual change", | ||
| original: &unstructured.Unstructured{ | ||
| Object: map[string]interface{}{ | ||
| "apiVersion": "keda.sh/v1alpha1", | ||
| "kind": "ScaledObject", | ||
| "metadata": map[string]interface{}{ | ||
| "name": "test-so", | ||
| "namespace": "default", | ||
| }, | ||
| "spec": map[string]interface{}{ | ||
| "maxReplicaCount": 10, | ||
| }, | ||
| }, | ||
| }, | ||
| current: &unstructured.Unstructured{ | ||
| Object: map[string]interface{}{ | ||
| "apiVersion": "keda.sh/v1alpha1", | ||
| "kind": "ScaledObject", | ||
| "metadata": map[string]interface{}{ | ||
| "name": "test-so", | ||
| "namespace": "default", | ||
| }, | ||
| "spec": map[string]interface{}{ | ||
| "maxReplicaCount": 30, | ||
| }, | ||
| }, | ||
| }, | ||
| target: &resource.Info{ | ||
| Mapping: &meta.RESTMapping{ | ||
| GroupVersionKind: schema.GroupVersionKind{ | ||
| Group: "keda.sh", | ||
| Version: "v1alpha1", | ||
| Kind: "ScaledObject", | ||
| }, | ||
| }, | ||
| Object: &unstructured.Unstructured{ | ||
| Object: map[string]interface{}{ | ||
| "apiVersion": "keda.sh/v1alpha1", | ||
| "kind": "ScaledObject", | ||
| "metadata": map[string]interface{}{ | ||
| "name": "test-so", | ||
| "namespace": "default", | ||
| }, | ||
| "spec": map[string]interface{}{ | ||
| "maxReplicaCount": 20, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| expectedChange: true, | ||
| description: "Chart explicitly changes maxReplicaCount from 10 to 20, overriding manual value of 30", | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| patch, patchType, err := createPatch(tt.original, tt.current, tt.target) | ||
| require.NoError(t, err, "createPatch should not return an error") | ||
| require.Equal(t, types.MergePatchType, patchType, "patch type should be MergePatchType for unstructured objects") | ||
|
|
||
| t.Logf("Patch result: %s", string(patch)) | ||
|
|
||
| if tt.expectedChange { | ||
| require.NotEmpty(t, patch, tt.description+": expected patch to detect changes, got empty patch") | ||
| require.NotEqual(t, []byte("{}"), patch, tt.description+": expected patch to detect changes, got empty patch") | ||
| require.NotEqual(t, []byte("null"), patch, tt.description+": expected patch to detect changes, got null patch") | ||
| } else { | ||
| // No changes expected: patch must be empty or effectively empty ("{}" or "null") | ||
| if len(patch) == 0 || string(patch) == "{}" || string(patch) == "null" { | ||
| return | ||
| } | ||
| require.Failf(t, tt.description+": expected no changes, got unexpected patch", "unexpected patch: %s", string(patch)) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The three-way merge implementation for unstructured/CRD objects here will still fail to detect drift when a field is unchanged between
oldDataandnewDatabut modified only in the live object (the scenario described in #917 for values explicitly set in the chart). In that casejsonpatch.CreateMergePatch(oldData, newData)returns an empty patch,mergedDataends up identical tocurrentData, andCreateMergePatch(currentData, mergedData)also returns an empty patch, so no diff is produced even though the live state diverges from the chart. This contradicts the PR description that manual changes to CRDs/CRs are now detected "just like" built-in resources, and it means the fix does not yet cover the core bug scenario. To align behavior with the strategic three-way merge path used for built-in types, the unstructured/CRD branch should compute a patch that also captures differences betweencurrentDataandnewDatafor chart-owned fields, even whennewDataequalsoldData, rather than only replayingold -> newchanges ontocurrentData.