fix: cluster_customization_defaults.kustomization returns inconsistency for same results (#321)

Fixes #318

Author: hanxiaop

akp/data_source_akp_kargoagent_test.go

@@ -22,7 +22,6 @@ func TestAccKargoAgentDataSource(t *testing.T) {
 					resource.TestCheckResourceAttr("data.akp_kargo_agent.test", "namespace", "akuity"),
 					resource.TestCheckResourceAttr("data.akp_kargo_agent.test", "labels.app", "test"),
 					resource.TestCheckResourceAttr("data.akp_kargo_agent.test", "annotations.app", "test"),
-					resource.TestCheckResourceAttr("data.akp_kargo_agent.test", "spec.data.target_version", "0.5.54"),
 				),
 			},
 		},

akp/data_source_akp_kargoagents_test.go

@@ -64,9 +64,6 @@ func testAccCheckKargoAgentAttributes(dataSourceName string, targetKargoAgentNam
 				if err := resource.TestCheckResourceAttr(dataSourceName, fmt.Sprintf("agents.%d.spec.data.size", i), "small")(s); err != nil {
 					return err
 				}
-				if err := resource.TestCheckResourceAttr(dataSourceName, fmt.Sprintf("agents.%d.spec.data.target_version", i), "0.5.54")(s); err != nil {
-					return err
-				}
 				return nil
 			}
 		}

akp/types/types.go

@@ -4,6 +4,7 @@ import (
 	"bytes"
 	"context"
 	"fmt"
+	"reflect"
 	"strconv"
 
 	"github.com/hashicorp/terraform-plugin-framework/attr"
@@ -12,6 +13,7 @@ import (
 	tftypes "github.com/hashicorp/terraform-plugin-framework/types"
 	"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
 	"google.golang.org/protobuf/types/known/structpb"
+	yamlv3 "gopkg.in/yaml.v3"
 	appsv1 "k8s.io/api/apps/v1"
 	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -87,7 +89,7 @@ func (a *ArgoCD) Update(ctx context.Context, diagnostics *diag.Diagnostics, cd *
 			Subdomain:                       tftypes.StringValue(cd.Spec.InstanceSpec.Subdomain),
 			DeclarativeManagementEnabled:    tftypes.BoolValue(declarativeManagementEnabled),
 			Extensions:                      toExtensionsTFModel(cd.Spec.InstanceSpec.Extensions),
-			ClusterCustomizationDefaults:    toClusterCustomizationTFModel(ctx, diagnostics, cd.Spec.InstanceSpec.ClusterCustomizationDefaults),
+			ClusterCustomizationDefaults:    a.toClusterCustomizationTFModel(ctx, diagnostics, cd.Spec.InstanceSpec.ClusterCustomizationDefaults),
 			ImageUpdaterEnabled:             tftypes.BoolValue(imageUpdaterEnabled),
 			BackendIpAllowListEnabled:       tftypes.BoolValue(backendIpAllowListEnabled),
 			RepoServerDelegate:              toRepoServerDelegateTFModel(cd.Spec.InstanceSpec.RepoServerDelegate),
@@ -765,7 +767,7 @@ func toManagedClusterTFModel(cluster *v1alpha1.ManagedCluster) *ManagedCluster {
 	}
 }
 
-func toClusterCustomizationTFModel(ctx context.Context, diagnostics *diag.Diagnostics, customization *v1alpha1.ClusterCustomization) tftypes.Object {
+func (a *ArgoCD) toClusterCustomizationTFModel(ctx context.Context, diagnostics *diag.Diagnostics, customization *v1alpha1.ClusterCustomization) tftypes.Object {
 	if customization == nil {
 		return tftypes.ObjectNull(clusterCustomizationAttrTypes)
 	}
@@ -774,6 +776,22 @@ func toClusterCustomizationTFModel(ctx context.Context, diagnostics *diag.Diagno
 		diagnostics.AddError("failed to convert json to yaml", err.Error())
 	}
 
+	if !a.Spec.InstanceSpec.ClusterCustomizationDefaults.IsNull() && !a.Spec.InstanceSpec.ClusterCustomizationDefaults.IsUnknown() {
+		var existingCustomization ClusterCustomization
+		diagnostics.Append(a.Spec.InstanceSpec.ClusterCustomizationDefaults.As(ctx, &existingCustomization, basetypes.ObjectAsOptions{
+			UnhandledNullAsEmpty:    true,
+			UnhandledUnknownAsEmpty: true,
+		})...)
+
+		if !diagnostics.HasError() {
+			existingYaml := existingCustomization.Kustomization.ValueString()
+			newYaml := string(yamlData)
+			if yamlEqual(existingYaml, newYaml) {
+				yamlData = []byte(existingYaml)
+			}
+		}
+	}
+
 	autoUpgradeDisabled := false
 	if customization.AutoUpgradeDisabled != nil && *customization.AutoUpgradeDisabled {
 		autoUpgradeDisabled = true
@@ -1603,3 +1621,14 @@ func areResourcesValid(min, max string) bool {
 	}
 	return minQ.Cmp(maxQ) <= 0
 }
+
+func yamlEqual(a, b string) bool {
+	var objA, objB any
+	if err := yamlv3.Unmarshal([]byte(a), &objA); err != nil {
+		return false
+	}
+	if err := yamlv3.Unmarshal([]byte(b), &objB); err != nil {
+		return false
+	}
+	return reflect.DeepEqual(objA, objB)
+}