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

Fix bug where using kubectl patch with $deleteFromPrimitiveList on an empty or nonexistent list adds the item to be removed #105421

Merged
merged 1 commit into from Nov 5, 2021
Merged

Fix bug where using kubectl patch with $deleteFromPrimitiveList on an empty or nonexistent list adds the item to be removed #105421

merged 1 commit into from Nov 5, 2021
+58 −3

Conversation

brianpursley
Copy link
Member

What type of PR is this?

/kind bug

What this PR does / why we need it:

Fixes bug where using kubectl patch with $deleteFromPrimitiveList on a nonexistent or empty list would add the item to the list

Here is a command that illustrates the problem:

kubectl patch --local -f <(kubectl create cm foo --dry-run=client -o yaml) --dry-run=client --type=strategic -p '{"metadata":{"$deleteFromPrimitiveList/finalizers":["fancy.io/foo"]}}' -o yaml

Current output with the bug. Notice the finalizer is added:

apiVersion: v1
kind: ConfigMap
metadata:
  creationTimestamp: null
  finalizers:
  - fancy.io/foo
  name: foo

Output after this PR fixes the bug:

apiVersion: v1
kind: ConfigMap
metadata:
  creationTimestamp: null
  name: foo

Which issue(s) this PR fixes:

Fixes #105146

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Fixed bug where using kubectl patch with $deleteFromPrimitiveList on a nonexistent or empty list would add the item to the list

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

@brianpursley
Fix bug where attempting to use patch with deleteFromPrimitiveList on…
8a72a54 
… an empty or nonexistent list incorrectly adds the item to be removed.
@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/bug Categorizes issue or PR as related to a bug. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Oct 2, 2021
@brianpursley
Copy link
Member Author

/retest

@fedebongio
Copy link
Contributor

/assign @apelisse
(the issue is already assigned to the same reviewer)
/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Oct 5, 2021
@apelisse
Copy link
Member

apelisse commented Oct 8, 2021

Thanks!
/lgtm
/approve

@apelisse
Copy link
Member

apelisse commented Oct 8, 2021

cc @mengqiy

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 8, 2021
@brianpursley
Copy link
Member Author

Hmm, I guess I forgot to do /assign...

/assign @pwittrock

sttts
sttts reviewed Nov 5, 2021
View reviewed changes
staging/src/k8s.io/apimachinery/pkg/util/strategicpatch/patch.go
original[k] = patchV
if !isDeleteList {
original[k] = patchV
}
Copy link
Contributor

Choose a reason for hiding this comment

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

missing test case for this

Copy link
Member

Choose a reason for hiding this comment

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

IIUC https://github.com/kubernetes/kubernetes/pull/105421/files#diff-0f579f8292053ed842e08773b87393bb70de697fdcd32779c9ce820562e0c546R707 is to cover this case. The originalType is string and the patchType is int.

mengqiy
mengqiy approved these changes Nov 5, 2021
View reviewed changes
Copy link
Member

@mengqiy mengqiy left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve
Thanks for fixing this!

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: apelisse, brianpursley, mengqiy

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 Nov 5, 2021
@mengqiy
Copy link
Member

mengqiy commented Nov 5, 2021

/retest

@k8s-ci-robot k8s-ci-robot merged commit 0b0007a into kubernetes:master Nov 5, 2021
@k8s-ci-robot k8s-ci-robot added this to the v1.23 milestone Nov 5, 2021
@timebertt
Copy link
Contributor

@brianpursley thanks for fixing this!

I think, this deserves a backport, WDYT?

@brianpursley
Copy link
Member Author

@brianpursley thanks for fixing this!

I think, this deserves a backport, WDYT?

@timebertt Agreed. It is a bug that affects previous versions, so it should be backported. I'll see if I can follow the cherry pick process to do that.

This was referenced Nov 8, 2021
Closed
Closed
Closed
@feloy feloy mentioned this pull request Jun 6, 2022
Closed
@brianpursley brianpursley deleted the kubernetes-105146 branch February 2, 2023 01:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sttts sttts sttts left review comments

@mengqiy mengqiy mengqiy approved these changes

@apelisse apelisse Awaiting requested review from apelisse

Assignees

@apelisse apelisse

@mengqiy mengqiy

@pwittrock pwittrock

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. kind/bug Categorizes issue or PR as related to a bug. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. release-note Denotes a PR that will be considered when it comes time to generate release notes. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
v1.23
Development

Successfully merging this pull request may close these issues.

$deleteFromPrimitiveList is not idempotent
8 participants
@brianpursley @fedebongio @apelisse @k8s-ci-robot @mengqiy @timebertt @sttts @pwittrock