Add group snapshot controller unit tests

Signed-off-by: Leonardo Cecchi <leonardo.cecchi@enterprisedb.com>
kubernetes-csi · Aug 26, 2024 · 56e110e · 56e110e
1 parent 36ed525
commit 56e110e
Show file tree

Hide file tree

Showing 10 changed files with 1,440 additions and 26 deletions.
diff --git a/pkg/common-controller/framework_test.go b/pkg/common-controller/framework_test.go
diff --git a/pkg/common-controller/groupsnapshot_controller_helper.go b/pkg/common-controller/groupsnapshot_controller_helper.go
@@ -223,10 +223,10 @@ func (ctrl *csiSnapshotCommonController) getClaimsFromVolumeGroupSnapshot(groupS
 	// Get PVC that has group snapshot label applied.
 	pvcList, err := ctrl.client.CoreV1().PersistentVolumeClaims(groupSnapshot.Namespace).List(context.TODO(), metav1.ListOptions{LabelSelector: labels.Set(labelSelector.MatchLabels).String()})
 	if err != nil {
-		return nil, fmt.Errorf("failed to list PVCs with label selector %s: %q", labelSelector.String(), err)
+		return nil, fmt.Errorf("failed to list PVCs with label selector %s: %q", metav1.FormatLabelSelector(labelSelector), err)
 	}
 	if len(pvcList.Items) == 0 {
-		return nil, fmt.Errorf("label selector %s for group snapshot not applied to any PVC", labelSelector.String())
+		return nil, fmt.Errorf("label selector %s for group snapshot not applied to any PVC", metav1.FormatLabelSelector(labelSelector))
 	}
 	return pvcList.Items, nil
 }

