Add tests for using ImageVolumeSource in AdditionalVolume feature.

Author: dsessler7

internal/testing/validation/postgrescluster_test.go

@@ -9,7 +9,10 @@ import (
 	"testing"
 
 	"gotest.tools/v3/assert"
+	apierrors "k8s.io/apimachinery/pkg/api/errors"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"sigs.k8s.io/controller-runtime/pkg/client"
+	"sigs.k8s.io/yaml"
 
 	"github.com/crunchydata/postgres-operator/internal/testing/require"
 	v1 "github.com/crunchydata/postgres-operator/pkg/apis/postgres-operator.crunchydata.com/v1"
@@ -103,3 +106,141 @@ func TestPostgresUserInterfaceAcrossVersions(t *testing.T) {
 			"userInterface not available in v1")
 	})
 }
+
+func TestAdditionalVolumes(t *testing.T) {
+	ctx := context.Background()
+	cc := require.KubernetesAtLeast(t, "1.30")
+	t.Parallel()
+
+	namespace := require.Namespace(t, cc)
+	base := v1beta1.NewPostgresCluster()
+
+	base.Namespace = namespace.Name
+	base.Name = "image-volume-source-test"
+	// required fields
+	require.UnmarshalInto(t, &base.Spec, `{
+		postgresVersion: 16,
+		instances: [{
+			dataVolumeClaimSpec: {
+				accessModes: [ReadWriteOnce],
+				resources: { requests: { storage: 1Mi } },
+			},
+		}],
+	}`)
+
+	assert.NilError(t, cc.Create(ctx, base.DeepCopy(), client.DryRunAll),
+		"expected this base to be valid")
+
+	var unstructuredBase unstructured.Unstructured
+	require.UnmarshalInto(t, &unstructuredBase, require.Value(yaml.Marshal(base)))
+
+	t.Run("Cannot set both image and claimName", func(t *testing.T) {
+		tmp := unstructuredBase.DeepCopy()
+
+		require.UnmarshalIntoField(t, tmp, `[{
+				dataVolumeClaimSpec: {
+					accessModes: [ReadWriteOnce],
+					resources: { requests: { storage: 1Mi } },
+				},
+				volumes: {
+					additional: [{
+						name: "test",
+						claimName: "pvc-claim",
+						image: {
+							reference: "test-image",
+							pullPolicy: Always
+						},
+						readOnly: true
+					}]
+				}
+			}]`, "spec", "instances")
+		err := cc.Create(ctx, tmp.DeepCopy(), client.DryRunAll)
+		assert.Assert(t, apierrors.IsInvalid(err))
+		assert.ErrorContains(t, err, "you must set only one of image or claimName")
+	})
+
+	t.Run("Cannot set readOnly to false when using image volume", func(t *testing.T) {
+		tmp := unstructuredBase.DeepCopy()
+
+		require.UnmarshalIntoField(t, tmp, `[{
+				dataVolumeClaimSpec: {
+					accessModes: [ReadWriteOnce],
+					resources: { requests: { storage: 1Mi } },
+				},
+				volumes: {
+					additional: [{
+						name: "test",
+						image: {
+							reference: "test-image",
+							pullPolicy: Always
+						},
+						readOnly: false
+					}]
+				}
+			}]`, "spec", "instances")
+		err := cc.Create(ctx, tmp.DeepCopy(), client.DryRunAll)
+		assert.Assert(t, apierrors.IsInvalid(err))
+		assert.ErrorContains(t, err, "readOnly cannot be set false when using an ImageVolumeSource")
+	})
+
+	t.Run("Reference must be set when using image volume", func(t *testing.T) {
+		tmp := unstructuredBase.DeepCopy()
+
+		require.UnmarshalIntoField(t, tmp, `[{
+				dataVolumeClaimSpec: {
+					accessModes: [ReadWriteOnce],
+					resources: { requests: { storage: 1Mi } },
+				},
+				volumes: {
+					additional: [{
+						name: "test",
+						image: {
+							pullPolicy: Always
+						},
+						readOnly: true
+					}]
+				}
+			}]`, "spec", "instances")
+		err := cc.Create(ctx, tmp.DeepCopy(), client.DryRunAll)
+		assert.Assert(t, apierrors.IsInvalid(err))
+		assert.ErrorContains(t, err, "if using an ImageVolumeSource, you must set a reference")
+	})
+
+	t.Run("ReadOnly can be omitted or set true when using image volume", func(t *testing.T) {
+		tmp := unstructuredBase.DeepCopy()
+
+		require.UnmarshalIntoField(t, tmp, `[{
+				name: "test-instance",
+				dataVolumeClaimSpec: {
+					accessModes: [ReadWriteOnce],
+					resources: { requests: { storage: 1Mi } },
+				},
+				volumes: {
+					additional: [{
+						name: "test",
+						image: {
+							reference: "test-image",
+							pullPolicy: Always
+						},
+					}]
+				}
+			}, {
+				name: "another-instance",
+				dataVolumeClaimSpec: {
+					accessModes: [ReadWriteOnce],
+					resources: { requests: { storage: 1Mi } },
+				},
+				volumes: {
+					additional: [{
+						name: "another",
+						image: {
+							reference: "another-image",
+							pullPolicy: Always
+						},
+						readOnly: true
+					}]
+				}
+			}]`, "spec", "instances")
+		assert.NilError(t, cc.Create(ctx, tmp.DeepCopy(), client.DryRunAll))
+	})
+}

