Moved StatefulSet Merging functions into merge package. (#296)

Author: chatton

pkg/kube/container/container_util.go

@@ -0,0 +1,14 @@
+package container
+
+import corev1 "k8s.io/api/core/v1"
+
+// GetByName returns a container with the given name from the slice of containers.
+// nil is returned if the container does not exist.
+func GetByName(name string, containers []corev1.Container) *corev1.Container {
+	for i, c := range containers {
+		if c.Name == name {
+			return &containers[i]
+		}
+	}
+	return nil
+}

pkg/kube/podtemplatespec/podspec_template.go

@@ -40,7 +40,7 @@ func WithContainer(name string, containerfunc func(*corev1.Container)) Modificat
 		idx := findIndexByName(name, podTemplateSpec.Spec.Containers)
 		if idx == notFound {
 			// if we are attempting to modify a container that does not exist, we will add a new one
-			podTemplateSpec.Spec.Containers = append(podTemplateSpec.Spec.Containers, corev1.Container{})
+			podTemplateSpec.Spec.Containers = append(podTemplateSpec.Spec.Containers, corev1.Container{Name: name})
 			idx = len(podTemplateSpec.Spec.Containers) - 1
 		}
 		c := &podTemplateSpec.Spec.Containers[idx]
@@ -68,7 +68,7 @@ func WithInitContainer(name string, containerfunc func(*corev1.Container)) Modif
 		idx := findIndexByName(name, podTemplateSpec.Spec.InitContainers)
 		if idx == notFound {
 			// if we are attempting to modify a container that does not exist, we will add a new one
-			podTemplateSpec.Spec.InitContainers = append(podTemplateSpec.Spec.InitContainers, corev1.Container{})
+			podTemplateSpec.Spec.InitContainers = append(podTemplateSpec.Spec.InitContainers, corev1.Container{Name: name})
 			idx = len(podTemplateSpec.Spec.InitContainers) - 1
 		}
 		c := &podTemplateSpec.Spec.InitContainers[idx]

pkg/kube/podtemplatespec/podspec_template_test.go

@@ -351,9 +351,10 @@ func getDefaultPodSpec() corev1.PodTemplateSpec {
 
 	return corev1.PodTemplateSpec{
 		ObjectMeta: metav1.ObjectMeta{
-			Name:      "my-default-name",
-			Namespace: "my-default-namespace",
-			Labels:    map[string]string{"app": "operator"},
+			Name:        "my-default-name",
+			Namespace:   "my-default-namespace",
+			Labels:      map[string]string{"app": "operator"},
+			Annotations: map[string]string{},
 		},
 		Spec: corev1.PodSpec{
 			NodeSelector: map[string]string{
@@ -376,7 +377,8 @@ func getCustomPodSpec() corev1.PodTemplateSpec {
 
 	return corev1.PodTemplateSpec{
 		ObjectMeta: metav1.ObjectMeta{
-			Labels: map[string]string{"custom": "some"},
+			Labels:      map[string]string{"custom": "some"},
+			Annotations: map[string]string{},
 		},
 		Spec: corev1.PodSpec{
 			NodeSelector: map[string]string{

pkg/kube/statefulset/merge_spec.go

@@ -1,6 +1,7 @@
 package statefulset
 
 import (
+	"github.com/mongodb/mongodb-kubernetes-operator/pkg/util/merge"
 	"reflect"
 	"testing"
 
@@ -50,7 +51,7 @@ func TestGetLabelSelectorRequirementByKey(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			if got := getLabelSelectorRequirementByKey(tt.args.labelSelectorRequirements, tt.args.key); !reflect.DeepEqual(got, tt.want) {
+			if got := merge.LabelSelectorRequirementByKey(tt.args.labelSelectorRequirements, tt.args.key); !reflect.DeepEqual(got, tt.want) {
 				t.Errorf("getLabelSelectorRequirementByKey() = %v, want %v", got, tt.want)
 			}
 		})
@@ -115,7 +116,7 @@ func TestMergeSpec(t *testing.T) {
 		}),
 	)
 
-	mergedSpec := MergeSpecs(original.Spec, override.Spec)
+	mergedSpec := merge.StatefulSetSpecs(original.Spec, override.Spec)
 
 	t.Run("Primitive fields of spec have been merged correctly", func(t *testing.T) {
 		assert.Equal(t, "override-svc-name", mergedSpec.ServiceName)

pkg/kube/statefulset/merge_spec_test.go …be/statefulset/merge_statefulset_test.gopkg/kube/statefulset/merge_spec_test.go renamed to pkg/kube/statefulset/merge_statefulset_test.go pkg/kube/statefulset/merge_spec_test.go renamed to pkg/kube/statefulset/merge_statefulset_test.go

@@ -78,6 +78,7 @@ type VolumeMountData struct {
 	Name      string
 	MountPath string
 	Volume    corev1.Volume
+	ReadOnly  bool
 }
 
 func CreateVolumeFromConfigMap(name, sourceName string) corev1.Volume {
@@ -286,3 +287,12 @@ func findVolumeClaimIndexByName(name string, pvcs []corev1.PersistentVolumeClaim
 	}
 	return notFound
 }
+
+func VolumeMountWithNameExists(mounts []corev1.VolumeMount, volumeName string) bool {
+	for _, mount := range mounts {
+		if mount.Name == volumeName {
+			return true
+		}
+	}
+	return false
+}

pkg/kube/statefulset/statefulset.go

@@ -107,8 +107,8 @@ func (s *Builder) AddVolumes(volumes []corev1.Volume) *Builder {
 	return s
 }
 
-// getContainerIndexByName returns the index of the container with containerName
-func (s Builder) getContainerIndexByName(containerName string) (int, error) {
+// GetContainerIndexByName returns the index of the container with containerName.
+func (s Builder) GetContainerIndexByName(containerName string) (int, error) {
 	for i, c := range s.podTemplateSpec.Spec.Containers {
 		if c.Name == containerName {
 			return i, nil
@@ -117,23 +117,26 @@ func (s Builder) getContainerIndexByName(containerName string) (int, error) {
 	return -1, errors.Errorf("no container with name [%s] found", containerName)
 }
 
-func (s *Builder) AddVolumeAndMount(containerName string, volumeMountData VolumeMountData) *Builder {
+func (s *Builder) AddVolumeAndMount(volumeMountData VolumeMountData, containerNames ...string) *Builder {
 	s.AddVolume(volumeMountData.Volume)
-	s.AddVolumeMount(containerName,
-		corev1.VolumeMount{
-			Name:      volumeMountData.Name,
-			ReadOnly:  true,
-			MountPath: volumeMountData.MountPath,
-		},
-	)
+	for _, containerName := range containerNames {
+		s.AddVolumeMount(
+			containerName,
+			corev1.VolumeMount{
+				Name:      volumeMountData.Name,
+				ReadOnly:  volumeMountData.ReadOnly,
+				MountPath: volumeMountData.MountPath,
+			},
+		)
+	}
 	return s
 }
 
 func (s Builder) buildPodTemplateSpec() (corev1.PodTemplateSpec, error) {
 	podTemplateSpec := s.podTemplateSpec.DeepCopy()
 	var errs error
 	for containerName, volumeMounts := range s.volumeMountsPerContainer {
-		idx, err := s.getContainerIndexByName(containerName)
+		idx, err := s.GetContainerIndexByName(containerName)
 		if err != nil {
 			errs = multierror.Append(errs, err)
 			// other containers may have valid mounts
@@ -152,7 +155,7 @@ func (s Builder) buildPodTemplateSpec() (corev1.PodTemplateSpec, error) {
 	}
 
 	for containerName, overrideReadinessProbe := range s.readinessProbePerContainer {
-		idx, err := s.getContainerIndexByName(containerName)
+		idx, err := s.GetContainerIndexByName(containerName)
 		if err != nil {
 			errs = multierror.Append(errs, err)
 			continue

pkg/kube/statefulset/statefulset_builder.go

@@ -29,25 +29,25 @@ func TestGetContainerIndexByName(t *testing.T) {
 	}
 
 	stsBuilder := defaultStatefulSetBuilder().SetPodTemplateSpec(podTemplateWithContainers(containers))
-	idx, err := stsBuilder.getContainerIndexByName("container-0")
+	idx, err := stsBuilder.GetContainerIndexByName("container-0")
 
 	assert.NoError(t, err)
 	assert.NotEqual(t, -1, idx)
 	assert.Equal(t, 0, idx)
 
-	idx, err = stsBuilder.getContainerIndexByName("container-1")
+	idx, err = stsBuilder.GetContainerIndexByName("container-1")
 
 	assert.NoError(t, err)
 	assert.NotEqual(t, -1, idx)
 	assert.Equal(t, 1, idx)
 
-	idx, err = stsBuilder.getContainerIndexByName("container-2")
+	idx, err = stsBuilder.GetContainerIndexByName("container-2")
 
 	assert.NoError(t, err)
 	assert.NotEqual(t, -1, idx)
 	assert.Equal(t, 2, idx)
 
-	idx, err = stsBuilder.getContainerIndexByName("doesnt-exist")
+	idx, err = stsBuilder.GetContainerIndexByName("doesnt-exist")
 
 	assert.Error(t, err)
 	assert.Equal(t, -1, idx)
@@ -63,7 +63,7 @@ func TestAddVolumeAndMount(t *testing.T) {
 		Volume:    CreateVolumeFromConfigMap("mount-name", "config-map"),
 	}
 
-	stsBuilder = defaultStatefulSetBuilder().SetPodTemplateSpec(podTemplateWithContainers([]corev1.Container{{Name: "container-name"}})).AddVolumeAndMount("container-name", vmd)
+	stsBuilder = defaultStatefulSetBuilder().SetPodTemplateSpec(podTemplateWithContainers([]corev1.Container{{Name: "container-name"}})).AddVolumeAndMount(vmd, "container-name")
 	sts, err = stsBuilder.Build()
 
 	// assert container was correctly updated with the volumes
@@ -78,7 +78,7 @@ func TestAddVolumeAndMount(t *testing.T) {
 	assert.NotNil(t, sts.Spec.Template.Spec.Volumes[0].VolumeSource.ConfigMap, "volume should have been configured from a config map source")
 	assert.Nil(t, sts.Spec.Template.Spec.Volumes[0].VolumeSource.Secret, "volume should not have been configured from a secret source")
 
-	stsBuilder = defaultStatefulSetBuilder().SetPodTemplateSpec(podTemplateWithContainers([]corev1.Container{{Name: "container-0"}, {Name: "container-1"}})).AddVolumeAndMount("container-0", vmd)
+	stsBuilder = defaultStatefulSetBuilder().SetPodTemplateSpec(podTemplateWithContainers([]corev1.Container{{Name: "container-0"}, {Name: "container-1"}})).AddVolumeAndMount(vmd, "container-0")
 	sts, err = stsBuilder.Build()
 
 	assert.NoError(t, err, "volume should successfully mount when the container exists")
@@ -90,7 +90,7 @@ func TestAddVolumeAndMount(t *testing.T) {
 	}
 
 	// add a 2nd container to previously defined stsBuilder
-	sts, err = stsBuilder.AddVolumeAndMount("container-1", secretVmd).Build()
+	sts, err = stsBuilder.AddVolumeAndMount(secretVmd, "container-1").Build()
 
 	assert.NoError(t, err, "volume should successfully mount when the container exists")
 	assert.Len(t, sts.Spec.Template.Spec.Containers[1].VolumeMounts, 1, "volume mount should have been added to the container in the stateful set")

pkg/kube/statefulset/statefulset_test.go

@@ -8,6 +8,7 @@ import (
 func PodTemplateSpecs(original, override corev1.PodTemplateSpec) corev1.PodTemplateSpec {
 	merged := original
 
+	merged.Annotations = StringToStringMap(original.Annotations, override.Annotations)
 	merged.Labels = StringToStringMap(original.Labels, override.Labels)
 	merged.Spec.Volumes = Volumes(original.Spec.Volumes, override.Spec.Volumes)
 	merged.Spec.Containers = Containers(original.Spec.Containers, override.Spec.Containers)