resource/aws_eip_association: fix eventual consistency issue when associating EIP

[dohoangkhiem]

Community Note

• Please vote on this pull request by adding a 👍 reaction to the original pull request comment to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for pull request followers and do not help prioritize the request

Relates #11617
Relates #12449

Terraform Version

$ terraform -v
Terraform v0.12.16
+ provider.aws v2.39.0

Affected Resource(s)

aws_eip_association

Terraform Configuration

provider "aws" {
  version = "2.39.0"
  region = var.aws_region
}

resource "aws_instance" "this" {
  ami = "ami-06fb5332e8e3e577a"
  instance_type = "t2.nano"
  key_name = "default_key"
  vpc_security_group_ids = ["sg-923d3cf4"]
  subnet_id = "subnet-61a23e06"
  associate_public_ip_address = true

  root_block_device {
    volume_size = 20
    volume_type = "gp2"
    delete_on_termination = true
  }

  lifecycle {
    create_before_destroy = true
  }
}

resource "aws_eip" "this" {
  vpc = true
}

resource "aws_eip_association" "this" {
  instance_id   = aws_instance.this.id
  allocation_id = aws_eip.this.id
}

Expected Behavior

aws_eip_association is created successfully in TF state and in EC2.

Actual Behavior

Rarely, the EIP is associated, but in TF state the resource is not recorded due to eventual consistency issue when reading back the association

Error: Provider produced inconsistent result after apply
When applying changes to aws_eip_association.this, provider "aws" produced an unexpected new value for was present, but now absent. This is a bug in the provider, which should be reported in the provider's own issue tracker.

Output from acceptance testing:

$ make testacc TEST=./aws TESTARGS='-run=TestAccAWSEIPAssociation_'
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./aws -v -count 1 -parallel 20 -run=TestAccAWSEIPAssociation_ -timeout 120m
=== RUN   TestAccAWSEIPAssociation_instance
=== PAUSE TestAccAWSEIPAssociation_instance
=== RUN   TestAccAWSEIPAssociation_networkInterface
=== PAUSE TestAccAWSEIPAssociation_networkInterface
=== RUN   TestAccAWSEIPAssociation_basic
=== PAUSE TestAccAWSEIPAssociation_basic
=== RUN   TestAccAWSEIPAssociation_ec2Classic
=== PAUSE TestAccAWSEIPAssociation_ec2Classic
=== RUN   TestAccAWSEIPAssociation_spotInstance
=== PAUSE TestAccAWSEIPAssociation_spotInstance
=== RUN   TestAccAWSEIPAssociation_disappears
=== PAUSE TestAccAWSEIPAssociation_disappears
=== CONT  TestAccAWSEIPAssociation_instance
=== CONT  TestAccAWSEIPAssociation_spotInstance
=== CONT  TestAccAWSEIPAssociation_disappears
=== CONT  TestAccAWSEIPAssociation_ec2Classic
=== CONT  TestAccAWSEIPAssociation_networkInterface
=== CONT  TestAccAWSEIPAssociation_basic
=== CONT  TestAccAWSEIPAssociation_ec2Classic
    ec2_classic_test.go:54: this test can only run in EC2-Classic, platforms available in us-east-1: ["VPC"]
--- SKIP: TestAccAWSEIPAssociation_ec2Classic (5.79s)
--- PASS: TestAccAWSEIPAssociation_networkInterface (75.35s)
--- PASS: TestAccAWSEIPAssociation_instance (108.61s)
--- PASS: TestAccAWSEIPAssociation_disappears (109.13s)
--- PASS: TestAccAWSEIPAssociation_basic (169.76s)
--- PASS: TestAccAWSEIPAssociation_spotInstance (310.48s)
PASS
ok  	github.com/terraform-providers/terraform-provider-aws/aws	310.577s

[bflad]

Hi @dohoangkhiem 👋 Thank you for submitting this fix. It is definitely on the right track -- just a few minor things and should be good to go. 👍

[dohoangkhiem]

Many thanks @bflad for suggestions, I updated PR, acc tests passed.

[bflad]

Looks great, thank you @dohoangkhiem 🚀

Output from acceptance testing in AWS Commercial:

--- PASS: TestAccAWSEIPAssociation_networkInterface (67.84s)
--- PASS: TestAccAWSEIPAssociation_ec2Classic (82.56s)
--- PASS: TestAccAWSEIPAssociation_instance (95.90s)
--- PASS: TestAccAWSEIPAssociation_disappears (103.23s)
--- PASS: TestAccAWSEIPAssociation_basic (170.68s)
--- PASS: TestAccAWSEIPAssociation_spotInstance (302.76s)

Output from acceptance testing in AWS GovCloud (US):

--- PASS: TestAccAWSEIPAssociation_networkInterface (71.88s)
--- PASS: TestAccAWSEIPAssociation_instance (97.48s)
--- PASS: TestAccAWSEIPAssociation_disappears (104.81s)
--- PASS: TestAccAWSEIPAssociation_basic (181.36s)
--- PASS: TestAccAWSEIPAssociation_spotInstance (337.15s)
--- SKIP: TestAccAWSEIPAssociation_ec2Classic (2.41s)

[ghost]

This has been released in version 3.22.0 of the Terraform AWS provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template for triage. Thanks!

[ghost]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks!