Add a test helper that unmarshals JSON and YAML

The "sigs.k8s.io/yaml" package alone does not produce the same results
as the Kubernetes API. This new function produces the same results and
uses type parameters to accept input as a string or byte slice.

go.mod

@@ -29,6 +29,7 @@ require (
 	k8s.io/component-base v0.31.0
 	k8s.io/kube-openapi v0.0.0-20240521193020-835d969ad83a
 	sigs.k8s.io/controller-runtime v0.19.3
+	sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd
 	sigs.k8s.io/yaml v1.4.0
 )
 
@@ -123,6 +124,5 @@ require (
 	k8s.io/klog/v2 v2.130.1 // indirect
 	k8s.io/utils v0.0.0-20240711033017-18e509b52bc8 // indirect
 	sigs.k8s.io/apiserver-network-proxy/konnectivity-client v0.30.3 // indirect
-	sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
 	sigs.k8s.io/structured-merge-diff/v4 v4.4.1 // indirect
 )

internal/bridge/installation_test.go

@@ -18,10 +18,10 @@ import (
 	corev1 "k8s.io/api/core/v1"
 	corev1apply "k8s.io/client-go/applyconfigurations/core/v1"
 	"sigs.k8s.io/controller-runtime/pkg/client"
-	"sigs.k8s.io/yaml"
 
 	"github.com/crunchydata/postgres-operator/internal/controller/runtime"
 	"github.com/crunchydata/postgres-operator/internal/testing/cmp"
+	"github.com/crunchydata/postgres-operator/internal/testing/require"
 )
 
 func TestExtractSecretContract(t *testing.T) {
@@ -136,7 +136,7 @@ func TestInstallationReconcile(t *testing.T) {
 			assert.Assert(t, cmp.Contains(applies[0], `"kind":"Secret"`))
 
 			var decoded corev1.Secret
-			assert.NilError(t, yaml.Unmarshal([]byte(applies[0]), &decoded))
+			require.UnmarshalInto(t, &decoded, applies[0])
 			assert.Assert(t, cmp.Contains(string(decoded.Data["bridge-token"]), `"id":"abc"`))
 			assert.Assert(t, cmp.Contains(string(decoded.Data["bridge-token"]), `"secret":"xyz"`))
 		})
@@ -230,7 +230,7 @@ func TestInstallationReconcile(t *testing.T) {
 				assert.Assert(t, cmp.Contains(applies[0], `"kind":"Secret"`))
 
 				var decoded corev1.Secret
-				assert.NilError(t, yaml.Unmarshal([]byte(applies[0]), &decoded))
+				require.UnmarshalInto(t, &decoded, applies[0])
 				assert.Assert(t, cmp.Contains(string(decoded.Data["bridge-token"]), `"id":"asdf"`))
 			})
 		}
@@ -326,7 +326,7 @@ func TestInstallationReconcile(t *testing.T) {
 			assert.Assert(t, cmp.Contains(applies[0], `"kind":"Secret"`))
 
 			var decoded corev1.Secret
-			assert.NilError(t, yaml.Unmarshal([]byte(applies[0]), &decoded))
+			require.UnmarshalInto(t, &decoded, applies[0])
 			assert.Assert(t, cmp.Contains(string(decoded.Data["bridge-token"]), `"id":"xyz"`))
 			assert.Assert(t, cmp.Contains(string(decoded.Data["bridge-token"]), `"secret":"def"`))
 		})
