Add support_oss_cluster_api and others optional (#369)

This adds the `support_oss_cluster_api` attribute to the
`rediscloud_active_active_subscription` resource, as well as making a
number of other attributes optional:
* `rediscloud_subscription.preferred_availability_zones`
* `rediscloud_subscription.modules`
* `rediscloud_subscription_database.protocol`
* Remove `support_oss_cluster_api` from `rediscloud_subscription`
example as it is optional.

Author: wjam

.github/workflows/terraform_provider.yml

@@ -150,7 +150,7 @@ jobs:
             code-changes:
               - 'go.mod'
               - 'go.sum'
-              - 'internal/**'
+              - 'provider/**'
               - '*.go'
               - '.github/workflows/**'
       - run: make testacc

docs/resources/rediscloud_active_active_subscription.md

@@ -62,6 +62,7 @@ The `creation_plan` block supports:
 
 * `memory_limit_in_gb` - (Required) Maximum memory usage that will be used for your largest planned database, including replication and other overhead
 * `quantity` - (Required) The planned number of databases in the subscription.
+* `support_oss_cluster_api` - (Optional) Support Redis open-source (OSS) Cluster API. Default: ‘false’
 
 The creation_plan `region` block supports:
 

docs/resources/rediscloud_subscription.md

@@ -47,7 +47,6 @@ resource "rediscloud_subscription" "subscription-resource" {
     memory_limit_in_gb = 2
     quantity = 1
     replication= false
-    support_oss_cluster_api= false
     throughput_measurement_by = "operations-per-second"
     throughput_measurement_value = 10000
     modules = ["RediSearch", "RedisBloom"]
@@ -85,7 +84,7 @@ only with Redis Labs internal cloud account
 The `creation_plan` block supports:
 
 * `memory_limit_in_gb` - (Required) Maximum memory usage that will be used for your largest planned database.
-* `modules` - (Required) a list of modules that will be used by the databases in this subscription. Not currently compatible with ‘ram-and-flash’ memory storage.
+* `modules` - (Optional) a list of modules that will be used by the databases in this subscription. Not currently compatible with ‘ram-and-flash’ memory storage.
 Example: `modules = ["RedisJSON", RedisBloom"]`
 * `support_oss_cluster_api` - (Optional) Support Redis open-source (OSS) Cluster API. Default: ‘false’
 * `replication` - (Required) Databases replication. Set to `true` if any of your databases will use replication
@@ -108,7 +107,7 @@ The cloud_provider `region` block supports:
 * `networking_vpc_id` - (Optional) Either an existing VPC Id (already exists in the specific region) or create a new VPC
 (if no VPC is specified). VPC Identifier must be in a valid format (for example: ‘vpc-0125be68a4986384ad’) and existing
 within the hosting account.
-* `preferred_availability_zones` - (Required) Availability zones deployment preferences (for the selected provider & region). If multiple_availability_zones is set to 'true', select three availability zones from the list. If you don't want to specify preferred avaialbility zones, set this attribute to an empty list ('[]').
+* `preferred_availability_zones` - (Optional) Availability zones deployment preferences (for the selected provider & region). If multiple_availability_zones is set to 'true', select three availability zones from the list. If you don't want to specify preferred availability zones, set this attribute to an empty list ('[]').
 
 ~> **Note:** The preferred_availability_zones parameter is required for Terraform, but is optional within the Redis Enterprise Cloud UI. 
 This difference in behaviour is to guarantee that a plan after an apply does not generate differences. In AWS Redis internal cloud account, please set the zone IDs (for example: `["use-az2", "use-az3", "use-az5"]`).

provider/resource_rediscloud_active_active_subscription.go

@@ -104,6 +104,12 @@ func resourceRedisCloudActiveActiveSubscription() *schema.Resource {
 							Required:     true,
 							ValidateFunc: validation.IntAtLeast(1),
 						},
+						"support_oss_cluster_api": {
+							Description: "Support Redis open-source (OSS) Cluster API",
+							Type:        schema.TypeBool,
+							Optional:    true,
+							Default:     false,
+						},
 						"region": {
 							Description: "Cloud networking details, per region (multiple regions for Active-Active cluster)",
 							Type:        schema.TypeSet,
@@ -410,6 +416,7 @@ func buildSubscriptionCreatePlanAADatabases(planMap map[string]interface{}) []*s
 	numDatabases := planMap["quantity"].(int)
 	memoryLimitInGB := planMap["memory_limit_in_gb"].(float64)
 	regions := planMap["region"]
+	supportOSSClusterAPI := planMap["support_oss_cluster_api"].(bool)
 	var localThroughputs []*subscriptions.CreateLocalThroughput
 	for _, v := range regions.(*schema.Set).List() {
 		region := v.(map[string]interface{})
@@ -420,13 +427,13 @@ func buildSubscriptionCreatePlanAADatabases(planMap map[string]interface{}) []*s
 		})
 	}
 	// create the remaining DBs with all other modules
-	createDatabases = append(createDatabases, createAADatabase(dbName, &idx, localThroughputs, numDatabases, memoryLimitInGB)...)
+	createDatabases = append(createDatabases, createAADatabase(dbName, &idx, localThroughputs, numDatabases, memoryLimitInGB, supportOSSClusterAPI)...)
 
 	return createDatabases
 }
 
 // createDatabase returns a CreateDatabase struct with the given parameters
