Fix CLI help messages #4948
Merged
Fix CLI help messages #4948
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
Previously if a user called pki-server CLI with a wrong sub-command the ArgumentParser would show an auto-generated error message which looks significantly different from the help message already defined in print_help(). To fix the issue the PKIServerCLI.create_parser() and execute() have been modified to use remainder instead of subparsers, and the create_parser() in the sub-commands has been modified to create a regular ArgumentParser instead of a subparser. Similar changes were made to the CLI base class to fix the help messages for sub-commands (e.g. pki-server ca). The pki-server has also been modified to provide a --version option to show the version number of the tool. A new CLIException has been added to distinguish a normal CLI error (which will generate a simple error message such as "Invalid module") from an unexpected exception which will generate a full stack trace. Resolves: dogtagpki#4932
Some tests have been added to check the help and error messages generated by pki and pki-server CLIs.
|
|
@fmarco76 Thanks! |
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.
Previously if a user called
pki-serverCLI with a wrong sub-command theArgumentParserwould show an auto-generated error message which looks significantly different from help message already defined inprint_help().To fix the issue the
PKIServerCLI.create_parser()andexecute()have been modified to useremainderinstead of subparsers, and thecreate_parser()in the sub-commands has been modified to create a regularArgumentParserinstead of a subparser.Similar changes were made to the
CLIbase class to fix the help messages for sub-commands (e.g.pki-server ca).The
pki-serverhas also been modified to provide a--versionoption to show the version number of the tool.A new
CLIExceptionhas been added to distinguish a normal CLI error (which will generate a simple error message such asInvalid module) from an unexpected exception which will generate a full stack trace.Some tests have been added to check the help and error messages generated by
pkiandpki-serverCLIs.Resolves: #4932