Merge pull request #5906 from zakcutner/ruleset/rules-actions

test(cloudflare_ruleset): add coverage for `action_parameters` attributes

Author: vaishakdinesh

internal/services/ruleset/model.go

@@ -34,7 +34,7 @@ func (m RulesetModel) MarshalJSONForUpdate(state RulesetModel) (data []byte, err
 type RulesetRulesModel struct {
 	ID                     types.String                                                      `tfsdk:"id" json:"id,computed"`
 	Action                 types.String                                                      `tfsdk:"action" json:"action,required"`
-	ActionParameters       customfield.NestedObject[RulesetRulesActionParametersModel]       `tfsdk:"action_parameters" json:"action_parameters,optional"`
+	ActionParameters       customfield.NestedObject[RulesetRulesActionParametersModel]       `tfsdk:"action_parameters" json:"action_parameters,computed_optional,decode_null_to_zero"`
 	Description            types.String                                                      `tfsdk:"description" json:"description,optional"`
 	Enabled                types.Bool                                                        `tfsdk:"enabled" json:"enabled,computed_optional"`
 	ExposedCredentialCheck customfield.NestedObject[RulesetRulesExposedCredentialCheckModel] `tfsdk:"exposed_credential_check" json:"exposed_credential_check,optional"`

internal/services/ruleset/resource_test.go

@@ -12,12 +12,12 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework-validators/listvalidator"
 	"github.com/hashicorp/terraform-plugin-framework-validators/objectvalidator"
 	"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
-	"github.com/hashicorp/terraform-plugin-framework/attr"
 	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/booldefault"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/listdefault"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/objectdefault"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringdefault"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier"
@@ -111,11 +111,8 @@ func ResourceSchema(ctx context.Context) schema.Schema {
 				Description: "The list of rules in the ruleset.",
 				Computed:    true,
 				Optional:    true,
-				Default: listdefault.StaticValue(types.ListValueMust(
-					customfield.NewNestedObjectType[RulesetRulesModel](ctx),
-					[]attr.Value{},
-				)),
-				CustomType: customfield.NewNestedObjectListType[RulesetRulesModel](ctx),
+				Default:     listdefault.StaticValue(customfield.NewObjectListMust(ctx, []RulesetRulesModel{}).ListValue),
+				CustomType:  customfield.NewNestedObjectListType[RulesetRulesModel](ctx),
 				NestedObject: schema.NestedAttributeObject{
 					Attributes: map[string]schema.Attribute{
 						"id": schema.StringAttribute{
@@ -150,7 +147,9 @@ func ResourceSchema(ctx context.Context) schema.Schema {
 						},
 						"action_parameters": schema.SingleNestedAttribute{
 							Description: "The parameters configuring the rule's action.",
+							Computed:    true,
 							Optional:    true,
+							Default:     objectdefault.StaticValue(customfield.NewObjectMust(ctx, &RulesetRulesActionParametersModel{}).ObjectValue),
 							CustomType:  customfield.NewNestedObjectType[RulesetRulesActionParametersModel](ctx),
 							Attributes: map[string]schema.Attribute{
 								"response": schema.SingleNestedAttribute{

internal/services/ruleset/schema.go

@@ -0,0 +1,14 @@
+variable "zone_id" {}
+
+resource "cloudflare_ruleset" "my_ruleset" {
+  zone_id = var.zone_id
+  name    = "My ruleset"
+  phase   = "http_request_firewall_custom"
+  kind    = "zone"
+  rules = [
+    {
+      expression = "ip.src eq 1.1.1.1"
+      action     = "block"
+    }
+  ]
+}

internal/services/ruleset/testdata/TestAccCloudflareRuleset_BlockRules/1.tf

@@ -0,0 +1,21 @@
+variable "zone_id" {}
+
+resource "cloudflare_ruleset" "my_ruleset" {
+  zone_id = var.zone_id
+  name    = "My ruleset"
+  phase   = "http_request_firewall_custom"
+  kind    = "zone"
+  rules = [
+    {
+      expression = "ip.src eq 1.1.1.1"
+      action     = "block"
+      action_parameters = {
+        response = {
+          status_code  = 403
+          content      = "Access denied"
+          content_type = "text/plain"
+        }
+      }
+    }
+  ]
+}

internal/services/ruleset/testdata/TestAccCloudflareRuleset_BlockRules/2.tf

@@ -0,0 +1,21 @@
+variable "zone_id" {}
+
+resource "cloudflare_ruleset" "my_ruleset" {
+  zone_id = var.zone_id
+  name    = "My ruleset"
+  phase   = "http_response_compression"
+  kind    = "zone"
+  rules = [
+    {
+      expression = "ip.src eq 1.1.1.1"
+      action     = "compress_response"
+      action_parameters = {
+        algorithms = [
+          {
+            name = "auto"
+          }
+        ]
+      }
+    }
+  ]
+}

internal/services/ruleset/testdata/TestAccCloudflareRuleset_CompressResponseRules/1.tf

@@ -0,0 +1,24 @@
+variable "zone_id" {}
+
+resource "cloudflare_ruleset" "my_ruleset" {
+  zone_id = var.zone_id
+  name    = "My ruleset"
+  phase   = "http_response_compression"
+  kind    = "zone"
+  rules = [
+    {
+      expression = "ip.src eq 1.1.1.1"
+      action     = "compress_response"
+      action_parameters = {
+        algorithms = [
+          {
+            name = "brotli"
+          },
+          {
+            name = "gzip"
+          }
+        ]
+      }
+    }
+  ]
+}

internal/services/ruleset/testdata/TestAccCloudflareRuleset_CompressResponseRules/2.tf

@@ -0,0 +1,14 @@
+variable "zone_id" {}
+
+resource "cloudflare_ruleset" "my_ruleset" {
+  zone_id = var.zone_id
+  name    = "My ruleset"
+  phase   = "http_request_firewall_custom"
+  kind    = "zone"
+  rules = [
+    {
+      expression = "ip.src eq 1.1.1.1"
+      action     = "block"
+    }
+  ]
+}

internal/services/ruleset/testdata/TestAccCloudflareRuleset_RulesActionParameters/1.tf

@@ -0,0 +1,15 @@
+variable "zone_id" {}
+
+resource "cloudflare_ruleset" "my_ruleset" {
+  zone_id = var.zone_id
+  name    = "My ruleset"
+  phase   = "http_request_firewall_custom"
+  kind    = "zone"
+  rules = [
+    {
+      expression        = "ip.src eq 1.1.1.1"
+      action            = "block"
+      action_parameters = {}
+    }
+  ]
+}