Merge pull request #7396 from blackpiglet/backup_volumeinfo_e2e

Add E2E test cases for backup VolumeInfo feature.

cmd/velero-restore-helper/velero-restore-helper.go

@@ -73,7 +73,7 @@ func done() bool {
 			return false
 		}
 
-		fmt.Printf("Found %s", doneFile)
+		fmt.Printf("Found the done file %s\n", doneFile)
 	}
 
 	return true

test/e2e/basic/backup-volume-info/base.go

@@ -0,0 +1,148 @@
+/*
+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 (
+	"context"
+	"fmt"
+	"strconv"
+	"strings"
+	"time"
+
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+	"github.com/pkg/errors"
+
+	. "github.com/vmware-tanzu/velero/test"
+	. "github.com/vmware-tanzu/velero/test/e2e/test"
+	. "github.com/vmware-tanzu/velero/test/util/k8s"
+	. "github.com/vmware-tanzu/velero/test/util/velero"
+)
+
+type BackupVolumeInfo struct {
+	TestCase
+	SnapshotVolumes          bool
+	DefaultVolumesToFSBackup bool
+	SnapshotMoveData         bool
+	TimeoutDuration          time.Duration
+}
+
+func (v *BackupVolumeInfo) Init() error {
+	v.TestCase.Init()
+
+	BeforeEach(func() {
+		if v.VeleroCfg.CloudProvider == "vsphere" && (!strings.Contains(v.CaseBaseName, "fs-upload") && !strings.Contains(v.CaseBaseName, "skipped")) {
+			fmt.Printf("Skip snapshot case %s for vsphere environment.\n", v.CaseBaseName)
+			Skip("Skip snapshot case due to vsphere environment doesn't cover the CSI test, and it doesn't have a Velero native snapshot plugin.")
+		}
+
+		if strings.Contains(v.VeleroCfg.Features, "EnableCSI") {
+			if strings.Contains(v.CaseBaseName, "native-snapshot") {
+				fmt.Printf("Skip native snapshot case %s when the CSI feature is enabled.\n", v.CaseBaseName)
+				Skip("Skip native snapshot case due to CSI feature is enabled.")
+			}
+		} else {
+			if strings.Contains(v.CaseBaseName, "csi") {
+				fmt.Printf("Skip CSI related case %s when the CSI feature is not enabled.\n", v.CaseBaseName)
+				Skip("Skip CSI cases due to CSI feature is not enabled.")
+			}
+		}
+	})
+
+	v.CaseBaseName = v.CaseBaseName + v.UUIDgen
+	v.BackupName = "backup-" + v.CaseBaseName
+	v.RestoreName = "restore-" + v.CaseBaseName
+	v.TimeoutDuration = 10 * time.Minute
+	v.NamespacesTotal = 1
+
+	v.VeleroCfg = VeleroCfg
+	v.Client = *v.VeleroCfg.ClientToInstallVelero
+	v.NSIncluded = &[]string{v.CaseBaseName}
+
+	v.TestMsg = &TestMSG{
+		Desc:      "Test backup's VolumeInfo metadata content",
+		Text:      "The VolumeInfo should be generated based on the backup type",
+		FailedMSG: "Failed to verify the backup VolumeInfo's content",
+	}
+
+	v.BackupArgs = []string{
+		"backup", "create", v.BackupName,
+		"--namespace", v.VeleroCfg.VeleroNamespace,
+		"--include-namespaces", v.CaseBaseName,
+		"--snapshot-volumes" + "=" + strconv.FormatBool(v.SnapshotVolumes),
+		"--default-volumes-to-fs-backup" + "=" + strconv.FormatBool(v.DefaultVolumesToFSBackup),
+		"--snapshot-move-data" + "=" + strconv.FormatBool(v.SnapshotMoveData),
+		"--wait",
+	}
+
+	v.RestoreArgs = []string{
+		"create", "--namespace", v.VeleroCfg.VeleroNamespace, "restore", v.RestoreName,
+		"--from-backup", v.BackupName, "--wait",
+	}
+	return nil
+}
+
+func (v *BackupVolumeInfo) CreateResources() error {
+	v.Ctx, v.CtxCancel = context.WithTimeout(context.Background(), v.TimeoutDuration)
+	labels := map[string]string{
+		"volume-info": "true",
+	}
+	for nsNum := 0; nsNum < v.NamespacesTotal; nsNum++ {
+		fmt.Printf("Creating namespaces ...\n")
+		createNSName := v.CaseBaseName
+		if err := CreateNamespaceWithLabel(v.Ctx, v.Client, createNSName, labels); err != nil {
+			return errors.Wrapf(err, "Failed to create namespace %s", createNSName)
+		}
+
+		// Install StorageClass
+		Expect(InstallTestStorageClasses(fmt.Sprintf("../testdata/storage-class/%s-csi.yaml", v.VeleroCfg.CloudProvider))).To(Succeed(), "Failed to install StorageClass")
+
+		pvc, err := CreatePVC(v.Client, createNSName, "volume-info", CSIStorageClassName, nil)
+		Expect(err).To(Succeed())
+		vols := CreateVolumes(pvc.Name, []string{"volume-info"})
+
+		//Create deployment
+		fmt.Printf("Creating deployment in namespaces ...%s\n", createNSName)
+		deployment := NewDeployment(v.CaseBaseName, createNSName, 1, labels, nil).WithVolume(vols).Result()
+		deployment, err = CreateDeployment(v.Client.ClientGo, createNSName, deployment)
+		if err != nil {
+			return errors.Wrap(err, fmt.Sprintf("failed to delete the namespace %q", createNSName))
+		}
+		err = WaitForReadyDeployment(v.Client.ClientGo, createNSName, deployment.Name)
+		if err != nil {
+			return errors.Wrap(err, fmt.Sprintf("failed to ensure job completion in namespace: %q", createNSName))
+		}
+	}
+	return nil
+}
+
+func (v *BackupVolumeInfo) Destroy() error {
+	err := CleanupNamespaces(v.Ctx, v.Client, v.CaseBaseName)
+	if err != nil {
+		return errors.Wrap(err, "Could cleanup retrieve namespaces")
+	}
+
+	return WaitAllSelectedNSDeleted(v.Ctx, v.Client, "ns-test=true")
+}
+
+func (v *BackupVolumeInfo) cleanResource() error {
+	if err := DeleteStorageClass(v.Ctx, v.Client, CSIStorageClassName); err != nil {
+		return errors.Wrap(err, "fail to delete the StorageClass")
+	}
+
+	return nil
+}

test/e2e/basic/backup-volume-info/csi_data_mover.go

@@ -0,0 +1,66 @@
+/*
+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/onsi/gomega"
+
+	. "github.com/vmware-tanzu/velero/test/e2e/test"
+	. "github.com/vmware-tanzu/velero/test/util/providers"
+	. "github.com/vmware-tanzu/velero/test/util/velero"
+)
+
+var CSIDataMoverVolumeInfoTest func() = TestFunc(&CSIDataMoverVolumeInfo{
+	BackupVolumeInfo{
+		SnapshotMoveData: true,
+		SnapshotVolumes:  true,
+		TestCase: TestCase{
+			CaseBaseName: "csi-data-mover-volumeinfo",
+			TestMsg: &TestMSG{
+				Desc: "Test backup's VolumeInfo metadata content for CSI data mover case.",
+				Text: "The VolumeInfo should be generated, and the SnapshotDataMovementInfo structure should not be nil.",
+			},
+		},
+	},
+})
+
+type CSIDataMoverVolumeInfo struct {
+	BackupVolumeInfo
+}
+
+func (c *CSIDataMoverVolumeInfo) 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).ShouldNot(HaveOccurred(), fmt.Sprintf("Fail to get VolumeInfo metadata in the Backup Repository."))
+
+	fmt.Printf("The VolumeInfo metadata content: %+v\n", *volumeInfo[0])
+	Expect(len(volumeInfo) > 0).To(BeIdenticalTo(true))
+	Expect(volumeInfo[0].SnapshotDataMovementInfo).NotTo(BeNil())
+
+	// Clean SC and VSC
+	return c.cleanResource()
+}

test/e2e/basic/backup-volume-info/csi_snapshot.go

@@ -0,0 +1,65 @@
+/*
+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/onsi/gomega"
+
+	. "github.com/vmware-tanzu/velero/test/e2e/test"
+	. "github.com/vmware-tanzu/velero/test/util/providers"
+	. "github.com/vmware-tanzu/velero/test/util/velero"
+)
+
+var CSISnapshotVolumeInfoTest func() = TestFunc(&CSISnapshotVolumeInfo{
+	BackupVolumeInfo{
+		SnapshotVolumes: true,
+		TestCase: TestCase{
+			CaseBaseName: "csi-snapshot-volumeinfo",
+			TestMsg: &TestMSG{
+				Desc: "Test backup's VolumeInfo metadata content for CSI snapshot case.",
+				Text: "The VolumeInfo should be generated, and the CSISnapshotInfo structure should not be nil.",
+			},
+		},
+	},
+})
+
+type CSISnapshotVolumeInfo struct {
+	BackupVolumeInfo
+}
+
+func (c *CSISnapshotVolumeInfo) 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).ShouldNot(HaveOccurred(), fmt.Sprintf("Fail to get VolumeInfo metadata in the Backup Repository."))
+
+	fmt.Printf("The VolumeInfo metadata content: %+v\n", *volumeInfo[0])
+	Expect(len(volumeInfo) > 0).To(BeIdenticalTo(true))
+	Expect(volumeInfo[0].CSISnapshotInfo).NotTo(BeNil())
+
+	// Clean SC and VSC
+	return c.cleanResource()
+}

test/e2e/basic/backup-volume-info/filesystem_upload.go

@@ -0,0 +1,65 @@
+/*
+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/onsi/gomega"
+
+	. "github.com/vmware-tanzu/velero/test/e2e/test"
+	. "github.com/vmware-tanzu/velero/test/util/providers"
+	. "github.com/vmware-tanzu/velero/test/util/velero"
+)
+
+var FilesystemUploadVolumeInfoTest func() = TestFunc(&FilesystemUploadVolumeInfo{
+	BackupVolumeInfo{
+		DefaultVolumesToFSBackup: true,
+		TestCase: TestCase{
+			CaseBaseName: "fs-upload-volumeinfo",
+			TestMsg: &TestMSG{
+				Desc: "Test backup's VolumeInfo metadata content for filesystem upload case.",
+				Text: "The VolumeInfo should be generated, and the PVBInfo structure should not be nil.",
+			},
+		},
+	},
+})
+
+type FilesystemUploadVolumeInfo struct {
+	BackupVolumeInfo
+}
+
+func (f *FilesystemUploadVolumeInfo) Verify() error {
+	volumeInfo, err := GetVolumeInfo(
+		f.VeleroCfg.ObjectStoreProvider,
+		f.VeleroCfg.CloudCredentialsFile,
+		f.VeleroCfg.BSLBucket,
+		f.VeleroCfg.BSLPrefix,
+		f.VeleroCfg.BSLConfig,
+		f.BackupName,
+		BackupObjectsPrefix+"/"+f.BackupName,
+	)
+
+	Expect(err).ShouldNot(HaveOccurred(), fmt.Sprintf("Fail to get VolumeInfo metadata in the Backup Repository."))
+
+	fmt.Printf("The VolumeInfo metadata content: %+v\n", *volumeInfo[0])
+	Expect(len(volumeInfo) > 0).To(BeIdenticalTo(true))
+	Expect(volumeInfo[0].PVBInfo).NotTo(BeNil())
+
+	// Clean SC and VSC
+	return f.cleanResource()
+}