New Checks: Avoid ID-Only Refresh Testing in Acceptance Testing

[bflad]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue 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 issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

Identifier only refresh testing is generally a legacy testing practice before full import testing was the normal convention and the testing framework automatically performed refresh after apply. Other use cases for IDRefreshName are not clear.

New Checks

• AT010: Prefer TestStep.ImportState over TestCase.IDRefreshName
• AT011: Avoid TestCase.IDRefreshIgnore without TestCase.IDRefreshName

Flagged Provider Code

resource.TestCase{
	// ... other configuration ...
	IDRefreshName: "example_thing.test",
})

resource.TestCase{
	// ... other configuration except IDRefreshName ...
	IDRefreshIgnore: []string{"attr"},
})

Passing Provider Code

resource.TestCase{
	// ... other configuration ...
})

References

• tests/provider: Remove ID-Only Refresh Testing (Fix and Enable tfproviderlint AT010 and AT011) hashicorp/terraform-provider-aws#18354
• TestCase ID-Only Refresh Testing Documentation / Generally Extraneous State Fetch hashicorp/terraform-plugin-sdk#730