[envTest] Add AssertVolumeMountPathExists function

We recently introduced extraMounts envTests in several operators, and
they rely on the common helpers/volume Assert function to check if the
resulting deployment has the right Volume/VolumeMountPath.
This patch introduces a new version of AssertVolumeMountExists to either
assert a subPath or a regular MountPath (or both!) exists.

Jira: https://issues.redhat.com/browse/OSPRH-15839

Signed-off-by: Francesco Pantano <[email protected]>

Author: fmount

modules/common/test/helpers/volumes.go

@@ -50,3 +50,69 @@ func (tc *TestHelper) AssertVolumeMountExists(name string, subPath string, volum
 
 	return exist
 }
+
+// AssertVolumeMountPathExists - Returns true if mountPath and subPath exist in
+// the volumeMounts array.
+// Assumptions:
+//   - an empty []corev1.VolumeMount results in a failure
+//   - an empty "name" results in a failure
+//   - when no mountPath and no subPath are passed (empty string) it results in a
+//     failure
+//   - if no mountPath is provided it is skipped during the evaluation and
+//   - if no subPath is provided it is skipped during the evaluation
+//   - when both mountPath and subPath are passed, it returns true only when
+//     both are found in the volumeMount array
+func (tc *TestHelper) AssertVolumeMountPathExists(
+	name string,
+	mountPath string,
+	subPath string,
+	volumeMounts []corev1.VolumeMount,
+) bool {
+	// Early return for an empty volumeMounts list
+	if len(volumeMounts) == 0 {
+		gomega.Expect(false).To(gomega.BeTrue(), "Volume mounts list is empty")
+		return false
+	}
+
+	// Early return for an empty VolumeMount name
+	if name == "" {
+		gomega.Expect(false).To(gomega.BeTrue(), "Volume name cannot be empty")
+		return false
+	}
+
+	// Early return if both mountPath and subPath are empty strings
+	if mountPath == "" && subPath == "" {
+		gomega.Expect(false).To(gomega.BeTrue(), "Both mountPath and subPath are empty")
+		return false
+	}
+
+	// init two bool variables to represent the status of mountPath and
+	// subPath check: when the function reaches this point we have at least an
+	// input that should be checked
+	mountPathExists := mountPath == ""
+	subPathExists := subPath == ""
+
+	for _, v := range volumeMounts {
+		// only process the current volumeMount if the name
+		// mathes
+		if v.Name == name {
+			// mountPath is passed as input and it has not
+			// been evaluated
+			if v.MountPath == mountPath && !mountPathExists {
+				mountPathExists = true
+			}
+			// subPath is passed as input and it has not
+			// been evaluated
+			if v.SubPath == subPath && !subPathExists {
+				subPathExists = true
+			}
+		}
+		// check if we can break early and optimize the
+		// iterations
+		if mountPathExists && subPathExists {
+			break
+		}
+	}
+	gomega.Expect(mountPathExists && subPathExists).To(gomega.BeTrue())
+	return (mountPathExists && subPathExists)
+}