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.

Sign up for GitHub

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

Jump to bottom

🐛 controllerutil.CreateOrPatch doesn't update not empty Status fields if Spec fields are specified #1403

Merged
merged 1 commit into from Apr 27, 2021
Merged

🐛 controllerutil.CreateOrPatch doesn't update not empty Status fields if Spec fields are specified #1403

merged 1 commit into from Apr 27, 2021

Conversation

dmvolod
Copy link
Contributor

@dmvolod dmvolod commented Mar 1, 2021

If we would like to patch custom resource with some Spec fields and Status which are not empty, the controllerutil.CreateOrPatch patches Spec only fields, but any Status keep unchanged,
result returns OperationResultUpdatedStatus which means that both Spec and Status where updated
The reason why this happens is that the original Status of the object returned when the Patch procedure is exited and, as a result, no Status fields are updated

Fixes #1392

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Mar 1, 2021
@k8s-ci-robot
Copy link
Contributor

Hi @dmvolod. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 1, 2021
@alvaroaleman
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 2, 2021
cbandy
cbandy reviewed Mar 4, 2021
View reviewed changes
pkg/controller/controllerutil/controllerutil.go Outdated
@@ -309,6 +309,20 @@ func CreateOrPatch(ctx context.Context, c client.Client, obj client.Object, f Mu
if (hasBeforeStatus || hasAfterStatus) && !reflect.DeepEqual(beforeStatus, afterStatus) {
// Only issue a Status Patch if the resource has a status and the beforeStatus
// and afterStatus copies differ
if result == OperationResultUpdated {
// If Status was replaced by Patch before, set it to afterStatus
objectAfterPatch, err := runtime.DefaultUnstructuredConverter.ToUnstructured(&obj)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be ToUnstructured(obj) (no address operator) like L282?

I see that L257 makes a deep copy while L282 does not. Is it possible that Patch() on L303 has manipulated afterStatus as well? I think a test that calls CreateOrPatch() with an *unstructured.Unstructured will confirm.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably should use obj, not its address, thanks @cbandy, fixed. But tests both variants, it seems to be working fine.

@vincepri
Copy link
Member

vincepri commented Mar 5, 2021

/milestone v0.9.x

@k8s-ci-robot k8s-ci-robot added this to the v0.9.x milestone Mar 5, 2021
@dmvolod dmvolod changed the title 🐛 controllerutil.CreateOrPatch doesn't update not empty Status fields if Spec fields are specified 🐛:bug: controllerutil.CreateOrPatch doesn't update not empty Status fields if Spec fields are specified Mar 5, 2021
@dmvolod dmvolod changed the title 🐛:bug: controllerutil.CreateOrPatch doesn't update not empty Status fields if Spec fields are specified 🐛 controllerutil.CreateOrPatch doesn't update not empty Status fields if Spec fields are specified Mar 5, 2021
@dmvolod
Copy link
Contributor Author

dmvolod commented Apr 26, 2021

@vincepri is there any chance to merge this PR?
Thanks in advance.

@estroz
Copy link
Contributor

estroz commented Apr 27, 2021

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 27, 2021
alvaroaleman
alvaroaleman approved these changes Apr 27, 2021
View reviewed changes
Copy link
Member

@alvaroaleman alvaroaleman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alvaroaleman, dmvolod

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 27, 2021
@k8s-ci-robot k8s-ci-robot merged commit e10bf72 into kubernetes-sigs:master Apr 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cbandy cbandy cbandy left review comments

@alvaroaleman alvaroaleman alvaroaleman approved these changes

@droot droot Awaiting requested review from droot

@joelanford joelanford Awaiting requested review from joelanford

Assignees

@estroz estroz

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
v0.9.x
Development

Successfully merging this pull request may close these issues.

controllerutil.CreateOrPatch doesn't update not empty Status fields if Spec fields are specified
6 participants
@dmvolod @k8s-ci-robot @alvaroaleman @vincepri @estroz @cbandy