depsfile: Don't panic when lock file is unreadable #27250
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
apparentlymart
added
bug
crash
cli
v0.14
0.14-backport
Codecov Report
|
alisdair
approved these changes
Dec 11, 2020
internal/depsfile/locks_file_test.go
Outdated
| // This can never happen when Terraform is the one generating the | ||
| // lock file, but might arise if the user makes a directory with the | ||
| // lock file's name for some reason. (There is no actual reason to do | ||
| // so, so that would always be a mistake.) |
There was a problem hiding this comment.
I don't think this comment applies to this test case, copy & paste error?
There was a problem hiding this comment.
Right you are! Thanks
Previously we were expecting that the *hcl.File would always be non-nil, even in error cases. That isn't always true, so now we'll be more robust about it and explicitly return an empty locks object in that case, along with the error diagnostics. In particular this avoids a panic in a strange situation where the user created a directory where the lock file would normally go. There's no meaning to such a directory, so it would always be a mistake and so now we'll return an error message about it, rather than panicking as before. The error message for the situation where the lock file is a directory is currently not very specific, but since it's HCL responsible for generating that message we can't really fix that at this layer. Perhaps in future we can change HCL to have a specialized error message for that particular error situation, but for the sake of this commit the goal is only to stop the panic and return a normal error message.
apparentlymart
force-pushed
the
b-lock-file-dir-crash
branch
from
7ba5c96 to
24ec855
Compare
|
I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. |
ghost
locked as resolved and limited conversation to collaborators
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.
Previously we were expecting that the
*hcl.Filewould always be non-nil, even in error cases. That isn't always true, so now we'll be more robust about it and explicitly return an empty locks object in that case, along with the error diagnostics.In particular this avoids a panic in a strange situation where the user created a directory where the lock file would normally go, and so this fixes #27144. There's no meaning to such a directory, so it would always be a mistake and so now we'll return an error message about it, rather than panicking as before.
The error message for the situation where the lock file is a directory is currently rather vague, but since it's HCL responsible for generating that message we can't easily fix that at this layer. Perhaps in future we can change HCL to have a specialized error message for that particular error situation, but for the sake of this commit the goal is only to stop the panic and return a normal error message.