Delete rules when destroying the resource

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.5 (unreleased)
+
+- Delete all rules when destroying `meraki_appliance_cellular_firewall_rules`, `meraki_appliance_inbound_cellular_firewall_rules`, `meraki_appliance_inbound_firewall_rules`, `meraki_appliance_l3_firewall_rules`, `meraki_appliance_l7_firewall_rules`, `meraki_appliance_one_to_many_nat_rules`, `meraki_appliance_one_to_one_nat_rules`, `meraki_appliance_port_forwarding_rules`, `meraki_appliance_traffic_shaping_rules`, `meraki_appliance_vpn_firewall_rules`, `meraki_wireless_ssid_l3_firewall_rules`, `meraki_wireless_ssid_l7_firewall_rules`, `meraki_wireless_ssid_traffic_shaping_rules` resources
+
 ## 0.1.4
 
 - Add `ip_version` attribute to `meraki_wireless_ssid_l3_firewall_rules` resource and data source

docs/guides/changelog.md

@@ -7,6 +7,10 @@ description: |-
 
 # Changelog
 
+## 0.1.5 (unreleased)
+
+- Delete all rules when destroying `meraki_appliance_cellular_firewall_rules`, `meraki_appliance_inbound_cellular_firewall_rules`, `meraki_appliance_inbound_firewall_rules`, `meraki_appliance_l3_firewall_rules`, `meraki_appliance_l7_firewall_rules`, `meraki_appliance_one_to_many_nat_rules`, `meraki_appliance_one_to_one_nat_rules`, `meraki_appliance_port_forwarding_rules`, `meraki_appliance_traffic_shaping_rules`, `meraki_appliance_vpn_firewall_rules`, `meraki_wireless_ssid_l3_firewall_rules`, `meraki_wireless_ssid_l7_firewall_rules`, `meraki_wireless_ssid_traffic_shaping_rules` resources
+
 ## 0.1.4
 
 - Add `ip_version` attribute to `meraki_wireless_ssid_l3_firewall_rules` resource and data source

gen/definitions/appliance_cellular_firewall_rules.yaml

@@ -19,6 +19,7 @@ attributes:
     allow_import_changes: true
     description: An ordered array of the firewall rules (not including the default rule)
     ordered_list: true
+    destroy_value: '[]interface{}{}'
     attributes:
       - model_name: comment
         type: String

gen/definitions/appliance_inbound_cellular_firewall_rules.yaml

@@ -19,6 +19,7 @@ attributes:
     allow_import_changes: true
     description: An ordered array of the firewall rules (not including the default rule)
     ordered_list: true
+    destroy_value: '[]interface{}{}'
     attributes:
       - model_name: comment
         type: String

gen/definitions/appliance_inbound_firewall_rules.yaml

@@ -24,6 +24,7 @@ attributes:
     allow_import_changes: true
     description: An ordered array of the firewall rules (not including the default rule)
     ordered_list: true
+    destroy_value: '[]interface{}{}'
     attributes:
       - model_name: comment
         type: String

gen/definitions/appliance_l3_firewall_rules.yaml

@@ -24,6 +24,7 @@ attributes:
     allow_import_changes: true
     description: An ordered array of the firewall rules (not including the default rule)
     ordered_list: true
+    destroy_value: '[]interface{}{}'
     attributes:
       - model_name: comment
         type: String

gen/definitions/appliance_l7_firewall_rules.yaml

@@ -18,6 +18,7 @@ attributes:
     mandatory: true
     description: An ordered array of the MX L7 firewall rules
     ordered_list: true
+    destroy_value: '[]interface{}{}'
     attributes:
       - model_name: policy
         type: String

gen/definitions/appliance_one_to_many_nat_rules.yaml

@@ -17,6 +17,7 @@ attributes:
     type: List
     mandatory: true
     description: An array of 1:Many nat rules
