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_ssm_document: Fixes for tfproviderlint R006 #12046

Merged
merged 1 commit into from
Feb 20, 2020

Conversation

bflad
Copy link
Contributor

@bflad bflad commented Feb 13, 2020

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

Reference: #11864

Release note for CHANGELOG:

NONE

RetryFunc should only be used when logic has a retryable condition. In the case of working with the AWS Go SDK, it also arbitrarily restricts the automatic retrying logic of API calls to the timeout, which is generally undesired.

Previously:

aws/resource_aws_ssm_document.go:213:39: R006: RetryFunc should include RetryableError() handling or be removed

Output from acceptance testing:

--- PASS: TestAccAWSSSMDocument_basic (26.29s)
--- PASS: TestAccAWSSSMDocument_session (37.24s)
--- PASS: TestAccAWSSSMDocument_automation (41.32s)
--- PASS: TestAccAWSSSMDocument_permission_batching (44.07s)
--- PASS: TestAccAWSSSMDocument_params (46.96s)
--- PASS: TestAccAWSSSMDocument_SchemaVersion_1 (48.76s)
--- PASS: TestAccAWSSSMDocument_DocumentFormat_YAML (51.32s)
--- PASS: TestAccAWSSSMDocument_target_type (51.87s)
--- PASS: TestAccAWSSSMDocument_Tags (58.75s)
--- PASS: TestAccAWSSSMDocument_permission_private (66.11s)
--- PASS: TestAccAWSSSMDocument_permission_public (67.63s)
--- PASS: TestAccAWSSSMDocument_update (76.88s)
--- PASS: TestAccAWSSSMDocument_permission_change (77.82s)
--- PASS: TestAccAWSSSMDocument_package (83.33s)

Reference: #11864

`RetryFunc` should only be used when logic has a retryable condition. In the case of working with the AWS Go SDK, it also arbitrarily restricts the automatic retrying logic of API calls to the timeout, which is generally undesired.

Previously:

```
aws/resource_aws_ssm_document.go:213:39: R006: RetryFunc should include RetryableError() handling or be removed
```

Output from acceptance testing:

```
--- PASS: TestAccAWSSSMDocument_basic (26.29s)
--- PASS: TestAccAWSSSMDocument_session (37.24s)
--- PASS: TestAccAWSSSMDocument_automation (41.32s)
--- PASS: TestAccAWSSSMDocument_permission_batching (44.07s)
--- PASS: TestAccAWSSSMDocument_params (46.96s)
--- PASS: TestAccAWSSSMDocument_SchemaVersion_1 (48.76s)
--- PASS: TestAccAWSSSMDocument_DocumentFormat_YAML (51.32s)
--- PASS: TestAccAWSSSMDocument_target_type (51.87s)
--- PASS: TestAccAWSSSMDocument_Tags (58.75s)
--- PASS: TestAccAWSSSMDocument_permission_private (66.11s)
--- PASS: TestAccAWSSSMDocument_permission_public (67.63s)
--- PASS: TestAccAWSSSMDocument_update (76.88s)
--- PASS: TestAccAWSSSMDocument_permission_change (77.82s)
--- PASS: TestAccAWSSSMDocument_package (83.33s)
```
@bflad bflad added the technical-debt Addresses areas of the codebase that need refactoring or redesign. label Feb 13, 2020
@bflad bflad requested a review from a team February 13, 2020 20:31
@ghost ghost added needs-triage Waiting for first response or review from a maintainer. size/XS Managed by automation to categorize the size of a PR. service/ssm Issues and PRs that pertain to the ssm service. labels Feb 13, 2020
@bflad bflad removed the needs-triage Waiting for first response or review from a maintainer. label Feb 13, 2020
@gdavison gdavison self-assigned this Feb 19, 2020
Copy link
Contributor

@gdavison gdavison left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

--- PASS: TestAccAWSSSMDocument_basic (13.45s)
--- PASS: TestAccAWSSSMDocument_params (16.67s)
--- PASS: TestAccAWSSSMDocument_session (26.99s)
--- PASS: TestAccAWSSSMDocument_permission_public (27.43s)
--- PASS: TestAccAWSSSMDocument_update (37.45s)
--- PASS: TestAccAWSSSMDocument_permission_private (42.56s)
--- PASS: TestAccAWSSSMDocument_Tags (46.00s)
--- PASS: TestAccAWSSSMDocument_automation (50.81s)
--- PASS: TestAccAWSSSMDocument_permission_batching (54.25s)
--- PASS: TestAccAWSSSMDocument_target_type (56.36s)
--- PASS: TestAccAWSSSMDocument_package (57.27s)
--- PASS: TestAccAWSSSMDocument_permission_change (64.75s)
--- PASS: TestAccAWSSSMDocument_DocumentFormat_YAML (65.38s)
--- PASS: TestAccAWSSSMDocument_SchemaVersion_1 (114.07s)

@bflad bflad added this to the v2.50.0 milestone Feb 20, 2020
@bflad bflad merged commit 39ef07c into master Feb 20, 2020
@bflad bflad deleted the td-aws_ssm_document-R006 branch February 20, 2020 00:22
@ghost
Copy link

ghost commented Feb 21, 2020

This has been released in version 2.50.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
Copy link

ghost commented Mar 21, 2020

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!

@ghost ghost locked and limited conversation to collaborators Mar 21, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
service/ssm Issues and PRs that pertain to the ssm service. size/XS Managed by automation to categorize the size of a PR. technical-debt Addresses areas of the codebase that need refactoring or redesign.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants