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.

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

Exit with non-zero codes when user input is invalid #2090

Merged
merged 2 commits into from
Mar 2, 2021

Conversation

vainu-lauri
Copy link
Contributor

This pr contains my attempt of fixing the exit codes of invalid CLI commands (as defined in the issue #2087).

As you can probably see from the submission I'm no golang expert so this will probably need a bit more or less tuning.

One thing that comes to mind is the philosophical question whether we should consider an incomplete but correct command (like kind delete) as a success or a failure. The current implementation in this PR considers it as a failure (I think this way just seemed right).

Closes #2087

Detects that invalind cli commands raise an error for the later part of
the process to be able to exit with proper exit code.
Executing, for example, `kind load some-typo` would previously cause the
program to exit with zero. Now exiting with non-zero if user input is
unknown.
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 25, 2021
@k8s-ci-robot
Copy link
Contributor

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.


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. I understand the commands that are listed here.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Feb 25, 2021
@k8s-ci-robot
Copy link
Contributor

Welcome @vainu-lauri!

It looks like this is your first PR to kubernetes-sigs/kind 🎉. 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-sigs/kind 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 k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Feb 25, 2021
@k8s-ci-robot
Copy link
Contributor

Hi @vainu-lauri. 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 the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Feb 25, 2021
@vainu-lauri
Copy link
Contributor Author

/check-cla

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Feb 25, 2021
@BenTheElder
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 Feb 26, 2021
@BenTheElder
Copy link
Member

One thing that comes to mind is the philosophical question whether we should consider an incomplete but correct command (like kind delete) as a success or a failure. The current implementation in this PR considers it as a failure (I think this way just seemed right).

I think if we have to show help and the user did not explicitly request help we should consider it a failure, +1
We can make it not a failure in the future if the command starts to do something useful without further subcommand.

@vainu-lauri
Copy link
Contributor Author

/retest

@vainu-lauri vainu-lauri changed the title [WIP] Exit with non-zero codes when user input is invalid Exit with non-zero codes when user input is invalid Mar 1, 2021
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 1, 2021
cases := []struct {
Name string
Command string
Subcommand string
Copy link
Contributor

Choose a reason for hiding this comment

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

should we add a expectErr field and do some positive testing? i..e commands that we know can't fail

Copy link
Member

Choose a reason for hiding this comment

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

only if we turn this into an integration test, which can be in a follow-up (let's not be running real commands in unit tests)

@BenTheElder
Copy link
Member

thanks so much!
sorry for the delay getting to this, I've been tied up with some big changes in kubernetes/kubernetes before code freeze hits there 😅
/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 2, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: BenTheElder, vainu-lauri

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 Mar 2, 2021
@aojea
Copy link
Contributor

aojea commented Mar 2, 2021

/retest
tests timing out in the 1.20 job
job timed out for the ipv6 job

@BenTheElder
Copy link
Member

we should probably up the limit, looks like it only took 40m

@k8s-ci-robot k8s-ci-robot merged commit 0cd1834 into kubernetes-sigs:master Mar 2, 2021
@vainu-lauri
Copy link
Contributor Author

No problem at all, thanks for having a look. Happy to help!

What comes to the positive testing we could have the kind versionand kind help tested without needing integrations.
That would add a little bit of coverage on that side of the commands as well.

@BenTheElder
Copy link
Member

if you're up for another PR that sounds reasonable to me, good point!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Running invalid command causes kind CLI to exit with 0
4 participants