helper/resource: Deprecate non-testing constants, functions, and types #96
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The initial creation of the `terraform-plugin-testing` Go module was a migration of some existing packages within the `terraform-plugin-sdk` Go module. The `helper/resource` package itself contained multiple abstractions, some related to testing resources (the parts we want in this Go module) and some related to developing resources (the parts we do not want in this Go module). Version 1.0.0 with compatibility promises shipped before this extraneous code was pruned, so it is being deprecated in adherence to our versioning policy. It will not be included in any future major version of this Go module. Each constant, function, method, and type includes a Go documentation deprecation comment with an explicit action for the developer. This is generally either copying the code or continuing to use the `terraform-plugin-sdk` Go module for effected usage.
bendbennett
approved these changes
Mar 10, 2023
There was a problem hiding this comment.
LGTM 👍
Is it worth adding to the migration docs (website/docs/plugin/testing/migrating.mdx) along the lines of:
- Change all instances of the following Go import statements in `*.go` files:
- `github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource` to `github.com/hashicorp/terraform-plugin-sdk/v2/helper/retry` where `resource.NotFoundError`, `resource.UnexpectedStateError`, `resource.TimeoutError`, `resource.StateRefreshFunc`, `resource.StateChangeConf `, `resource.RetryContext `, `resource.RetryFunc`, `resource.RetryError`, `resource.RetryableError` and `resource.NonRetryableError` are being used.
- `github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource` to `github.com/hashicorp/terraform-plugin-sdk/v2/helper/id` where `resource.UniqueIdPrefix`, `resource.UniqueId`, `resource.UniqueIDSuffixLength` and `resource.PrefixedUniqueId` are being used.
|
Yeah, that's definitely a good call. |
|
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 contributions. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The initial creation of the
terraform-plugin-testingGo module was a migration of some existing packages within theterraform-plugin-sdkGo module. Thehelper/resourcepackage itself contained multiple abstractions, some related to testing resources (the parts we want in this Go module) and some related to developing resources (the parts we do not want in this Go module). Version 1.0.0 with compatibility promises shipped before this extraneous code was pruned, so it is being deprecated in adherence to our versioning policy. It will not be included in any future major version of this Go module.Each constant, function, method, and type includes a Go documentation deprecation comment with an explicit action for the developer. This is generally either copying the code or continuing to use the
terraform-plugin-sdkGo module for effected usage.