internal/util/volumes_test.go

@@ -207,6 +207,60 @@ func TestAddAdditionalVolumesAndMounts(t *testing.T) {
     claimName: required
     readOnly: true`,
 		expectedMissing: []string{},
+	}, {
+		tcName: "image volumes - readOnly overridden true",
+		additionalVolumes: []v1beta1.AdditionalVolume{{
+			Containers: []string{"database"},
+			Image: &corev1.ImageVolumeSource{
+				Reference:  "some-image-name",
+				PullPolicy: corev1.PullAlways,
+			},
+			Name:     "required",
+			ReadOnly: true,
+		}, {
+			Image: &corev1.ImageVolumeSource{
+				Reference:  "another-image-name",
+				PullPolicy: corev1.PullAlways,
+			},
+			Name:     "other",
+			ReadOnly: false,
+		}},
+		expectedContainers: `- name: database
+  resources: {}
+  volumeMounts:
+  - mountPath: /volumes/required
+    name: volumes-required
+    readOnly: true
+  - mountPath: /volumes/other
+    name: volumes-other
+    readOnly: true
+- name: other
+  resources: {}
+  volumeMounts:
+  - mountPath: /volumes/other
+    name: volumes-other
+    readOnly: true`,
+		expectedInitContainers: `- name: startup
+  resources: {}
+  volumeMounts:
+  - mountPath: /volumes/other
+    name: volumes-other
+    readOnly: true
+- name: config
+  resources: {}
+  volumeMounts:
+  - mountPath: /volumes/other
+    name: volumes-other
+    readOnly: true`,
+		expectedVolumes: `- image:
+    pullPolicy: Always
+    reference: some-image-name
+  name: volumes-required
+- image:
+    pullPolicy: Always
+    reference: another-image-name
+  name: volumes-other`,
+		expectedMissing: []string{},
 	}}
 
 	for _, tc := range testCases {

pkg/apis/postgres-operator.crunchydata.com/v1beta1/shared_types_test.go

@@ -45,6 +45,25 @@ func TestAdditionalVolumeAsVolume(t *testing.T) {
 			assert.DeepEqual(t, out, expected)
 		})
 	})
+
+	t.Run("Image", func(t *testing.T) {
+		in := v1beta1.AdditionalVolume{Image: &corev1.ImageVolumeSource{
+			Reference:  "jkl;",
+			PullPolicy: corev1.PullAlways,
+		}}
+		out := in.AsVolume("asdf")
+
+		var expected corev1.Volume
+		assert.NilError(t, yaml.Unmarshal([]byte(`{
+			name: asdf,
+			image: {
+				reference: jkl;,
+				pullPolicy: Always,
+			},
+		}`), &expected))
+
+		assert.DeepEqual(t, out, expected)
+	})
 }
 
 func TestDurationAsDuration(t *testing.T) {