Check for required name parameter in dynamic client #75072

lblackstone · 2019-03-06T23:42:44Z

What type of PR is this?
/kind bug

What this PR does / why we need it:
The dynamic client in the client-go library was not validating that the required name parameter was non-empty for the Delete, Get, and Patch requests. If an empty string was provided, these methods would panic.

This PR adds a check for empty string and returns an error rather than panicking.

Which issue(s) this PR fixes:

Fixes #75069

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Add name validation for dynamic client methods in client-go

k8s-ci-robot · 2019-03-06T23:42:51Z

Hi @lblackstone. Thanks for your PR.

I'm waiting for a kubernetes 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.

yue9944882 · 2019-03-07T04:05:19Z

/ok-to-test

yue9944882 · 2019-03-07T04:17:44Z

staging/src/k8s.io/client-go/dynamic/simple.go

@@ -216,6 +217,9 @@ func (c *dynamicResourceClient) DeleteCollection(opts *metav1.DeleteOptions, lis
 }

 func (c *dynamicResourceClient) Get(name string, opts metav1.GetOptions, subresources ...string) (*unstructured.Unstructured, error) {
+	if name == "" {
+		return nil, fmt.Errorf("name is required")


this validation should also be applied to Patch, Delete, Update, UpdateStatus.

I updated Patch and Delete. The other ones didn't have a name parameter to validate.

update/updatestatus can use accessor.GetName()

create should also validate name if len(subresources) > 0

staging/src/k8s.io/client-go/dynamic/simple.go

fedebongio · 2019-03-07T21:42:21Z

/assign @caesarxuchao

yue9944882 · 2019-03-21T04:14:16Z

/lgtm
/cc @liggitt
for approval

The Create, Delete, Get, Patch, Update and UpdateStatus methods in the dynamic client all expect the name parameter to be non-empty, but did not validate this requirement, which could lead to a panic. Add explicit checks to these methods.

lblackstone · 2019-03-21T15:29:34Z

I rebased on master and added the name check to Create, Update and UpdateStatus

yue9944882 · 2019-03-21T16:04:32Z

staging/src/k8s.io/client-go/dynamic/simple.go

@@ -102,6 +103,9 @@ func (c *dynamicResourceClient) Create(obj *unstructured.Unstructured, opts meta
 			return nil, err
 		}
 		name = accessor.GetName()
+		if len(name) == 0 {
+			return nil, fmt.Errorf("name is required")


name can be empty, if we set the generateName

not when dealing with a subresource

oh tricked. it's subresource.

liggitt · 2019-03-21T16:20:28Z

/lgtm
/approve

k8s-ci-robot · 2019-03-21T16:20:51Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lblackstone, liggitt

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:

~~staging/src/k8s.io/client-go/OWNERS~~ [liggitt]

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

lblackstone · 2019-03-21T21:53:58Z

The pull-kubernetes-e2e-gce-100-performance test has failed several times today, but I don't think the failure would be related to this change. I'll retry again since it passed before.

lblackstone · 2019-03-21T22:06:03Z

/retest

fejta-bot · 2019-03-22T01:12:08Z

/retest
This bot automatically retries jobs that failed/flaked on approved PRs (send feedback to fejta).

Review the full test history for this PR.

Silence the bot with an /lgtm cancel or /hold comment for consistent failures.

…2-upstream-release-1.13 Automated cherry pick of #75072: Check for required name parameter in dynamic client

…2-upstream-release-1.14 Automated cherry pick of #75072: Check for required name parameter in dynamic client

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. and removed needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Mar 6, 2019

k8s-ci-robot requested review from lavalamp and liggitt March 6, 2019 23:43

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 7, 2019

yue9944882 reviewed Mar 7, 2019

View reviewed changes

staging/src/k8s.io/client-go/dynamic/simple.go Outdated Show resolved Hide resolved

lblackstone force-pushed the dynamic-get-name-validation branch from 6cfac3f to ec958c4 Compare March 7, 2019 06:21

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 7, 2019

lblackstone changed the title ~~Check for required name parameter on dynamic Get~~ Check for required name parameter in dynamic client Mar 7, 2019

k8s-ci-robot assigned caesarxuchao Mar 7, 2019

k8s-ci-robot assigned yue9944882 Mar 21, 2019

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 21, 2019

lblackstone force-pushed the dynamic-get-name-validation branch from ec958c4 to a9cba03 Compare March 21, 2019 15:29

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 21, 2019

yue9944882 reviewed Mar 21, 2019

View reviewed changes

k8s-ci-robot assigned liggitt Mar 21, 2019

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 21, 2019

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 21, 2019

k8s-ci-robot merged commit 0118630 into kubernetes:master Mar 22, 2019

lblackstone mentioned this pull request Mar 22, 2019

Empty name on dynamic client Get causes client-go to panic pulumi/pulumi-kubernetes#470

Closed

lblackstone deleted the dynamic-get-name-validation branch April 2, 2019 03:14

This was referenced Apr 5, 2019

Automated cherry pick of #75072: Check for required name parameter in dynamic client #76199

Merged

Automated cherry pick of #75072: Check for required name parameter in dynamic client #76200

Merged

k8s-ci-robot added a commit that referenced this pull request May 7, 2019

Merge pull request #76200 from mvladev/automated-cherry-pick-of-#7507…

405aa2e

…2-upstream-release-1.13 Automated cherry pick of #75072: Check for required name parameter in dynamic client

k8s-ci-robot added a commit that referenced this pull request May 10, 2019

Merge pull request #76199 from mvladev/automated-cherry-pick-of-#7507…

59a9c64

…2-upstream-release-1.14 Automated cherry pick of #75072: Check for required name parameter in dynamic client

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Check for required name parameter in dynamic client #75072

Check for required name parameter in dynamic client #75072

lblackstone commented Mar 6, 2019 •

edited

k8s-ci-robot commented Mar 6, 2019

yue9944882 commented Mar 7, 2019

yue9944882 Mar 7, 2019

lblackstone Mar 7, 2019

liggitt Mar 21, 2019 •

edited

fedebongio commented Mar 7, 2019

yue9944882 commented Mar 21, 2019

lblackstone commented Mar 21, 2019

yue9944882 Mar 21, 2019

liggitt Mar 21, 2019

yue9944882 Mar 21, 2019

liggitt commented Mar 21, 2019

k8s-ci-robot commented Mar 21, 2019

lblackstone commented Mar 21, 2019

lblackstone commented Mar 21, 2019

fejta-bot commented Mar 22, 2019

Check for required name parameter in dynamic client #75072

Check for required name parameter in dynamic client #75072

Conversation

lblackstone commented Mar 6, 2019 • edited

k8s-ci-robot commented Mar 6, 2019

yue9944882 commented Mar 7, 2019

yue9944882 Mar 7, 2019

Choose a reason for hiding this comment

lblackstone Mar 7, 2019

Choose a reason for hiding this comment

liggitt Mar 21, 2019 • edited

Choose a reason for hiding this comment

fedebongio commented Mar 7, 2019

yue9944882 commented Mar 21, 2019

lblackstone commented Mar 21, 2019

yue9944882 Mar 21, 2019

Choose a reason for hiding this comment

liggitt Mar 21, 2019

Choose a reason for hiding this comment

yue9944882 Mar 21, 2019

Choose a reason for hiding this comment

liggitt commented Mar 21, 2019

k8s-ci-robot commented Mar 21, 2019

lblackstone commented Mar 21, 2019

lblackstone commented Mar 21, 2019

fejta-bot commented Mar 22, 2019

lblackstone commented Mar 6, 2019 •

edited

liggitt Mar 21, 2019 •

edited