e2e: add VolumeGroupSnapshot coverage (#10598)

* e2e: add VolumeGroupSnapshot coverage Velero groups PVCs that share a label into one VolumeGroupSnapshot, but nothing in the e2e suite exercises that path, so a regression in it would go unnoticed. Add a case alongside the other backup-volume-info CSI cases. It creates two PVCs carrying the grouping label the Velero server defaults to, velero.io/volume-group, and asserts that the backup's volume info reports the same VolumeGroupSnapshotHandle for both. One shared handle is what distinguishes a group snapshot from the volumes having been snapshotted one at a time, which is the part worth asserting. The suite installs a VolumeGroupSnapshotClass beside the VolumeSnapshotClass and removes it afterwards. Only providers that have the test data get one, so the case runs where a class exists and is skipped elsewhere, in the same way the existing CSI cases are skipped when the CSI feature is off. Removing it afterwards matters: Velero cannot choose between two classes carrying the selector label, and fails every VolumeGroupSnapshot backup on that cluster if one is left behind. Signed-off-by: krishhna24 <krishhnatupedev@gmail.com> * Add changelog for #10598 Signed-off-by: krishhna24 <krishhnatupedev@gmail.com> * e2e: log the VolumeGroupSnapshotHandle the VGS case asserts on CSISnapshotInfo is a pointer, so printing the VolumeInfo with %+v emits CSISnapshotInfo:0x270e179b4900 and nothing about the handle. This case exists to check that every volume in the group reports the same handle, so a failure in CI currently gives no way to see what the handles actually were. Print the handle per PVC alongside the existing line. The other backup-volume-info cases print the same way; changing those belongs in its own change. Signed-off-by: krishhna24 <krishhnatupedev@gmail.com> --------- Signed-off-by: krishhna24 <krishhnatupedev@gmail.com>
2026-10-22 06:13:00 +00:00 · 2026-10-09 10:53:08 -07:00
parent fca7ff8705
commit 6fcf350fb9
4 changed files with 187 additions and 0 deletions
@@ -0,0 +1 @@
+Add e2e coverage for CSI VolumeGroupSnapshot backups
@@ -0,0 +1,153 @@
+/*
+Copyright the Velero contributors.
+
+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 basic
+
+import (
+	"fmt"
+
+	"github.com/cockroachdb/errors"
+	. "github.com/onsi/gomega"
+	corev1api "k8s.io/api/core/v1"
+
+	velerov1api "github.com/vmware-tanzu/velero/pkg/apis/velero/v1"
+	. "github.com/vmware-tanzu/velero/test"
+	. "github.com/vmware-tanzu/velero/test/e2e/test"
+	"github.com/vmware-tanzu/velero/test/util/common"
+	. "github.com/vmware-tanzu/velero/test/util/k8s"
+	. "github.com/vmware-tanzu/velero/test/util/providers"
+	. "github.com/vmware-tanzu/velero/test/util/velero"
+)
+
+// volumeGroup is the value of the grouping label. The key is the one the
+// Velero server groups by, velero.io/volume-group unless it was started with
+// --volume-group-snapshot-label-key.
+const volumeGroup = "volumeinfo"
+
+// vgsPVCCount is how many PVCs share the group. Two is enough to tell a group
+// snapshot from two independent ones.
+const vgsPVCCount = 2
+
+var CSIVolumeGroupSnapshotVolumeInfoTest func() = TestFunc(&CSIVolumeGroupSnapshotVolumeInfo{
+	BackupVolumeInfo{
+		SnapshotVolumes: true,
+		TestCase: TestCase{
+			CaseBaseName: "csi-vgs-volumeinfo",
+			TestMsg: &TestMSG{
+				Desc: "Test backup's VolumeInfo metadata content for the CSI VolumeGroupSnapshot case.",
+				Text: "PVCs sharing the group label should be snapshotted by one VolumeGroupSnapshot, and the VolumeInfo should report the same VolumeGroupSnapshotHandle for each of them.",
+			},
+		},
+	},
+})
+
+type CSIVolumeGroupSnapshotVolumeInfo struct {
+	BackupVolumeInfo
+}
+
+// CreateResources replaces the base case's resources with PVCs that carry the
+// grouping label, which is what makes Velero take a VolumeGroupSnapshot rather
+// than one snapshot per volume.
+func (c *CSIVolumeGroupSnapshotVolumeInfo) CreateResources() error {
+	labels := map[string]string{
+		"volume-info": "true",
+	}
+
+	if c.VeleroCfg.WorkerOS == common.WorkerOSWindows {
+		labels["pod-security.kubernetes.io/enforce"] = "privileged"
+		labels["pod-security.kubernetes.io/enforce-version"] = "latest"
+	}
+
+	namespace := c.CaseBaseName
+	fmt.Printf("Creating namespace %s ...\n", namespace)
+	if err := CreateNamespaceWithLabel(c.Ctx, c.Client, namespace, labels); err != nil {
+		return errors.Wrapf(err, "failed to create namespace %s", namespace)
+	}
+
+	var vols []*corev1api.Volume
+	for i := range vgsPVCCount {
+		pvcName := fmt.Sprintf("vgs-pvc-%d", i)
+		fmt.Printf("Creating PVC %s in namespace %s, in volume group %s ...\n", pvcName, namespace, volumeGroup)
+
+		pvcBuilder := NewPVC(namespace, pvcName).
+			WithLabels(map[string]string{velerov1api.DefaultVGSLabelKey: volumeGroup}).
+			WithStorageClass(StorageClassName)
+		if err := CreatePvc(c.Client, pvcBuilder); err != nil {
+			return errors.Wrapf(err, "failed to create PVC %s", pvcName)
+		}
+
+		volumeName := fmt.Sprintf("vgs-pv-%d", i)
+		vols = append(vols, CreateVolumes(pvcName, []string{volumeName})...)
+	}
+
+	// The PVCs only bind once something mounts them, so the deployment is what
+	// gives the snapshots anything to snapshot.
+	deployment := NewDeployment(
+		c.CaseBaseName,
+		namespace,
+		1,
+		labels,
+		c.VeleroCfg.ImageRegistryProxy,
+		c.VeleroCfg.WorkerOS,
+	).WithVolume(vols).Result()
+
+	deployment, err := CreateDeployment(c.Client.ClientGo, namespace, deployment)
+	if err != nil {
+		return errors.Wrapf(err, "failed to create deployment in namespace %s", namespace)
+	}
+	if err := WaitForReadyDeployment(c.Client.ClientGo, namespace, deployment.Name); err != nil {
+		return errors.Wrapf(err, "failed to wait for the deployment in namespace %s", namespace)
+	}
+	return nil
+}
+
+func (c *CSIVolumeGroupSnapshotVolumeInfo) Verify() error {
+	volumeInfo, err := GetVolumeInfo(
+		c.VeleroCfg.ObjectStoreProvider,
+		c.VeleroCfg.CloudCredentialsFile,
+		c.VeleroCfg.BSLBucket,
+		c.VeleroCfg.BSLPrefix,
+		c.VeleroCfg.BSLConfig,
+		c.BackupName,
+		BackupObjectsPrefix+"/"+c.BackupName,
+	)
+	Expect(err).ToNot(HaveOccurred(), "Fail to get VolumeInfo metadata in the Backup Repository.")
+	Expect(volumeInfo).To(HaveLen(vgsPVCCount))
+
+	// Every volume in the group must report the same VolumeGroupSnapshotHandle.
+	// One shared handle is what distinguishes a group snapshot from the volumes
+	// having been snapshotted one by one.
+	var groupHandle string
+	for _, info := range volumeInfo {
+		fmt.Printf("The VolumeInfo metadata content: %+v\n", *info)
+		Expect(info.CSISnapshotInfo).NotTo(BeNil())
+		// CSISnapshotInfo is a pointer, so the line above prints its address. Print
+		// the handle too, since it is what this case asserts on and a CI failure is
+		// not diagnosable without it.
+		fmt.Printf("PVC %s: VolumeGroupSnapshotHandle %q\n",
+			info.PVCName, info.CSISnapshotInfo.VolumeGroupSnapshotHandle)
+		Expect(info.CSISnapshotInfo.VolumeGroupSnapshotHandle).NotTo(BeEmpty(),
+			fmt.Sprintf("PVC %s was not snapshotted by a VolumeGroupSnapshot", info.PVCName))
+
+		if groupHandle == "" {
+			groupHandle = info.CSISnapshotInfo.VolumeGroupSnapshotHandle
+			continue
+		}
+		Expect(info.CSISnapshotInfo.VolumeGroupSnapshotHandle).To(Equal(groupHandle),
+			"the volumes in the group were snapshotted by more than one VolumeGroupSnapshot")
+	}
+	return nil
+}
@@ -21,6 +21,7 @@ import (
 	"errors"
 	"flag"
 	"fmt"
+	"os"
 	"slices"
 	"strings"
 	"testing"
@@ -550,6 +551,11 @@ var _ = Describe(
 	Label("BackupVolumeInfo", "CSISnapshot"),
 	CSISnapshotVolumeInfoTest,
 )
+var _ = Describe(
+	"",
+	Label("BackupVolumeInfo", "CSIVolumeGroupSnapshot"),
+	CSIVolumeGroupSnapshotVolumeInfoTest,
+)
 var _ = Describe(
 	"",
 	Label("BackupVolumeInfo", "NativeSnapshot"),
@@ -789,6 +795,16 @@ func TestE2e(t *testing.T) {
 	testSuitePassed = RunSpecs(t, "E2e Suite")
 }

+// volumeGroupSnapshotClassFile returns the VolumeGroupSnapshotClass test data
+// for the provider under test, or the empty string when it has none.
+func volumeGroupSnapshotClassFile() string {
+	path := fmt.Sprintf("../testdata/volume-group-snapshot-class/%s.yaml", test.VeleroCfg.CloudProvider)
+	if _, err := os.Stat(path); err != nil {
+		return ""
+	}
+	return path
+}
+
 var _ = BeforeSuite(func() {
 	By("Install StorageClass for E2E.")
 	Expect(veleroutil.InstallStorageClasses(test.VeleroCfg.CloudProvider)).To(Succeed())
@@ -802,6 +818,13 @@ var _ = BeforeSuite(func() {
 				fmt.Sprintf("../testdata/volume-snapshot-class/%s.yaml", test.VeleroCfg.CloudProvider),
 			),
 		).To(Succeed())
+
+		// Only some providers have a VolumeGroupSnapshotClass to install, so
+		// the VolumeGroupSnapshot cases only run where the test data exists.
+		if path := volumeGroupSnapshotClassFile(); path != "" {
+			By("Install VolumeGroupSnapshotClass for E2E.")
+			Expect(k8s.KubectlApplyByFile(context.Background(), path)).To(Succeed())
+		}
 	}

 	By("Install PriorityClasses for E2E.")
@@ -853,6 +876,11 @@ var _ = AfterSuite(func() {
 				fmt.Sprintf("../testdata/volume-snapshot-class/%s.yaml", test.VeleroCfg.CloudProvider),
 			),
 		).To(Succeed())
+
+		if path := volumeGroupSnapshotClassFile(); path != "" {
+			By("Delete VolumeGroupSnapshotClass created by E2E")
+			Expect(k8s.KubectlDeleteByFile(ctx, path)).To(Succeed())
+		}
 	}

 	By("Delete PriorityClasses created by E2E")
@@ -57,6 +57,11 @@ func (p *PVCBuilder) WithAnnotation(ann map[string]string) *PVCBuilder {
 	return p
 }

+func (p *PVCBuilder) WithLabels(labels map[string]string) *PVCBuilder {
+	p.Labels = labels
+	return p
+}
+
 func (p *PVCBuilder) WithStorageClass(sc string) *PVCBuilder {
 	p.Spec.StorageClassName = &sc
 	return p
				`@@ -0,0 +1 @@`
				`Add e2e coverage for CSI VolumeGroupSnapshot backups`