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

resource/aws_batch_job_description: Ignore diffs on container_properties environment variables with an empty value #29820

Merged
merged 7 commits into from Mar 7, 2023

Conversation

gdavison
Copy link
Contributor

@gdavison gdavison commented Mar 7, 2023

Description

The AWS API accepts container properties environment variables with empty values, but ignores them. They do not get set on the Batch Job Description, and therefore do not get returned. This causes a perpetual diff, and since the field is marked ForceNew, the recreation of the resource.

In the AWS Console, a user can create a variable with an empty value, but is not persisted.

This PR ignores the diff when an environment variable has an empty value.

Relations

Closes #26960

Output from Acceptance Testing

$ make testacc PKG=batch TESTS=TestAccBatchJobDefinition_

--- PASS: TestAccBatchJobDefinition_disappears (13.95s)
--- PASS: TestAccBatchJobDefinition_ContainerProperties_EmptyField (18.50s)
--- PASS: TestAccBatchJobDefinition_ContainerProperties_advanced (18.83s)
--- PASS: TestAccBatchJobDefinition_PlatformCapabilities_ec2 (18.91s)
--- PASS: TestAccBatchJobDefinition_basic (19.21s)
--- PASS: TestAccBatchJobDefinition_PlatformCapabilitiesFargate_containerPropertiesDefaults (22.27s)
--- PASS: TestAccBatchJobDefinition_propagateTags (22.40s)
--- PASS: TestAccBatchJobDefinition_PlatformCapabilities_fargate (22.56s)
--- PASS: TestAccBatchJobDefinition_updateForcesNewResource (26.20s)
--- PASS: TestAccBatchJobDefinition_tags (32.79s)

@github-actions
Copy link

github-actions bot commented Mar 7, 2023

Community Note

Voting for Prioritization

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

For Submitters

  • Review the contribution guide relating to the type of change you are making to ensure all of the necessary steps have been taken.
  • For new resources and data sources, use skaff to generate scaffolding with comments detailing common expectations.
  • Whether or not the branch has been rebased will not impact prioritization, but doing so is always a welcome surprise.

@github-actions github-actions bot added size/XL Managed by automation to categorize the size of a PR. service/batch Issues and PRs that pertain to the batch service. tests PRs: expanded test coverage. Issues: expanded coverage, enhancements to test infrastructure. labels Mar 7, 2023
Copy link
Contributor

@ewbankkit ewbankkit left a comment

Choose a reason for hiding this comment

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

LGTM 🚀.

% make testacc TESTARGS='-run=TestAccBatchJobDefinition_' PKG=batch ACCTEST_PARALLELISM=3
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go test ./internal/service/batch/... -v -count 1 -parallel 3  -run=TestAccBatchJobDefinition_ -timeout 180m
=== RUN   TestAccBatchJobDefinition_basic
=== PAUSE TestAccBatchJobDefinition_basic
=== RUN   TestAccBatchJobDefinition_disappears
=== PAUSE TestAccBatchJobDefinition_disappears
=== RUN   TestAccBatchJobDefinition_PlatformCapabilities_ec2
=== PAUSE TestAccBatchJobDefinition_PlatformCapabilities_ec2
=== RUN   TestAccBatchJobDefinition_PlatformCapabilitiesFargate_containerPropertiesDefaults
=== PAUSE TestAccBatchJobDefinition_PlatformCapabilitiesFargate_containerPropertiesDefaults
=== RUN   TestAccBatchJobDefinition_PlatformCapabilities_fargate
=== PAUSE TestAccBatchJobDefinition_PlatformCapabilities_fargate
=== RUN   TestAccBatchJobDefinition_ContainerProperties_advanced
=== PAUSE TestAccBatchJobDefinition_ContainerProperties_advanced
=== RUN   TestAccBatchJobDefinition_updateForcesNewResource
=== PAUSE TestAccBatchJobDefinition_updateForcesNewResource
=== RUN   TestAccBatchJobDefinition_tags
=== PAUSE TestAccBatchJobDefinition_tags
=== RUN   TestAccBatchJobDefinition_propagateTags
=== PAUSE TestAccBatchJobDefinition_propagateTags
=== RUN   TestAccBatchJobDefinition_ContainerProperties_EmptyField
=== PAUSE TestAccBatchJobDefinition_ContainerProperties_EmptyField
=== CONT  TestAccBatchJobDefinition_basic
=== CONT  TestAccBatchJobDefinition_ContainerProperties_advanced
=== CONT  TestAccBatchJobDefinition_PlatformCapabilitiesFargate_containerPropertiesDefaults
--- PASS: TestAccBatchJobDefinition_basic (20.20s)
=== CONT  TestAccBatchJobDefinition_PlatformCapabilities_fargate
--- PASS: TestAccBatchJobDefinition_ContainerProperties_advanced (20.21s)
=== CONT  TestAccBatchJobDefinition_PlatformCapabilities_ec2
--- PASS: TestAccBatchJobDefinition_PlatformCapabilitiesFargate_containerPropertiesDefaults (20.92s)
=== CONT  TestAccBatchJobDefinition_propagateTags
--- PASS: TestAccBatchJobDefinition_propagateTags (14.21s)
=== CONT  TestAccBatchJobDefinition_ContainerProperties_EmptyField
--- PASS: TestAccBatchJobDefinition_PlatformCapabilities_ec2 (17.25s)
=== CONT  TestAccBatchJobDefinition_tags
--- PASS: TestAccBatchJobDefinition_PlatformCapabilities_fargate (18.15s)
=== CONT  TestAccBatchJobDefinition_updateForcesNewResource
--- PASS: TestAccBatchJobDefinition_ContainerProperties_EmptyField (17.46s)
=== CONT  TestAccBatchJobDefinition_disappears
--- PASS: TestAccBatchJobDefinition_disappears (12.14s)
--- PASS: TestAccBatchJobDefinition_updateForcesNewResource (29.13s)
--- PASS: TestAccBatchJobDefinition_tags (37.94s)
PASS
ok  	github.com/hashicorp/terraform-provider-aws/internal/service/batch	80.831s

@gdavison gdavison merged commit 8a22891 into main Mar 7, 2023
@gdavison gdavison deleted the b-batch-empty-var branch March 7, 2023 18:19
@github-actions github-actions bot added this to the v4.58.0 milestone Mar 7, 2023
github-actions bot pushed a commit that referenced this pull request Mar 7, 2023
@github-actions
Copy link

This functionality has been released in v4.58.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. Thank you!

@github-actions
Copy link

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
service/batch Issues and PRs that pertain to the batch service. size/XL Managed by automation to categorize the size of a PR. tests PRs: expanded test coverage. Issues: expanded coverage, enhancements to test infrastructure.
Projects
None yet
2 participants