+    destroy_value: '[]interface{}{}'
     attributes:
       - model_name: publicIp
         type: String

gen/definitions/appliance_one_to_one_nat_rules.yaml

@@ -17,6 +17,7 @@ attributes:
     type: List
     mandatory: true
     description: An array of 1:1 nat rules
+    destroy_value: '[]interface{}{}'
     attributes:
       - model_name: lanIp
         type: String

gen/definitions/appliance_port_forwarding_rules.yaml

@@ -17,6 +17,7 @@ attributes:
     type: List
     mandatory: true
     description: An array of port forwarding params
+    destroy_value: '[]interface{}{}'
     attributes:
       - model_name: lanIp
         type: String

gen/definitions/appliance_traffic_shaping_rules.yaml

@@ -21,6 +21,7 @@ attributes:
     type: List
     description: An array of traffic shaping rules. Rules are applied in the order that they are specified in. An empty list (or null) means no rules. Note that you are allowed a maximum of 8 rules.
     ordered_list: true
+    destroy_value: '[]interface{}{}'
     attributes:
       - model_name: dscpTagValue
         type: Int64

gen/definitions/appliance_vpn_firewall_rules.yaml

@@ -24,6 +24,7 @@ attributes:
     allow_import_changes: true
     description: An ordered array of the firewall rules (not including the default rule)
     ordered_list: true
+    destroy_value: '[]interface{}{}'
     attributes:
       - model_name: comment
         type: String

gen/definitions/wireless_ssid_l3_firewall_rules.yaml

@@ -30,6 +30,7 @@ attributes:
     allow_import_changes: true
     description: An ordered array of the firewall rules for this SSID (not including the local LAN access rule or the default rule).
     ordered_list: true
+    destroy_value: '[]interface{}{}'
     attributes:
       - model_name: comment
         type: String

gen/definitions/wireless_ssid_l7_firewall_rules.yaml

@@ -24,6 +24,7 @@ attributes:
     type: List
     description: An array of L7 firewall rules for this SSID. Rules will get applied in the same order user has specified in request. Empty array will clear the L7 firewall rule configuration.
     ordered_list: true
+    destroy_value: '[]interface{}{}'
     attributes:
       - model_name: policy
         type: String

gen/definitions/wireless_ssid_traffic_shaping_rules.yaml

@@ -31,6 +31,7 @@ attributes:
     type: List
     description: An array of traffic shaping rules. Rules are applied in the order that they are specified in. An empty list (or null) means no rules. Note that you are allowed a maximum of 8 rules.
     ordered_list: true
+    destroy_value: '[]interface{}{}'
     attributes:
       - model_name: dscpTagValue
         type: Int64

gen/schema/schema.yaml

@@ -60,5 +60,6 @@ attribute:
   value: any(str(), int(), bool(), required=False) # Hardcoded value for the attribute
   test_value: str(required=False) # Value used for acceptance test
   minimum_test_value: str(required=False) # Value used for "minimum" resource acceptance test
+  destroy_value: str(required=False) # Value used when destroying resource using PUT
   test_tags: list(str(), required=False) # List of test tags, attribute is only included in acceptance tests if an environment variable with one of these tags is configured
   attributes: list(include('attribute'), required=False) # List of attributes, only relevant if type is "List" or "Set"

gen/templates/model.go

