Make odk.py seed more robust
#1097
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
Calling `odk.py seed` without any argument results in a crash because the `repo` variable (supposed to hold the name of the repository) is set to None, which is not expected by the Jinja template (it expects a string). When no positional arguments are specified, we set the `repo` variable to `noname` instead, thereby allowing the creation of a full repository with a dummy name instead of causing an error.
When seeding, and unless the --skipgit option has been used, we need a username and email address to pass to Git. If we don't have those, the seeding process will crash at the very end, after all files have been generated. Since the Git username and email are necessary, we should detect whether we have them at the very beginning, and exit cleanly (with a message telling the user what they need to to) as soon as possible, without even initiating a process that is bound to fail.
The seed command expects only one positional arguments. If we got more than one, we should exit with a clean error message, instead of crashing with an uncaught exception and the associated stacktrace.
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.
The
seedcommand of theodk.pyscript is quite fragile, in that it will easily and loudly crash out when it used incorrectly.A) Called with no positional arguments (
odk.py seed):This causes a crash because the
repovariable is then set toNone, while the Jinja template expects a string (or at least something that has aupper()method):This PR fixes that by setting the
repovariable tononamerather thanNone, resulting in the seeding process successfully creating anonamerepository.B) Called with too many positional arguments (
odk.py seed repo1 repo2)Only one positional argument is expected. The error condition is correctly caught early, but it still yields an unhelpful stack trace:
We fix that here by raising a
ClickExceptionrather than a rawException; Click can intercept those and display only the error message rather than a full stack trace.C) Missing Git username and/or email
Unless
--skipgitis used, the seeding process needs a Git username and email to pass to Git to create the first commit once the repository is initialised. If for some reason we don’t have a username and/or an email address, this will cause an uncaught exception quite late in the seedingprocess, after all the files have been generated:That error condition should instead be caught early in the script, before even attempting to generate anything. This is what we do here.