fix: 81134: display conflicted taint without a json representation #104011

manugupt1 · 2021-07-29T16:10:37Z

string is formatted as unsafe json. Since this is created on the fly;
TaintKey and Effect are formatted as a 'key=effect' instead of '{key=effect}'
eliminating unsafe json representation.
Adds a fail test case for the case where a taint with same key and effect is added
and removed together.

Manual Testing

▶ ./_output/bin/kubectl taint nodes kind-control-plane key1=:NoSchedule key1=:NoSchedule-
error: can not both modify and remove the following taint(s) in the same command: key1=NoSchedule

Also, ran unit tests

▶ make test WHAT=./staging/src/k8s.io/kubectl/pkg/cmd/taint
+++ [0729 16:32:27] Running tests without code coverage and with -race
ok  	k8s.io/kubernetes/staging/src/k8s.io/kubectl/pkg/cmd/taint	0.278s

What type of PR is this?

/kind bug

What this PR does / why we need it:

Earlier the string that was constructed was an unsafe json.
As recommended in #81134 I am adding an in-depth check
to not create a json as araw string.

Which issue(s) this PR fixes:

#81134

Special notes for your reviewer:

Please see Manual Testing to see that the user output did not change.

Does this PR introduce a user-facing change?

1. Changes json representation for a conflicted taint to Key=Effect when a conflicted taint occurs in kubectl taint.

k8s-ci-robot · 2021-07-29T16:10:45Z

Welcome @manugupt1!

It looks like this is your first PR to kubernetes/kubernetes 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/kubernetes has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2021-07-29T16:10:46Z

Hi @manugupt1. 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.

eddiezane

Thanks for the PR!

eddiezane · 2021-07-29T22:54:02Z

