-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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 roundtripping issue when genearting JSON patch #251
Closed
mengqiy
wants to merge
2
commits into
kubernetes-sigs:master
from
mengqiy:fix_roundtripping_when_gen_patch
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains 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 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 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,192 @@ | ||
/* | ||
Copyright 2018 The Kubernetes Authors. | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package patch_test | ||
|
||
import ( | ||
"encoding/json" | ||
"fmt" | ||
"reflect" | ||
"testing" | ||
|
||
jpatch "github.com/evanphx/json-patch" | ||
"github.com/mattbaird/jsonpatch" | ||
|
||
appsv1 "k8s.io/api/apps/v1" | ||
corev1 "k8s.io/api/core/v1" | ||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
"k8s.io/apimachinery/pkg/runtime" | ||
"sigs.k8s.io/controller-runtime/pkg/patch" | ||
) | ||
|
||
type testcase struct { | ||
original runtime.Object | ||
current runtime.Object | ||
originalRaw []byte | ||
// expectedPatchesFromRaw is the expected json patches when using originalRaw | ||
expectedPatchesFromRaw []jsonpatch.JsonPatchOperation | ||
// expectedPatchesFromRaw is the expected json patches when NOT using originalRaw | ||
expectedPatches []jsonpatch.JsonPatchOperation | ||
} | ||
|
||
var testcases = []testcase{ | ||
{ | ||
original: &appsv1.Deployment{ | ||
TypeMeta: metav1.TypeMeta{ | ||
APIVersion: "apps/v1", | ||
Kind: "Deployment", | ||
}, | ||
ObjectMeta: metav1.ObjectMeta{ | ||
Name: "test-deployment", | ||
}, | ||
}, | ||
current: &appsv1.Deployment{ | ||
TypeMeta: metav1.TypeMeta{ | ||
APIVersion: "apps/v1", | ||
Kind: "Deployment", | ||
}, | ||
ObjectMeta: metav1.ObjectMeta{ | ||
Name: "test-deployment", | ||
}, | ||
Spec: appsv1.DeploymentSpec{ | ||
Replicas: func(x int32) *int32 { return &x }(1), | ||
Selector: &metav1.LabelSelector{ | ||
MatchLabels: map[string]string{ | ||
"foo": "bar", | ||
}, | ||
}, | ||
Template: corev1.PodTemplateSpec{}, | ||
Strategy: appsv1.DeploymentStrategy{ | ||
Type: appsv1.RecreateDeploymentStrategyType, | ||
}, | ||
}, | ||
}, | ||
originalRaw: []byte(`{"apiVersion":"apps/v1", "kind":"Deployment", "metadata": {"creationTimestamp":null, "name": "test-deployment"}, "status": {}}`), | ||
expectedPatchesFromRaw: []jsonpatch.JsonPatchOperation{ | ||
{ | ||
Operation: "add", | ||
Path: "/spec", | ||
Value: map[string]interface{}{ | ||
"replicas": 1.0, | ||
"selector": map[string]interface{}{ | ||
"matchLabels": map[string]interface{}{ | ||
"foo": "bar", | ||
}, | ||
}, | ||
"strategy": map[string]interface{}{ | ||
"type": "Recreate", | ||
}, | ||
"template": map[string]interface{}{ | ||
"metadata": map[string]interface{}{ | ||
"creationTimestamp": nil, | ||
}, | ||
"spec": map[string]interface{}{ | ||
"containers": nil, | ||
}, | ||
}, | ||
}, | ||
}, | ||
}, | ||
expectedPatches: []jsonpatch.JsonPatchOperation{ | ||
{ | ||
Operation: "add", | ||
Path: "/spec/replicas", | ||
// float64 will be used by default in the generated JSON patch | ||
Value: 1.0, | ||
}, | ||
{ | ||
Operation: "replace", | ||
Path: "/spec/selector", | ||
Value: map[string]interface{}{ | ||
"matchLabels": map[string]interface{}{ | ||
"foo": "bar", | ||
}, | ||
}, | ||
}, | ||
{ | ||
Operation: "add", | ||
Path: "/spec/strategy/type", | ||
Value: "Recreate", | ||
}, | ||
}, | ||
}, | ||
} | ||
|
||
func TestJSONPatchFromRaw(t *testing.T) { | ||
for _, tc := range testcases { | ||
patches, err := patch.NewJSONPatch(tc.original, tc.current, tc.originalRaw...) | ||
assertNoError(err, t) | ||
|
||
err = arrayEqual(tc.expectedPatchesFromRaw, patches) | ||
assertNoError(err, t) | ||
|
||
// Applying the patch to the original raw object should yield the desired object | ||
patchByte, err := json.Marshal(patches) | ||
assertNoError(err, t) | ||
|
||
p, err := jpatch.DecodePatch(patchByte) | ||
assertNoError(err, t) | ||
|
||
modified, err := p.Apply(tc.originalRaw) | ||
assertNoError(err, t) | ||
|
||
var appliedObject *appsv1.Deployment | ||
err = json.Unmarshal(modified, &appliedObject) | ||
assertNoError(err, t) | ||
|
||
if !reflect.DeepEqual(tc.current, appliedObject) { | ||
t.Fatalf("expect object:\n%#v,\nbut got:\n%#v", tc.current, appliedObject) | ||
} | ||
} | ||
} | ||
|
||
func TestJSONPatch(t *testing.T) { | ||
for _, tc := range testcases { | ||
patches, err := patch.NewJSONPatch(tc.original, tc.current) | ||
assertNoError(err, t) | ||
|
||
err = arrayEqual(tc.expectedPatches, patches) | ||
assertNoError(err, t) | ||
} | ||
} | ||
|
||
func arrayEqual(expected, got []jsonpatch.JsonPatchOperation) error { | ||
if len(expected) != len(got) { | ||
return fmt.Errorf("expected to have length %d, but got length %d", len(expected), len(got)) | ||
} | ||
for _, e := range expected { | ||
found := false | ||
for _, g := range got { | ||
if e.Path == g.Path { | ||
if !reflect.DeepEqual(e, g) { | ||
return fmt.Errorf("expected: %#v,\nbut got: %#v", e, g) | ||
} | ||
found = true | ||
break | ||
} | ||
} | ||
if !found { | ||
return fmt.Errorf("expected entry: %#v but didn't get it", e) | ||
} | ||
} | ||
return nil | ||
} | ||
|
||
func assertNoError(err error, t *testing.T) { | ||
if err != nil { | ||
t.Fatalf("unexpected error: %v", err) | ||
} | ||
} |
This file contains 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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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.
Since it is STRONGLY recommended to provide originalRaw, it will help to not to treat this field optional. I know that will introduce a breaking change, but I think thats ok (we can include this for next major release). Also using
originalRaw...
is also not intuitive (I know its clever because it keeps this change backward compatible) when you expect a slice of bytes.So my recommendation would be to introduce it with breaking change with
originalRaw []byte
as the last arg.