Merge ecs-params service resources with task def values

allisaurus · allisaurus · commit 7d68914be378 · 2018-06-04T10:55:48.000-07:00
diff --git a/ecs-cli/modules/utils/compose/convert_task_definition.go b/ecs-cli/modules/utils/compose/convert_task_definition.go
@@ -248,12 +248,6 @@ func convertToContainerDef(inputCfg *adapter.ContainerConfig, ecsContainerDef *C
 		return nil, errors.New("mem_limit must be greater than mem_reservation")
 	}
 
-	// One or both of memory and memoryReservation is required to register a task definition with ECS
-	// NOTE: Docker does not set a memory limit for containers
-	if mem == 0 && memoryReservation == 0 {
-		mem = defaultMemLimit
-	}
-
 	// Populate ECS container definition, offloading the validation to aws-sdk
 	outputContDef.SetCpu(inputCfg.CPU)
 	outputContDef.SetCommand(aws.StringSlice(inputCfg.Command))
@@ -317,6 +311,44 @@ func convertToContainerDef(inputCfg *adapter.ContainerConfig, ecsContainerDef *C
 	// Set fields from ecs-params file
 	if ecsContainerDef != nil {
 		outputContDef.Essential = aws.Bool(ecsContainerDef.Essential)
+
+		overrideMsg := "Using ecs-params value as override (was %v but is now %v)"
+		if ecsContainerDef.Cpu > 0 {
+			if outputContDef.Cpu != nil && *outputContDef.Cpu > 0 {
+				log.WithFields(log.Fields{
+					"option name":  "Cpu",
+					"service name": inputCfg.Name,
+				}).Infof(overrideMsg, *outputContDef.Cpu, ecsContainerDef.Cpu)
+			}
+			outputContDef.Cpu = aws.Int64(ecsContainerDef.Cpu)
+		}
+		memInMB := adapter.ConvertToMemoryInMB(int64(ecsContainerDef.Memory))
+		if memInMB > 0 {
+			if outputContDef.Memory != nil {
+				log.WithFields(log.Fields{
+					"option name":  "Memory",
+					"service name": inputCfg.Name,
+				}).Infof(overrideMsg, *outputContDef.Memory, memInMB)
+			}
+			outputContDef.Memory = aws.Int64(memInMB)
+		}
+		memResInMB := adapter.ConvertToMemoryInMB(int64(ecsContainerDef.MemoryReservation))
+		if memResInMB > 0 {
+			if outputContDef.MemoryReservation != nil {
+				log.WithFields(log.Fields{
+					"option name":  "MemoryReservation",
+					"service name": inputCfg.Name,
+				}).Infof(overrideMsg, *outputContDef.MemoryReservation, memResInMB)
+			}
+			outputContDef.MemoryReservation = aws.Int64(memResInMB)
+		}
+	}
+
+	// One or both of memory and memoryReservation is required to register a task definition with ECS
+	// If neither is provided by 1) compose file or 2) ecs-params, set default
+	// NOTE: Docker does not set a memory limit for containers
+	if outputContDef.Memory == nil && outputContDef.MemoryReservation == nil {
+		outputContDef.SetMemory(defaultMemLimit)
 	}
 
 	return outputContDef, nil
diff --git a/ecs-cli/modules/utils/compose/convert_task_definition_test.go b/ecs-cli/modules/utils/compose/convert_task_definition_test.go
@@ -731,6 +731,160 @@ task_definition:
 	}
 }
 
