refactor: use cmp.Diff for yaml comparision

Author: ingvagabund

lib/resourcebuilder/core_test.go

@@ -15,10 +15,13 @@ import (
 	configv1 "github.com/openshift/api/config/v1"
 	fakeconfigclientv1 "github.com/openshift/client-go/config/clientset/versioned/fake"
 	"github.com/openshift/library-go/pkg/crypto"
+
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/runtime"
+
+	"github.com/google/go-cmp/cmp"
 )
 
 // makeGenericOperatorConfigYAML generates a GenericOperatorConfig YAML string
@@ -303,38 +306,38 @@ func TestModifyConfigMap(t *testing.T) {
 			},
 		},
 		{
-		  name: "ConfigMap with valid GenericOperatorConfig - annotation value not set to true - no modification",
-		  configMap: func() *corev1.ConfigMap {
-		    cm := makeConfigMap(true, map[string]string{
-		      genericOperatorConfigCMKey: makeGenericOperatorConfigYAML(testCipherSuites, tlsVersion12),
-		    })
-		    cm.Annotations[ConfigMapInjectTLSAnnotation] = "false"
-		    return cm
-		  }(),
-		  apiServer:   makeAPIServerConfig(withCustomTLSProfile(testOpenSSLCipherSuites, configv1.VersionTLS13)),
-		  expectError: false,
-		  validateConfigMap: func(t *testing.T, original, modified *corev1.ConfigMap) {
-		    if err := validateConfigMapsEqual(original, modified); err != nil {
-		      t.Fatalf("validation failed: %v", err)
-		    }
-		  },
+			name: "ConfigMap with valid GenericOperatorConfig - annotation value not set to true - no modification",
+			configMap: func() *corev1.ConfigMap {
+				cm := makeConfigMap(true, map[string]string{
+					genericOperatorConfigCMKey: makeGenericOperatorConfigYAML(testCipherSuites, tlsVersion12),
+				})
+				cm.Annotations[ConfigMapInjectTLSAnnotation] = "false"
+				return cm
+			}(),
+			apiServer:   makeAPIServerConfig(withCustomTLSProfile(testOpenSSLCipherSuites, configv1.VersionTLS13)),
+			expectError: false,
+			validateConfigMap: func(t *testing.T, original, modified *corev1.ConfigMap) {
+				if err := validateConfigMapsEqual(original, modified); err != nil {
+					t.Fatalf("validation failed: %v", err)
+				}
+			},
 		},
 		{
-		  name: "ConfigMap with valid GenericOperatorConfig - annotation value empty - no modification",
-		  configMap: func() *corev1.ConfigMap {
-		    cm := makeConfigMap(true, map[string]string{
-		      genericOperatorConfigCMKey: makeGenericOperatorConfigYAML(testCipherSuites, tlsVersion12),
-		    })
-		    cm.Annotations[ConfigMapInjectTLSAnnotation] = ""
-		    return cm
-		  }(),
-		  apiServer:   makeAPIServerConfig(withCustomTLSProfile(testOpenSSLCipherSuites, configv1.VersionTLS13)),
-		  expectError: false,
-		  validateConfigMap: func(t *testing.T, original, modified *corev1.ConfigMap) {
-		    if err := validateConfigMapsEqual(original, modified); err != nil {
-		      t.Fatalf("validation failed: %v", err)
-		    }
-		  },
+			name: "ConfigMap with valid GenericOperatorConfig - annotation value empty - no modification",
+			configMap: func() *corev1.ConfigMap {
+				cm := makeConfigMap(true, map[string]string{
+					genericOperatorConfigCMKey: makeGenericOperatorConfigYAML(testCipherSuites, tlsVersion12),
+				})
+				cm.Annotations[ConfigMapInjectTLSAnnotation] = ""
+				return cm
+			}(),
+			apiServer:   makeAPIServerConfig(withCustomTLSProfile(testOpenSSLCipherSuites, configv1.VersionTLS13)),
+			expectError: false,
+			validateConfigMap: func(t *testing.T, original, modified *corev1.ConfigMap) {
+				if err := validateConfigMapsEqual(original, modified); err != nil {
+					t.Fatalf("validation failed: %v", err)
+				}
+			},
 		},
 		{
 			name:      "ConfigMap with annotation but nil Data - no modification",
@@ -523,11 +526,8 @@ servingInfo:
 			apiServer:   makeAPIServerConfig(withCustomTLSProfile(testOpenSSLCipherSuitesReversed, configv1.VersionTLS13)),
 			expectError: false,
 			validateConfigMap: func(t *testing.T, original, modified *corev1.ConfigMap) {
-				// Validate through pure string comparison
-				originalData := original.Data[genericOperatorConfigCMKey]
-				modifiedData := modified.Data[genericOperatorConfigCMKey]
-				if originalData != modifiedData {
-					t.Errorf("ConfigMap data was modified when it should not have been.\nOriginal:\n%s\nModified:\n%s", originalData, modifiedData)
+				if diff := cmp.Diff(original.Data[genericOperatorConfigCMKey], modified.Data[genericOperatorConfigCMKey]); diff != "" {
+					t.Errorf("ConfigMap YAML mismatch (-want +got):\n%s", diff)
 				}
 			},
 		},

lib/resourcebuilder/resourcebuilder_test.go

@@ -7,12 +7,15 @@ import (
 
 	"sigs.k8s.io/yaml"
 
-	configv1 "github.com/openshift/api/config/v1"
-	fakeconfigclientv1 "github.com/openshift/client-go/config/clientset/versioned/fake"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	fakekubernetes "k8s.io/client-go/kubernetes/fake"
+
+	configv1 "github.com/openshift/api/config/v1"
+	fakeconfigclientv1 "github.com/openshift/client-go/config/clientset/versioned/fake"
+
+	"github.com/google/go-cmp/cmp"
 )
 
 const (
@@ -99,8 +102,8 @@ func TestModifyConfigMapWithBuilder(t *testing.T) {
 
 			// Verify the result matches expected YAML
 			modifiedYAML := appliedConfigMap.Data["config.yaml"]
-			if modifiedYAML != tt.expectYAML {
-				t.Errorf("ConfigMap YAML does not match expected.\nExpected:\n%s\nGot:\n%s", tt.expectYAML, modifiedYAML)
+			if diff := cmp.Diff(tt.expectYAML, modifiedYAML); diff != "" {
+				t.Errorf("ConfigMap YAML mismatch (-want +got):\n%s", diff)
 			}
 		})
 	}