-
Notifications
You must be signed in to change notification settings - Fork 38.7k
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 --override and --patch flags in kubectl #4448
Merged
Merged
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
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,57 @@ | ||
/* | ||
Copyright 2014 Google Inc. All rights reserved. | ||
|
||
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 merge | ||
|
||
import ( | ||
"encoding/json" | ||
) | ||
|
||
// MergeJSON merges JSON according to RFC7386 | ||
// (see https://tools.ietf.org/html/rfc7386) | ||
func MergeJSON(dst, src []byte) ([]byte, error) { | ||
var target interface{} | ||
if err := json.Unmarshal(dst, &target); err != nil { | ||
return nil, err | ||
} | ||
var patch interface{} | ||
if err := json.Unmarshal(src, &patch); err != nil { | ||
return nil, err | ||
} | ||
return json.Marshal(MergePatch(target, patch)) | ||
} | ||
|
||
// MergePatch is an implementation of MergePatch described in RFC7386 that operates on | ||
// json marshalled into empty interface{} by encoding/json.Unmarshal() | ||
// (see https://tools.ietf.org/html/rfc7386#section-2) | ||
func MergePatch(target, patch interface{}) interface{} { | ||
if patchObject, isPatchObject := patch.(map[string]interface{}); isPatchObject { | ||
targetObject := make(map[string]interface{}) | ||
if m, isTargetObject := target.(map[string]interface{}); isTargetObject { | ||
targetObject = m | ||
} | ||
for name, value := range patchObject { | ||
if _, found := targetObject[name]; value == nil && found { | ||
delete(targetObject, name) | ||
} else { | ||
targetObject[name] = MergePatch(targetObject[name], value) | ||
} | ||
} | ||
return targetObject | ||
} else { | ||
return patch | ||
} | ||
} |
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,68 @@ | ||
/* | ||
Copyright 2014 Google Inc. All rights reserved. | ||
|
||
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 merge | ||
|
||
import ( | ||
"testing" | ||
) | ||
|
||
func TestMergeJSON(t *testing.T) { | ||
tests := []struct { | ||
target string | ||
patch string | ||
expected string | ||
}{ | ||
{target: `{}`, patch: `{}`, expected: `{}`}, | ||
{target: `{"a":"b","c":{"d":"e","f":"g"}}`, patch: `{}`, expected: `{"a":"b","c":{"d":"e","f":"g"}}`}, | ||
//update | ||
{target: `{"a":"b","c":"d"}`, patch: `{"a":"z"}`, expected: `{"a":"z","c":"d"}`}, | ||
//remove key | ||
{target: `{"f":"g"}`, patch: `{"f":null}`, expected: `{}`}, | ||
//inner update | ||
{target: `{"c":{"d":"e","f":"g"}}`, patch: `{"c":{"f":"z"}}`, expected: `{"c":{"d":"e","f":"z"}}`}, | ||
//inner remove | ||
{target: `{"c":{"d":"e","f":"g"}}`, patch: `{"c":{"f":null}}`, expected: `{"c":{"d":"e"}}`}, | ||
//complex update and remove | ||
{target: `{"a":"b","c":{"d":"e","f":"g"}}`, patch: `{"a":"z","c":{"f":null}}`, expected: `{"a":"z","c":{"d":"e"}}`}, | ||
// test cases from https://tools.ietf.org/html/rfc7386#appendix-A slightly adapted to correspond to go's | ||
// encoding/json conventions | ||
{target: `{"a":"b"}`, patch: `{"a":"c"}`, expected: `{"a":"c"}`}, | ||
{target: `{"a":"b"}`, patch: `{"b":"c"}`, expected: `{"a":"b","b":"c"}`}, | ||
{target: `{"a":"b"}`, patch: `{"a":null}`, expected: `{}`}, | ||
{target: `{"a":"b","b":"c"}`, patch: `{"a":null}`, expected: `{"b":"c"}`}, | ||
{target: `{"a":["b"]}`, patch: `{"a":"c"}`, expected: `{"a":"c"}`}, | ||
{target: `{"a":"c"}`, patch: `{"a":["b"]}`, expected: `{"a":["b"]}`}, | ||
{target: `{"a":{"b": "c"}}`, patch: `{"a": {"b": "d","c": null}}`, expected: `{"a":{"b":"d","c":null}}`}, | ||
{target: `{"a":[{"b":"c"}]}`, patch: `{"a":[1]}`, expected: `{"a":[1]}`}, | ||
{target: `["a","b"]`, patch: `["c","d"]`, expected: `["c","d"]`}, | ||
{target: `{"a":"b"}`, patch: `["c"]`, expected: `["c"]`}, | ||
{target: `{"a":"foo"}`, patch: `null`, expected: `null`}, | ||
{target: `{"a":"foo"}`, patch: `"bar"`, expected: `"bar"`}, | ||
{target: `{"e":null}`, patch: `{"a":1}`, expected: `{"a":1,"e":null}`}, | ||
{target: `[1,2]`, patch: `{"a":"b","c":null}`, expected: `{"a":"b","c":null}`}, | ||
{target: `{}`, patch: `{"a":{"bb":{"ccc":null}}}`, expected: `{"a":{"bb":{"ccc":null}}}`}, | ||
} | ||
for i, test := range tests { | ||
out, err := MergeJSON([]byte(test.target), []byte(test.patch)) | ||
if err != nil { | ||
t.Errorf("case %v, unexpected error: %v", i, err) | ||
} | ||
if string(out) != test.expected { | ||
t.Errorf("case %v, expected:\n%v\nsaw:\n%v\n", i, test.expected, string(out)) | ||
} | ||
} | ||
} |
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.
Does this actually fix the handling of default-valued field updates when the object gets re-marshalled?
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.
This particular line does not but the PR does :). Check out merge_test.go. Just to be sure i've added some test to helper_test.go as well. See
https://github.com/GoogleCloudPlatform/kubernetes/pull/4448/files#diff-c8e282cc368fe38828935844bb3bd00aR113
which delete's a field and
https://github.com/GoogleCloudPlatform/kubernetes/pull/4448/files#diff-c8e282cc368fe38828935844bb3bd00aR133
which updates an int field to zero. default-value updates are fixed by applying patch json directly to versioned type json.
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.
I think I see why you put the comment on this line. On the trip back to the server are the default fields wiped out? I believe they still are if the field is annotated with omitempty. For that we would have to eliminate conversion round trip in kubectl.
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.
Or implement HTTP PATCH on our resource endpoints.
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.
Thanks for clarifying, I just wanted to double check that this wasn't supposed to be fixing everything we talked about in the comments of #4008, just the original issue.
I got interrupted last night when going through this, I'll check out the rest now.