makes cli application return non-zero error code on errors #541
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
josephschorr
force-pushed
the
non-zero-exit-code
branch
from
4140dc8
to
d853185
Compare
jzelinskie
approved these changes
Apr 21, 2022
- if the error is a parsing error, command usage will be printed - if the error is an application error, the error is logged using zerolog so that it shows up nicely just like any other application log message examples: - incorrect flag: error code 1, prints command usage - incorrect flag value: error code 1, does not print command usage - SIGTERM: error code 0
jzelinskie
force-pushed
the
non-zero-exit-code
branch
from
d853185
to
272685b
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
fixes #538
changes the application to return non-zero error codes when an
erroris returned by the root command.I attempted to make the output of the CLI "pretty":
zerologso that it shows up nicely just like any other application log messageIf we wanted the flag values to be recognized as a "parsing/cli error" (e.g. unrecognized datastore) we could signal it with a specific error, but we would need to adjust every part of the application that initializes spicedb to return an error deemed to be considered "cli error". I considered that to be out of scope of this PR.
example: unrecognized flag: error code 1, prints command usage
example: incorrect flag value: error code 1, does not print command usage
example: SIGTERM: error code 0