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

r/aws_cloudformation_stack_set_instance: fix crash during ID construction #38969

Merged
merged 3 commits into from
Aug 22, 2024

Conversation

jar-b
Copy link
Member

@jar-b jar-b commented Aug 21, 2024

Description

Fixes a crash caused by incorrect logic used to construct the multi-part key for id and improper handling of the error returned from the resource ID constructor helper.

Relations

Closes #38846

References

Output from Acceptance Testing

%  make testacc PKG=cloudformation TESTS=TestAccCloudFormationStackSetInstance_
make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.22.6 test ./internal/service/cloudformation/... -v -count 1 -parallel 20 -run='TestAccCloudFormationStackSetInstance_'  -timeout 360m

=== CONT  TestAccCloudFormationStackSetInstance_delegatedAdministrator
    stack_set_instance_test.go:375: skipping test because at least one environment variable of [AWS_ALTERNATE_PROFILE AWS_ALTERNATE_ACCESS_KEY_ID] must be set. Usage: credentials for running acceptance testing in alternate AWS account.
--- SKIP: TestAccCloudFormationStackSetInstance_delegatedAdministrator (0.91s)
=== NAME  TestAccCloudFormationStackSetInstance_concurrencyMode
    stack_set_instance_test.go:339: this AWS account must be the management account of an AWS Organization
--- SKIP: TestAccCloudFormationStackSetInstance_concurrencyMode (1.27s)
=== NAME  TestAccCloudFormationStackSetInstance_operationPreferences
    stack_set_instance_test.go:304: this AWS account must be the management account of an AWS Organization
--- SKIP: TestAccCloudFormationStackSetInstance_operationPreferences (5.82s)
=== NAME  TestAccCloudFormationStackSetInstance_DeploymentTargets_emptyOU
    stack_set_instance_test.go:258: this AWS account must be the management account of an AWS Organization
--- SKIP: TestAccCloudFormationStackSetInstance_DeploymentTargets_emptyOU (6.21s)
=== NAME  TestAccCloudFormationStackSetInstance_deploymentTargets
    stack_set_instance_test.go:209: this AWS account must be the management account of an AWS Organization
--- SKIP: TestAccCloudFormationStackSetInstance_deploymentTargets (14.76s)
--- PASS: TestAccCloudFormationStackSetInstance_Disappears_stackSet (67.25s)
--- PASS: TestAccCloudFormationStackSetInstance_basic (71.28s)
--- PASS: TestAccCloudFormationStackSetInstance_disappears (72.69s)
--- PASS: TestAccCloudFormationStackSetInstance_parameterOverrides (123.31s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/service/cloudformation     132.610s

jar-b added 2 commits August 21, 2024 14:35
The create method incorrectly assumed that when `deployment_targets` are provided, organizational unit IDs must be provided in that block, and attempted to use those values in the multi-part key stored for the `id`. This is not the case for self-managed stack sets, which allow `deployment_targets` to be configured with an empty list of organzation unit IDs. The provider will now fall back to `account_id` for this section of the identifier instead.
Previously this error was wrapped by `errs.Must` triggering a crash when a non-nil error is returned. This error is now correctly wrapped in a diagnostic.

```console
%  make testacc PKG=cloudformation TESTS=TestAccCloudFormationStackSetInstance_
make: Verifying source code with gofmt...
==> Checking that code complies with gofmt requirements...
TF_ACC=1 go1.22.6 test ./internal/service/cloudformation/... -v -count 1 -parallel 20 -run='TestAccCloudFormationStackSetInstance_'  -timeout 360m

=== CONT  TestAccCloudFormationStackSetInstance_delegatedAdministrator
    stack_set_instance_test.go:375: skipping test because at least one environment variable of [AWS_ALTERNATE_PROFILE AWS_ALTERNATE_ACCESS_KEY_ID] must be set. Usage: credentials for running acceptance testing in alternate AWS account.
--- SKIP: TestAccCloudFormationStackSetInstance_delegatedAdministrator (0.91s)
=== NAME  TestAccCloudFormationStackSetInstance_concurrencyMode
    stack_set_instance_test.go:339: this AWS account must be the management account of an AWS Organization
--- SKIP: TestAccCloudFormationStackSetInstance_concurrencyMode (1.27s)
=== NAME  TestAccCloudFormationStackSetInstance_operationPreferences
    stack_set_instance_test.go:304: this AWS account must be the management account of an AWS Organization
--- SKIP: TestAccCloudFormationStackSetInstance_operationPreferences (5.82s)
=== NAME  TestAccCloudFormationStackSetInstance_DeploymentTargets_emptyOU
    stack_set_instance_test.go:258: this AWS account must be the management account of an AWS Organization
--- SKIP: TestAccCloudFormationStackSetInstance_DeploymentTargets_emptyOU (6.21s)
=== NAME  TestAccCloudFormationStackSetInstance_deploymentTargets
    stack_set_instance_test.go:209: this AWS account must be the management account of an AWS Organization
--- SKIP: TestAccCloudFormationStackSetInstance_deploymentTargets (14.76s)
--- PASS: TestAccCloudFormationStackSetInstance_Disappears_stackSet (67.25s)
--- PASS: TestAccCloudFormationStackSetInstance_basic (71.28s)
--- PASS: TestAccCloudFormationStackSetInstance_disappears (72.69s)
--- PASS: TestAccCloudFormationStackSetInstance_parameterOverrides (123.31s)
PASS
ok      github.com/hashicorp/terraform-provider-aws/internal/service/cloudformation     132.610s
```
@jar-b jar-b requested a review from a team as a code owner August 21, 2024 19:20
Copy link

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 service/cloudformation Issues and PRs that pertain to the cloudformation service. prioritized Part of the maintainer teams immediate focus. To be addressed within the current quarter. labels Aug 21, 2024
@jar-b jar-b added crash Results from or addresses a Terraform crash or kernel panic. bug Addresses a defect in current functionality. labels Aug 21, 2024
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 🚀.

@jar-b jar-b merged commit bbbac07 into main Aug 22, 2024
44 checks passed
@jar-b jar-b deleted the b-cfn-crash branch August 22, 2024 13:20
@github-actions github-actions bot added this to the v5.64.0 milestone Aug 22, 2024
terraform-aws-provider bot pushed a commit that referenced this pull request Aug 22, 2024
Copy link

This functionality has been released in v5.64.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 github-actions bot removed the prioritized Part of the maintainer teams immediate focus. To be addressed within the current quarter. label Aug 22, 2024
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 Sep 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Addresses a defect in current functionality. crash Results from or addresses a Terraform crash or kernel panic. service/cloudformation Issues and PRs that pertain to the cloudformation service.
Projects
None yet
2 participants