staging/src/k8s.io/kubectl/pkg/cmd/taint/taint.go

 	for _, taintAdd := range o.taintsToAdd {
 		for _, taintRemove := range o.taintsToRemove {
 			if taintAdd.Key != taintRemove.Key {
 				continue
 			}
 			if len(taintRemove.Effect) == 0 || taintAdd.Effect == taintRemove.Effect {
-				conflictTaint := fmt.Sprintf("{\"%s\":\"%s\"}", taintRemove.Key, taintRemove.Effect)


Let's scrap the json altogether here and just make these key=value.

We don't even output the conflicts for labels 😅

https://github.com/kubernetes/kubernetes/blob/fc85deff7faef7f349742bba599696175ba920d4/staging/src/k8s.io/kubectl/pkg/cmd/label/label.go#L431

Thank you for reviewing the PR. I have made the requested changes.

@eddiezane before issuing the lgtm here, I think that your point in the second review is: we should also print the "conflictTaints" right?

@manugupt1 maybe doing something like:

return nil, nil, fmt.Errorf("can not both modify and remove a label in the same command: %v", conflictTaint)

or creating a pretifier just for this array would be really helpful for users :D

@rikatz sorry for the confusion. The return error is happening already below

https://github.com/kubernetes/kubernetes/blob/5f35d48104cf285511adffeed8bee79207ee00cc/staging/src/k8s.io/kubectl/pkg/cmd/taint/taint.go#L257

Thanks Eddie, I didn't went to check above :)

eddiezane · 2021-07-29T22:55:17Z

/triage accepted
/priority backlog
/ok-to-test

eddiezane · 2021-07-30T01:55:56Z

/approve

k8s-ci-robot · 2021-07-30T01:59:13Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: eddiezane, manugupt1

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/kubectl/OWNERS~~ [eddiezane]

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

rikatz · 2021-07-30T15:52:34Z

/lgtm
Thanks!

1. string is formatted as unsafe json. Since this is created on the fly; TaintKey and Effect are formatted as a 'key=effect' instead of '{key=effect}' eliminating unsafe json representation. 2. Adds a fail test case for the case where a taint with same key and effect is added and removed together. Manual Testing ``` ▶ ./_output/bin/kubectl taint nodes kind-control-plane key1=:NoSchedule key1=:NoSchedule- error: can not both modify and remove the following taint(s) in the same command: key1=NoSchedule ```

manugupt1 · 2021-07-31T03:43:58Z

/test pull-kubernetes-integration

Failure looks like it is related to calico.

manugupt1 · 2021-08-04T16:30:41Z

@rikatz can you please give another LGTM as I had rebased my changes earlier. Thanks!

rikatz · 2021-08-04T17:13:52Z

/lgtm
Thanks!

dims · 2021-08-05T10:41:30Z

/ok-to-test

pacoxu · 2021-08-05T11:38:16Z

/retest

k8s-ci-robot requested review from eddiezane and rikatz July 29, 2021 16:10

k8s-ci-robot added area/kubectl sig/cli Categorizes an issue or PR as relevant to SIG CLI. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jul 29, 2021

k8s-ci-robot removed the do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. label Jul 29, 2021

eddiezane suggested changes Jul 29, 2021

View reviewed changes

manugupt1 force-pushed the master branch from fc85def to 5f35d48 Compare July 29, 2021 23:33

manugupt1 changed the title ~~81134: Ensures that the string is formatted as a safe json~~ fix: 81134: display conflicted taint without a json representation Jul 30, 2021

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 30, 2021

k8s-ci-robot assigned rikatz Jul 30, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 30, 2021

manugupt1 force-pushed the master branch from 5f35d48 to 1a3eda9 Compare July 31, 2021 01:44

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 31, 2021

pacoxu mentioned this pull request Aug 2, 2021

TOB-K8S-016: Unsafe JSON construction #81134

Open

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 4, 2021

k8s-ci-robot merged commit 94a5568 into kubernetes:master Aug 5, 2021

k8s-ci-robot added this to the v1.23 milestone Aug 5, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: 81134: display conflicted taint without a json representation #104011

fix: 81134: display conflicted taint without a json representation #104011

manugupt1 commented Jul 29, 2021 •

edited

k8s-ci-robot commented Jul 29, 2021

k8s-ci-robot commented Jul 29, 2021

eddiezane left a comment

eddiezane Jul 29, 2021

eddiezane Jul 29, 2021

manugupt1 Jul 29, 2021

rikatz Jul 30, 2021

eddiezane Jul 30, 2021

rikatz Jul 30, 2021

eddiezane commented Jul 29, 2021

eddiezane commented Jul 30, 2021

k8s-ci-robot commented Jul 30, 2021

rikatz commented Jul 30, 2021

manugupt1 commented Jul 31, 2021

manugupt1 commented Aug 4, 2021

rikatz commented Aug 4, 2021

dims commented Aug 5, 2021

pacoxu commented Aug 5, 2021

fix: 81134: display conflicted taint without a json representation #104011

fix: 81134: display conflicted taint without a json representation #104011

Conversation

manugupt1 commented Jul 29, 2021 • edited

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

k8s-ci-robot commented Jul 29, 2021

k8s-ci-robot commented Jul 29, 2021

eddiezane left a comment

Choose a reason for hiding this comment

eddiezane Jul 29, 2021

Choose a reason for hiding this comment

eddiezane Jul 29, 2021

Choose a reason for hiding this comment

manugupt1 Jul 29, 2021

Choose a reason for hiding this comment

rikatz Jul 30, 2021

Choose a reason for hiding this comment

eddiezane Jul 30, 2021

Choose a reason for hiding this comment

rikatz Jul 30, 2021

Choose a reason for hiding this comment

eddiezane commented Jul 29, 2021

eddiezane commented Jul 30, 2021

k8s-ci-robot commented Jul 30, 2021

rikatz commented Jul 30, 2021

manugupt1 commented Jul 31, 2021

manugupt1 commented Aug 4, 2021

rikatz commented Aug 4, 2021

dims commented Aug 5, 2021

pacoxu commented Aug 5, 2021

manugupt1 commented Jul 29, 2021 •

edited