Use posix-style CLI opts, provide method help #5081
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
Adds all the gRPC server boilerplate, and a simple help service that serves method help in man page format. Help text is maintained in text files located in core/src/main/resources/help. Only some of the method help text files are defined in this change, more to be added.
This helps reduce size of growing CLI class file.
Not needed anymore, and all method opts are posix style. (The opts parsing lib used to treat negative numbers as opt labels.)
There is no need for a switch here, the doc exists or it does not.
sqrrm
approved these changes
Jan 16, 2021
| @@ -72,14 +73,15 @@ | |||
| @Inject | |||
| public CoreApi(Config config, | |||
| CoreDisputeAgentsService coreDisputeAgentsService, | |||
| CoreOffersService coreOffersService, | |||
| CoreHelpService coreHelpService, CoreOffersService coreOffersService, | |||
There was a problem hiding this comment.
This fix (5538914) will go into the next PR.
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.
Posix-style method opts replace the formerly ambiguous, positional method params in the CLI.
This change also adds new api
CoreHelpService, for serving method specific help from the server. (Help text is defined on the server to avoid duplicating it when the api starts serving RESTful clients.)Add
CoreHelpServiceto serve method help in man page format.Add some method help docs (man pages) to core's resources:
createoffer,takeoffer, and several no-arg methods.Add
gRPCCoreHelpServicestubs to CLI.Move CLI method enum to its own class to help reduce file-size of growing
CliMainclass.Add CLI method specific posix-style option parsers. Opts are parsed by the
joptsimplelib, adding much needed client side validation tobisq-clicommands.Adjust CLI to new posix-style opts, and method help service.
Delete uneeded
NegativeNumberOptionsclass becausejoptsimplecorrectly handles negative posix style opt values (joptsimple was treating negative param values as opt labels).Adjust
batsmainnet smoke test to new posix-style CLI opts.