Update module github.com/hashicorp/terraform-plugin-sdk/v2 to v2.40.1

[renovate]

This PR contains the following updates:

Package	Change	Age	Confidence
github.com/hashicorp/terraform-plugin-sdk/v2	v2.6.1 → v2.40.1

---

Release Notes

hashicorp/terraform-plugin-sdk (github.com/hashicorp/terraform-plugin-sdk/v2)

v2.40.1

Compare Source

BUG FIXES:

• helper/schema: Fixed a bug that caused spurious diffs in the plan when resource identity is set but didn't change. (#​1582)

v2.40.0

Compare Source

NOTES:

• This release moves the resource configuration generation logic for the -generate-config-out flag from Terraform Core to the SDKv2 for Terraform v1.14.0 and above. There should be no functionality changes for resource configuration generation in this release. (#​1559)
• This Go module has been updated to Go 1.25 per the Go support policy. Any consumers building on earlier Go versions may experience errors. (#​1564)

v2.39.0

Compare Source

ENHANCEMENTS:

• helper/schema: Added support for deprecation messages on attributes and blocks, which are now populated from the Schema's Deprecated field and passed through to the protocol layer (#​1553)

v2.38.2

Compare Source

BUG FIXES:

• all: Prevent "Missing Resource Identity" error if the resource returned any errors during apply. (#​1541)

v2.38.1

Compare Source

BUG FIXES:

• all: Prevent identity change validation from raising an error when prior identity is empty (all attributes are null) (#​1527)

v2.38.0

Compare Source

NOTES:

• all: This Go module has been updated to Go 1.24 per the Go support policy. It is recommended to review the Go 1.24 release notes before upgrading. Any consumers building on earlier Go versions may experience errors. (#​1518)
• helper/schema: Update the provider server to handle the ListResource RPCs by returning an error since they are not supported by SDKv2. (#​1521)
• helper/schema: Update the provider server to handle Action RPCs by returning an error since they are not supported by SDKv2. (#​1522)

ENHANCEMENTS:

• helper/schema: Added new helper methods for converting Resource and Identity schemas to protocol representations. (#​1504)
• helper/schema: Added an additional validation check to ensure the resource identity object is not null. (#​1513)
• helper/schema: Added the TfTypeIdentityState() and TfTypeResourceState() methods to ResourceData which return the identity and state values as a tftypes.Value. (#​1508)

v2.37.0

Compare Source

NOTES:

• all: This Go module has been updated to Go 1.23 per the Go support policy. It is recommended to review the Go 1.23 release notes before upgrading. Any consumers building on earlier Go versions may experience errors. (#​1445)
• all: This release contains new fields and structs for implmenting managed resource identity. Resource identity is data that is defined by a separate schema and is stored alongside resource state. Identity data is used by Terrform to uniquely identify a remote object and is meant to be immutable during the remote object's lifecycle. Resources that support identity can now be imported using the identity attribute in Terraform configuration import blocks, available in Terraform v1.12+. The resource.Identity field on the schema.Resource struct can be used to support identity by defining an identity schema. Once the identity schema is defined, you can read and store identity data in the state file with the new IdentityData struct that is available via the Identity() method on schema.ResourceData and schema.ResourceDiff structs. (#​1444)

FEATURES:

• helper/schema: Added new TestResourceDataWithIdentityRaw function for creating a ResourceData struct with identity data for unit testing. (#​1475)
• helper/schema: Added new Identity field to Resource that supports defining an identity schema for managed resources only. (#​1444)
• Added new ImportStatePassthroughWithIdentity helper that can support both identity and ID importing via a single field. (#​1474)

ENHANCEMENTS:

• helper/schema: Added RequiredForImport and OptionalForImport fields to the Schema struct, which are only valid for identity schemas. (#​1444)
• helper/schema: Updated ResourceData to support passing of identity data in CRUD and import functions for managed resources. (#​1444)

BUG FIXES:

• helper/schema: Fixed bug that blocked write-only attributes from being used with resources without update functions. (#​1472)

v2.36.1

Compare Source

NOTES:

• Write-only attribute support is in technical preview and offered without compatibility promises until Terraform 1.11 is generally available. (#​1375)

BUG FIXES:

• helper/schema: Fixed bug that allowed write-only attributes within set nested blocks. Any attribute within a set nested block with WriteOnly set to true will now trigger an error message. (#​1427)

v2.36.0

Compare Source

NOTES:

• Write-only attribute support is in technical preview and offered without compatibility promises until Terraform 1.11 is generally available. (#​1375)

FEATURES:

• helper/schema: Added WriteOnly schema behavior for managed resource schemas to indicate a write-only attribute. Write-only attribute values are not saved to the Terraform plan or state artifacts. (#​1375)
• helper/validation: Added PreferWriteOnlyAttribute() validator that warns practitioners when a write-only version of a configured attribute is available. (#​1375)
• schema/resource: Added ValidateRawResourceConfigFuncs field which allows resources to define validation logic during the ValidateResourceTypeConfig RPC. (#​1375)

v2.35.0

Compare Source

NOTES:

• all: This Go module has been updated to Go 1.22 per the Go support policy. It is recommended to review the Go 1.22 release notes before upgrading. Any consumers building on earlier Go versions may experience errors. (#​1373)
• helper/schema: While this Go module will not receive support for ephemeral resource types, the provider server is updated to handle the new operations, which will be required to prevent errors when updating terraform-plugin-framework or terraform-plugin-mux in the future. (#​1390)

v2.34.0

Compare Source

NOTES:

• all: The v2.33.0 release updated this Go module to Go 1.21 per the Go support policy. It is recommended to review the Go 1.21 release notes before upgrading. Any consumers building on earlier Go versions may experience errors (#​1318)
• This release contains support for deferred actions, which is an experimental feature only available in prerelease builds of Terraform 1.9 and later. This functionality is subject to change and is not protected by version compatibility guarantees. (#​1335)

FEATURES:

• helper/schema: Added (Provider).ConfigureProvider function for configuring providers that support additional features, such as deferred actions. (#​1335)
• helper/schema: Added (Resource).ResourceBehavior to allow additional control over deferred action behavior during plan modification. (#​1335)

v2.33.0

Compare Source

NOTES:

• helper/schema: While this Go module will not receive support for provider defined functions, the provider server is updated to handle the new operation, which will be required to prevent errors when updating terraform-plugin-framework or terraform-plugin-mux in the future (#​1316)

v2.32.0

Compare Source

NOTES:

• helper/schema: While this Go module will not receive support for moving resource state across resource types, the provider server is updated to handle the new operation, which will be required to prevent errors when updating terraform-plugin-framework or terraform-plugin-mux in the future. (#​1307)

v2.31.0

Compare Source

NOTES:

• helper/schema: While this Go module will not receive support for provider-defined functions, the provider server is updated to handle the new operations, which will be required to prevent errors when updating terraform-plugin-framework or terraform-plugin-mux in the future. (#​1288)

v2.30.0

Compare Source

NOTES:

• meta: The SDKVersion variable, SDKPrerelease variable, and SDKVersionString() function have been deprecated. Use the Go standard library runtime/debug package build information instead. (#​1257)

BUG FIXES:

• meta: Fixed version in SDKVersion variable and SDKVersionString() function (#​1257)
• helper/schema: Ensured (ResourceData).GetRawConfig() data is populated for Provider.ConfigureFunc and Provider.ConfigureContextFunc (#​1270)
• helper/schema: Ensured (ResourceData).GetOkExists() second result is true when configuration contains zero-value data in Provider.ConfigureFunc and Provider.ConfigureContextFunc (#​1270)

v2.29.0

Compare Source

NOTES:

• all: This Go module has been updated to Go 1.20 per the Go support policy. It is recommended to review the Go 1.20 release notes before upgrading. Any consumers building on earlier Go versions may experience errors. (#​1245)

FEATURES:

• helper/schema: Upgrade to protocol version 5.4, which can significantly reduce memory usage with Terraform 1.6 and later when a configuration includes multiple instances of the same provider (#​1234)

ENHANCEMENTS:

• helper/validation: Added AllDiag and AnyDiag, which are SchemaValidateDiagFunc variants of All and Any (#​1155)
• helper/validation: Added quoting in StringInSlice error diagnostic output to prevent confusion with values that contain spaces (#​464)

v2.28.0

Compare Source

NOTES:

• helper/schema: The Resource type EnableApplyLegacyTypeSystemErrors and EnablePlanLegacyTypeSystemErrors fields can be enabled to more easily discover resource data consistency errors which Terraform would normally demote to warning logs. Before enabling the flag in a production release for a resource, the resource should be exhaustively acceptance tested as there may be unrecoverable error situations for practitioners. It is recommended to first enable and test in environments where it is easy to clean up resources, potentially outside of Terraform. (#​1227)

ENHANCEMENTS:

• helper/schema: Added Resource type EnableLegacyTypeSystemApplyErrors field, which will prevent Terraform from demoting data consistency errors to warning logs during ApplyResourceChange (Create, Update, and Delete) operations with the resource (#​1227)
• helper/schema: Added Resource type EnableLegacyTypeSystemPlanErrors field, which can be used to prevent Terraform from demoting data consistency errors to warning logs during PlanResourceChange operations with the resource (#​1227)

v2.27.0

Compare Source

NOTES:

• helper/schema: Consumers directly referencing the Resource type Schema field should switch to the SchemaMap method to ensure new SchemaFunc field data is properly retrieved (#​1217)

ENHANCEMENTS:

• all: Improved SDK logging performance when messages would be skipped due to configured logging level (#​1202)
• helper/schema: Added Resource type SchemaFunc field and SchemaMap method, which can reduce resident memory usage with large schemas (#​1217)

v2.26.1

Compare Source

BUG FIXES:

• helper/resource: Prevented build errors with type aliasing added in v2.26.0 (#​1176)

v2.26.0

Compare Source

NOTES:

• This Go module has been updated to Go 1.19 per the Go support policy. Any consumers building on earlier Go versions may experience errors. (#​1163)
• helper/resource: Deprecated PrefixedUniqueId() and UniqueId(). Use the helper/id package instead. These deprecations are to assist in migrating to terraform-plugin-testing (#​1167)
• helper/resource: Deprecated RetryContext(), StateChangeConf, and associated *Error types. Use the helper/retry package instead. These deprecations are to assist in migrating to terraform-plugin-testing (#​1167)

ENHANCEMENTS:

• helper/id: New helper/id package added. resource.PrefixedUniqueId() and resource.UniqueId() are deprecated, helper/id should be used instead. helper/resource now contains aliases to the migrated code (#​1167)
• helper/retry: New helper/retry package added. resource.RetryContext(), resource.StateChangeConf, and associated *Error types are deprecated, helper/retry should be used instead. `helper/resource now contains aliases to the migrated code (#​1167)

v2.25.0

Compare Source

BUG FIXES:

• helper/schema: Allow diagnostic messages with incorrect UTF-8 encoding to pass through with the invalid sequences replaced with the Unicode Replacement Character. This avoids returning the unhelpful message "string field contains invalid UTF-8" in that case. (#​1111)
• helper/schema: Prevented unexpected difference for timeouts on first plan after import (#​1146)

v2.24.1

Compare Source

BUG FIXES:

• helper/resource: Fixed TestStep type ImportStateCheck field so that it only matches against resources following a change in behaviour in Terraform 1.3 that imports both resources and data sources into state (#​1089)
• helper/resource: Prevented go-plugin goroutine leak per Terraform command (#​1095)
• helper/resource: Prevented goroutine leak per Terraform command when testing terraform-plugin-sdk based providers via Providers or ProviderFactories (#​1091)
• helper/resource: Prevented provider configuration already given error when TestStep type Config field already contained provider configuration block (#​1092)

v2.24.0

Compare Source

ENHANCEMENTS:

• helper/resource: Added TestStep type RefreshState field, which enables a step that refreshes state without an explicit apply or configuration changes (#​1070)

BUG FIXES:

• helper/resource: Fixed TestStep type ImportStateVerify field so that it only matches against resources following a change in behaviour in Terraform 1.3 that imports both resources and their dependent data sources (#​1077)

v2.23.0

Compare Source

ENHANCEMENTS:

• helper/resource: Added Terraform configuration to TRACE logging (#​1059)
• helper/resource: Added terraform plan output to TRACE logging (#​1058)

BUG FIXES:

• helper/resource: Prevented Inconsistent dependency lock file errors when using ExternalProviders outside the hashicorp namespace (#​1057)

v2.22.0

Compare Source

ENHANCEMENTS:

• helper/resource: Add ImportStatePersist to optionally persist state generated during import (#​1052)

BUG FIXES:

• helper/schema: Delayed deprecated attribute warnings for unknown values, which may be null (#​1047)
• helper/schema: Included path information in list size diagnostics for cases where Terraform does not include the configuration source (#​826)

v2.21.0

Compare Source

NOTES:

• This Go module has been updated to Go 1.18 per the Go support policy. Any consumers building on earlier Go versions may experience errors. (#​1027)

BUG FIXES:

• helper/resource: Fixed TestStep type Taint field usage to properly recreate resources (#​1031)
• helper/schema: Ensured RawConfig, RawPlan, and RawState are correctly copied during planning with recreation (#​1024)

v2.20.0

Compare Source

NOTES:

• helper/logging: Existing NewTransport() is now deprecated in favour of using the new NewLoggingHTTPTransport() or NewSubsystemLoggingHTTPTransport() (#​1006)

FEATURES:

• helper/logging: New NewLoggingHTTPTransport() and NewSubsystemLoggingHTTPTransport() functions, providing http.RoundTripper Transport implementations that log request/response using terraform-plugin-log (#​546) (#​1006)

v2.19.0

Compare Source

NOTES:

• The underlying terraform-plugin-log dependency has been updated to v0.6.0, which includes log filtering support and breaking changes of With() to SetField() function names. Any provider logging which calls those functions may require updates. (#​1003)

v2.18.0

Compare Source

ENHANCEMENTS:

• helper/resource: Added TF_ACC_LOG, TF_LOG_CORE, and TF_LOG_PROVIDER environment variable handling for Terraform versions 0.15 and later (#​993)
• helper/schema: Added sdk.proto logger request duration and response diagnostics logging (#​996)

BUG FIXES:

• helper/resource: Ensured errors are always logged. (#​983)

v2.17.0

Compare Source

NOTES:

• helper/resource: Provider references or external installation can now be handled at either the TestCase or TestStep level. Using the TestStep handling, advanced use cases are now enabled such as state upgrade acceptance testing. (#​972)

ENHANCEMENTS:

• helper/resource: Added TestStep type ExternalProviders, ProtoV5ProviderFactories, ProtoV6ProviderFactories, and ProviderFactories fields (#​972)

BUG FIXES:

• helper/resource: Removed extraneous terraform state show command when not using the TestStep type Taint field (#​972)

v2.16.0

Compare Source

ENHANCEMENTS:

• helper/resource: Added error logging before failing tests, so errors are visible in test output and any separate log file (#​958)

BUG FIXES:

• helper/resource: Updated version of hc-install in response to change in HashiCorp Release API sending back a different Content-Type header. This was causing failures when the SDK attempted to install Terraform. (#​960)

v2.15.0

Compare Source

FEATURES:

• helper/resource: New TestCheckResourceAttrWith test helper, that simplifies checking of attribute values via custom functions (#​950)

ENHANCEMENTS:

• helper/schema: Propagated tf_data_source_type, tf_req_id, tf_resource_type, and tf_rpc fields in log entries (#​955)

BUG FIXES:

• helper/resource: Prevented Unable to create logging subsystem with AdditionalLocationOffset due to missing root logger options warning logs during acceptance testing (#​955)

v2.14.0

Compare Source

NOTES:

• This Go module has been updated to Go 1.17 per the Go support policy. Any consumers building on earlier Go versions may experience errors. (#​934)

BUG FIXES:

• helper/resource: Ensured Terraform CLI logs are written to TF_LOG_PATH_MASK environment variable value when both TF_ACC_LOG_PATH and TF_LOG_PATH_MASK are set (#​938)
• helper/resource: Ensured @caller in SDK logging entries accurately reflected calling code location (#​939)
• helper/resource: Prevented regression since 2.13.0 with the removal of environment variables, including TF_VAR_*, when calling Terraform CLI commands (#​937)
• helper/schema: Ensured @caller in SDK logging entries accurately reflected calling code location (#​939)
• helper/schema: Prevented missing SDK logging entries and confusing provider.stdio TRACE logging entries (#​936)

v2.13.0

Compare Source

NOTES:

• helper/resource: False positive checks of list, map, and set attributes with TestCheckNoResourceAttr and TestCheckResourceAttrSet will now return an error to explain how to accurately check those types of attributes. Some previously passing tests will now fail until the check is correctly updated. (#​920)
• helper/schema: Any returned non-nil error with an Error() method that returns an empty string (""), will now return an error diagnostic with an "Empty Error String" summary instead of a panic. Enabling Terraform logging at the WARN level (e.g. TF_LOG=WARN terraform apply) can help locate the problematic error by searching for the detected empty error string log message. (#​914)

ENHANCEMENTS:

• helper/resource: Added error when errantly checking list, map, or set attributes in TestCheckNoResourceAttr, TestCheckResourceAttr, and TestCheckResourceAttrSet (#​920)
• helper/resource: Execute Terraform CLI commands during acceptance testing with CHECKPOINT_DISABLE=1 set, removing extraneous calls to checkpoint.hashicorp.com to check for latest Terraform CLI version (#​913)

BUG FIXES:

• helper/schema: Allowed Schema with TypeInt to accept string values from DefaultFunc, such as EnvDefaultFunc (#​841) (#​841)
• helper/schema: Prevented panics during error to diagnostic conversion for a non-nil error with an Error() method that returns an empty string ("") (#​914)
• helper/validation: Prevented panics with ToDiagFunc() function when used inside Schema type Elem field, such as validating TypeList elements (#​915)

v2.12.0

ENHANCEMENTS:

• helper/resource: Support JSON in TestStep type Config field (#​722)

BUG FIXES:

• customdiff: Prevented unexpected non-existent key errors in ComputedIf, ForceNewIf, and ForceNewIfChange since 2.11.0, using a warning log for backwards compatibility instead (#​909)

v2.11.0

Compare Source

NOTES:

• The underlying terraform-plugin-log dependency has been updated to v0.3.0, which includes a breaking change in the optional additional fields parameter of logging function calls to ensure correctness and catch coding errors during compilation. Any early adopter provider logging which calls those functions may require updates. (#​900)
• helper/resource: The new terraform-plugin-log sdk.helper_resource logger inherits the TF_LOG, TF_LOG_PATH_MASK, and TF_ACC_LOG_PATH environment variable settings, similar to the prior logging. The TF_LOG_SDK_HELPER_RESOURCE environment variable can be used to separately control the new logger level. (#​891)
• helper/schema: Started using terraform-plugin-log to write some SDK-level logs. Very few logs use this functionality now, but in the future, the environment variable TF_LOG_SDK_HELPER_SCHEMA will be able to set the log level for the SDK separately from the provider. (#​837)
• helper/schema: The Schema type DiffSuppressOnRefresh field opts in to using DiffSuppressFunc to detect normalization changes during refresh, using the same rules as for planning. This can prevent normalization cascading downstream and producing confusing changes in other resources, and will avoid reporting "Values changed outside of Terraform" for normalization-only situations. This is a desirable behavior for most attributes that have DiffSuppressFunc and so would ideally be on by default, but it is opt-in for backward compatibility reasons. (#​882)
• plugin: The Debug function has been deprecated in preference of setting the Debug field in the ServeOpts passed into the Serve function. (#​857)

ENHANCEMENTS:

• helper/resource: Added more visible logging for test steps skipped via the TestStep type SkipFunc field. (#​889)
• helper/resource: Added terraform-plugin-log sdk.helper_resource logger and extensive TRACE log entries (#​891)
• helper/schema: Added the DiffSuppressOnRefresh field to the Schema type (#​882)
• plugin: Added support for writing protocol data to disk by setting TF_LOG_SDK_PROTO_DATA_DIR environment variable (#​857)
• plugin: Increased maximum gRPC send and receive message size limit to 256MB (#​857)

BUG FIXES:

• helper/resource: Removed extraneous Terraform CLI show command each TestStep unless using TestCase.IDRefreshName (#​892)
• plugin: Prevent potential process leak on Windows platforms (#​856)

v2.10.1

Compare Source

v2.10.0

Compare Source

v2.9.0

Compare Source

v2.8.0

Compare Source

v2.7.1

Compare Source

v2.7.0

Compare Source

---

Configuration

📅 Schedule: (UTC)

• Branch creation
  • At any time (no schedule defined)
• Automerge
  • At any time (no schedule defined)

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

---

• If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.

[renovate]

ℹ️ Artifact update notice

File name: go.mod

In order to perform the update(s) described in the table above, Renovate ran the go get command, which resulted in the following additional change(s):

• The go directive was updated for compatibility reasons

Details:

Package	Change
go	1.14 -> 1.25.8