cli/config/configfile: Make sure to not leak a temp config behind and improve unit tests #1366
Conversation
This file contains hidden or 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
In the unlikely event that we fail to rename the temp config file to the destination file, don't leave the temp config file behind as this could cause temp files to pile up in ~/.docker for example if there is a permission problem. Signed-off-by: Benoit Sigoure <tsunanet@gmail.com>
Signed-off-by: Benoit Sigoure <tsunanet@gmail.com>
thaJeztah
approved these changes
Sep 12, 2018
| @@ -183,10 +183,10 @@ func (configFile *ConfigFile) Save() error { | |||
| if err != nil { | |||
| return err | |||
| } | |||
| defer os.Remove(temp.Name()) | |||
There was a problem hiding this comment.
this would also attempt to remove temp.Name() in the happy case (i.e., it being succesfully renamed); guess that's not a problem.
vdemeester
reviewed
Sep 12, 2018
|
oh! hm... |
|
I haven't yet had time to figure out why this is failing on CirleCI, it's as if the test's attempt to make the test directory read-only wasn't actually making it read-only... maybe they do something funky with the filesystem there. 🤔 I'll follow up as soon as I have a few free cycles, sorry guys. |
|
Could it be because the tests run docker-in-docker, and tests are running as |
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.
This is a small followup change to #1359. It addresses the astute observation from @thaJeztah that we can potentially leak temp files in the config directory. While I couldn't easily test this particular failure from the unit test, I took the opportunity to expand the unit test to cover a few failure modes.
cc @vdemeester — thanks guys.
- A picture of a cute animal (not mandatory but encouraged)
🦋