-func createAADatabase(dbName string, idx *int, localThroughputs []*subscriptions.CreateLocalThroughput, numDatabases int, memoryLimitInGB float64) []*subscriptions.CreateDatabase {
+func createAADatabase(dbName string, idx *int, localThroughputs []*subscriptions.CreateLocalThroughput, numDatabases int, memoryLimitInGB float64, supportOSSClusterAPI bool) []*subscriptions.CreateDatabase {
 	var databases []*subscriptions.CreateDatabase
 	for i := 0; i < numDatabases; i++ {
 		createDatabase := subscriptions.CreateDatabase{
@@ -435,6 +442,7 @@ func createAADatabase(dbName string, idx *int, localThroughputs []*subscriptions
 			MemoryLimitInGB:            redis.Float64(memoryLimitInGB),
 			LocalThroughputMeasurement: localThroughputs,
 			Quantity:                   redis.Int(1),
+			SupportOSSClusterAPI:       redis.Bool(supportOSSClusterAPI),
 		}
 		*idx++
 		databases = append(databases, &createDatabase)

provider/resource_rediscloud_active_active_subscription_test.go

@@ -165,6 +165,7 @@ func TestAccResourceRedisCloudActiveActiveSubscription_createUpdateMarketplacePa
 				Check: resource.ComposeTestCheckFunc(
 					resource.TestCheckResourceAttr(resourceName, "name", name),
 					resource.TestCheckResourceAttr(resourceName, "cloud_provider.0.provider", "AWS"),
+					resource.TestCheckResourceAttr(resourceName, "creation_plan.0.support_oss_cluster_api", "true"),
 					resource.TestCheckResourceAttrSet(resourceName, "payment_method_id"),
 					resource.TestCheckResourceAttr(resourceName, "creation_plan.0.region.#", "2"),
 					resource.TestCheckResourceAttr(resourceName, "creation_plan.0.region.0.write_operations_per_second", "1000"),
@@ -225,6 +226,7 @@ resource "rediscloud_active_active_subscription" "example" {
 	creation_plan {
 		memory_limit_in_gb = 1
 		quantity = 1
+		support_oss_cluster_api = true
 		region {
 			region = "us-east-1"
 			networking_deployment_cidr = "192.168.0.0/24"

provider/resource_rediscloud_subscription.go

@@ -167,8 +167,9 @@ func resourceRedisCloudSubscription() *schema.Resource {
 									"preferred_availability_zones": {
 										Description: "List of availability zones used",
 										Type:        schema.TypeList,
-										Required:    true,
+										Optional:    true,
 										ForceNew:    true,
+										Computed:    true,
 										Elem: &schema.Schema{
 											Type: schema.TypeString,
 										},
@@ -278,7 +279,8 @@ func resourceRedisCloudSubscription() *schema.Resource {
 						"modules": {
 							Description: "Modules that will be used by the databases in this subscription.",
 							Type:        schema.TypeList,
-							Required:    true,
+							Optional:    true,
+							Computed:    true,
 							Elem: &schema.Schema{
 								Type: schema.TypeString,
 							},
@@ -932,19 +934,6 @@ func flattenRegexRules(rules []*databases.RegexRule) []string {
 	return ret
 }
 
-func getDatabaseNameIdMap(ctx context.Context, subId int, client *apiClient) (map[string]int, error) {
-	ret := map[string]int{}
-	list := client.client.Database.List(ctx, subId)
-	for list.Next() {
-		db := list.Value()
-		ret[redis.StringValue(db.Name)] = redis.IntValue(db.ID)
-	}
-	if list.Err() != nil {
-		return nil, list.Err()
-	}
-	return ret, nil
-}
-
 func readPaymentMethodID(d *schema.ResourceData) (*int, error) {
 	pmID := d.Get("payment_method_id").(string)
 	if pmID != "" {

provider/resource_rediscloud_subscription_database.go

@@ -67,9 +67,10 @@ func resourceRedisCloudSubscriptionDatabase() *schema.Resource {
 			"protocol": {
 				Description:      "The protocol that will be used to access the database, (either ‘redis’ or 'memcached’) ",
 				Type:             schema.TypeString,
-				Required:         true,
 				ValidateDiagFunc: validateDiagFunc(validation.StringInSlice(databases.ProtocolValues(), false)),
+				Optional:         true,
 				ForceNew:         true,
+				Computed:         true,
 			},
 			"memory_limit_in_gb": {
 				Description: "Maximum memory usage for this specific database",
@@ -241,7 +242,6 @@ func resourceRedisCloudSubscriptionDatabaseCreate(ctx context.Context, d *schema
 	subscriptionMutex.Lock(subId)
 
 	name := d.Get("name").(string)
-	protocol := d.Get("protocol").(string)
 	memoryLimitInGB := d.Get("memory_limit_in_gb").(float64)
 	supportOSSClusterAPI := d.Get("support_oss_cluster_api").(bool)
 	dataPersistence := d.Get("data_persistence").(string)
@@ -284,7 +284,6 @@ func resourceRedisCloudSubscriptionDatabaseCreate(ctx context.Context, d *schema
 
 	createDatabase := databases.CreateDatabase{
 		Name:                 redis.String(name),
-		Protocol:             redis.String(protocol),
 		MemoryLimitInGB:      redis.Float64(memoryLimitInGB),
 		SupportOSSClusterAPI: redis.Bool(supportOSSClusterAPI),
 		DataPersistence:      redis.String(dataPersistence),
@@ -305,6 +304,10 @@ func resourceRedisCloudSubscriptionDatabaseCreate(ctx context.Context, d *schema
 		createDatabase.AverageItemSizeInBytes = &averageItemSizeInBytes
 	}
 
+	if v, ok := d.GetOk("protocol"); ok {
+		createDatabase.Protocol = redis.String(v.(string))
+	}
+
 	dbId, err := api.client.Database.Create(ctx, subId, createDatabase)
 	if err != nil {
 		return diag.FromErr(err)

provider/resource_rediscloud_subscription_database_test.go

@@ -133,6 +133,27 @@ func TestAccResourceRedisCloudSubscriptionDatabase_CRUDI(t *testing.T) {
 	})
 }
 
+func TestAccResourceRedisCloudSubscriptionDatabase_optionalAttributes(t *testing.T) {
+	// Test that attributes can be optional, either by setting them or not having them set when compared to CRUDI test
+	name := acctest.RandomWithPrefix(testResourcePrefix)
+	resourceName := "rediscloud_subscription_database.example"
+	testCloudAccountName := os.Getenv("AWS_TEST_CLOUD_ACCOUNT_NAME")
+
+	resource.Test(t, resource.TestCase{
+		PreCheck:          func() { testAccPreCheck(t); testAccAwsPreExistingCloudAccountPreCheck(t) },
+		ProviderFactories: providerFactories,
+		CheckDestroy:      testAccCheckSubscriptionDestroy,
+		Steps: []resource.TestStep{
+			{
+				Config: fmt.Sprintf(testAccResourceRedisCloudSubscriptionDatabaseOptionalAttributes, testCloudAccountName, name),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr(resourceName, "protocol", "redis"),
+				),
+			},
+		},
+	})
+}
+
 // Tests the multi-modules feature in a database resource.
 func TestAccResourceRedisCloudSubscriptionDatabase_MultiModules(t *testing.T) {
 	name := acctest.RandomWithPrefix(testResourcePrefix)
@@ -182,7 +203,7 @@ resource "rediscloud_subscription" "example" {
 
   allowlist {
     cidrs = ["192.168.0.0/16"]
-	security_group_ids = []
+    security_group_ids = []
   }
 
   cloud_provider {
@@ -203,7 +224,7 @@ resource "rediscloud_subscription" "example" {
     quantity = 1
     replication=false
     support_oss_cluster_api=false
-	modules = []
+    modules = []
   }
 }
 `
@@ -217,30 +238,41 @@ resource "rediscloud_subscription_database" "example" {
     protocol = "redis"
     memory_limit_in_gb = 3
     data_persistence = "none"
-	data_eviction = "allkeys-random"
+    data_eviction = "allkeys-random"
     throughput_measurement_by = "operations-per-second"
     throughput_measurement_value = 1000
-	password = "%s"
-	support_oss_cluster_api = false 
-	external_endpoint_for_oss_cluster_api = false
-	replication = false
-	average_item_size_in_bytes = 0
-	client_ssl_certificate = "" 
-	periodic_backup_path = ""
+    password = "%s"
+    support_oss_cluster_api = false 
+    external_endpoint_for_oss_cluster_api = false
+    replication = false
+    average_item_size_in_bytes = 0
+    client_ssl_certificate = "" 
+    periodic_backup_path = ""
 
-	alert {
-		name = "dataset-size"
-		value = 40
-	}
-	
-	modules = [
+    alert {
+        name = "dataset-size"
+        value = 40
+    }
+
+    modules = [
         {
           name = "RedisBloom"
         }
     ]
 } 
 `
 
+const testAccResourceRedisCloudSubscriptionDatabaseOptionalAttributes = subscriptionBoilerplate + `
+resource "rediscloud_subscription_database" "example" {
+    subscription_id = rediscloud_subscription.example.id
+    name = "example-no-protocol"
+    memory_limit_in_gb = 1
+    data_persistence = "none"
+    throughput_measurement_by = "operations-per-second"
+    throughput_measurement_value = 1000   
+} 
+`
+
 // TF config for provisioning a database where the password is not specified
 const testAccResourceRedisCloudSubscriptionDatabaseNoPassword = subscriptionBoilerplate + `
 resource "rediscloud_subscription_database" "no_password_database" {
@@ -338,7 +370,7 @@ resource "rediscloud_subscription" "example" {
 const testAccResourceRedisCloudSubscriptionDatabaseMultiModules = multiModulesSubscriptionBoilerplate + `
 resource "rediscloud_subscription_database" "example" {
     subscription_id              = rediscloud_subscription.example.id
-	name                         = "%s"
+    name                         = "%s"
     protocol                     = "redis"
     memory_limit_in_gb           = 1
     data_persistence             = "none"