Renaming the method and interface just for the resource

Author: rainkwan

internal/fwserver/server_upgraderesourceidentity.go

@@ -94,7 +94,7 @@ func (s *Server) UpgradeResourceIdentity(ctx context.Context, req *UpgradeResour
 		}
 	}
 
-	resourceWithUpgradeResourceIdentity, ok := req.Resource.(resource.ResourceWithUpgradeResourceIdentity)
+	resourceWithUpgradeResourceIdentity, ok := req.Resource.(resource.ResourceWithUpgradeIdentity)
 
 	if !ok {
 		resp.Diagnostics.AddError(
@@ -106,11 +106,11 @@ func (s *Server) UpgradeResourceIdentity(ctx context.Context, req *UpgradeResour
 		return
 	}
 
-	logging.FrameworkTrace(ctx, "Resource implements ResourceWithUpgradeResourceIdentity")
+	logging.FrameworkTrace(ctx, "Resource implements ResourceWithUpgradeIdentity")
 
-	logging.FrameworkTrace(ctx, "Calling provider defined Resource UpgradeResourceIdentity")
-	resourceIdentityUpgraders := resourceWithUpgradeResourceIdentity.UpgradeResourceIdentity(ctx)
-	logging.FrameworkTrace(ctx, "Called provider defined Resource UpgradeResourceIdentity")
+	logging.FrameworkTrace(ctx, "Calling provider defined Resource UpgradeIdentity")
+	resourceIdentityUpgraders := resourceWithUpgradeResourceIdentity.UpgradeIdentity(ctx)
+	logging.FrameworkTrace(ctx, "Called provider defined Resource UpgradeIdentity")
 
 	// Panic prevention
 	if resourceIdentityUpgraders == nil {
@@ -134,7 +134,7 @@ func (s *Server) UpgradeResourceIdentity(ctx context.Context, req *UpgradeResour
 	}
 
 	if resourceIdentityUpgrader.PriorSchema != nil {
-		logging.FrameworkTrace(ctx, "Initializing populated UpgradeResourceIdentityRequest Identity from provider defined prior schema and request RawState")
+		logging.FrameworkTrace(ctx, "Initializing populated UpgradeIdentityRequest Identity from provider defined prior schema and request RawState")
 
 		priorSchemaType := resourceIdentityUpgrader.PriorSchema.Type().TerraformType(ctx)
 

internal/testing/testprovider/resourcewithconfigureandupgradeidentity.go

@@ -11,7 +11,7 @@ import (
 
 var _ resource.Resource = &ResourceWithConfigureAndUpgradeResourceIdentity{}
 var _ resource.ResourceWithConfigure = &ResourceWithConfigureAndUpgradeResourceIdentity{}
-var _ resource.ResourceWithUpgradeResourceIdentity = &ResourceWithConfigureAndUpgradeResourceIdentity{}
+var _ resource.ResourceWithUpgradeIdentity = &ResourceWithConfigureAndUpgradeResourceIdentity{}
 
 // Declarative resource.ResourceWithConfigureAndUpgradeResourceIdentity for unit testing.
 type ResourceWithConfigureAndUpgradeResourceIdentity struct {
@@ -34,7 +34,7 @@ func (r *ResourceWithConfigureAndUpgradeResourceIdentity) Configure(ctx context.
 }
 
 // UpgradeResourceIdentity satisfies the resource.ResourceWithUpgradeResourceIdentity interface.
-func (r *ResourceWithConfigureAndUpgradeResourceIdentity) UpgradeResourceIdentity(ctx context.Context) map[int64]resource.IdentityUpgrader {
+func (r *ResourceWithConfigureAndUpgradeResourceIdentity) UpgradeIdentity(ctx context.Context) map[int64]resource.IdentityUpgrader {
 	if r.UpgradeResourceIdentityMethod == nil {
 		return nil
 	}

internal/testing/testprovider/resourcewithupgradeidentity.go

@@ -10,7 +10,7 @@ import (
 )
 
 var _ resource.Resource = &ResourceWithUpgradeResourceIdentity{}
-var _ resource.ResourceWithUpgradeResourceIdentity = &ResourceWithUpgradeResourceIdentity{}
+var _ resource.ResourceWithUpgradeIdentity = &ResourceWithUpgradeResourceIdentity{}
 
 // Declarative resource.ResourceWithUpgradeResourceIdentity for unit testing.
 type ResourceWithUpgradeResourceIdentity struct {
@@ -24,7 +24,7 @@ type ResourceWithUpgradeResourceIdentity struct {
 }
 
 // UpgradeResourceIdentity satisfies the resource.ResourceWithUpgradeResourceIdentity interface.
-func (p *ResourceWithUpgradeResourceIdentity) UpgradeResourceIdentity(ctx context.Context) map[int64]resource.IdentityUpgrader {
+func (p *ResourceWithUpgradeResourceIdentity) UpgradeIdentity(ctx context.Context) map[int64]resource.IdentityUpgrader {
 	if p.UpgradeResourceIdentityMethod == nil {
 		return nil
 	}

resource/identity_upgrader.go

@@ -8,19 +8,19 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/resource/identityschema"
 )
 
-// Implementation handler for an UpgradeResourceIdentity operation.
+// Implementation handler for an UpgradeIdentity operation.
 //
 // This is used to encapsulate all upgrade logic from a prior identity to the
 // current version when a Resource implements the
-// ResourceWithUpgradeResourceIdentity interface.
+// ResourceWithUpgradeIdentity interface.
 type IdentityUpgrader struct {
 	// Schema information for the prior identity version. While not required,
-	// setting this will populate the UpgradeResourceIdentityRequest type Identity
+	// setting this will populate the UpgradeIdentityRequest type Identity
 	// field similar to other Resource data types. This allows for easier data
 	// handling such as calling Get() or GetAttribute().
 	//
 	// If not set, prior identity data is available in the
-	// UpgradeResourceIdentityRequest type RawIdentity field.
+	// UpgradeIdentityRequest type RawIdentity field.
 	PriorSchema *identityschema.Schema
 
 	// Provider defined logic for upgrading a resource identity from the prior
@@ -29,11 +29,11 @@ type IdentityUpgrader struct {
 	// The context.Context parameter contains framework-defined loggers and
 	// supports request cancellation.
 	//
-	// The UpgradeResourceIdentityRequest parameter contains the prior identity data.
+	// The UpgradeIdentityRequest parameter contains the prior identity data.
 	// If PriorSchema was set, the Identity field will be available. Otherwise,
 	// the RawIdentity must be used.
 	//
-	// The UpgradeResourceIdentityResponse parameter should contain the upgraded
+	// The UpgradeIdentityResponse parameter should contain the upgraded
 	// identity data and can be used to signal any logic warnings or errors.
 	IdentityUpgrader func(context.Context, UpgradeIdentityRequest, *UpgradeIdentityResponse)
 }

resource/identityschema/schema.go

@@ -29,7 +29,7 @@ type Schema struct {
 
 	// Version indicates the current version of the resource identity schema. Resource
 	// identity schema versioning enables identity state upgrades in conjunction with the
-	// [resource.ResourceWithUpgradeResourceIdentity] interface. Versioning is only
+	// [resource.ResourceWithUpgradeIdentity] interface. Versioning is only
 	// required if there is a breaking change involving existing identity state data,
 	// such as changing an attribute type in a manner that is incompatible with the Terraform type.
 	//

resource/resource.go

@@ -216,15 +216,15 @@ type ResourceWithValidateConfig interface {
 //     by the identity object via the ResourceWithImportState interface.
 //   - The resource identity should not change during the lifecycle of the remote object. That is, from the
 //     creation of the remote object in the remote system until its destruction. An exception to this rule
-//     is an upgrade of the identity data after a schema change, via the ResourceWithUpgradeResourceIdentity interface.
+//     is an upgrade of the identity data after a schema change, via the ResourceWithUpgradeIdentity interface.
 type ResourceWithIdentity interface {
 	Resource
 
 	// IdentitySchema should return the identity schema for this resource.
 	IdentitySchema(context.Context, IdentitySchemaRequest, *IdentitySchemaResponse)
 }
 
-type ResourceWithUpgradeResourceIdentity interface {
+type ResourceWithUpgradeIdentity interface {
 	Resource
 
 	// A mapping of the prior identity version to current identity upgrade
@@ -236,5 +236,5 @@ type ResourceWithUpgradeResourceIdentity interface {
 	// Version keys begin at 0, which is the default schema version when
 	// undefined. The framework will return an error diagnostic should the
 	// requested identity version not be implemented.
-	UpgradeResourceIdentity(context.Context) map[int64]IdentityUpgrader
+	UpgradeIdentity(context.Context) map[int64]IdentityUpgrader
 }