Some refactoring on leo subcommands #664
Closed
Conversation
This file contains hidden or 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
0x2b3bfa0
reviewed
Sep 9, 2022
Is there any reason to keep identical single file packages? |
It probably boils down to a matter of taste1 but, to my mind, it looks cleaner once we introduce subcommands or more complex commands (e.g. #291 or #531) which may be split over several files. See also docker/cli, kubernetes/kubectl or cli/cli for inspiration. Footnotes
|
delete -> destroy read -> status
It looks like there's a bug in cobra where a required persistent flag is enforced even for the help command.
tasdomas
force-pushed
the
d016-leo-cmd-rename
branch
from
2b012e9 to
35e27b5
Compare
0x2b3bfa0
reviewed
Sep 16, 2022
tasdomas
changed the title
0x2b3bfa0
reviewed
Oct 4, 2022
0x2b3bfa0
reviewed
Oct 12, 2022
Comment on lines
+1
to
+58
| package cmd | ||
|
|
||
| import ( | ||
| "time" | ||
|
|
||
| "github.com/sirupsen/logrus" | ||
| "github.com/spf13/cobra" | ||
| "github.com/spf13/pflag" | ||
|
|
||
| "terraform-provider-iterative/task/common" | ||
| ) | ||
|
|
||
| // BaseOptions specify base flags for commands that interact with | ||
| // cloud deployments. | ||
| type BaseOptions struct { | ||
| Region string | ||
| Provider string | ||
| Verbose bool | ||
| } | ||
|
|
||
| // defaultCloud specifies default timeouts. | ||
| var defaultCloud = common.Cloud{ | ||
| Timeouts: common.Timeouts{ | ||
| Create: 15 * time.Minute, | ||
| Read: 3 * time.Minute, | ||
| Update: 3 * time.Minute, | ||
| Delete: 15 * time.Minute, | ||
| }, | ||
| } | ||
|
|
||
| // SetFlags sets base option flags on the provided flagset. | ||
| func (o *BaseOptions) SetFlags(f *pflag.FlagSet) { | ||
| f.StringVar(&o.Provider, "cloud", "", "cloud provider") | ||
| f.StringVar(&o.Region, "region", "us-east", "cloud region") | ||
| f.BoolVar(&o.Verbose, "verbose", false, "verbose output") | ||
| cobra.CheckErr(cobra.MarkFlagRequired(f, "cloud")) | ||
| } | ||
|
|
||
| // GetCloud parses cloud-specific options and returns a cloud structure. | ||
| func (o *BaseOptions) GetCloud() *common.Cloud { | ||
| cloud := defaultCloud | ||
| cloud.Provider = common.Provider(o.Provider) | ||
| cloud.Region = common.Region(o.Region) | ||
| return &cloud | ||
| } | ||
|
|
||
| // ConfigureLogging configures logging and sets the log level. | ||
| func (o *BaseOptions) ConfigureLogging() { | ||
| logrus.SetLevel(logrus.InfoLevel) | ||
| if o.Verbose { | ||
| logrus.SetLevel(logrus.DebugLevel) | ||
| } | ||
|
|
||
| logrus.SetFormatter(&logrus.TextFormatter{ | ||
| ForceColors: true, | ||
| DisableTimestamp: true, | ||
| }) | ||
| } |
There was a problem hiding this comment.
Message in a botte for myself: lots of good stuff here, don't let them disappear forever
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.
Renamed delete to destroy.
Renamed read to status.
Restructured base options and moved all subcommands into a single package.