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.

Sign up for GitHub

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

Jump to bottom

Suppress task definition diffs for equivalent port mappings. #5833

Merged
merged 1 commit into from
Sep 11, 2018
Merged

Suppress task definition diffs for equivalent port mappings. #5833

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 7 additions & 4 deletions aws/ecs_task_definition_equivalency.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ import (
"github.com/mitchellh/copystructure"
)

func ecsContainerDefinitionsAreEquivalent(def1, def2 string) (bool, error) {
func ecsContainerDefinitionsAreEquivalent(def1, def2 string, isAWSVPC bool) (bool, error) {
var obj1 containerDefinitions
err := json.Unmarshal([]byte(def1), &obj1)
if err != nil {
return false, err
}
err = obj1.Reduce()
err = obj1.Reduce(isAWSVPC)
if err != nil {
return false, err
}
Expand All @@ -33,7 +33,7 @@ func ecsContainerDefinitionsAreEquivalent(def1, def2 string) (bool, error) {
if err != nil {
return false, err
}
err = obj2.Reduce()
err = obj2.Reduce(isAWSVPC)
if err != nil {
return false, err
}
Expand All @@ -53,7 +53,7 @@ func ecsContainerDefinitionsAreEquivalent(def1, def2 string) (bool, error) {

type containerDefinitions []*ecs.ContainerDefinition

func (cd containerDefinitions) Reduce() error {
func (cd containerDefinitions) Reduce(isAWSVPC bool) error {
for i, def := range cd {
// Deal with special fields which have defaults
if def.Cpu != nil && *def.Cpu == 0 {
Expand All @@ -69,6 +69,9 @@ func (cd containerDefinitions) Reduce() error {
if pm.HostPort != nil && *pm.HostPort == 0 {
cd[i].PortMappings[j].HostPort = nil
}
if isAWSVPC && cd[i].PortMappings[j].HostPort == nil {
cd[i].PortMappings[j].HostPort = cd[i].PortMappings[j].ContainerPort
}
}

// Deal with fields which may be re-ordered in the API
Expand Down
58 changes: 54 additions & 4 deletions aws/ecs_task_definition_equivalency_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ func TestAwsEcsContainerDefinitionsAreEquivalent_basic(t *testing.T) {
}
]`

equal, err := ecsContainerDefinitionsAreEquivalent(cfgRepresention, apiRepresentation)
equal, err := ecsContainerDefinitionsAreEquivalent(cfgRepresention, apiRepresentation, false)
if err != nil {
t.Fatal(err)
}
Expand Down Expand Up @@ -125,7 +125,57 @@ func TestAwsEcsContainerDefinitionsAreEquivalent_portMappings(t *testing.T) {
}
]`

equal, err := ecsContainerDefinitionsAreEquivalent(cfgRepresention, apiRepresentation)
equal, err := ecsContainerDefinitionsAreEquivalent(cfgRepresention, apiRepresentation, false)
if err != nil {
t.Fatal(err)
}
if !equal {
t.Fatal("Expected definitions to be equal.")
}
}

func TestAwsEcsContainerDefinitionsAreEquivalent_portMappingsIgnoreHostPort(t *testing.T) {
cfgRepresention := `
[
{
"name": "wordpress",
"image": "wordpress",
"portMappings": [
{
"containerPort": 80,
"hostPort": 80
}
]
}
]`

apiRepresentation := `
[
{
"name": "wordpress",
"image": "wordpress",
"portMappings": [
{
"containerPort": 80
}
]
}
]`

var (
equal bool
err error
)

equal, err = ecsContainerDefinitionsAreEquivalent(cfgRepresention, apiRepresentation, false)
if err != nil {
t.Fatal(err)
}
if equal {
t.Fatal("Expected definitions to differ.")
}

equal, err = ecsContainerDefinitionsAreEquivalent(cfgRepresention, apiRepresentation, true)
if err != nil {
t.Fatal(err)
}
Expand Down Expand Up @@ -378,7 +428,7 @@ func TestAwsEcsContainerDefinitionsAreEquivalent_arrays(t *testing.T) {
]
`

equal, err := ecsContainerDefinitionsAreEquivalent(cfgRepresention, apiRepresentation)
equal, err := ecsContainerDefinitionsAreEquivalent(cfgRepresention, apiRepresentation, false)
if err != nil {
t.Fatal(err)
}
Expand Down Expand Up @@ -416,7 +466,7 @@ func TestAwsEcsContainerDefinitionsAreEquivalent_negative(t *testing.T) {
}
]`

equal, err := ecsContainerDefinitionsAreEquivalent(cfgRepresention, apiRepresentation)
equal, err := ecsContainerDefinitionsAreEquivalent(cfgRepresention, apiRepresentation, false)
if err != nil {
t.Fatal(err)
}
Expand Down
4 changes: 3 additions & 1 deletion aws/resource_aws_ecs_task_definition.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,9 @@ func resourceAwsEcsTaskDefinition() *schema.Resource {
return json
},
DiffSuppressFunc: func(k, old, new string, d *schema.ResourceData) bool {
equal, _ := ecsContainerDefinitionsAreEquivalent(old, new)
networkMode, ok := d.GetOk("network_mode")
isAWSVPC := ok && networkMode.(string) == ecs.NetworkModeAwsvpc
equal, _ := ecsContainerDefinitionsAreEquivalent(old, new, isAWSVPC)
return equal
},
ValidateFunc: validateAwsEcsTaskDefinitionContainerDefinitions,
Expand Down
14 changes: 10 additions & 4 deletions aws/resource_aws_ecs_task_definition_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,14 +227,19 @@ func TestAccAWSEcsTaskDefinition_Fargate(t *testing.T) {
CheckDestroy: testAccCheckAWSEcsTaskDefinitionDestroy,
Steps: []resource.TestStep{
{
Config: testAccAWSEcsTaskDefinitionFargate(tdName),
Config: testAccAWSEcsTaskDefinitionFargate(tdName, `[{"protocol": "tcp", "containerPort": 8000}]`),
Check: resource.ComposeTestCheckFunc(
testAccCheckAWSEcsTaskDefinitionExists("aws_ecs_task_definition.fargate", &conf),
resource.TestCheckResourceAttr("aws_ecs_task_definition.fargate", "requires_compatibilities.#", "1"),
resource.TestCheckResourceAttr("aws_ecs_task_definition.fargate", "cpu", "256"),
resource.TestCheckResourceAttr("aws_ecs_task_definition.fargate", "memory", "512"),
),
},
{
ExpectNonEmptyPlan: false,
PlanOnly: true,
Config: testAccAWSEcsTaskDefinitionFargate(tdName, `[{"protocol": "tcp", "containerPort": 8000, "hostPort": 8000}]`),
},
},
})
}
Expand Down Expand Up @@ -649,7 +654,7 @@ TASK_DEFINITION
`, tdName)
}

func testAccAWSEcsTaskDefinitionFargate(tdName string) string {
func testAccAWSEcsTaskDefinitionFargate(tdName, portMappings string) string {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick: It'd be much better if this was a separate test and test configuration as it does not pertain to the basic functionality of the resource with Fargate

return fmt.Sprintf(`
resource "aws_ecs_task_definition" "fargate" {
family = "%s"
Expand All @@ -665,12 +670,13 @@ resource "aws_ecs_task_definition" "fargate" {
"cpu": 10,
"command": ["sleep","360"],
"memory": 10,
"essential": true
"essential": true,
"portMappings": %s
}
]
TASK_DEFINITION
}
`, tdName)
`, tdName, portMappings)
}

func testAccAWSEcsTaskDefinitionExecutionRole(roleName, policyName, tdName string) string {
Expand Down