Fix the docker auth configuration overrides problem in #732 #751
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
samuelkarp
reviewed
Apr 4, 2017
agent/config/types_test.go
Outdated
| @@ -37,7 +39,14 @@ func TestSensitiveRawMessage(t *testing.T) { | |||
| fmt.Sprint(sensitive), | |||
| } { | |||
| if str != "[redacted]" { | |||
| t.Errorf("#%v: expected redacted, got %s", i, str) | |||
| assert.Equal(t, i, str, "expected redacted") | |||
There was a problem hiding this comment.
Can you remove the if and just have assert.Equal?
aaithal
requested changes
Apr 4, 2017
| @@ -146,9 +147,13 @@ func NewDockerGoClient(clientFactory dockerclient.Factory, cfg *config.Config) ( | |||
| return nil, err | |||
| } | |||
|
|
|||
| dockerAuthData := json.RawMessage("") | |||
There was a problem hiding this comment.
Can you use var dockerAuthData json.RawMessage instead? Somehow seems cleaner to me than parsing an empty string. FWIW, this is how it's being initialized in encoding/stream.go: https://golang.org/src/encoding/json/stream.go#L266
agent/config/config_test.go
Outdated
| config, err := fileConfig() | ||
| assert.NoError(t, err, "reading configuration from file failed") | ||
|
|
||
| assert.Equal(t, "TestConfig", config.Cluster, "cluster name not as expected from file") |
There was a problem hiding this comment.
Please extract "TestConfig" into a var/const (here and in the next test)
agent/config/config_test.go
Outdated
| assert.NoError(t, err, "reading configuration from file failed") | ||
|
|
||
| assert.Equal(t, "TestConfig", config.Cluster, "cluster name not as expected from file") | ||
| assert.Equal(t, "dockercfg", config.EngineAuthType, "docker auth type not as expected from file") |
There was a problem hiding this comment.
Please extract "dockercfg" into a var/const (here and in the next test)
agent/config/types.go
Outdated
| @@ -157,6 +157,9 @@ type SensitiveRawMessage struct { | |||
| // NewSensitiveRawMessage returns a new encapsulated json.RawMessage that | |||
| // cannot be accidentally logged via .String/.GoString/%v/%#v | |||
| func NewSensitiveRawMessage(data json.RawMessage) *SensitiveRawMessage { | |||
There was a problem hiding this comment.
Please update the documentation that this can now return nil when invoked with empty data
samuelkarp
approved these changes
Apr 13, 2017
aaithal
approved these changes
Apr 13, 2017
DockerAuth returned as an empty object(which is not nil) when it is not set from environment variable, which won't be overrides from contents read from file.
Merged
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.
Summary
Fix issue #732
Implementation details
Return an nil instead of an empty object for dockerauth.
Testing
make release)go build -out amazon-ecs-agent.exe ./agent)make test) passgo test -timeout=25s ./agent/...) passmake run-integ-tests) pass.\scripts\run-integ-tests.ps1) passmake run-functional-tests) pass.\scripts\run-functional-tests.ps1) passNew tests cover the changes:
yes
Description for the changelog
Fix an issue where docker auth information can't be correctly read from file
Licensing
This contribution is under the terms of the Apache 2.0 License:
yes