@@ -373,7 +373,7 @@ func TestInstallationReconcile(t *testing.T) {
 			assert.Assert(t, cmp.Contains(applies[0], `"kind":"Secret"`))
 
 			var decoded corev1.Secret
-			assert.NilError(t, yaml.Unmarshal([]byte(applies[0]), &decoded))
+			require.UnmarshalInto(t, &decoded, applies[0])
 			assert.Equal(t, len(decoded.Data["bridge-token"]), 0)
 
 			archived := string(decoded.Data["bridge-token--2020-10-28"])
@@ -463,7 +463,7 @@ func TestInstallationReconcile(t *testing.T) {
 				assert.Assert(t, cmp.Contains(applies[0], `"kind":"Secret"`))
 
 				var decoded corev1.Secret
-				assert.NilError(t, yaml.Unmarshal([]byte(applies[0]), &decoded))
+				require.UnmarshalInto(t, &decoded, applies[0])
 				assert.Assert(t, cmp.Contains(string(decoded.Data["bridge-token"]), `"id":"ddd"`))
 				assert.Assert(t, cmp.Contains(string(decoded.Data["bridge-token"]), `"secret":"fresh"`))
 			})

internal/collector/pgadmin_test.go

@@ -10,13 +10,13 @@ import (
 
 	"gotest.tools/v3/assert"
 	corev1 "k8s.io/api/core/v1"
-	"sigs.k8s.io/yaml"
 
 	"github.com/crunchydata/postgres-operator/internal/collector"
 	pgadmin "github.com/crunchydata/postgres-operator/internal/controller/standalone_pgadmin"
 	"github.com/crunchydata/postgres-operator/internal/feature"
 	"github.com/crunchydata/postgres-operator/internal/initialize"
 	"github.com/crunchydata/postgres-operator/internal/testing/cmp"
+	"github.com/crunchydata/postgres-operator/internal/testing/require"
 	"github.com/crunchydata/postgres-operator/pkg/apis/postgres-operator.crunchydata.com/v1beta1"
 )
 
@@ -125,7 +125,7 @@ collector.yaml: |
 		ctx := feature.NewContext(context.Background(), gate)
 
 		var spec v1beta1.InstrumentationSpec