+func TestConvertToTaskDefinitionWithECSParams_ContainerResourcesPresent(t *testing.T) {
+	containerConfigs := testContainerConfigs([]string{"mysql", "wordpress"})
+
+	mysqlCPU := int64(100)
+	mysqlMem := int64(15)
+	mysqlMemRes := int64(10)
+
+	wordpressCPU := int64(4)
+	wordpressMem := int64(8)
+	wordpressMemRes := int64(5)
+
+	ecsParamsString := `version: 1
+task_definition:
+  services:
+    mysql:  
+      cpu_shares: 100
+      mem_limit: 15m
+      mem_reservation: 10m
+    wordpress:
+      cpu_shares: 4
+      mem_limit: 8m
+      mem_reservation: 5m`
+
+	content := []byte(ecsParamsString)
+
+	tmpfile, err := ioutil.TempFile("", "ecs-params")
+	assert.NoError(t, err, "Could not create ecs fields tempfile")
+
+	defer os.Remove(tmpfile.Name())
+
+	_, err = tmpfile.Write(content)
+	assert.NoError(t, err, "Could not write data to ecs fields tempfile")
+
+	err = tmpfile.Close()
+	assert.NoError(t, err, "Could not close tempfile")
+
+	ecsParamsFileName := tmpfile.Name()
+	ecsParams, err := ReadECSParams(ecsParamsFileName)
+	assert.NoError(t, err, "Could not read ECS Params file")
+
+	taskDefinition, err := convertToTaskDefWithEcsParamsInTest(t, containerConfigs, "", ecsParams)
+
+	containerDefs := taskDefinition.ContainerDefinitions
+	mysql := findContainerByName("mysql", containerDefs)
+	wordpress := findContainerByName("wordpress", containerDefs)
+
+	if assert.NoError(t, err) {
+		assert.Equal(t, mysqlCPU, aws.Int64Value(mysql.Cpu), "Expected CPU to match")
+		assert.Equal(t, mysqlMem, aws.Int64Value(mysql.Memory), "Expected Memory to match")
+		assert.Equal(t, mysqlMemRes, aws.Int64Value(mysql.MemoryReservation), "Expected MemoryReservation to match")
+
+		assert.Equal(t, wordpressCPU, aws.Int64Value(wordpress.Cpu), "Expected CPU to match")
+		assert.Equal(t, wordpressMem, aws.Int64Value(wordpress.Memory), "Expected Memory to match")
+		assert.Equal(t, wordpressMemRes, aws.Int64Value(wordpress.MemoryReservation), "Expected MemoryReservation to match")
+	}
+}
+
+func TestConvertToTaskDefinitionWithECSParams_ContainerResourcesOverrideProvidedVals(t *testing.T) {
+	containerConfig := &adapter.ContainerConfig{
+		Name:              "web",
+		Image:             "httpd",
+		CPU:               int64(2),
+		Memory:            int64(3),
+		MemoryReservation: int64(3),
+	}
+
+	// define ecs-params values we expect to override containerConfig vals
+	webCPU := int64(5)
+	webMem := int64(15)
+	webMemRes := int64(10)
+
+	ecsParamsString := `version: 1
+task_definition:
+  services:
+    web:
+      cpu_shares: 5
+      mem_limit: 15m
+      mem_reservation: 10m`
+
+	content := []byte(ecsParamsString)
+
+	tmpfile, err := ioutil.TempFile("", "ecs-params")
+	assert.NoError(t, err, "Could not create ecs fields tempfile")
+
+	defer os.Remove(tmpfile.Name())
+
+	_, err = tmpfile.Write(content)
+	assert.NoError(t, err, "Could not write data to ecs fields tempfile")
+
+	err = tmpfile.Close()
+	assert.NoError(t, err, "Could not close tempfile")
+
+	ecsParamsFileName := tmpfile.Name()
+	ecsParams, err := ReadECSParams(ecsParamsFileName)
+	assert.NoError(t, err, "Could not read ECS Params file")
+
+	containerConfigs := []adapter.ContainerConfig{*containerConfig}
+	taskDefinition, err := convertToTaskDefWithEcsParamsInTest(t, containerConfigs, "", ecsParams)
+
+	containerDefs := taskDefinition.ContainerDefinitions
+	web := findContainerByName("web", containerDefs)
+
+	if assert.NoError(t, err) {
+		assert.Equal(t, webCPU, aws.Int64Value(web.Cpu), "Expected CPU to match")
+		assert.Equal(t, webMem, aws.Int64Value(web.Memory), "Expected Memory to match")
+		assert.Equal(t, webMemRes, aws.Int64Value(web.MemoryReservation), "Expected MemoryReservation to match")
+	}
+}
+
+func TestConvertToTaskDefinitionWithECSParams_NoMemoryProvided(t *testing.T) {
+	containerConfig := &adapter.ContainerConfig{
+		Name:  "web",
+		Image: "httpd",
+	}
+
+	// define ecs-params values we expect to override containerConfig vals
+	webCPU := int64(5)
+
+	ecsParamsString := `version: 1
+task_definition:
+  services:
+    web:
+      cpu_shares: 5`
+
+	content := []byte(ecsParamsString)
+
+	tmpfile, err := ioutil.TempFile("", "ecs-params")
+	assert.NoError(t, err, "Could not create ecs fields tempfile")
+
+	defer os.Remove(tmpfile.Name())
+
+	_, err = tmpfile.Write(content)
+	assert.NoError(t, err, "Could not write data to ecs fields tempfile")
+
+	err = tmpfile.Close()
+	assert.NoError(t, err, "Could not close tempfile")
+
+	ecsParamsFileName := tmpfile.Name()
+	ecsParams, err := ReadECSParams(ecsParamsFileName)
+	assert.NoError(t, err, "Could not read ECS Params file")
+
+	containerConfigs := []adapter.ContainerConfig{*containerConfig}
+	taskDefinition, err := convertToTaskDefWithEcsParamsInTest(t, containerConfigs, "", ecsParams)
+
+	containerDefs := taskDefinition.ContainerDefinitions
+	web := findContainerByName("web", containerDefs)
+
+	if assert.NoError(t, err) {
+		assert.Equal(t, webCPU, aws.Int64Value(web.Cpu), "Expected CPU to match")
+		assert.Equal(t, int64(defaultMemLimit), aws.Int64Value(web.Memory), "Expected Memory to match default")
+		assert.Empty(t, aws.Int64Value(web.MemoryReservation), "Expected MemoryReservation to be empty")
+	}
+}
+
 func TestConvertToTaskDefinition_WithTaskSize(t *testing.T) {
 	containerConfigs := testContainerConfigs([]string{"mysql", "wordpress"})
 	ecsParamsString := `version: 1
