Fix Nullable Field of Cluster Email (#121)

dell · Feb 4, 2024 · 9e750ad · 9e750ad
1 parent c922128
commit 9e750ad
Show file tree

Hide file tree

Showing 6 changed files with 54 additions and 6 deletions.
diff --git a/docs/resources/cluster_email.md b/docs/resources/cluster_email.md
@@ -73,7 +73,7 @@ resource "powerscale_cluster_email" "test" {
 
 }
 
-# After the execution of above resource block, Cluster Email Settings would have been cached in terraform state file, or
+# After the execution of above resource block, Cluster Email Settings would have been cached in terraform state file, and
 # Cluster Email Settings would have been updated on PowerScale.
 # For more information, Please check the terraform state file.
 ```
@@ -103,7 +103,7 @@ Optional:
 - `smtp_auth_username` (String) Username to authenticate with if SMTP authentication is being used.
 - `smtp_port` (Number) The port on the SMTP server to be used for relaying the notification messages.
 - `use_smtp_auth` (Boolean) If true, this cluster will send SMTP authentication credentials to the SMTP relay server in order to send its notification emails.  If false, the cluster will attempt to send its notification emails without authentication.
-- `user_template` (String) Location of a custom template file that can be used to specify the layout of the notification emails.
+- `user_template` (String) Location of a custom template file that can be used to specify the layout of the notification emails.  If this string is empty, the default template will be used.
 
 Read-Only:
 

diff --git a/examples/resources/powerscale_cluster_email/resource.tf b/examples/resources/powerscale_cluster_email/resource.tf
@@ -41,6 +41,6 @@ resource "powerscale_cluster_email" "test" {
 
 }
 
-# After the execution of above resource block, Cluster Email Settings would have been cached in terraform state file, or
+# After the execution of above resource block, Cluster Email Settings would have been cached in terraform state file, and
 # Cluster Email Settings would have been updated on PowerScale.
 # For more information, Please check the terraform state file.
diff --git a/goClientZip/PowerScale_API_9.5.0.json b/goClientZip/PowerScale_API_9.5.0.json
@@ -45408,7 +45408,8 @@
         "user_template": {
           "description": "Location of a custom template file that can be used to specify the layout of the notification emails.",
           "pattern": "^/ifs$|^/ifs/",
-          "type": "string"
+          "type": "string",
+          "x-nullable": true
         }
       },
       "type": "object"

diff --git a/goClientZip/powerscale-go-client.zip b/goClientZip/powerscale-go-client.zip
diff --git a/powerscale/provider/cluster_email_resource.go b/powerscale/provider/cluster_email_resource.go
@@ -147,8 +147,8 @@ func (r *ClusterEmailResource) Schema(ctx context.Context, req resource.SchemaRe
 						Computed:            true,
 					},
 					"user_template": schema.StringAttribute{
-						Description:         "Location of a custom template file that can be used to specify the layout of the notification emails.",
-						MarkdownDescription: "Location of a custom template file that can be used to specify the layout of the notification emails.",
+						Description:         "Location of a custom template file that can be used to specify the layout of the notification emails.  If this string is empty, the default template will be used.",
+						MarkdownDescription: "Location of a custom template file that can be used to specify the layout of the notification emails.  If this string is empty, the default template will be used.",
 						Optional:            true,
 						Computed:            true,
 					},
@@ -201,6 +201,13 @@ func (r *ClusterEmailResource) Create(ctx context.Context, req resource.CreateRe
 		)
 		return
 	}
+	// if the field is set to empty, set it to null to update back to default
+	// if not set, unset the field to not update it
+	if plan.Settings.UserTemplate.IsUnknown() {
+		toUpdate.UserTemplate.Unset()
+	} else if plan.Settings.UserTemplate.ValueString() == "" {
+		toUpdate.UserTemplate.Set(nil)
+	}
 	err = helper.UpdateClusterEmail(ctx, r.client, toUpdate)
 	if err != nil {
 		errStr := constants.UpdateClusterEmailSettingsErrorMsg + "with error: "
@@ -301,6 +308,11 @@ func (r *ClusterEmailResource) Update(ctx context.Context, req resource.UpdateRe
 		)
 		return
 	}
+	if plan.Settings.UserTemplate.IsUnknown() {
+		toUpdate.UserTemplate.Unset()
+	} else if plan.Settings.UserTemplate.ValueString() == "" {
+		toUpdate.UserTemplate.Set(nil)
+	}
 	err = helper.UpdateClusterEmail(ctx, r.client, toUpdate)
 	if err != nil {
 		errStr := constants.UpdateClusterEmailSettingsErrorMsg + "with error: "

diff --git a/powerscale/provider/cluster_email_resource_test.go b/powerscale/provider/cluster_email_resource_test.go
@@ -58,6 +58,24 @@ func TestAccClusterEmailResourceImport(t *testing.T) {
 	})
 }
 
+func TestAccClusterEmailResourceNullableField(t *testing.T) {
+	resource.Test(t, resource.TestCase{
+		PreCheck:                 func() { testAccPreCheck(t) },
+		ProtoV6ProviderFactories: testAccProtoV6ProviderFactories,
+		Steps: []resource.TestStep{
+			{
+				Config: ProviderConfig + clusterEmailResourceConfig,
+			},
+			{
+				Config: ProviderConfig + clusterEmailUserTemplateSetResourceConfig,
+			},
+			{
+				Config: ProviderConfig + clusterEmailUserTemplateEmptyResourceConfig,
+			},
+		},
+	})
+}
+
 func TestAccClusterEmailResourceUpdate(t *testing.T) {
 	var clusterEmailResourceName = "powerscale_cluster_email.test"
 	resource.Test(t, resource.TestCase{
@@ -216,6 +234,23 @@ resource "powerscale_cluster_email" "test" {
 	}
 }
 `
+
+var clusterEmailUserTemplateSetResourceConfig = `
+resource "powerscale_cluster_email" "test" {
+	settings = {
+		user_template = "/ifs/README.txt"
+	}
+}
+`
+
+var clusterEmailUserTemplateEmptyResourceConfig = `
+resource "powerscale_cluster_email" "test" {
+	settings = {
+		user_template = ""
+	}
+}
+`
+
 var clusterEmailUpdateResourceConfig = `
 resource "powerscale_cluster_email" "test" {
 	settings = {