CLOUDP-80774: support enums in the spec (#97)

Author: Anton

pkg/api/v1/atlascluster_types.go

@@ -30,6 +30,22 @@ func init() {
 	SchemeBuilder.Register(&AtlasCluster{}, &AtlasClusterList{})
 }
 
+type ProviderName string
+type ClusterType string
+
+const (
+	ProviderAWS    ProviderName = "AWS"
+	ProviderGCP    ProviderName = "GCP"
+	ProviderAzure  ProviderName = "AZURE"
+	ProviderTenant ProviderName = "TENANT"
+)
+
+const (
+	TypeReplicaSet ClusterType = "REPLICASET"
+	TypeSharded    ClusterType = "SHARDED"
+	TypeGeoSharded ClusterType = "GEOSHARDED"
+)
+
 // AtlasClusterSpec defines the desired state of AtlasCluster
 type AtlasClusterSpec struct {
 	// Project is a reference to AtlasProject resource the cluster belongs to
@@ -49,7 +65,7 @@ type AtlasClusterSpec struct {
 	// The parameter is required if replicationSpecs are set or if Global Clusters are deployed.
 	// +kubebuilder:validation:Enum=REPLICASET;SHARDED;GEOSHARDED
 	// +optional
-	ClusterType string `json:"clusterType,omitempty"`
+	ClusterType ClusterType `json:"clusterType,omitempty"`
 
 	// Capacity, in gigabytes, of the host's root volume.
 	// Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB).
@@ -179,7 +195,7 @@ type ProviderSettingsSpec struct {
 
 	// Cloud service provider on which Atlas provisions the hosts.
 	// +kubebuilder:validation:Enum=AWS;GCP;AZURE;TENANT
-	ProviderName string `json:"providerName"`
+	ProviderName ProviderName `json:"providerName"`
 
 	// Physical location of your MongoDB cluster.
 	// The region you choose can affect network latency for clients accessing your databases.

pkg/api/v1/atlascluster_types_test.go

@@ -40,6 +40,26 @@ func TestCompatibility(t *testing.T) {
 	compareStruct(AtlasClusterSpec{}, mongodbatlas.Cluster{}, t)
 }
 
+// TestEnums verifies that replacing the strings with "enum" in Atlas Operator works correctly and is (de)serialized
+// into the correct Atlas Cluster
+func TestEnums(t *testing.T) {
+	atlasCluster := mongodbatlas.Cluster{
+		ProviderSettings: &mongodbatlas.ProviderSettings{
+			ProviderName: "AWS",
+		},
+		ClusterType: "GEOSHARDED",
+	}
+	operatorCluster := AtlasClusterSpec{
+		ProviderSettings: &ProviderSettingsSpec{
+			ProviderName: ProviderAWS,
+		},
+		ClusterType: TypeGeoSharded,
+	}
+	transformedCluster, err := operatorCluster.Cluster()
+	assert.NoError(t, err)
+	assert.Equal(t, atlasCluster, *transformedCluster)
+}
+
 func compareStruct(ours interface{}, their interface{}, t *testing.T) {
 	ourFields := getAllFieldsSorted(ours, excludedClusterFieldsOurs)
 	theirFields := getAllFieldsSorted(their, excludedClusterFieldsTheirs)

pkg/controller/atlascluster/cluster_test.go

@@ -0,0 +1,40 @@
+package atlascluster
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"go.mongodb.org/atlas/mongodbatlas"
+	"go.uber.org/zap"
+
+	mdbv1 "github.com/mongodb/mongodb-atlas-kubernetes/pkg/api/v1"
+)
+
+func TestClusterMatchesSpec(t *testing.T) {
+	t.Run("Clusters match (enums)", func(t *testing.T) {
+		atlasClusterEnum := mongodbatlas.Cluster{
+			ProviderSettings: &mongodbatlas.ProviderSettings{
+				ProviderName: "AWS",
+			},
+			ClusterType: "GEOSHARDED",
+		}
+		operatorClusterEnum := mdbv1.AtlasClusterSpec{
+			ProviderSettings: &mdbv1.ProviderSettingsSpec{
+				ProviderName: mdbv1.ProviderAWS,
+			},
+			ClusterType: mdbv1.TypeGeoSharded,
+		}
+
+		match, err := clusterMatchesSpec(zap.S(), &atlasClusterEnum, operatorClusterEnum)
+		assert.NoError(t, err)
+		assert.True(t, match)
+	})
+	t.Run("Clusters don't match (enums)", func(t *testing.T) {
+		atlasClusterEnum := mongodbatlas.Cluster{ClusterType: "GEOSHARDED"}
+		operatorClusterEnum := mdbv1.AtlasClusterSpec{ClusterType: mdbv1.TypeReplicaSet}
+
+		match, err := clusterMatchesSpec(zap.S(), &atlasClusterEnum, operatorClusterEnum)
+		assert.NoError(t, err)
+		assert.False(t, match)
+	})
+}

test/e2e/configuration_test.go

@@ -109,7 +109,7 @@ var _ = Describe("Deploy simple cluster", func() {
 		).Should(Equal(userClusterConfig.Spec.ProviderSettings.InstanceSizeName))
 		Expect(
 			cluster.ProviderSettings.ProviderName,
-		).Should(Equal(userClusterConfig.Spec.ProviderSettings.ProviderName))
+		).Should(Equal(string(userClusterConfig.Spec.ProviderSettings.ProviderName)))
 		Expect(
 			cluster.ProviderSettings.RegionName,
 		).Should(Equal(userClusterConfig.Spec.ProviderSettings.RegionName))

test/int/cluster_test.go

@@ -262,7 +262,7 @@ func testAtlasCluster(namespace, name, projectName string) *mdbv1.AtlasCluster {
 			Project: mdbv1.ResourceRef{Name: projectName},
 			ProviderSettings: &mdbv1.ProviderSettingsSpec{
 				InstanceSizeName: "M10",
-				ProviderName:     "GCP",
+				ProviderName:     mdbv1.ProviderGCP,
 				RegionName:       "EASTERN_US",
 			},
 		},