Change GetAll CRD API to return a Map with keys as CRD name (#1024)

* changed the key for the GetAll CRD API to use name of the CRD instead of Kind

* corrected linting errors as highlighted by the IDE

Author: unmarshall

api/core/crds/crd.go

@@ -20,16 +20,18 @@ var (
 )
 
 const (
-	// KindEtcd is the kind of the etcd CRD.
-	KindEtcd = "Etcd"
-	// KindEtcdCopyBackupsTask is the kind of the etcd-copy-backup-task CRD.
-	KindEtcdCopyBackupsTask = "EtcdCopyBackupsTask"
+	// ResourceNameEtcd is the name of the etcd CRD.
+	ResourceNameEtcd = "etcds.druid.gardener.cloud"
+	// ResourceNameEtcdCopyBackupsTask is the name of the etcd-copy-backup-task CRD.
+	ResourceNameEtcdCopyBackupsTask = "etcdcopybackupstasks.druid.gardener.cloud"
 )
 
 // GetAll returns all CRDs for the given k8s version.
+// The function will return a map with the CRD name as key and the CRD content as value.
 // There are currently two sets of CRDs maintained.
 // 1. One set is for Kubernetes version 1.29 and above. These CRDs contain embedded CEL validation expressions. CEL expressions are only GA since Kubernetes 1.29 onwards.
 // 2. The other set is for Kubernetes versions below 1.29. These CRDs do not contain embedded CEL validation expressions.
+// If there are any errors in parsing the k8s version, the function will return an error.
 func GetAll(k8sVersion string) (map[string]string, error) {
 	k8sVersionAbove129, err := IsK8sVersionEqualToOrAbove129(k8sVersion)
 	if err != nil {
@@ -42,8 +44,8 @@ func GetAll(k8sVersion string) (map[string]string, error) {
 		selectedEtcdCRD = etcdCRDWithoutCEL
 	}
 	return map[string]string{
-		KindEtcd:                selectedEtcdCRD,
-		KindEtcdCopyBackupsTask: etcdCopyBackupsTaskCRD,
+		ResourceNameEtcd:                selectedEtcdCRD,
+		ResourceNameEtcdCopyBackupsTask: etcdCopyBackupsTaskCRD,
 	}, nil
 }
 

api/core/crds/crd_test.go

@@ -20,48 +20,48 @@ func TestGetAll(t *testing.T) {
 			name:       "k8s version is 1.29",
 			k8sVersion: "1.29",
 			expectedCRDs: map[string]string{
-				KindEtcd:                etcdCRD,
-				KindEtcdCopyBackupsTask: etcdCopyBackupsTaskCRD,
+				ResourceNameEtcd:                etcdCRD,
+				ResourceNameEtcdCopyBackupsTask: etcdCopyBackupsTaskCRD,
 			},
 		},
 		{
 			name:       "k8s version is v1.29.0",
 			k8sVersion: "v1.29.0",
 			expectedCRDs: map[string]string{
-				KindEtcd:                etcdCRD,
-				KindEtcdCopyBackupsTask: etcdCopyBackupsTaskCRD,
+				ResourceNameEtcd:                etcdCRD,
+				ResourceNameEtcdCopyBackupsTask: etcdCopyBackupsTaskCRD,
 			},
 		},
 		{
 			name:       "k8s version is below 1.29",
 			k8sVersion: "1.28",
 			expectedCRDs: map[string]string{
-				KindEtcd:                etcdCRDWithoutCEL,
-				KindEtcdCopyBackupsTask: etcdCopyBackupsTaskCRD,
+				ResourceNameEtcd:                etcdCRDWithoutCEL,
+				ResourceNameEtcdCopyBackupsTask: etcdCopyBackupsTaskCRD,
 			},
 		},
 		{
 			name:       "k8s version is below v1.29",
 			k8sVersion: "v1.28.3",
 			expectedCRDs: map[string]string{
-				KindEtcd:                etcdCRDWithoutCEL,
-				KindEtcdCopyBackupsTask: etcdCopyBackupsTaskCRD,
+				ResourceNameEtcd:                etcdCRDWithoutCEL,
+				ResourceNameEtcdCopyBackupsTask: etcdCopyBackupsTaskCRD,
 			},
 		},
 		{
 			name:       "k8s version is above 1.29",
 			k8sVersion: "1.30",
 			expectedCRDs: map[string]string{
-				KindEtcd:                etcdCRD,
-				KindEtcdCopyBackupsTask: etcdCopyBackupsTaskCRD,
+				ResourceNameEtcd:                etcdCRD,
+				ResourceNameEtcdCopyBackupsTask: etcdCopyBackupsTaskCRD,
 			},
 		},
 		{
 			name:       "k8s version is above v1.29",
 			k8sVersion: "v1.30.1",
 			expectedCRDs: map[string]string{
-				KindEtcd:                etcdCRD,
-				KindEtcdCopyBackupsTask: etcdCopyBackupsTaskCRD,
+				ResourceNameEtcd:                etcdCRD,
+				ResourceNameEtcdCopyBackupsTask: etcdCopyBackupsTaskCRD,
 			},
 		},
 	}

test/it/assets/assets.go

@@ -15,17 +15,17 @@ import (
 	. "github.com/onsi/gomega"
 )
 
-// returns the kubernetes version used from the environment variable
+// GetK8sVersionFromEnv returns the kubernetes version used from the environment variable
 func GetK8sVersionFromEnv() (string, error) {
 	k8sVersion, isPresent := os.LookupEnv("ENVTEST_K8S_VERSION")
 	if isPresent {
 		return k8sVersion, nil
 	} else {
-		return "", errors.New("Error fetching k8s version from environment")
+		return "", errors.New("error fetching k8s version from environment")
 	}
 }
 
-// Duplicating some code here that can be replaced with a call to the API module of etcd-druid.  
+// Duplicating some code here that can be replaced with a call to the API module of etcd-druid.
 // This will be removed once Kubernetes 1.29 becomes the minimum supported version.
 
 // GetEtcdCrdPath returns the path to the Etcd CRD for k8s versions >= 1.29 or the path to the Etcd CRD without CEL expressions (For versions < 1.29)

test/it/crdvalidation/etcd/helper.go

@@ -12,13 +12,13 @@ import (
 	druidv1alpha1 "github.com/gardener/etcd-druid/api/core/v1alpha1"
 	"github.com/gardener/etcd-druid/test/it/setup"
 	"github.com/gardener/etcd-druid/test/utils"
+
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	. "github.com/onsi/gomega"
 )
 
-
 const testNamespacePrefix = "etcd-validation-test"
 
 var (
@@ -46,6 +46,7 @@ func validateEtcdUpdation(t *testing.T, g *WithT, etcd *druidv1alpha1.Etcd, expe
 		g.Expect(updateErr).To(BeNil())
 	}
 }
+
 var cronFieldTestCases = []struct {
 	name      string
 	etcdName  string
@@ -171,4 +172,4 @@ func setupTestEnvironment(t *testing.T) (string, *WithT) {
 	g.Expect(itTestEnv.StartManager()).To(Succeed())
 
 	return testNs, g
-}
+}

test/it/crdvalidation/etcd/specetcd_test.go

@@ -123,39 +123,39 @@ func TestValidateSpecStorageCapacitySpecEtcdQuotaRelation(t *testing.T) {
 		etcdName        string
 		storageCapacity resource.Quantity
 		quota           resource.Quantity
-		backupEnabled          bool
+		backupEnabled   bool
 		expectErr       bool
 	}{
 		{
 			name:            "Valid #1: backups enabled",
 			etcdName:        "etcd-valid-1",
 			storageCapacity: resource.MustParse("27Gi"),
 			quota:           resource.MustParse("8Gi"),
-			backupEnabled:          true,
+			backupEnabled:   true,
 			expectErr:       false,
 		},
 		{
 			name:            "Valid #2: backups disabled",
 			etcdName:        "etcd-valid-2",
 			storageCapacity: resource.MustParse("12Gi"),
 			quota:           resource.MustParse("8Gi"),
-			backupEnabled:          false,
+			backupEnabled:   false,
 			expectErr:       false,
 		},
 		{
 			name:            "Invalid #1: backups enabled",
 			etcdName:        "etcd-invalid-1",
 			storageCapacity: resource.MustParse("15Gi"),
 			quota:           resource.MustParse("8Gi"),
-			backupEnabled:          true,
+			backupEnabled:   true,
 			expectErr:       true,
 		},
 		{
 			name:            "Invalid #2: backups disabled",
 			etcdName:        "etcd-invalid-2",
 			storageCapacity: resource.MustParse("9Gi"),
 			quota:           resource.MustParse("10Gi"),
-			backupEnabled:          false,
+			backupEnabled:   false,
 			expectErr:       true,
 		},
 	}

test/it/crdvalidation/etcd/specsharedconfig_test.go

@@ -13,7 +13,6 @@ import (
 	"github.com/gardener/etcd-druid/test/utils"
 )
 
-
 // validates whether the value passed to the etcd.spec.sharedConfig.autoCompactionMode is either set as "periodic" or "revision"
 func TestValidateSpecSharedConfigAutoCompactionMode(t *testing.T) {
 	tests := []struct {