@@ -507,6 +507,20 @@ func (data *{{camelCase .Name}}) fromBodyUnknowns(ctx context.Context, res merak
 
 // End of section. //template:end fromBodyUnknowns
 
+// Section below is generated&owned by "gen/generator.go". //template:begin toDestroyBody
+
+func (data {{camelCase .Name}}) toDestroyBody(ctx context.Context) string {
+	body := ""
+	{{- range .Attributes}}
+	{{- if .DestroyValue}}
+	body, _ = sjson.Set(body, "{{getFullModelName .}}", {{.DestroyValue}})
+	{{- end}}
+	{{- end}}
+	return body
+}
+
+// End of section. //template:end toDestroyBody
+
 {{- range .Attributes}}
 	{{- range .Attributes}}
 		{{- if .OrderedList }}

gen/templates/resource.go

@@ -580,7 +580,14 @@ func (r *{{camelCase .Name}}Resource) Delete(ctx context.Context, req resource.D
 
 	tflog.Debug(ctx, fmt.Sprintf("%s: Beginning Delete", state.Id.ValueString()))
 
-	{{- if not .NoDelete}}
+	{{- if hasDestroyValues .Attributes}}
+	body := state.toDestroyBody(ctx)
+	res, err := r.client.Put(state.getPath(), body)
+	if err != nil {
+		resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to configure object (PUT), got error: %s, %s", err, res.String()))
+		return
+	}
+	{{- else if not .NoDelete}}
 	res, err := r.client.Delete(state.getPath() + "/" + url.QueryEscape(state.Id.ValueString()))
 	if err != nil && !strings.Contains(err.Error(), "StatusCode 404") {
 		resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to delete object (DELETE), got error: %s, %s", err, res.String()))

gen/yamlconfig/main.go

@@ -109,6 +109,7 @@ type YamlConfigAttribute struct {
 	Value              string                `yaml:"value,omitempty"`
 	TestValue          string                `yaml:"test_value,omitempty"`
 	MinimumTestValue   string                `yaml:"minimum_test_value,omitempty"`
+	DestroyValue       string                `yaml:"destroy_value,omitempty"`
 	TestTags           []string              `yaml:"test_tags,omitempty,flow"`
 	Attributes         []YamlConfigAttribute `yaml:"attributes,omitempty"`
 	GoTypeName         string                `yaml:"gotypename,omitempty"`
@@ -149,6 +150,7 @@ type YamlConfigAttributeP struct {
 	Value              *string                 `yaml:"value,omitempty"`
 	TestValue          *string                 `yaml:"test_value,omitempty"`
 	MinimumTestValue   *string                 `yaml:"minimum_test_value,omitempty"`
+	DestroyValue       *string                 `yaml:"destroy_value,omitempty"`
 	TestTags           *[]string               `yaml:"test_tags,omitempty,flow"`
 	Attributes         *[]YamlConfigAttributeP `yaml:"attributes,omitempty"`
 	GoTypeName         *string                 `yaml:"gotypename,omitempty"`
@@ -410,6 +412,19 @@ func BuildTestPath(attr ...YamlConfigAttribute) string {
 	return strings.Join(path, ".") + "."
 }
 
+// HasDestroyValues returns true if any attributes have explicit destroy values
+func HasDestroyValues(attributes []YamlConfigAttribute) bool {
+	for _, attr := range attributes {
+		if attr.DestroyValue != "" {
+			return true
+		}
+		if len(attr.Attributes) > 0 && HasDestroyValues(attr.Attributes) {
+			return true
+		}
+	}
+	return false
+}
+
 // Map of templating functions
 var Functions = template.FuncMap{
 	"toGoName":              ToGoName,
@@ -439,6 +454,7 @@ var Functions = template.FuncMap{
 	"getFullModelName":      GetFullModelName,
 	"hasComputedAttributes": HasComputedAttributes,
 	"buildTestPath":         BuildTestPath,
+	"hasDestroyValues":      HasDestroyValues,
 }
 
 var matchFirstCap = regexp.MustCompile("(.)([A-Z][a-z]+)")
@@ -795,6 +811,9 @@ func MergeYamlConfigAttribute(existing *YamlConfigAttributeP, new *YamlConfigAtt
 	if existing.MinimumTestValue != nil {
 		new.MinimumTestValue = existing.MinimumTestValue
 	}
+	if existing.DestroyValue != nil {
+		new.DestroyValue = existing.DestroyValue
+	}
 	if existing.TestTags != nil {
 		new.TestTags = existing.TestTags
 	}

internal/provider/model_meraki_appliance_cellular_firewall_rules.go

@@ -230,3 +230,13 @@ func (data *ApplianceCellularFirewallRules) fromBodyUnknowns(ctx context.Context
 }
 
 // End of section. //template:end fromBodyUnknowns
+
+// Section below is generated&owned by "gen/generator.go". //template:begin toDestroyBody
+
+func (data ApplianceCellularFirewallRules) toDestroyBody(ctx context.Context) string {
+	body := ""
+	body, _ = sjson.Set(body, "rules", []interface{}{})
+	return body
+}
+
+// End of section. //template:end toDestroyBody

internal/provider/model_meraki_appliance_connectivity_monitoring_destinations.go

@@ -185,3 +185,12 @@ func (data *ApplianceConnectivityMonitoringDestinations) fromBodyUnknowns(ctx co
 }
 
 // End of section. //template:end fromBodyUnknowns
+
+// Section below is generated&owned by "gen/generator.go". //template:begin toDestroyBody
+
+func (data ApplianceConnectivityMonitoringDestinations) toDestroyBody(ctx context.Context) string {
+	body := ""
+	return body
+}
+
+// End of section. //template:end toDestroyBody

internal/provider/model_meraki_appliance_content_filtering.go

@@ -125,3 +125,12 @@ func (data *ApplianceContentFiltering) fromBodyUnknowns(ctx context.Context, res
 }
 
 // End of section. //template:end fromBodyUnknowns
+
+// Section below is generated&owned by "gen/generator.go". //template:begin toDestroyBody
+
+func (data ApplianceContentFiltering) toDestroyBody(ctx context.Context) string {
+	body := ""
+	return body
+}
+
+// End of section. //template:end toDestroyBody

internal/provider/model_meraki_appliance_firewall_settings.go

@@ -96,3 +96,12 @@ func (data *ApplianceFirewallSettings) fromBodyUnknowns(ctx context.Context, res
 }
 
 // End of section. //template:end fromBodyUnknowns
+
+// Section below is generated&owned by "gen/generator.go". //template:begin toDestroyBody
+
+func (data ApplianceFirewallSettings) toDestroyBody(ctx context.Context) string {
+	body := ""
+	return body
+}
+
+// End of section. //template:end toDestroyBody

internal/provider/model_meraki_appliance_firewalled_service.go

@@ -114,3 +114,12 @@ func (data *ApplianceFirewalledService) fromBodyUnknowns(ctx context.Context, re
 }
 
 // End of section. //template:end fromBodyUnknowns
+
+// Section below is generated&owned by "gen/generator.go". //template:begin toDestroyBody
+
+func (data ApplianceFirewalledService) toDestroyBody(ctx context.Context) string {
+	body := ""
+	return body
+}
+
+// End of section. //template:end toDestroyBody

internal/provider/model_meraki_appliance_inbound_cellular_firewall_rules.go

@@ -230,3 +230,13 @@ func (data *ApplianceInboundCellularFirewallRules) fromBodyUnknowns(ctx context.
 }
 
 // End of section. //template:end fromBodyUnknowns
+
+// Section below is generated&owned by "gen/generator.go". //template:begin toDestroyBody
+
+func (data ApplianceInboundCellularFirewallRules) toDestroyBody(ctx context.Context) string {
+	body := ""
+	body, _ = sjson.Set(body, "rules", []interface{}{})
+	return body
+}
+
+// End of section. //template:end toDestroyBody

internal/provider/model_meraki_appliance_inbound_firewall_rules.go

@@ -244,3 +244,13 @@ func (data *ApplianceInboundFirewallRules) fromBodyUnknowns(ctx context.Context,
 }
 
 // End of section. //template:end fromBodyUnknowns
+
+// Section below is generated&owned by "gen/generator.go". //template:begin toDestroyBody
+
+func (data ApplianceInboundFirewallRules) toDestroyBody(ctx context.Context) string {
+	body := ""
+	body, _ = sjson.Set(body, "rules", []interface{}{})
+	return body
+}
+
+// End of section. //template:end toDestroyBody

internal/provider/model_meraki_appliance_l3_firewall_rules.go

@@ -244,3 +244,13 @@ func (data *ApplianceL3FirewallRules) fromBodyUnknowns(ctx context.Context, res
 }
 
 // End of section. //template:end fromBodyUnknowns
+
+// Section below is generated&owned by "gen/generator.go". //template:begin toDestroyBody
+
+func (data ApplianceL3FirewallRules) toDestroyBody(ctx context.Context) string {
+	body := ""
+	body, _ = sjson.Set(body, "rules", []interface{}{})
+	return body
+}
+
+// End of section. //template:end toDestroyBody

internal/provider/model_meraki_appliance_l7_firewall_rules.go

@@ -160,3 +160,13 @@ func (data *ApplianceL7FirewallRules) fromBodyUnknowns(ctx context.Context, res
 }
 
 // End of section. //template:end fromBodyUnknowns
+
+// Section below is generated&owned by "gen/generator.go". //template:begin toDestroyBody
+
+func (data ApplianceL7FirewallRules) toDestroyBody(ctx context.Context) string {
+	body := ""
+	body, _ = sjson.Set(body, "rules", []interface{}{})
+	return body
+}
+
+// End of section. //template:end toDestroyBody

internal/provider/model_meraki_appliance_network_security_intrusion.go

@@ -157,3 +157,12 @@ func (data *ApplianceNetworkSecurityIntrusion) fromBodyUnknowns(ctx context.Cont
 }
 
 // End of section. //template:end fromBodyUnknowns
+
+// Section below is generated&owned by "gen/generator.go". //template:begin toDestroyBody
+
+func (data ApplianceNetworkSecurityIntrusion) toDestroyBody(ctx context.Context) string {
+	body := ""
+	return body
+}
+
+// End of section. //template:end toDestroyBody

internal/provider/model_meraki_appliance_one_to_many_nat_rules.go

@@ -316,3 +316,13 @@ func (data *ApplianceOneToManyNATRules) fromBodyUnknowns(ctx context.Context, re
 }
 
 // End of section. //template:end fromBodyUnknowns
+
+// Section below is generated&owned by "gen/generator.go". //template:begin toDestroyBody
+
+func (data ApplianceOneToManyNATRules) toDestroyBody(ctx context.Context) string {
+	body := ""
+	body, _ = sjson.Set(body, "rules", []interface{}{})
+	return body
+}
+
+// End of section. //template:end toDestroyBody

internal/provider/model_meraki_appliance_one_to_one_nat_rules.go

@@ -304,3 +304,13 @@ func (data *ApplianceOneToOneNATRules) fromBodyUnknowns(ctx context.Context, res
 }
 
 // End of section. //template:end fromBodyUnknowns
+
+// Section below is generated&owned by "gen/generator.go". //template:begin toDestroyBody
+
+func (data ApplianceOneToOneNATRules) toDestroyBody(ctx context.Context) string {
+	body := ""
+	body, _ = sjson.Set(body, "rules", []interface{}{})
+	return body
+}
+
+// End of section. //template:end toDestroyBody

internal/provider/model_meraki_appliance_organization_security_intrusion.go

@@ -171,3 +171,12 @@ func (data *ApplianceOrganizationSecurityIntrusion) fromBodyUnknowns(ctx context
 }
 
 // End of section. //template:end fromBodyUnknowns
+
+// Section below is generated&owned by "gen/generator.go". //template:begin toDestroyBody
+
+func (data ApplianceOrganizationSecurityIntrusion) toDestroyBody(ctx context.Context) string {
+	body := ""
+	return body
+}
+
+// End of section. //template:end toDestroyBody