Add DPT to OADP must gather (#1746)

* Add DPT to OADP must gather

* minor fix

* fix fmt verb and add yaml link

* Add DPT to e2e tests

* add lib/dpt.go

* Fix CI tests

* lint fix

Author: shubham-pampattiwar

must-gather/go.mod

@@ -8,7 +8,7 @@ require (
 	github.com/kubernetes-csi/external-snapshotter/client/v8 v8.0.0
 	github.com/migtools/oadp-non-admin v0.0.0-20250324123917-741ae3b7a67d
 	github.com/openshift/api v0.0.0-20240912201240-0a8800162826
-	github.com/openshift/oadp-operator v1.0.2-0.20250327225822-5cc21cec9653
+	github.com/openshift/oadp-operator v1.0.2-0.20250506010707-2a52b7a20c4b
 	github.com/openshift/oc v0.0.0-alpha.0.0.20250108103617-ae1bd9e4a75b
 	github.com/operator-framework/api v0.26.0
 	github.com/spf13/cobra v1.8.1

must-gather/go.sum

@@ -200,6 +200,8 @@ github.com/openshift/api v0.0.0-20240912201240-0a8800162826 h1:A8D9SN/hJUwAbdO0r
 github.com/openshift/api v0.0.0-20240912201240-0a8800162826/go.mod h1:OOh6Qopf21pSzqNVCB5gomomBXb8o5sGKZxG2KNpaXM=
 github.com/openshift/oadp-operator v1.0.2-0.20250327225822-5cc21cec9653 h1:p6t+nVTJsrT1FQSaL/n/sf9begEoLXfX08OVxfjdLYM=
 github.com/openshift/oadp-operator v1.0.2-0.20250327225822-5cc21cec9653/go.mod h1:tzlEfI5g4gomtv5dZ4qgEQSNSiwiOrsBj2P5nTqawPY=
+github.com/openshift/oadp-operator v1.0.2-0.20250506010707-2a52b7a20c4b h1:rz8ccMAPeFaFvxVfiD0k/GshGzU/uA10q/mJSLg6xWg=
+github.com/openshift/oadp-operator v1.0.2-0.20250506010707-2a52b7a20c4b/go.mod h1:IvBUP2qVUBst49SSzVhxajq4Bs1n/lm9K/kguhTltqI=
 github.com/openshift/oc v0.0.0-alpha.0.0.20250108103617-ae1bd9e4a75b h1:dBEu456jnnhr7KH1T+Mrna1DvFadk1qN+NEtLb8Nn8U=
 github.com/openshift/oc v0.0.0-alpha.0.0.20250108103617-ae1bd9e4a75b/go.mod h1:22L7FMouzG54z19RZ/o+RcMCLa8vCdvZ4jQ+u3iHWHw=
 github.com/openshift/velero v0.10.2-0.20250313160323-584cf1148a74 h1:ZHO0O6g1Enel2O4rAk7VfWLHlQKYkOcdWGAmoiZ3fQw=

must-gather/pkg/cli.go

@@ -156,6 +156,7 @@ For more information, check OADP must-gather documentation: https://docs.redhat.
 			subscriptionList := &operatorsv1alpha1.SubscriptionList{}
 
 			dataProtectionApplicationList := &oadpv1alpha1.DataProtectionApplicationList{}
+			dataProtectionTestList := &oadpv1alpha1.DataProtectionTestList{}
 			cloudStorageList := &oadpv1alpha1.CloudStorageList{}
 			backupStorageLocationList := &velerov1.BackupStorageLocationList{}
 			volumeSnapshotLocationList := &velerov1.VolumeSnapshotLocationList{}
@@ -186,6 +187,7 @@ For more information, check OADP must-gather documentation: https://docs.redhat.
 				subscriptionList,
 
 				dataProtectionApplicationList,
+				dataProtectionTestList,
 				cloudStorageList,
 				backupStorageLocationList,
 				volumeSnapshotLocationList,
@@ -314,6 +316,7 @@ For more information, check OADP must-gather documentation: https://docs.redhat.
 			templates.ReplaceClusterInformationSection(outputPath, clusterID, clusterVersion, infrastructureList, nodeList)
 			templates.ReplaceOADPOperatorInstallationSection(outputPath, importantCSVsByNamespace, importantSubscriptionsByNamespace, foundOADP, foundRelatedProducts, oldOADPError, oadpOperatorsText)
 			templates.ReplaceDataProtectionApplicationsSection(outputPath, dataProtectionApplicationList)
+			templates.ReplaceDataProtectionTestsSection(outputPath, dataProtectionTestList)
 			templates.ReplaceCloudStoragesSection(outputPath, cloudStorageList)
 			templates.ReplaceBackupStorageLocationsSection(outputPath, backupStorageLocationList)
 			templates.ReplaceVolumeSnapshotLocationsSection(outputPath, volumeSnapshotLocationList)

must-gather/pkg/gvk/gvk.go

@@ -30,6 +30,11 @@ var (
 		Version: "v1alpha1",
 		Kind:    "DataProtectionApplication",
 	}
+	DataProtectionTestGVK = schema.GroupVersionKind{
+		Group:   "oadp.openshift.io",
+		Version: "v1alpha1",
+		Kind:    "DataProtectionTest",
+	}
 	CloudStorageGVK = schema.GroupVersionKind{
 		Group:   "oadp.openshift.io",
 		Version: "v1alpha1",

must-gather/pkg/templates/summary.go

@@ -45,6 +45,7 @@ var (
 		"CLUSTER_ID", "OCP_VERSION", "CLOUD", "ARCH", "CLUSTER_VERSION",
 		"OADP_VERSIONS",
 		"DATA_PROTECTION_APPLICATIONS",
+		"DATA_PROTECTION_TESTS",
 		"CLOUD_STORAGES",
 		"BACKUP_STORAGE_LOCATIONS",
 		"VOLUME_SNAPSHOT_LOCATIONS",
@@ -82,6 +83,7 @@ const summaryTemplate = `# OADP must-gather summary version <<MUST_GATHER_VERSIO
 - [Cluster information](#cluster-information)
 - [OADP operator installation information](#oadp-operator-installation-information)
     - [DataProtectionApplications (DPAs)](#dataprotectionapplications-dpas)
+	- [DataProtectionTests (DPTs)](#dataprotectiontests-dpts)
     - [CloudStorages](#cloudstorages)
     - [BackupStorageLocations (BSLs)](#backupstoragelocations-bsls)
     - [VolumeSnapshotLocations (VSLs)](#volumesnapshotlocations-vsls)
@@ -127,6 +129,10 @@ const summaryTemplate = `# OADP must-gather summary version <<MUST_GATHER_VERSIO
 
 <<DATA_PROTECTION_APPLICATIONS>>
 
+### DataProtectionTests (DPTs)
+
+<<DATA_PROTECTION_TESTS>>
+
 ### CloudStorages
 
 <<CLOUD_STORAGES>>
@@ -387,6 +393,88 @@ func ReplaceDataProtectionApplicationsSection(outputPath string, dataProtectionA
 	}
 }
 
+func ReplaceDataProtectionTestsSection(outputPath string, dptList *oadpv1alpha1.DataProtectionTestList) {
+	if dptList != nil && len(dptList.Items) != 0 {
+		dataProtectionTestsByNamespace := map[string][]oadpv1alpha1.DataProtectionTest{}
+
+		for _, dpt := range dptList.Items {
+			dataProtectionTestsByNamespace[dpt.Namespace] = append(dataProtectionTestsByNamespace[dpt.Namespace], dpt)
+		}
+
+		summaryTemplateReplaces["DATA_PROTECTION_TESTS"] = ""
+		summaryTemplateReplaces["DATA_PROTECTION_TESTS"] += "| Name | Phase | Last Tested | Upload Speed (MBps) | Encryption | Versioning | Snapshots | Age | YAML |\n"
+		summaryTemplateReplaces["DATA_PROTECTION_TESTS"] += "| ---- | ----- | ----------- | ------------------- | ---------- | -----------| --------- | --- | ---- |\n"
+
+		for namespace, dpts := range dataProtectionTestsByNamespace {
+			folder := fmt.Sprintf("namespaces/%s/oadp.openshift.io/dataprotectiontests", namespace)
+			file := folder + "/dataprotectiontests.yaml"
+
+			list := &corev1.List{}
+			list.GetObjectKind().SetGroupVersionKind(gvk.ListGVK)
+
+			for _, dpt := range dpts {
+				dpt.GetObjectKind().SetGroupVersionKind(gvk.DataProtectionTestGVK)
+				list.Items = append(list.Items, runtime.RawExtension{Object: &dpt})
+
+				// Fields
+				name := dpt.Name
+
+				phase := "⚠️ Unknown"
+				if dpt.Status.Phase != "" {
+					phase = string(dpt.Status.Phase)
+				}
+
+				lastTested := "N/A"
+				if !dpt.Status.LastTested.IsZero() {
+					lastTested = humanizeDurationSince(dpt.Status.LastTested.Time)
+				}
+
+				uploadSpeed := "⚠️ N/A"
+				if dpt.Status.UploadTest.SpeedMbps > 0 {
+					uploadSpeed = fmt.Sprintf("%d", dpt.Status.UploadTest.SpeedMbps)
+				}
+
+				encryption := dpt.Status.BucketMetadata.EncryptionAlgorithm
+				if encryption == "" {
+					encryption = "None"
+				}
+
+				versioning := dpt.Status.BucketMetadata.VersioningStatus
+				if versioning == "" {
+					versioning = "None"
+				}
+
+				snapshots := "N/A"
+				if dpt.Status.SnapshotSummary != "" {
+					snapshots = dpt.Status.SnapshotSummary
+				}
+
+				age := humanizeDurationSince(dpt.CreationTimestamp.Time)
+
+				yamlLink := fmt.Sprintf("[`yaml`](%s)", file)
+
+				summaryTemplateReplaces["DATA_PROTECTION_TESTS"] += fmt.Sprintf(
+					"| %s | %s | %s | %s | %s | %s | %s | %s | %s |\n",
+					name, phase, lastTested, uploadSpeed, encryption, versioning, snapshots, age, yamlLink,
+				)
+			}
+
+			createYAML(outputPath, file, list)
+		}
+	} else {
+		summaryTemplateReplaces["DATA_PROTECTION_TESTS"] = "❌ No DataProtectionTest was found in the cluster"
+		summaryTemplateReplaces["ERRORS"] += "⚠️ No DataProtectionTest was found in the cluster\n\n"
+	}
+}
+
+func humanizeDurationSince(t time.Time) string {
+	if t.IsZero() {
+		return "N/A"
+	}
+	return time.Since(t).Round(time.Second).String()
+}
+
+
 func ReplaceCloudStoragesSection(outputPath string, cloudStorageList *oadpv1alpha1.CloudStorageList) {
 	if cloudStorageList != nil && len(cloudStorageList.Items) != 0 {
 		cloudStorageByNamespace := map[string][]oadpv1alpha1.CloudStorage{}
@@ -1574,6 +1662,7 @@ func ReplaceCustomResourceDefinitionsSection(outputPath string, clusterConfig *r
 	// CRD spec.names.plural : CRD spec.group
 	crds := map[string]string{
 		"dataprotectionapplications":            gvk.DataProtectionApplicationGVK.Group,
+		"dataprotectiontests":					 gvk.DataProtectionTestGVK.Group,
 		"cloudstorages":                         gvk.CloudStorageGVK.Group,
 		"backupstoragelocations":                gvk.BackupStorageLocationGVK.Group,
 		"volumesnapshotlocations":               gvk.VolumeSnapshotLocationGVK.Group,

tests/e2e/backup_restore_suite_test.go

@@ -295,8 +295,16 @@ var _ = ginkgo.Describe("Backup and restore tests", ginkgo.Ordered, func() {
 		// using kopia to collect more info (DaemonSet)
 		waitOADPReadiness(lib.KOPIA)
 
+		log.Printf("Creating real DataProtectionTest before must-gather")
+		bsls, err := dpaCR.ListBSLs()
+		gomega.Expect(err).ToNot(gomega.HaveOccurred())
+
+		bslName := bsls.Items[0].Name
+		err = lib.CreateUploadTestOnlyDPT(dpaCR.Client, dpaCR.Namespace, bslName)
+		gomega.Expect(err).ToNot(gomega.HaveOccurred())
+
 		log.Printf("Running OADP must-gather")
-		err := lib.RunMustGather(artifact_dir, dpaCR.Client)
+		err = lib.RunMustGather(artifact_dir, dpaCR.Client)
 		gomega.Expect(err).ToNot(gomega.HaveOccurred())
 
 		err = dpaCR.Delete()

tests/e2e/lib/dpt.go

@@ -0,0 +1,47 @@
+package lib
+
+import (
+	"context"
+	"fmt"
+	"log"
+	"time"
+
+	"github.com/onsi/gomega"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/types"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+
+	"github.com/openshift/oadp-operator/api/v1alpha1"
+)
+
+func CreateUploadTestOnlyDPT(c client.Client, namespace, bslName string) error {
+	dpt := &v1alpha1.DataProtectionTest{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      fmt.Sprintf("e2e-uploadtest-dpt-%d", time.Now().Unix()),
+			Namespace: namespace,
+		},
+		Spec: v1alpha1.DataProtectionTestSpec{
+			BackupLocationName: bslName,
+			UploadSpeedTestConfig: &v1alpha1.UploadSpeedTestConfig{
+				FileSize: "5MB",
+				Timeout:  metav1.Duration{Duration: 120 * time.Second},
+			},
+		},
+	}
+
+	if err := c.Create(context.TODO(), dpt); err != nil {
+		return fmt.Errorf("creating DataProtectionTest: %w", err)
+	}
+
+	// Wait until DPT completes
+	gomega.Eventually(func() bool {
+		_ = c.Get(context.TODO(), types.NamespacedName{
+			Name:      dpt.Name,
+			Namespace: namespace,
+		}, dpt)
+		return dpt.Status.Phase == "Complete" || dpt.Status.Phase == "Failed"
+	}, time.Minute*3, time.Second*10).Should(gomega.BeTrue())
+
+	log.Printf("✅ DPT %s completed with phase: %s", dpt.Name, dpt.Status.Phase)
+	return nil
+}

tests/e2e/virt_backup_restore_suite_test.go

@@ -218,8 +218,16 @@ var _ = ginkgo.Describe("VM backup and restore tests", ginkgo.Ordered, func() {
 		// using kopia to collect more info (DaemonSet)
 		waitOADPReadiness(lib.KOPIA)
 
+		log.Printf("Creating real DataProtectionTest before must-gather")
+		bsls, err := dpaCR.ListBSLs()
+		gomega.Expect(err).ToNot(gomega.HaveOccurred())
+
+		bslName := bsls.Items[0].Name
+		err = lib.CreateUploadTestOnlyDPT(dpaCR.Client, dpaCR.Namespace, bslName)
+		gomega.Expect(err).ToNot(gomega.HaveOccurred())
+
 		log.Printf("Running OADP must-gather")
-		err := lib.RunMustGather(artifact_dir, dpaCR.Client)
+		err = lib.RunMustGather(artifact_dir, dpaCR.Client)
 		gomega.Expect(err).ToNot(gomega.HaveOccurred())
 
 		err = dpaCR.Delete()