engflow_auth: Migrate to CLI library #15
Merged
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
jayconrod
approved these changes
Jul 29, 2024
internal/autherr/coded_error_test.go
Outdated
|
|
||
| func TestCodedErrorImplementsExitCoder(t *testing.T) { | ||
| var want cli.ExitCoder | ||
| assert.Implements(t, &want, &CodedError{}) |
There was a problem hiding this comment.
This could be a static check at global scope:
var _ cli.ExitCoder = (*CodedError)(nil)
This change moves CLI parsing into urfave/cli/v2, so that we can easily
add more subcommands without incrementally also writing our own CLI
parser. The app is now split into two objects:
* `appState`, which contains injected dependencies that commands can use
to interact with the various subsystems
* `cli.App`, which takes care of the CLI parsing logic. Each leaf
subcommand has its logic implemented as a method of `appState`.
This change requires the following migrations:
* `rootCmd` type renamed to `appState`, since the former no longer does
any CLI arg parsing
* methods of `appState` are now integrated with `cli.App`, as they can
be used as Actions on subcommands:
* they now take a `*cli.Context` as a parameter
* they read from/write to Readers/Writers found on the `*cli.Context`,
rather than those on the `appState` (which are now removed)
* help text is now printed on stdout rather than stderr (default
behavior of `cli.App`)
* `autherr.CodedError` implements `cli.ExitCoder` (it may be possible to
remove CodedError in favor of `cli.Exit()` in the future)
Tested:
* Because main's tests are shimming at the level of
os.Args/stdin/stdout/stderr, we can have high confidence that the unit
tests passing means that behavior of the CLI is not meaningfully
changed
* TODO(scott): Manually run commands anyway
minor-fixes
force-pushed
the
scott/cli_migration
branch
from
aa6bfc8
to
f524220
Compare
jayconrod
approved these changes
Jul 29, 2024
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.
This change moves CLI parsing into urfave/cli/v2, so that we can easily add more subcommands without incrementally also writing our own CLI parser. The app is now split into two objects:
appState, which contains injected dependencies that commands can use to interact with the various subsystemscli.App, which takes care of the CLI parsing logic. Each leaf subcommand has its logic implemented as a method ofappState.This change requires the following migrations:
rootCmdtype renamed toappState, since the former no longer does any CLI arg parsingappStateare now integrated withcli.App, as they can be used as Actions on subcommands:*cli.Contextas a parameter*cli.Context, rather than those on theappState(which are now removed)cli.App)autherr.CodedErrorimplementscli.ExitCoder(it may be possible to remove CodedError in favor ofcli.Exit()in the future)Tested:
version,help,loginsubcommands and did build on Kyanite using new binary