Feature: More verbose error messages for synapsectl configure #158
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.
Summary
Added error messages for the following cases when using
synapsectl -u foo configureandsynapsectl -u foo start:and more importantly:
Motivation
Previously, every single error in the configuration process would simply give this error message:
This would be the case even if the file was not found, which was not informative if they typo'd the filename. The message would also be not informative if they did not have read permissions for the file. It now prints an informative error message for these cases.
The syntax error messages though is especially helpful, as it'll inform users on how to debug where syntax errors occur in their config. Now, it will print something along the lines of (Case: forgot ending quote):
or something like (Case: forgot to put value in field)
or even incompatibilities with Synapse API (Case: typo'd enum value w.r.t. Synapse API):