[refactor][kubectl-plugin] use cobra's posargs length validator #2985
+69
−50
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
davidxia
commented
Feb 8, 2025
| @@ -22,7 +22,7 @@ import ( | |||
| type GetClusterOptions struct { | |||
| configFlags *genericclioptions.ConfigFlags | |||
| ioStreams *genericclioptions.IOStreams | |||
| args []string | |||
| cluster string | |||
There was a problem hiding this comment.
rename to be more obvious what this variable is for
| @@ -43,6 +43,7 @@ func NewGetClusterCommand(streams genericclioptions.IOStreams) *cobra.Command { | |||
| Short: "Get cluster information.", | |||
| SilenceUsage: true, | |||
| ValidArgsFunction: completion.RayClusterCompletionFunc(cmdFactory), | |||
| Args: cobra.MaximumNArgs(1), | |||
| @@ -68,7 +69,10 @@ func (options *GetClusterOptions) Complete(args []string) error { | |||
| options.AllNamespaces = true | |||
| } | |||
|
|
|||
| options.args = args | |||
| if len(args) >= 1 { | |||
There was a problem hiding this comment.
there should never be more than one positional argument, but just ignore the rest instead of erroring if there is for some reason
Comment on lines
-84
to
-87
| if len(options.args) > 1 { | ||
| return fmt.Errorf("too many arguments, either one or no arguments are allowed") | ||
| } |
There was a problem hiding this comment.
now we don't need this
| @@ -21,22 +21,62 @@ import ( | |||
| rayClientFake "github.com/ray-project/kuberay/ray-operator/pkg/client/clientset/versioned/fake" | |||
| ) | |||
|
|
|||
| // This is to test Complete() and ensure that it is setting the namespace and arguments correctly | |||
| // This is to test Complete() and ensure that it is setting the namespace and cluster correctly | |||
| // No validation test is done here | |||
| func TestRayClusterGetComplete(t *testing.T) { | |||
| @@ -98,24 +138,6 @@ func TestRayClusterGetValidate(t *testing.T) { | |||
| ioStreams: &testStreams, | |||
| }, | |||
| }, | |||
| { | |||
| name: "Test validation when more than 1 arg", | |||
There was a problem hiding this comment.
test no longer needed
MortalHappiness
approved these changes
Feb 11, 2025
|
@davidxia would you mind resolving the conflict? |
We're currently validating the number of positional arguments ourselves.
We can do this with `cobra.Command{Args: cobra.MaximumNArgs(1)}` instead
to simplify logic. There are no functional changes. The error message changes
slightly but still conveys the same information.
## Before
```console
$ kubectl ray --context gke_kubeflow-platform_europe-west4-b_ml-compute-1 get cluster foo bar
Error: too many arguments, either one or no arguments are allowed
```
## After
```console
$ kubectl ray get cluster foo bar
Error: accepts at most 1 arg(s), received 2
```
Signed-off-by: David Xia <david@davidxia.com>
davidxia
force-pushed
the
get-cluster-patch1
branch
from
1cf6d45 to
b9e593d
Compare
|
thanks, resolved the conflicts |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We're currently validating the number of positional arguments ourselves.
We can do this with
cobra.Command{Args: cobra.MaximumNArgs(1)}insteadto simplify logic. There are no functional changes. The error message changes
slightly but still conveys the same information.
Before
After
Signed-off-by: David Xia david@davidxia.com
Checks