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

Add diff command return status code greater than 1 when flags invalid #105445

Merged
merged 1 commit into from Oct 12, 2021
Merged

Add diff command return status code greater than 1 when flags invalid #105445

merged 1 commit into from Oct 12, 2021

Conversation

ardaguclu
Copy link
Member

@ardaguclu ardaguclu commented Oct 4, 2021 •
edited by k8s-ci-robot

What type of PR is this?

/kind bug

What this PR does / why we need it:

This PR adds flagerror handler function to detect when flags are invalid.
Default flag handler returns status code 1. However, diff command embraces
this status code as changes are found. By overriding flag errors,
this PR shows same message with default case and returns status code 2.

Which issue(s) this PR fixes:

Fixes #99354

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Change `kubectl diff --invalid-arg` status code from 1 to 2 to match docs

@ardaguclu
Add diff command return status code greater than 1 when flags invalid
4f08485 
This PR adds flagerror handler function to detect when flags are invalid.
Default flag handler returns status code 1. However, diff command embraces
this status code as changes are found. By overriding flag errors,
this PR shows same message with default case and returns status code 2.
@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/XS Denotes a PR that changes 0-9 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Oct 4, 2021
@k8s-ci-robot
Copy link
Contributor

@ardaguclu: This issue is currently awaiting triage.

If a SIG or subproject determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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 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. labels Oct 4, 2021
@k8s-ci-robot
Copy link
Contributor

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

@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. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Oct 4, 2021
@k8s-ci-robot k8s-ci-robot added area/kubectl sig/cli Categorizes an issue or PR as relevant to SIG CLI. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Oct 4, 2021
@ardaguclu
Copy link
Member Author

@eddiezane @brianpursley Could you PTAL?, thanks.

@eddiezane
Copy link
Member

@ardaguclu thanks for the fix. This looks fine to me. Can you please add a test to catch regression here?

This might help since it looks like NewCmdDiff isn't tested yet.

https://cs.k8s.io/?q=NewCmd&i=nope&files=_test.go&excludeFiles=&repos=kubernetes/kubectl

@ardaguclu
Copy link
Member Author

@eddiezane thanks for review. I spent some time to add tests using the link you provided. However,

	cmd := NewCmdDiff(tf, ioStreams)
	cmd.Flags().Set("invalid", "invalid")

method did not call cmd.SetFlagErrorFunc. Since we are passing this function into cobra as handler, it handles different than above.

Maybe this problem is also the reason why there is also no unit test in this usage

kubernetes/staging/src/k8s.io/component-base/cli/run.go

Line 69 in 79ee735

cmd.SetFlagErrorFunc(func(c *cobra.Command, err error) error {

@pacoxu pacoxu added this to Backlog(or Todo) in SIG CLI Oct 9, 2021
@ardaguclu
Copy link
Member Author

@pacoxu you moved this PR to backlog, but I think there is no elegant way to write unit tests for this case without applying some hacky methods.

@pacoxu pacoxu moved this from Backlog(or Todo) to Needs review in SIG CLI Oct 11, 2021
eddiezane
eddiezane approved these changes Oct 11, 2021
View reviewed changes
Copy link
Member

@eddiezane eddiezane left a comment

Choose a reason for hiding this comment

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

/approve

Thanks for taking a look at the tests!

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

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

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 Oct 11, 2021
@lauchokyip
Copy link
Member

/lgtm
/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 Oct 12, 2021
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 12, 2021
@lauchokyip lauchokyip mentioned this pull request Oct 12, 2021
Merged
@k8s-ci-robot k8s-ci-robot merged commit e054181 into kubernetes:master Oct 12, 2021
SIG CLI automation moved this from Needs review to Done Oct 12, 2021
@k8s-ci-robot k8s-ci-robot added this to the v1.23 milestone Oct 12, 2021
@eddiezane
Copy link
Member

/release-note-edit

Change `kubectl diff --invalid-arg` status code from 1 to 2 to match docs

@ankritisachan ankritisachan mentioned this pull request Sep 8, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eddiezane eddiezane eddiezane approved these changes

@brianpursley brianpursley Awaiting requested review from brianpursley

Assignees

@lauchokyip lauchokyip

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/kubectl 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. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. sig/cli Categorizes an issue or PR as relevant to SIG CLI. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
SIG CLI
Done
Milestone
v1.23
Development

Successfully merging this pull request may close these issues.

"kubectl diff --not-yet-supported" returns 1 which means "Differences were found"
4 participants
@ardaguclu @k8s-ci-robot @eddiezane @lauchokyip