e2e: add VolumeGroupSnapshot tests and examples for NVMe-oF

Add VolumeGroupSnapshot e2e test type for NVMe-oF and example YAMLs
for VolumeGroupSnapshotClass and VolumeGroupSnapshot resources.

Signed-off-by: Praveen M <m.praveen@ibm.com>

Author: iPraveenParihar

e2e/nvmeof.go

@@ -498,5 +498,18 @@ var _ = ginkgo.Describe("nvmeof", func() {
 			validateRBDImageCount(f, 0, nvmeofPool)
 			validateOmapCount(f, 0, rbdType, nvmeofPool, volumesType)
 		})
+
+		ginkgo.It("test volumeGroupSnapshot", func() {
+			scName := nvmeofStorageClass
+			snapshotter, err := newNVMeOFVolumeGroupSnapshot(
+				f, f.UniqueName, scName, false, deployTimeout, 3, 0)
+			if err != nil {
+				logAndFail("failed to create volumeGroupSnapshot Base: %v", err)
+			}
+			err = snapshotter.TestVolumeGroupSnapshot()
+			if err != nil {
+				logAndFail("failed to test volumeGroupSnapshot: %v", err)
+			}
+		})
 	})
 })

e2e/volumegroupsnapshot.go

@@ -322,3 +322,86 @@ func (rvgs *rbdVolumeGroupSnapshot) ValidateResourcesForDelete() error {
 
 	return nil
 }
+
+type nvmeofVolumeGroupSnapshot struct {
+	*volumeGroupSnapshotterBase
+}
+
+var _ VolumeGroupSnapshotter = &nvmeofVolumeGroupSnapshot{}
+
+func newNVMeOFVolumeGroupSnapshot(f *framework.Framework, namespace,
+	storageClass string,
+	blockPVC bool,
+	timeout, totalPVCCount, additionalVGSnapshotCount int,
+) (VolumeGroupSnapshotter, error) {
+	base, err := newVolumeGroupSnapshotBase(f, namespace, storageClass, blockPVC,
+		timeout, totalPVCCount, additionalVGSnapshotCount)
+	if err != nil {
+		return nil, fmt.Errorf("failed to create volumeGroupSnapshotterBase: %w", err)
+	}
+
+	return &nvmeofVolumeGroupSnapshot{
+		volumeGroupSnapshotterBase: base,
+	}, nil
+}
+
+func (nvgs *nvmeofVolumeGroupSnapshot) TestVolumeGroupSnapshot() error {
+	return nvgs.volumeGroupSnapshotterBase.testVolumeGroupSnapshot(nvgs)
+}
+
+func (nvgs *nvmeofVolumeGroupSnapshot) GetVolumeGroupSnapshotClass() (
+	*groupsnapapi.VolumeGroupSnapshotClass, error,
+) {
+	vgscPath := fmt.Sprintf("%s/%s", nvmeofExamplePath, "groupsnapshotclass.yaml")
+	vgsc := &groupsnapapi.VolumeGroupSnapshotClass{}
+	err := unmarshal(vgscPath, vgsc)
+	if err != nil {
+		return nil, fmt.Errorf("failed to unmarshal VolumeGroupSnapshotClass: %w", err)
+	}
+
+	vgsc.Parameters["csi.storage.k8s.io/group-snapshotter-secret-namespace"] = cephCSINamespace
+	vgsc.Parameters["csi.storage.k8s.io/group-snapshotter-secret-name"] = nvmeofProvisionerSecretName
+	vgsc.Parameters["pool"] = nvmeofPool
+
+	fsID, err := getClusterID(nvgs.framework)
+	if err != nil {
+		return nil, fmt.Errorf("failed to get clusterID: %w", err)
+	}
+	vgsc.Parameters["clusterID"] = fsID
+
+	return vgsc, nil
+}
+
+func (nvgs *nvmeofVolumeGroupSnapshot) ValidateResourcesForCreate(
+	vgs *groupsnapapi.VolumeGroupSnapshot,
+) error {
+	vgsc, err := nvgs.groupclient.VolumeGroupSnapshotContents().Get(
+		context.TODO(),
+		*vgs.Status.BoundVolumeGroupSnapshotContentName,
+		metav1.GetOptions{})
+	if err != nil {
+		return fmt.Errorf("failed to get VolumeGroupSnapshotContent: %w", err)
+	}
+
+	sourcePVCCount := len(vgsc.Status.VolumeSnapshotInfoList)
+	clonePVCCount := len(vgsc.Status.VolumeSnapshotInfoList)
+	totalPVCCount := sourcePVCCount + clonePVCCount
+
+	validateOmapCount(nvgs.framework, totalPVCCount, rbdType, nvmeofPool, volumesType)
+
+	return nil
+}
+
+func (nvgs *nvmeofVolumeGroupSnapshot) ValidateResourcesForDelete() error {
+	validateOmapCount(nvgs.framework, 0, rbdType, nvmeofPool, volumesType)
+	validateOmapCount(nvgs.framework, 0, rbdType, nvmeofPool, snapsType)
+	validateOmapCount(nvgs.framework, 0, rbdType, nvmeofPool, groupSnapsType)
+	validateRBDImageCount(nvgs.framework, 0, nvmeofPool)
+
+	err := waitToRemoveImagesFromTrash(nvgs.framework, nvmeofPool, deployTimeout)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

examples/nvmeof/groupsnapshot.yaml

@@ -0,0 +1,13 @@
+---
+apiVersion: groupsnapshot.storage.k8s.io/v1
+kind: VolumeGroupSnapshot
+metadata:
+  name: new-groupsnapshot-demo-1
+spec:
+  source:
+    selector:
+      matchLabels:
+        # The PVCs will need to have this label for it to be
+        # included in the VolumeGroupSnapshot
+        group: test
+  volumeGroupSnapshotClassName: csi-nvmeofplugin-groupsnapclass

examples/nvmeof/groupsnapshotclass.yaml

@@ -0,0 +1,18 @@
+---
+apiVersion: groupsnapshot.storage.k8s.io/v1
+kind: VolumeGroupSnapshotClass
+metadata:
+  name: csi-nvmeofplugin-groupsnapclass
+driver: nvmeof.csi.ceph.com
+parameters:
+  # String representing a Ceph cluster to provision storage from.
+  # Should be unique across all Ceph clusters in use for provisioning,
+  # cannot be greater than 36 bytes in length, and should remain immutable for
+  # the lifetime of the StorageClass in use
+  clusterID: <cluster-id>
+  # eg: pool: replicapool
+  pool: <rbd-pool-name>
+  # Group snapshot operations use the RBD backend credentials
+  csi.storage.k8s.io/group-snapshotter-secret-name: csi-rbd-secret
+  csi.storage.k8s.io/group-snapshotter-secret-namespace: default
+deletionPolicy: Delete