Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

api/task: initialize config in hostConfig when it is nil #2249

Merged
merged 1 commit into from
Oct 25, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion agent/api/container/container.go
Original file line number Diff line number Diff line change
Expand Up @@ -896,7 +896,7 @@ func (c *Container) ShouldCreateWithASMSecret() bool {
}

// MergeEnvironmentVariables appends additional envVarName:envVarValue pairs to
// the the container's enviornment values structure
// the the container's environment values structure
func (c *Container) MergeEnvironmentVariables(envVars map[string]string) {
c.lock.Lock()
defer c.lock.Unlock()
Expand Down
6 changes: 6 additions & 0 deletions agent/api/task/task.go
Original file line number Diff line number Diff line change
Expand Up @@ -1357,6 +1357,9 @@ func (task *Task) ApplyExecutionRoleLogsAuth(hostConfig *dockercontainer.HostCon
return &apierrors.HostConfigError{Msg: "Unable to get execution role credentials for task"}
}
credentialsEndpointRelativeURI := executionRoleCredentials.IAMRoleCredentials.GenerateCredentialsEndpointRelativeURI()
if hostConfig.LogConfig.Config == nil {
hostConfig.LogConfig.Config = map[string]string{}
}
hostConfig.LogConfig.Config[awslogsCredsEndpointOpt] = credentialsEndpointRelativeURI
return nil
}
Expand Down Expand Up @@ -2289,6 +2292,9 @@ func populateContainerSecrets(hostConfig *dockercontainer.HostConfig, container
// Check if all the name and secret value for the log driver do exist
// And add the secret value for this log driver into container's HostConfig
if hostConfig.LogConfig.Type != "" && logDriverTokenName != "" && logDriverTokenSecretValue != "" {
if hostConfig.LogConfig.Config == nil {
hostConfig.LogConfig.Config = map[string]string{}
}
hostConfig.LogConfig.Config[logDriverTokenName] = logDriverTokenSecretValue
}
}
Expand Down
97 changes: 88 additions & 9 deletions agent/api/task/task_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1602,10 +1602,57 @@ func TestApplyExecutionRoleLogsAuthSet(t *testing.T) {
}

rawHostConfig, err := json.Marshal(&rawHostConfigInput)
if err != nil {
t.Fatal(err)
require.NoError(t, err)

task := &Task{
Arn: "arn:aws:ecs:us-east-1:012345678910:task/c09f0188-7f87-4b0f-bfc3-16296622b6fe",
Family: "testFamily",
Version: "1",
Containers: []*apicontainer.Container{
{
Name: "c1",
DockerConfig: apicontainer.DockerConfig{
HostConfig: strptr(string(rawHostConfig)),
},
},
},
ExecutionCredentialsID: credentialsIDInTask,
}

taskCredentials := credentials.TaskIAMRoleCredentials{
IAMRoleCredentials: credentials.IAMRoleCredentials{CredentialsID: "credsid"},
}
credentialsManager.EXPECT().GetTaskCredentials(credentialsIDInTask).Return(taskCredentials, true)
task.initializeCredentialsEndpoint(credentialsManager)

config, err := task.DockerHostConfig(task.Containers[0], dockerMap(task), defaultDockerClientAPIVersion)
assert.Nil(t, err)

err = task.ApplyExecutionRoleLogsAuth(config, credentialsManager)
assert.Nil(t, err)

endpoint, ok := config.LogConfig.Config["awslogs-credentials-endpoint"]
assert.True(t, ok)
assert.Equal(t, expectedEndpoint, endpoint)
}

func TestApplyExecutionRoleLogsAuthNoConfigInHostConfig(t *testing.T) {
ctrl := gomock.NewController(t)
defer ctrl.Finish()
credentialsManager := mock_credentials.NewMockManager(ctrl)

credentialsIDInTask := "credsid"
expectedEndpoint := "/v2/credentials/" + credentialsIDInTask

rawHostConfigInput := dockercontainer.HostConfig{
LogConfig: dockercontainer.LogConfig{
Type: "foo",
},
}

rawHostConfig, err := json.Marshal(&rawHostConfigInput)
require.NoError(t, err)

task := &Task{
Arn: "arn:aws:ecs:us-east-1:012345678910:task/c09f0188-7f87-4b0f-bfc3-16296622b6fe",
Family: "testFamily",
Expand Down Expand Up @@ -1651,9 +1698,7 @@ func TestApplyExecutionRoleLogsAuthFailEmptyCredentialsID(t *testing.T) {
}

rawHostConfig, err := json.Marshal(&rawHostConfigInput)
if err != nil {
t.Fatal(err)
}
require.NoError(t, err)

task := &Task{
Arn: "arn:aws:ecs:us-east-1:012345678910:task/c09f0188-7f87-4b0f-bfc3-16296622b6fe",
Expand Down Expand Up @@ -1693,9 +1738,7 @@ func TestApplyExecutionRoleLogsAuthFailNoCredentialsForTask(t *testing.T) {
}

rawHostConfig, err := json.Marshal(&rawHostConfigInput)
if err != nil {
t.Fatal(err)
}
require.NoError(t, err)

task := &Task{
Arn: "arn:aws:ecs:us-east-1:012345678910:task/c09f0188-7f87-4b0f-bfc3-16296622b6fe",
Expand Down Expand Up @@ -2545,7 +2588,9 @@ func TestPopulateSecrets(t *testing.T) {
hostConfig := &dockercontainer.HostConfig{}
logDriverName := "splunk"
hostConfig.LogConfig.Type = logDriverName
configMap := map[string]string{}
configMap := map[string]string{
"splunk-option": "option",
}
hostConfig.LogConfig.Config = configMap

ssmRes := &ssmsecret.SSMSecretResource{}
Expand All @@ -2564,6 +2609,40 @@ func TestPopulateSecrets(t *testing.T) {
assert.Equal(t, "secretValue2", container.Environment["secret2"])
assert.Equal(t, "", container.Environment["secret3"])
assert.Equal(t, "secretValue3", hostConfig.LogConfig.Config["splunk-token"])
assert.Equal(t, "option", hostConfig.LogConfig.Config["splunk-option"])
}

func TestPopulateSecretsNoConfigInHostConfig(t *testing.T) {
secret1 := apicontainer.Secret{
Provider: "ssm",
Name: "splunk-token",
Region: "us-west-1",
Target: "LOG_DRIVER",
ValueFrom: "/test/secretName1",
}

container := &apicontainer.Container{
Name: "myName",
Image: "image:tag",
Secrets: []apicontainer.Secret{secret1},
TransitionDependenciesMap: make(map[apicontainerstatus.ContainerStatus]apicontainer.TransitionDependencySet),
}

task := &Task{
Arn: "test",
ResourcesMapUnsafe: make(map[string][]taskresource.TaskResource),
Containers: []*apicontainer.Container{container},
}

hostConfig := &dockercontainer.HostConfig{}
logDriverName := "splunk"
hostConfig.LogConfig.Type = logDriverName

ssmRes := &ssmsecret.SSMSecretResource{}
ssmRes.SetCachedSecretValue(secKeyLogDriver, "secretValue1")
task.AddResource(ssmsecret.ResourceName, ssmRes)
task.PopulateSecrets(hostConfig, container)
assert.Equal(t, "secretValue1", hostConfig.LogConfig.Config["splunk-token"])
}

func TestPopulateSecretsAsEnvOnlySSM(t *testing.T) {
Expand Down