-		assert.NilError(t, yaml.Unmarshal([]byte(`{
+		require.UnmarshalInto(t, &spec, `{
 			config: {
 				exporters: {
 					googlecloud: {
@@ -135,7 +135,7 @@ collector.yaml: |
 				},
 			},
 			logs: { exporters: [googlecloud] },
-		}`), &spec))
+		}`)
 
 		configmap := new(corev1.ConfigMap)
 		initialize.Map(&configmap.Data)

internal/config/config_test.go

@@ -9,8 +9,8 @@ import (
 	"testing"
 
 	"gotest.tools/v3/assert"
-	"sigs.k8s.io/yaml"
 
+	"github.com/crunchydata/postgres-operator/internal/testing/require"
 	"github.com/crunchydata/postgres-operator/pkg/apis/postgres-operator.crunchydata.com/v1beta1"
 )
 
@@ -54,7 +54,7 @@ func TestFetchKeyCommand(t *testing.T) {
 
 	t.Run("blank", func(t *testing.T) {
 		var spec1 v1beta1.PostgresClusterSpec
-		assert.NilError(t, yaml.Unmarshal([]byte(`{
+		require.UnmarshalInto(t, &spec1, `{
 			patroni: {
 				dynamicConfiguration: {
 					postgresql: {
@@ -64,23 +64,23 @@ func TestFetchKeyCommand(t *testing.T) {
 					},
 				},
 			},
-		}`), &spec1))
+		}`)
 		assert.Equal(t, "", FetchKeyCommand(&spec1))
 
 		var spec2 v1beta1.PostgresClusterSpec
-		assert.NilError(t, yaml.Unmarshal([]byte(`{
+		require.UnmarshalInto(t, &spec2, `{
 			config: {
 				parameters: {
 					encryption_key_command: "",
 				},
 			},
-		}`), &spec2))
+		}`)
 		assert.Equal(t, "", FetchKeyCommand(&spec2))
 	})
 
 	t.Run("exists", func(t *testing.T) {
 		var spec1 v1beta1.PostgresClusterSpec
-		assert.NilError(t, yaml.Unmarshal([]byte(`{
+		require.UnmarshalInto(t, &spec1, `{
 			patroni: {
 				dynamicConfiguration: {
 					postgresql: {
@@ -90,23 +90,23 @@ func TestFetchKeyCommand(t *testing.T) {
 					},
 				},
 			},
-		}`), &spec1))
+		}`)
 		assert.Equal(t, "echo mykey", FetchKeyCommand(&spec1))
 
 		var spec2 v1beta1.PostgresClusterSpec
-		assert.NilError(t, yaml.Unmarshal([]byte(`{
+		require.UnmarshalInto(t, &spec2, `{
 			config: {
 				parameters: {
 					encryption_key_command: "cat somefile",
 				},
 			},
-		}`), &spec2))
+		}`)
 		assert.Equal(t, "cat somefile", FetchKeyCommand(&spec2))
 	})
 
 	t.Run("config.parameters takes precedence", func(t *testing.T) {
 		var spec v1beta1.PostgresClusterSpec
-		assert.NilError(t, yaml.Unmarshal([]byte(`{
+		require.UnmarshalInto(t, &spec, `{
 			config: {
 				parameters: {
 					encryption_key_command: "cat somefile",
@@ -121,7 +121,7 @@ func TestFetchKeyCommand(t *testing.T) {
 					},
 				},
 			},
-		}`), &spec))
+		}`)
 		assert.Equal(t, "cat somefile", FetchKeyCommand(&spec))
 	})
 }
@@ -139,9 +139,9 @@ func TestPGAdminContainerImage(t *testing.T) {
 	t.Setenv("RELATED_IMAGE_PGADMIN", "env-var-pgadmin")
 	assert.Equal(t, PGAdminContainerImage(cluster), "env-var-pgadmin")
 
-	assert.NilError(t, yaml.Unmarshal([]byte(`{
+	require.UnmarshalInto(t, &cluster.Spec, `{
 		userInterface: { pgAdmin: { image: spec-image } },
-	}`), &cluster.Spec))
+	}`)
 	assert.Equal(t, PGAdminContainerImage(cluster), "spec-image")
 }
 
@@ -158,9 +158,9 @@ func TestPGBackRestContainerImage(t *testing.T) {
 	t.Setenv("RELATED_IMAGE_PGBACKREST", "env-var-pgbackrest")
 	assert.Equal(t, PGBackRestContainerImage(cluster), "env-var-pgbackrest")
 
-	assert.NilError(t, yaml.Unmarshal([]byte(`{
-		backups: { pgBackRest: { image: spec-image } },
-	}`), &cluster.Spec))
+	require.UnmarshalInto(t, &cluster.Spec, `{
+		backups: { pgbackrest: { image: spec-image } },
+	}`)
 	assert.Equal(t, PGBackRestContainerImage(cluster), "spec-image")
 }
 
@@ -177,9 +177,9 @@ func TestPGBouncerContainerImage(t *testing.T) {
 	t.Setenv("RELATED_IMAGE_PGBOUNCER", "env-var-pgbouncer")
 	assert.Equal(t, PGBouncerContainerImage(cluster), "env-var-pgbouncer")
 
-	assert.NilError(t, yaml.Unmarshal([]byte(`{
+	require.UnmarshalInto(t, &cluster.Spec, `{
 		proxy: { pgBouncer: { image: spec-image } },
-	}`), &cluster.Spec))
+	}`)
 	assert.Equal(t, PGBouncerContainerImage(cluster), "spec-image")
 }
 
@@ -196,9 +196,9 @@ func TestPGExporterContainerImage(t *testing.T) {
 	t.Setenv("RELATED_IMAGE_PGEXPORTER", "env-var-pgexporter")
 	assert.Equal(t, PGExporterContainerImage(cluster), "env-var-pgexporter")
 
-	assert.NilError(t, yaml.Unmarshal([]byte(`{
-		monitoring: { pgMonitor: { exporter: { image: spec-image } } },
-	}`), &cluster.Spec))
+	require.UnmarshalInto(t, &cluster.Spec, `{
+		monitoring: { pgmonitor: { exporter: { image: spec-image } } },
+	}`)
 	assert.Equal(t, PGExporterContainerImage(cluster), "spec-image")
 }
 
@@ -215,9 +215,9 @@ func TestStandalonePGAdminContainerImage(t *testing.T) {
 	t.Setenv("RELATED_IMAGE_STANDALONE_PGADMIN", "env-var-pgadmin")
 	assert.Equal(t, StandalonePGAdminContainerImage(pgadmin), "env-var-pgadmin")
 
-	assert.NilError(t, yaml.Unmarshal([]byte(`{
+	require.UnmarshalInto(t, &pgadmin.Spec, `{
 		image: spec-image
-	}`), &pgadmin.Spec))
+	}`)
 	assert.Equal(t, StandalonePGAdminContainerImage(pgadmin), "spec-image")
 }
 

internal/controller/pgupgrade/jobs_test.go

@@ -19,6 +19,7 @@ import (
 	"github.com/crunchydata/postgres-operator/internal/feature"
 	"github.com/crunchydata/postgres-operator/internal/initialize"
 	"github.com/crunchydata/postgres-operator/internal/testing/cmp"
+	"github.com/crunchydata/postgres-operator/internal/testing/require"
 	"github.com/crunchydata/postgres-operator/pkg/apis/postgres-operator.crunchydata.com/v1beta1"
 )
 
@@ -54,7 +55,7 @@ func TestLargestWholeCPU(t *testing.T) {
 	} {
 		t.Run(tt.Name, func(t *testing.T) {
 			var resources corev1.ResourceRequirements
-			assert.NilError(t, yaml.Unmarshal([]byte(tt.ResourcesYAML), &resources))
+			require.UnmarshalInto(t, &resources, tt.ResourcesYAML)
 			assert.Equal(t, tt.Result, largestWholeCPU(resources))
 		})
 	}
@@ -383,8 +384,7 @@ func TestPGUpgradeContainerImage(t *testing.T) {
 	t.Setenv("RELATED_IMAGE_PGUPGRADE", "env-var-pgbackrest")
 	assert.Equal(t, pgUpgradeContainerImage(upgrade), "env-var-pgbackrest")
 
-	assert.NilError(t, yaml.Unmarshal(
-		[]byte(`{ image: spec-image }`), &upgrade.Spec))
+	require.UnmarshalInto(t, &upgrade.Spec, `{ image: spec-image }`)
 	assert.Equal(t, pgUpgradeContainerImage(upgrade), "spec-image")
 }
 

internal/controller/postgrescluster/postgres_test.go

@@ -21,7 +21,6 @@ import (
 	"k8s.io/apimachinery/pkg/api/resource"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"sigs.k8s.io/controller-runtime/pkg/client"
-	"sigs.k8s.io/yaml"
 
 	"github.com/crunchydata/postgres-operator/internal/controller/runtime"
 	"github.com/crunchydata/postgres-operator/internal/feature"
@@ -198,9 +197,9 @@ func TestGeneratePostgresUserSecret(t *testing.T) {
 	})
 
 	t.Run("PgBouncer", func(t *testing.T) {
-		assert.NilError(t, yaml.Unmarshal([]byte(`{
+		require.UnmarshalInto(t, &cluster.Spec, `{
 			proxy: { pgBouncer: { port: 10220 } },
-		}`), &cluster.Spec))
+		}`)
 
 		secret, err := reconciler.generatePostgresUserSecret(cluster, spec, nil)
 		assert.NilError(t, err)
@@ -250,14 +249,14 @@ func TestReconcilePostgresVolumes(t *testing.T) {
 		t.Cleanup(func() { assert.Check(t, tClient.Delete(ctx, cluster)) })
 
 		spec := &v1beta1.PostgresInstanceSetSpec{}
-		assert.NilError(t, yaml.Unmarshal([]byte(`{
+		require.UnmarshalInto(t, spec, `{
 			name: "some-instance",
 			dataVolumeClaimSpec: {
 				accessModes: [ReadWriteOnce],
 				resources: { requests: { storage: 1Gi } },
 				storageClassName: "storage-class-for-data",
 			},
-		}`), spec))
+		}`)
 		instance := &appsv1.StatefulSet{ObjectMeta: naming.GenerateInstance(cluster, spec)}
 
 		pvc, err := reconciler.reconcilePostgresDataVolume(ctx, cluster, spec, instance, nil, nil)
@@ -290,14 +289,14 @@ volumeMode: Filesystem
 		t.Cleanup(func() { assert.Check(t, tClient.Delete(ctx, cluster)) })
 
 		spec := &v1beta1.PostgresInstanceSetSpec{}
-		assert.NilError(t, yaml.Unmarshal([]byte(`{
+		require.UnmarshalInto(t, spec, `{
 			name: "some-instance",
 			dataVolumeClaimSpec: {
 				accessModes: [ReadWriteOnce],
 				resources: { requests: { storage: 1Gi } },
 				storageClassName: "storage-class-for-data",
 			},
-		}`), spec))
+		}`)
 		instance := &appsv1.StatefulSet{ObjectMeta: naming.GenerateInstance(cluster, spec)}
 
 		recorder := events.NewRecorder(t, runtime.Scheme)
@@ -392,14 +391,14 @@ volumeMode: Filesystem
 		t.Cleanup(func() { assert.Check(t, tClient.Delete(ctx, cluster)) })
 
 		spec := &v1beta1.PostgresInstanceSetSpec{}
-		assert.NilError(t, yaml.Unmarshal([]byte(`{
+		require.UnmarshalInto(t, spec, `{
 			name: "some-instance",
 			dataVolumeClaimSpec: {
 				accessModes: [ReadWriteOnce],
 				resources: { requests: { storage: 1Gi } },
 				storageClassName: "storage-class-for-data",
 			},
-		}`), spec))
+		}`)
 		instance := &appsv1.StatefulSet{ObjectMeta: naming.GenerateInstance(cluster, spec)}
 
 		recorder := events.NewRecorder(t, runtime.Scheme)
@@ -455,14 +454,14 @@ volumeMode: Filesystem
 		t.Cleanup(func() { assert.Check(t, tClient.Delete(ctx, cluster)) })
 
 		spec := &v1beta1.PostgresInstanceSetSpec{}
-		assert.NilError(t, yaml.Unmarshal([]byte(`{
+		require.UnmarshalInto(t, spec, `{
 			name: "some-instance",
 			dataVolumeClaimSpec: {
 				accessModes: [ReadWriteOnce],
 				resources: { requests: { storage: 1Gi } },
 				storageClassName: "storage-class-for-data",
 			},
-		}`), spec))
+		}`)
 		instance := &appsv1.StatefulSet{ObjectMeta: naming.GenerateInstance(cluster, spec)}
 
 		observed := &Instance{}
@@ -475,13 +474,13 @@ volumeMode: Filesystem
 
 		t.Run("Specified", func(t *testing.T) {
 			spec := spec.DeepCopy()
-			assert.NilError(t, yaml.Unmarshal([]byte(`{
+			require.UnmarshalInto(t, spec, `{
 				walVolumeClaimSpec: {
 					accessModes: [ReadWriteMany],
 					resources: { requests: { storage: 2Gi } },
 					storageClassName: "storage-class-for-wal",
 				},
-			}`), spec))
+			}`)
 
 			pvc, err := reconciler.reconcilePostgresWALVolume(ctx, cluster, spec, instance, observed, nil)
 			assert.NilError(t, err)