Merge pull request #41539 from hashicorp/td-rename-calculate-calculat…

…ediff

autoflex: Rename Calculate to Diff

internal/framework/flex/diff.go

@@ -37,8 +37,8 @@ func (r *Results) IgnoredFieldNames() []string {
 	return r.ignoredFieldNames
 }
 
-// Calculate compares the plan and state values and returns whether there are changes
-func Calculate(ctx context.Context, plan, state any, options ...ChangeOption) (*Results, diag.Diagnostics) {
+// Diff compares the plan and state values and returns whether there are changes
+func Diff(ctx context.Context, plan, state any, options ...ChangeOption) (*Results, diag.Diagnostics) {
 	var diags diag.Diagnostics
 	opts := NewChangeOptions(options...)
 

internal/framework/flex/diff_test.go

@@ -83,7 +83,7 @@ func TestCalculate(t *testing.T) {
 		t.Run(name, func(t *testing.T) {
 			t.Parallel()
 
-			results, diags := fwflex.Calculate(context.Background(), test.plan, test.state)
+			results, diags := fwflex.Diff(context.Background(), test.plan, test.state)
 
 			if diff := cmp.Diff(diags.HasError(), test.expectErr); diff != "" {
 				t.Fatalf("unexpected diff (+wanted, -got): %s", diff)
@@ -129,7 +129,7 @@ func TestWithException(t *testing.T) {
 		t.Run(name, func(t *testing.T) {
 			t.Parallel()
 
-			results, _ := fwflex.Calculate(context.Background(), test.plan, test.state, test.withException...)
+			results, _ := fwflex.Diff(context.Background(), test.plan, test.state, test.withException...)
 
 			if diff := cmp.Diff(results.IgnoredFieldNames(), test.expectedIgnoredFieldNames); diff != "" {
 				t.Errorf("unexpected diff (+wanted, -got): %s", diff)

internal/service/apigateway/account.go

@@ -166,7 +166,7 @@ func (r *resourceAccount) Update(ctx context.Context, request resource.UpdateReq
 		return
 	}
 
-	diff, d := flex.Calculate(ctx, plan, state)
+	diff, d := flex.Diff(ctx, plan, state)
 	response.Diagnostics.Append(d...)
 	if response.Diagnostics.HasError() {
 		return

internal/service/chatbot/slack_channel_configuration.go

@@ -217,7 +217,7 @@ func (r *slackChannelConfigurationResource) Update(ctx context.Context, request
 
 	conn := r.Meta().ChatbotClient(ctx)
 
-	diff, d := fwflex.Calculate(ctx, new, old)
+	diff, d := fwflex.Diff(ctx, new, old)
 	response.Diagnostics.Append(d...)
 	if response.Diagnostics.HasError() {
 		return

internal/service/chatbot/teams_channel_configuration.go

@@ -220,7 +220,7 @@ func (r *teamsChannelConfigurationResource) Update(ctx context.Context, request
 
 	conn := r.Meta().ChatbotClient(ctx)
 
-	diff, d := fwflex.Calculate(ctx, new, old)
+	diff, d := fwflex.Diff(ctx, new, old)
 	response.Diagnostics.Append(d...)
 	if response.Diagnostics.HasError() {
 		return

internal/service/cleanrooms/membership.go

@@ -284,7 +284,7 @@ func (r *resourceMembership) Update(ctx context.Context, request resource.Update
 		return
 	}
 
-	diff, d := fwflex.Calculate(ctx, plan, state)
+	diff, d := fwflex.Diff(ctx, plan, state)
 	response.Diagnostics.Append(d...)
 	if response.Diagnostics.HasError() {
 		return

internal/service/datazone/user_profile.go

@@ -201,7 +201,7 @@ func (r *resourceUserProfile) Update(ctx context.Context, req resource.UpdateReq
 		return
 	}
 
-	diff, d := flex.Calculate(ctx, plan, state)
+	diff, d := flex.Diff(ctx, plan, state)
 	resp.Diagnostics.Append(d...)
 	if resp.Diagnostics.HasError() {
 		return

internal/service/docdbelastic/cluster.go

@@ -278,7 +278,7 @@ func (r *resourceCluster) Update(ctx context.Context, request resource.UpdateReq
 		return
 	}
 
-	diff, d := fwflex.Calculate(ctx, plan, state)
+	diff, d := fwflex.Diff(ctx, plan, state)
 	response.Diagnostics.Append(d...)
 	if response.Diagnostics.HasError() {
 		return

internal/service/elasticache/serverless_cache.go

@@ -336,7 +336,7 @@ func (r *serverlessCacheResource) Update(ctx context.Context, request resource.U
 
 	conn := r.Meta().ElastiCacheClient(ctx)
 
-	diff, d := fwflex.Calculate(ctx, new, old)
+	diff, d := fwflex.Diff(ctx, new, old)
 	response.Diagnostics.Append(d...)
 	if response.Diagnostics.HasError() {
 		return

internal/service/logs/anomaly_detector.go

@@ -178,7 +178,7 @@ func (r *anomalyDetectorResource) Update(ctx context.Context, request resource.U
 
 	conn := r.Meta().LogsClient(ctx)
 
-	diff, d := fwflex.Calculate(ctx, new, old)
+	diff, d := fwflex.Diff(ctx, new, old)
 	response.Diagnostics.Append(d...)
 	if response.Diagnostics.HasError() {
 		return

internal/service/medialive/multiplex_program.go

@@ -283,7 +283,7 @@ func (m *multiplexProgram) Update(ctx context.Context, req resource.UpdateReques
 		return
 	}
 
-	diff, d := fwflex.Calculate(ctx, plan, state)
+	diff, d := fwflex.Diff(ctx, plan, state)
 	resp.Diagnostics.Append(d...)
 	if resp.Diagnostics.HasError() {
 		return

internal/service/mediapackagev2/channel_group.go

@@ -156,7 +156,7 @@ func (r *resourceChannelGroup) Update(ctx context.Context, request resource.Upda
 		return
 	}
 
-	diff, d := fwflex.Calculate(ctx, plan, state)
+	diff, d := fwflex.Diff(ctx, plan, state)
 	response.Diagnostics.Append(d...)
 	if response.Diagnostics.HasError() {
 		return

internal/service/opensearchserverless/security_config.go

@@ -204,7 +204,7 @@ func (r *resourceSecurityConfig) Update(ctx context.Context, req resource.Update
 		return
 	}
 
-	diff, diags := fwflex.Calculate(ctx, plan, state)
+	diff, diags := fwflex.Diff(ctx, plan, state)
 	if diags.HasError() {
 		resp.Diagnostics.Append(diags...)
 		return

internal/service/opensearchserverless/security_policy.go

@@ -173,7 +173,7 @@ func (r *resourceSecurityPolicy) Update(ctx context.Context, req resource.Update
 		return
 	}
 
-	diff, diags := flex.Calculate(ctx, plan, state)
+	diff, diags := flex.Diff(ctx, plan, state)
 	resp.Diagnostics.Append(diags...)
 	if resp.Diagnostics.HasError() {
 		return

internal/service/resiliencehub/resiliency_policy.go

@@ -317,7 +317,7 @@ func (r *resourceResiliencyPolicy) Update(ctx context.Context, req resource.Upda
 		return
 	}
 
-	diff, d := flex.Calculate(ctx, plan, state)
+	diff, d := flex.Diff(ctx, plan, state)
 	resp.Diagnostics.Append(d...)
 	if resp.Diagnostics.HasError() {
 		return

internal/service/timestreamquery/scheduled_query.go

@@ -669,7 +669,7 @@ func (r *resourceScheduledQuery) Update(ctx context.Context, req resource.Update
 		return
 	}
 
-	diff, d := flex.Calculate(ctx, plan, state)
+	diff, d := flex.Diff(ctx, plan, state)
 	resp.Diagnostics.Append(d...)
 	if resp.Diagnostics.HasError() {
 		return

skaff/resource/resourcefw.gtpl

@@ -423,13 +423,15 @@ func (r *resource{{ .Resource }}) Update(ctx context.Context, req resource.Updat
 		return
 	}
 	{{ if .IncludeComments }}
-	// TIP: -- 3. Populate a modify input structure and check for changes
+	// TIP: -- 3. Get the difference between the plan and state, if any
 	{{- end }}
-	if !plan.Name.Equal(state.Name) ||
-		!plan.Description.Equal(state.Description) ||
-		!plan.ComplexArgument.Equal(state.ComplexArgument) ||
-		!plan.Type.Equal(state.Type) {
+	diff, d := flex.Diff(ctx, plan, state)
+	resp.Diagnostics.Append(d...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
 
+	if diff.HasChanges() {
 		var input {{ .SDKPackage }}.Update{{ .Resource }}Input
 		resp.Diagnostics.Append(flex.Expand(ctx, plan, &input, flex.WithFieldNamePrefix("Test"))...)
 		if resp.Diagnostics.HasError() {