Add a Comparison for YAML that contains a string

Author: cbandy

internal/controller/pgupgrade/jobs_test.go

@@ -150,8 +150,7 @@ status: {}
 	`))
 
 	tdeJob := reconciler.generateUpgradeJob(ctx, upgrade, startup, "echo testKey")
-	b, _ := yaml.Marshal(tdeJob)
-	assert.Assert(t, strings.Contains(string(b),
+	assert.Assert(t, cmp.MarshalContains(tdeJob,
 		`/usr/pgsql-"${new_version}"/bin/initdb -k -D /pgdata/pg"${new_version}" --encryption-key-command "echo testKey"`))
 }
 

internal/pgbackrest/config_test.go

@@ -13,13 +13,12 @@ import (
 	"testing"
 
 	"gotest.tools/v3/assert"
-	"gotest.tools/v3/assert/cmp"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/resource"
-	"sigs.k8s.io/yaml"
 
 	"github.com/crunchydata/postgres-operator/internal/initialize"
 	"github.com/crunchydata/postgres-operator/internal/naming"
+	"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"
 )
@@ -213,13 +212,13 @@ pg1-socket-path = /tmp/postgres
 			[]string{"some-instance"})
 
 		assert.Assert(t,
-			strings.Contains(configmap.Data["pgbackrest_instance.conf"],
+			cmp.Contains(configmap.Data["pgbackrest_instance.conf"],
 				"archive-header-check = n"))
 		assert.Assert(t,
-			strings.Contains(configmap.Data["pgbackrest_instance.conf"],
+			cmp.Contains(configmap.Data["pgbackrest_instance.conf"],
 				"page-header-check = n"))
 		assert.Assert(t,
-			strings.Contains(configmap.Data["pgbackrest_instance.conf"],
+			cmp.Contains(configmap.Data["pgbackrest_instance.conf"],
 				"pg-version-force"))
 
 		cluster.Spec.Backups.PGBackRest.Repos = []v1beta1.PGBackRestRepo{
@@ -234,13 +233,13 @@ pg1-socket-path = /tmp/postgres
 			[]string{"some-instance"})
 
 		assert.Assert(t,
-			strings.Contains(configmap.Data["pgbackrest_repo.conf"],
+			cmp.Contains(configmap.Data["pgbackrest_repo.conf"],
 				"archive-header-check = n"))
 		assert.Assert(t,
-			strings.Contains(configmap.Data["pgbackrest_repo.conf"],
+			cmp.Contains(configmap.Data["pgbackrest_repo.conf"],
 				"page-header-check = n"))
 		assert.Assert(t,
-			strings.Contains(configmap.Data["pgbackrest_repo.conf"],
+			cmp.Contains(configmap.Data["pgbackrest_repo.conf"],
 				"pg-version-force"))
 	})
 }
@@ -323,10 +322,8 @@ func TestReloadCommand(t *testing.T) {
 }
 
 func TestReloadCommandPrettyYAML(t *testing.T) {
-	b, err := yaml.Marshal(reloadCommand("any"))
-	assert.NilError(t, err)
-	assert.Assert(t, strings.Contains(string(b), "\n- |"),
-		"expected literal block scalar, got:\n%s", b)
+	assert.Assert(t, cmp.MarshalContains(reloadCommand("any"), "\n- |"),
+		"expected literal block scalar")
 }
 
 func TestRestoreCommand(t *testing.T) {
@@ -351,19 +348,21 @@ func TestRestoreCommand(t *testing.T) {
 }
 
 func TestRestoreCommandPrettyYAML(t *testing.T) {
-	b, err := yaml.Marshal(RestoreCommand("/dir", "try", "", nil, "--options"))
-
-	assert.NilError(t, err)
-	assert.Assert(t, strings.Contains(string(b), "\n- |"),
-		"expected literal block scalar, got:\n%s", b)
+	assert.Assert(t,
+		cmp.MarshalContains(
+			RestoreCommand("/dir", "try", "", nil, "--options"),
+			"\n- |",
+		),
+		"expected literal block scalar")
 }
 
 func TestRestoreCommandTDE(t *testing.T) {
-	b, err := yaml.Marshal(RestoreCommand("/dir", "try", "echo testValue", nil, "--options"))
-
-	assert.NilError(t, err)
-	assert.Assert(t, strings.Contains(string(b), "encryption_key_command = 'echo testValue'"),
-		"expected encryption_key_command setting, got:\n%s", b)
+	assert.Assert(t,
+		cmp.MarshalContains(
+			RestoreCommand("/dir", "try", "echo testValue", nil, "--options"),
+			"encryption_key_command = 'echo testValue'",
+		),
+		"expected encryption_key_command setting")
 }
 
 func TestDedicatedSnapshotVolumeRestoreCommand(t *testing.T) {
@@ -388,11 +387,12 @@ func TestDedicatedSnapshotVolumeRestoreCommand(t *testing.T) {
 }
 
 func TestDedicatedSnapshotVolumeRestoreCommandPrettyYAML(t *testing.T) {
-	b, err := yaml.Marshal(DedicatedSnapshotVolumeRestoreCommand("/dir", "--options"))
-
-	assert.NilError(t, err)
-	assert.Assert(t, strings.Contains(string(b), "\n- |"),
-		"expected literal block scalar, got:\n%s", b)
+	assert.Assert(t,
+		cmp.MarshalContains(
+			DedicatedSnapshotVolumeRestoreCommand("/dir", "--options"),
+			"\n- |",
+		),
+		"expected literal block scalar")
 }
 
 func TestServerConfig(t *testing.T) {

internal/testing/cmp/cmp.go

@@ -50,6 +50,15 @@ func DeepEqual(x, y any, opts ...gocmp.Option) Comparison {
 	return gotest.DeepEqual(x, y, opts...)
 }
 
+// MarshalContains converts actual to YAML and succeeds if expected is in the result.
+func MarshalContains(actual any, expected string) Comparison {
+	b, err := yaml.Marshal(actual)
+	if err != nil {
+		return func() gotest.Result { return gotest.ResultFromError(err) }
+	}
+	return Contains(string(b), expected)
+}
+
 // MarshalMatches converts actual to YAML and compares that to expected.
 func MarshalMatches(actual any, expected string) Comparison {
 	b, err := yaml.Marshal(actual)