diff --git a/pkg/common-controller/groupsnapshot_create_test.go b/pkg/common-controller/groupsnapshot_create_test.go
@@ -0,0 +1,377 @@
+/*
+Copyright 2024 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package common_controller
+
+import (
+	"testing"
+
+	crdv1alpha1 "github.com/kubernetes-csi/external-snapshotter/client/v8/apis/volumegroupsnapshot/v1alpha1"
+	crdv1 "github.com/kubernetes-csi/external-snapshotter/client/v8/apis/volumesnapshot/v1"
+	"github.com/kubernetes-csi/external-snapshotter/v8/pkg/utils"
+	v1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+var groupSnapshotClasses = []*crdv1alpha1.VolumeGroupSnapshotClass{
+	{
+		TypeMeta: metav1.TypeMeta{
+			Kind: "VolumeGroupSnapshotClass",
+		},
+		ObjectMeta: metav1.ObjectMeta{
+			Name: classGold,
+		},
+		Driver:         mockDriverName,
+		Parameters:     class1Parameters,
+		DeletionPolicy: crdv1.VolumeSnapshotContentDelete,
+	},
+	{
+		TypeMeta: metav1.TypeMeta{
+			Kind: "VolumeGroupSnapshotClass",
+		},
+		ObjectMeta: metav1.ObjectMeta{
+			Name:        defaultClass,
+			Annotations: map[string]string{utils.IsDefaultGroupSnapshotClassAnnotation: "true"},
+		},
+		Driver:         mockDriverName,
+		Parameters:     class1Parameters,
+		DeletionPolicy: crdv1.VolumeSnapshotContentDelete,
+	},
+	{
+		TypeMeta: metav1.TypeMeta{
+			Kind: "VolumeGroupSnapshotClass",
+		},
+		ObjectMeta: metav1.ObjectMeta{
+			Name:        classSilver,
+			Annotations: map[string]string{utils.IsDefaultGroupSnapshotClassAnnotation: "true"},
+		},
+		Driver:         mockDriverName,
+		Parameters:     class1Parameters,
+		DeletionPolicy: crdv1.VolumeSnapshotContentRetain,
+	},
+}
+
+func TestCreateGroupSnapshotSync(t *testing.T) {
+	tests := []controllerTest{
+		{
+			name: "1-1 - successful dynamically-provisioned create group snapshot with group snapshot class gold",
+			initialGroupSnapshots: newGroupSnapshotArray(
+				"snap-1-1", "snapuid1-1", map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				},
+				"", classGold, "", nil, nil, nil, true, false, nil,
+			),
+			expectedGroupSnapshots: newGroupSnapshotArray(
+				"snap-1-1", "snapuid1-1", map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				},
+				"", classGold, "groupsnapcontent-snapuid1-1", &False, nil, nil, false, false, nil,
+			),
+			initialGroupContents: nogroupcontents,
+			expectedGroupContents: newGroupSnapshotContentArray(
+				"groupsnapcontent-snapuid1-1", "snapuid1-1", "snap-1-1", "snapshot-handle", classGold, []string{
+					"1-pv-handle6-1",
+					"2-pv-handle6-1",
+				}, "", deletionPolicy, nil, false, false,
+			),
+			initialClaims: withClaimLabels(
+				newClaimCoupleArray("claim1-1", "pvc-uid6-1", "1Gi", "volume6-1", v1.ClaimBound, &classGold),
+				map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				}),
+			initialVolumes: newVolumeCoupleArray("volume6-1", "pv-uid6-1", "pv-handle6-1", "1Gi", "pvc-uid6-1", "claim1-1", v1.VolumeBound, v1.PersistentVolumeReclaimDelete, classGold),
+			errors:         noerrors,
+			test:           testSyncGroupSnapshot,
+			expectSuccess:  true,
+		},
+		{
+			name: "1-2 - unsuccessful create group snapshot with no existent group snapshot class",
+			initialGroupSnapshots: newGroupSnapshotArray(
+				"snap-1-1", "snapuid1-1", map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				},
+				"", classNonExisting, "", nil, nil, nil, true, false, nil,
+			),
+			expectedGroupSnapshots: newGroupSnapshotArray(
+				"snap-1-1", "snapuid1-1", map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				},
+				"", classNonExisting, "", &False, nil,
+				newVolumeError(`failed to create group snapshot content with error failed to get input parameters to create group snapshot snap-1-1: "volumegroupsnapshotclass.groupsnapshot.storage.k8s.io \"non-existing\" not found"`),
+				false, false, nil,
+			),
+			initialGroupContents:  nogroupcontents,
+			expectedGroupContents: nogroupcontents,
+			initialClaims: withClaimLabels(
+				newClaimCoupleArray("claim1-1", "pvc-uid6-1", "1Gi", "volume6-1", v1.ClaimBound, &classGold),
+				map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				}),
+			initialVolumes: newVolumeCoupleArray("volume6-1", "pv-uid6-1", "pv-handle6-1", "1Gi", "pvc-uid6-1", "claim1-1", v1.VolumeBound, v1.PersistentVolumeReclaimDelete, classGold),
+			errors:         noerrors,
+			test:           testSyncGroupSnapshot,
+			expectSuccess:  false,
+		},
+		{
+			name: "1-3 - fail to create group snapshot without group snapshot class",
+			initialGroupSnapshots: newGroupSnapshotArray(
+				"snap-1-1", "snapuid1-1", map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				},
+				"", "", "", nil, nil, nil, true, false, nil,
+			),
+			expectedGroupSnapshots: newGroupSnapshotArray(
+				"snap-1-1", "snapuid1-1", map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				},
+				"", "", "", &False, nil,
+				newVolumeError(`failed to create group snapshot content with error failed to get input parameters to create group snapshot snap-1-1: "failed to take group snapshot snap-1-1 without a group snapshot class"`),
+				false, false, nil,
+			),
+			initialGroupContents:  nogroupcontents,
+			expectedGroupContents: nogroupcontents,
+			initialClaims: withClaimLabels(
+				newClaimCoupleArray("claim1-1", "pvc-uid6-1", "1Gi", "volume6-1", v1.ClaimBound, &classGold),
+				map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				}),
+			initialVolumes: newVolumeCoupleArray("volume6-1", "pv-uid6-1", "pv-handle6-1", "1Gi", "pvc-uid6-1", "claim1-1", v1.VolumeBound, v1.PersistentVolumeReclaimDelete, classGold),
+			errors:         noerrors,
+			test:           testSyncGroupSnapshot,
+			expectSuccess:  false,
+		},
+		{
+			name: "1-4 - fail to create group snapshot with no existing volumes",
+			initialGroupSnapshots: newGroupSnapshotArray(
+				"snap-1-1", "snapuid1-1", map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				},
+				"", classGold, "", nil, nil, nil, true, false, nil,
+			),
+			expectedGroupSnapshots: newGroupSnapshotArray(
+				"snap-1-1", "snapuid1-1", map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				},
+				"", classGold, "", &False, nil,
+				newVolumeError(`failed to create group snapshot content with error failed to get input parameters to create group snapshot snap-1-1: "label selector app.kubernetes.io/name=postgresql for group snapshot not applied to any PVC"`),
+				false, false, nil,
+			),
+			initialGroupContents:  nogroupcontents,
+			expectedGroupContents: nogroupcontents,
+			initialClaims:         nil,
+			initialVolumes:        nil,
+			errors:                noerrors,
+			test:                  testSyncGroupSnapshot,
+			expectSuccess:         false,
+		},
+		{
+			name: "1-5 - fail to create group snapshot with volumes that are not bound",
+			initialGroupSnapshots: newGroupSnapshotArray(
+				"snap-1-1", "snapuid1-1", map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				},
+				"", classGold, "", nil, nil, nil, true, false, nil,
+			),
+			expectedGroupSnapshots: newGroupSnapshotArray(
+				"snap-1-1", "snapuid1-1", map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				},
+				"", classGold, "", &False, nil,
+				newVolumeError(`failed to create group snapshot content with error failed to get input parameters to create group snapshot snap-1-1: "the PVC claim1-1 is not yet bound to a PV, will not attempt to take a group snapshot"`),
+				false, false, nil,
+			),
+			initialGroupContents:  nogroupcontents,
+			expectedGroupContents: nogroupcontents,
+			initialClaims: withClaimLabels(
+				newClaimArray("claim1-1", "pvc-uid6-1", "1Gi", "", v1.ClaimPending, &classGold),
+				map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				}),
+			initialVolumes: nil,
+			errors:         noerrors,
+			test:           testSyncGroupSnapshot,
+			expectSuccess:  false,
+		},
+		{
+			name: "1-6 - fail to create group snapshot with volumes that are not created by a CSI driver",
+			initialGroupSnapshots: newGroupSnapshotArray(
+				"snap-1-1", "snapuid1-1", map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				},
+				"", classGold, "", nil, nil, nil, true, false, nil,
+			),
+			expectedGroupSnapshots: newGroupSnapshotArray(
+				"snap-1-1", "snapuid1-1", map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				},
+				"", classGold, "", &False, nil,
+				newVolumeError("failed to create group snapshot content with error cannot snapshot a non-CSI volume for group snapshot default/snap-1-1: volume6-1"),
+				false, false, nil,
+			),
+			initialGroupContents:  nogroupcontents,
+			expectedGroupContents: nogroupcontents,
+			initialClaims: withClaimLabels(
+				newClaimArray("claim1-1", "pvc-uid6-1", "1Gi", "volume6-1", v1.ClaimBound, &classGold),
+				map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				}),
+			initialVolumes: withVolumesLocalPath(
+				newVolumeArray("volume6-1", "pv-uid6-1", "pv-handle6-1", "1Gi", "pvc-uid6-1", "claim1-1", v1.VolumeBound, v1.PersistentVolumeReclaimDelete, classGold),
+				"/test",
+			),
+			errors:        noerrors,
+			test:          testSyncGroupSnapshot,
+			expectSuccess: false,
+		},
+		{
+			name: "1-7 - fail to create group snapshot with volumes that are created by a different CSI driver",
+			initialGroupSnapshots: newGroupSnapshotArray(
+				"snap-1-1", "snapuid1-1", map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				},
+				"", classGold, "", nil, nil, nil, true, false, nil,
+			),
+			expectedGroupSnapshots: newGroupSnapshotArray(
+				"snap-1-1", "snapuid1-1", map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				},
+				"", classGold, "", &False, nil,
+				newVolumeError("failed to create group snapshot content with error snapshot controller failed to update default/snap-1-1 on API server: Volume CSI driver (test.csi.driver.name) mismatch with VolumeGroupSnapshotClass (csi-mock-plugin) default/snap-1-1: volume6-1"),
+				false, false, nil,
+			),
+			initialGroupContents:  nogroupcontents,
+			expectedGroupContents: nogroupcontents,
+			initialClaims: withClaimLabels(
+				newClaimArray("claim1-1", "pvc-uid6-1", "1Gi", "volume6-1", v1.ClaimBound, &classGold),
+				map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				}),
+			initialVolumes: withVolumesCSIDriverName(
+				newVolumeArray("volume6-1", "pv-uid6-1", "pv-handle6-1", "1Gi", "pvc-uid6-1", "claim1-1", v1.VolumeBound, v1.PersistentVolumeReclaimDelete, classGold),
+				"test.csi.driver.name",
+			),
+			errors:        noerrors,
+			test:          testSyncGroupSnapshot,
+			expectSuccess: false,
+		},
+		{
+			name: "1-8 - successful pre-provisioned group snapshot",
+			initialGroupSnapshots: newGroupSnapshotArray(
+				"snap-1-1", "snapuid1-1", map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				},
+				"", classGold, "groupsnapcontent-snapuid1-1", &False, nil, nil, false, false, nil,
+			),
+			expectedGroupSnapshots: withGroupSnapshotFinalizers(
+				newGroupSnapshotArray(
+					"snap-1-1", "snapuid1-1", map[string]string{
+						"app.kubernetes.io/name": "postgresql",
+					},
+					"", classGold, "groupsnapcontent-snapuid1-1", &False, nil, nil, false, false, nil,
+				),
+				utils.VolumeGroupSnapshotBoundFinalizer,
+			),
+			initialGroupContents: newGroupSnapshotContentArray(
+				"groupsnapcontent-snapuid1-1", "snapuid1-1", "snap-1-1", "snapshot-handle", classGold, []string{
+					"1-pv-handle6-1",
+					"2-pv-handle6-1",
+				}, "", deletionPolicy, nil, false, false,
+			),
+			expectedGroupContents: newGroupSnapshotContentArray(
+				"groupsnapcontent-snapuid1-1", "snapuid1-1", "snap-1-1", "snapshot-handle", classGold, []string{
+					"1-pv-handle6-1",
+					"2-pv-handle6-1",
+				}, "", deletionPolicy, nil, false, false,
+			),
+			initialClaims: withClaimLabels(
+				newClaimCoupleArray("claim1-1", "pvc-uid6-1", "1Gi", "volume6-1", v1.ClaimBound, &classGold),
+				map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				}),
+			initialVolumes: newVolumeCoupleArray("volume6-1", "pv-uid6-1", "pv-handle6-1", "1Gi", "pvc-uid6-1", "claim1-1", v1.VolumeBound, v1.PersistentVolumeReclaimDelete, classGold),
+			errors:         noerrors,
+			test:           testSyncGroupSnapshot,
+			expectSuccess:  true,
+		},
+		{
+			name: "1-9 - unsuccessful pre-provisioned group snapshot (no content)",
+			initialGroupSnapshots: newGroupSnapshotArray(
+				"snap-1-1", "snapuid1-1", map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				},
+				"", classGold, "groupsnapcontent-snapuid1-1", &False, nil, nil, false, false, nil,
+			),
+			expectedGroupSnapshots: newGroupSnapshotArray(
+				"snap-1-1", "snapuid1-1", map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				},
+				"", classGold, "groupsnapcontent-snapuid1-1", &False, nil,
+				newVolumeError(`failed to create group snapshot content with error failed to get input parameters to create group snapshot snap-1-1: "failed to retrieve PV volume6-1 from the API server: \"cannot find volume volume6-1\""`),
+				false, false, nil,
+			),
+			initialGroupContents:  nogroupcontents,
+			expectedGroupContents: nogroupcontents,
+			initialClaims: withClaimLabels(
+				newClaimArray("claim1-1", "pvc-uid6-1", "1Gi", "volume6-1", v1.ClaimBound, &classGold),
+				map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				}),
+			initialVolumes: nil,
+			errors:         noerrors,
+			test:           testSyncGroupSnapshot,
+			expectSuccess:  false,
+		},
+		{
+			name: "1-10 - unsuccessful pre-provisioned group snapshot (wrong back-ref)",
+			initialGroupSnapshots: newGroupSnapshotArray(
+				"snap-1-1", "snapuid1-1", map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				},
+				"", classGold, "groupsnapcontent-snapuid1-1", &False, nil, nil, false, false, nil,
+			),
+			expectedGroupSnapshots: newGroupSnapshotArray(
+				"snap-1-1", "snapuid1-1", map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				},
+				"", classGold, "groupsnapcontent-snapuid1-1", &False, nil,
+				newVolumeError(`VolumeGroupSnapshotContent [groupsnapcontent-snapuid1-1] is bound to a different group snapshot`),
+				false, false, nil,
+			),
+			initialGroupContents: newGroupSnapshotContentArray(
+				"groupsnapcontent-snapuid1-1", "wronguid1-1", "snap-1-1", "snapshot-handle", classGold, []string{
+					"1-pv-handle6-1",
+					"2-pv-handle6-1",
+				}, "", deletionPolicy, nil, false, false,
+			),
+			expectedGroupContents: newGroupSnapshotContentArray(
+				"groupsnapcontent-snapuid1-1", "wronguid1-1", "snap-1-1", "snapshot-handle", classGold, []string{
+					"1-pv-handle6-1",
+					"2-pv-handle6-1",
+				}, "", deletionPolicy, nil, false, false,
+			),
+			initialClaims: withClaimLabels(
+				newClaimCoupleArray("claim1-1", "pvc-uid6-1", "1Gi", "volume6-1", v1.ClaimBound, &classGold),
+				map[string]string{
+					"app.kubernetes.io/name": "postgresql",
+				}),
+			initialVolumes: newVolumeCoupleArray("volume6-1", "pv-uid6-1", "pv-handle6-1", "1Gi", "pvc-uid6-1", "claim1-1", v1.VolumeBound, v1.PersistentVolumeReclaimDelete, classGold),
+			errors:         noerrors,
+			test:           testSyncGroupSnapshot,
+			expectSuccess:  false,
+		},
+	}
+	runSyncTests(t, tests, nil, groupSnapshotClasses)
+}