Added an error when invalid subcommand is provided for CLI commands #2655
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
andrewnester
requested review from
pietern,
shreyas-goenka,
denik and
anton-107
as code owners
andrewnester
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
andrewnester
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
andrewnester
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
pietern
reviewed
Apr 9, 2025
.codegen/service.go.tmpl
Outdated
| @@ -73,6 +73,23 @@ func New() *cobra.Command { | |||
| // This service is being previewed; hide from help output. | |||
| Hidden: true, | |||
| {{- end }} | |||
| RunE: func(cmd *cobra.Command, args []string) error { | |||
There was a problem hiding this comment.
If I understand correctly, RunE is only executed if the subcommand is not found.
Would it be possible to instead of specifying a custom RunE, to specify an Args: cobra.NoArgs, or custom function that prints something about the subcommand. I doubt this needs to resolve the subcommand.
There was a problem hiding this comment.
Unfortunately not, this is what I was trying to do in the first place. So the args validation happens in cmd.execute (https://github.com/spf13/cobra/blob/ceb39aba25c86233e4888210c4b57cdb0a78d1e1/command.go#L905) which is called only after c.Find call (which searches for subcommands) https://github.com/spf13/cobra/blob/ceb39aba25c86233e4888210c4b57cdb0a78d1e1/command.go#L1123-L1148
And Find calls this legacyArgs and returns an error before validate args are even executed https://github.com/spf13/cobra/blob/ceb39aba25c86233e4888210c4b57cdb0a78d1e1/command.go#L776
andrewnester
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
pietern
reviewed
Apr 16, 2025
.codegen/service.go.tmpl
Outdated
| @@ -73,6 +73,23 @@ func New() *cobra.Command { | |||
| // This service is being previewed; hide from help output. | |||
| Hidden: true, | |||
| {{- end }} | |||
| RunE: func(cmd *cobra.Command, args []string) error { | |||
andrewnester
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
andrewnester
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
andrewnester
temporarily deployed
to
test-trigger-is
GitHub Actions
Inactive
pietern
approved these changes
Apr 16, 2025
deco-sdk-tagging bot
added a commit
that referenced
this pull request
Apr 16, 2025
## Release v0.248.0 ### Notable Changes * Python for Databricks Asset Bundles is now in Public Preview. This feature extends bundles so that you can define jobs and pipelines as Python code, dynamically create jobs and pipelines using metadata, and modify jobs and pipelines defined in YAML or Python during bundle deployment. For more information and to get started see [Configuration in Python](https://docs.databricks.com/aws/en/dev-tools/bundles/python). * Fixed a regression with pipeline library globs introduced in 0.247.0 ([#2723](#2723)). The issue caused glob patterns to fail when using paths relative to a directory that is not the bundle root. ### Dependency updates * Upgraded Go SDK to 0.63.0 ([#2716](#2716)) * Upgraded TF provider to 1.73.0 ([#2728](#2728)) ### CLI * Added an error when invalid subcommand is provided for CLI commands ([#2655](#2655)) * Added dry-run flag support to sync command ([#2657](#2657)) ### Bundles * Do not use app config section in test templates and generated app configuration ([#2599](#2599)) * Do not exit early when checking incompatible tasks for specified DBR ([#2692](#2692)) * Removed include/exclude flags support from bundle sync command ([#2718](#2718)) * Do not clean up Python artifacts dist and build folder in "bundle validate", do it in "bundle deploy". This reverts the behaviour introduced in 0.245.0 ([#2722](#2722)) ### API Changes * Added enable-export-notebook, enable-notebook-table-clipboard and enable-results-downloading workspace-level commands. * Removed unused `timeout` and `no-wait` flags for clusters and pipelines
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.
Changes
Added an error when invalid subcommand is provided for CLI commands
Why
Previously unknown subcommands of subcommands would be happily accepted due to the cobra behaviour https://github.com/spf13/cobra/blob/ceb39aba25c86233e4888210c4b57cdb0a78d1e1/args.go#L28
This PR makes sure that only valid subcommands are accepted
Tests
Added acceptance test