Fix issue with global pools update (#91)

Author: kuba-mazurkiewicz

CHANGELOG.md

@@ -1,5 +1,6 @@
 ## 0.1.10 (unreleased)
 
+- BREAKING CHANGE: Fix `ip_pool` update if more than 25 pools are registered
 - BREAKING CHANGE: Rename `radio_type_a_power_treshold_v1` attribute of `catalystcenter_wireless_rf_profile` resource to `radio_type_a_power_threshold_v1`
 - BREAKING CHANGE: Rename `radio_type_b_power_treshold_v1` attribute of `catalystcenter_wireless_rf_profile` resource to `radio_type_b_power_threshold_v1`
 - BREAKING CHANGE: Rename `radio_type_c_power_treshold_v1` attribute of `catalystcenter_wireless_rf_profile` resource to `radio_type_c_power_threshold_v1`

docs/data-sources/ip_pool.md

@@ -30,7 +30,7 @@ data "catalystcenter_ip_pool" "example" {
 
 - `dhcp_server_ips` (Set of String) List of DHCP Server IPs
 - `dns_server_ips` (Set of String) List of DNS Server IPs
-- `gateway` (String) The gateway for the IP pool
+- `gateway` (Set of String) The gateway for the IP pool
 - `ip_address_space` (String) IP address version
 - `ip_subnet` (String) The IP subnet of the IP pool
 - `type` (String) Choose `Tunnel` to assign IP addresses to site-to-site VPN for IPSec tunneling. Choose `Generic` for all other network types.

docs/guides/changelog.md

@@ -9,6 +9,7 @@ description: |-
 
 ## 0.1.10 (unreleased)
 
+- BREAKING CHANGE: Fix `ip_pool` update if more than 25 pools are registered
 - BREAKING CHANGE: Rename `radio_type_a_power_treshold_v1` attribute of `catalystcenter_wireless_rf_profile` resource to `radio_type_a_power_threshold_v1`
 - BREAKING CHANGE: Rename `radio_type_b_power_treshold_v1` attribute of `catalystcenter_wireless_rf_profile` resource to `radio_type_b_power_threshold_v1`
 - BREAKING CHANGE: Rename `radio_type_c_power_treshold_v1` attribute of `catalystcenter_wireless_rf_profile` resource to `radio_type_c_power_threshold_v1`

docs/resources/ip_pool.md

@@ -16,9 +16,9 @@ This resource can manage an IP Pool.
 resource "catalystcenter_ip_pool" "example" {
   name             = "MyPool1"
   ip_address_space = "IPv4"
-  type             = "Generic"
+  type             = "generic"
   ip_subnet        = "21.1.1.0/24"
-  gateway          = "21.1.1.1"
+  gateway          = ["21.1.1.1"]
   dhcp_server_ips  = ["1.2.3.4"]
   dns_server_ips   = ["2.3.4.5"]
 }
@@ -36,13 +36,13 @@ resource "catalystcenter_ip_pool" "example" {
 
 - `dhcp_server_ips` (Set of String) List of DHCP Server IPs
 - `dns_server_ips` (Set of String) List of DNS Server IPs
-- `gateway` (String) The gateway for the IP pool
+- `gateway` (Set of String) The gateway for the IP pool
 - `ip_address_space` (String) IP address version
   - Choices: `IPv4`, `IPv6`
   - Default value: `IPv4`
 - `type` (String) Choose `Tunnel` to assign IP addresses to site-to-site VPN for IPSec tunneling. Choose `Generic` for all other network types.
-  - Choices: `Generic`, `Tunnel`
-  - Default value: `Generic`
+  - Choices: `generic`, `tunnel`
+  - Default value: `generic`
 
 ### Read-Only
 

examples/resources/catalystcenter_ip_pool/resource.tf

@@ -1,9 +1,9 @@
 resource "catalystcenter_ip_pool" "example" {
   name             = "MyPool1"
   ip_address_space = "IPv4"
-  type             = "Generic"
+  type             = "generic"
   ip_subnet        = "21.1.1.0/24"
-  gateway          = "21.1.1.1"
+  gateway          = ["21.1.1.1"]
   dhcp_server_ips  = ["1.2.3.4"]
   dns_server_ips   = ["2.3.4.5"]
 }

gen/definitions/ip_pool.yaml

@@ -1,59 +1,51 @@
 ---
 name: IP Pool
-rest_endpoint: /dna/intent/api/v1/global-pool
-get_rest_endpoint: /api/v2/ippool
-put_id_include_path: settings.ippool.0.id
+rest_endpoint: /api/v2/ippool
+get_requires_id: true
 id_from_query_path: response
 doc_category: Network Settings
 attributes:
   - model_name: ipPoolName
     tf_name: name
-    data_path: settings.ippool.0
     response_data_path: response.ipPoolName
     type: String
     match_id: true
     data_source_query: true
     description: The name of the IP pool
     example: MyPool1
   - model_name: IpAddressSpace
-    data_path: settings.ippool.0
-    write_only: true
     type: String
     enum_values: [IPv4, IPv6]
     default_value: IPv4
     description: IP address version
     example: IPv4
   - model_name: type
-    data_path: settings.ippool.0
     type: String
-    write_only: true
-    enum_values: [Generic, Tunnel]
-    default_value: Generic
+    enum_values: [generic, tunnel]
+    default_value: generic
     description: Choose `Tunnel` to assign IP addresses to site-to-site VPN for IPSec tunneling. Choose `Generic` for all other network types.
-    example: Generic
+    example: generic
   - model_name: ipPoolCidr
     tf_name: ip_subnet
-    data_path: settings.ippool.0
     response_data_path: response.ipPoolCidr
     type: String
     mandatory: true
     description: The IP subnet of the IP pool
     example: 21.1.1.0/24
-  - model_name: gateway
-    data_path: settings.ippool.0
-    response_data_path: response.gateways.0
-    type: String
+  - model_name: gateways
+    tf_name: gateway
+    response_data_path: response.gateways
+    type: Set
+    element_type: String
     description: The gateway for the IP pool
     example: 21.1.1.1
   - model_name: dhcpServerIps
-    data_path: settings.ippool.0
     response_data_path: response.dhcpServerIps
     type: Set
     element_type: String
     description: List of DHCP Server IPs
     example: 1.2.3.4
   - model_name: dnsServerIps
-    data_path: settings.ippool.0
     response_data_path: response.dnsServerIps
     type: Set
     element_type: String

internal/provider/data_source_catalystcenter_ip_pool.go

@@ -83,8 +83,9 @@ func (d *IPPoolDataSource) Schema(ctx context.Context, req datasource.SchemaRequ
 				MarkdownDescription: "The IP subnet of the IP pool",
 				Computed:            true,
 			},
-			"gateway": schema.StringAttribute{
+			"gateway": schema.SetAttribute{
 				MarkdownDescription: "The gateway for the IP pool",
+				ElementType:         types.StringType,
 				Computed:            true,
 			},
 			"dhcp_server_ips": schema.SetAttribute{
@@ -119,6 +120,7 @@ func (d *IPPoolDataSource) Configure(_ context.Context, req datasource.Configure
 
 // End of section. //template:end model
 
+// Section below is generated&owned by "gen/generator.go". //template:begin read
 func (d *IPPoolDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
 	var config IPPool
 
@@ -131,7 +133,7 @@ func (d *IPPoolDataSource) Read(ctx context.Context, req datasource.ReadRequest,
 
 	tflog.Debug(ctx, fmt.Sprintf("%s: Beginning Read", config.Id.String()))
 	if config.Id.IsNull() && !config.Name.IsNull() {
-		res, err := d.client.Get("/api/v2/ippool?limit=500")
+		res, err := d.client.Get(config.getPath())
 		if err != nil {
 			resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to retrieve objects, got error: %s", err))
 			return
@@ -155,7 +157,7 @@ func (d *IPPoolDataSource) Read(ctx context.Context, req datasource.ReadRequest,
 
 	params := ""
 	params += "/" + url.QueryEscape(config.Id.ValueString())
-	res, err := d.client.Get("/api/v2/ippool" + params)
+	res, err := d.client.Get(config.getPath() + params)
 	if err != nil {
 		resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to retrieve object, got error: %s", err))
 		return
@@ -168,3 +170,5 @@ func (d *IPPoolDataSource) Read(ctx context.Context, req datasource.ReadRequest,
 	diags = resp.State.Set(ctx, &config)
 	resp.Diagnostics.Append(diags...)
 }
+
+// End of section. //template:end read

internal/provider/data_source_catalystcenter_ip_pool_test.go

@@ -30,8 +30,9 @@ import (
 func TestAccDataSourceCcIPPool(t *testing.T) {
 	var checks []resource.TestCheckFunc
 	checks = append(checks, resource.TestCheckResourceAttr("data.catalystcenter_ip_pool.test", "name", "MyPool1"))
+	checks = append(checks, resource.TestCheckResourceAttr("data.catalystcenter_ip_pool.test", "ip_address_space", "IPv4"))
+	checks = append(checks, resource.TestCheckResourceAttr("data.catalystcenter_ip_pool.test", "type", "generic"))
 	checks = append(checks, resource.TestCheckResourceAttr("data.catalystcenter_ip_pool.test", "ip_subnet", "21.1.1.0/24"))
-	checks = append(checks, resource.TestCheckResourceAttr("data.catalystcenter_ip_pool.test", "gateway", "21.1.1.1"))
 	resource.Test(t, resource.TestCase{
 		PreCheck:                 func() { testAccPreCheck(t) },
 		ProtoV6ProviderFactories: testAccProtoV6ProviderFactories,
@@ -54,9 +55,9 @@ func testAccDataSourceCcIPPoolConfig() string {
 	config := `resource "catalystcenter_ip_pool" "test" {` + "\n"
 	config += `	name = "MyPool1"` + "\n"
 	config += `	ip_address_space = "IPv4"` + "\n"
-	config += `	type = "Generic"` + "\n"
+	config += `	type = "generic"` + "\n"
 	config += `	ip_subnet = "21.1.1.0/24"` + "\n"
-	config += `	gateway = "21.1.1.1"` + "\n"
+	config += `	gateway = ["21.1.1.1"]` + "\n"
 	config += `	dhcp_server_ips = ["1.2.3.4"]` + "\n"
 	config += `	dns_server_ips = ["2.3.4.5"]` + "\n"
 	config += `}` + "\n"

internal/provider/model_catalystcenter_ip_pool.go

@@ -36,7 +36,7 @@ type IPPool struct {
 	IpAddressSpace types.String `tfsdk:"ip_address_space"`
 	Type           types.String `tfsdk:"type"`
 	IpSubnet       types.String `tfsdk:"ip_subnet"`
-	Gateway        types.String `tfsdk:"gateway"`
+	Gateway        types.Set    `tfsdk:"gateway"`
 	DhcpServerIps  types.Set    `tfsdk:"dhcp_server_ips"`
 	DnsServerIps   types.Set    `tfsdk:"dns_server_ips"`
 }
@@ -45,44 +45,49 @@ type IPPool struct {
 
 // Section below is generated&owned by "gen/generator.go". //template:begin getPath
 func (data IPPool) getPath() string {
-	return "/dna/intent/api/v1/global-pool"
+	return "/api/v2/ippool"
 }
 
 // End of section. //template:end getPath
 
+// Section below is generated&owned by "gen/generator.go". //template:begin getPathDelete
+
+// End of section. //template:end getPathDelete
+
 // Section below is generated&owned by "gen/generator.go". //template:begin toBody
 func (data IPPool) toBody(ctx context.Context, state IPPool) string {
 	body := ""
 	put := false
 	if state.Id.ValueString() != "" {
 		put = true
-		body, _ = sjson.Set(body, "settings.ippool.0.id", state.Id.ValueString())
 	}
 	_ = put
 	if !data.Name.IsNull() {
-		body, _ = sjson.Set(body, "settings.ippool.0.ipPoolName", data.Name.ValueString())
+		body, _ = sjson.Set(body, "ipPoolName", data.Name.ValueString())
 	}
 	if !data.IpAddressSpace.IsNull() {
-		body, _ = sjson.Set(body, "settings.ippool.0.IpAddressSpace", data.IpAddressSpace.ValueString())
+		body, _ = sjson.Set(body, "IpAddressSpace", data.IpAddressSpace.ValueString())
 	}
 	if !data.Type.IsNull() {
-		body, _ = sjson.Set(body, "settings.ippool.0.type", data.Type.ValueString())
+		body, _ = sjson.Set(body, "type", data.Type.ValueString())
 	}
 	if !data.IpSubnet.IsNull() {
-		body, _ = sjson.Set(body, "settings.ippool.0.ipPoolCidr", data.IpSubnet.ValueString())
+		body, _ = sjson.Set(body, "ipPoolCidr", data.IpSubnet.ValueString())
 	}
 	if !data.Gateway.IsNull() {
-		body, _ = sjson.Set(body, "settings.ippool.0.gateway", data.Gateway.ValueString())
+		var values []string
+		data.Gateway.ElementsAs(ctx, &values, false)
+		body, _ = sjson.Set(body, "gateways", values)
 	}
 	if !data.DhcpServerIps.IsNull() {
 		var values []string
 		data.DhcpServerIps.ElementsAs(ctx, &values, false)
-		body, _ = sjson.Set(body, "settings.ippool.0.dhcpServerIps", values)
+		body, _ = sjson.Set(body, "dhcpServerIps", values)
 	}
 	if !data.DnsServerIps.IsNull() {
 		var values []string
 		data.DnsServerIps.ElementsAs(ctx, &values, false)
-		body, _ = sjson.Set(body, "settings.ippool.0.dnsServerIps", values)
+		body, _ = sjson.Set(body, "dnsServerIps", values)
 	}
 	return body
 }
@@ -96,15 +101,25 @@ func (data *IPPool) fromBody(ctx context.Context, res gjson.Result) {
 	} else {
 		data.Name = types.StringNull()
 	}
+	if value := res.Get("IpAddressSpace"); value.Exists() {
+		data.IpAddressSpace = types.StringValue(value.String())
+	} else {
+		data.IpAddressSpace = types.StringValue("IPv4")
+	}
+	if value := res.Get("type"); value.Exists() {
+		data.Type = types.StringValue(value.String())
+	} else {
+		data.Type = types.StringValue("generic")
+	}
 	if value := res.Get("response.ipPoolCidr"); value.Exists() {
 		data.IpSubnet = types.StringValue(value.String())
 	} else {
 		data.IpSubnet = types.StringNull()
 	}
-	if value := res.Get("response.gateways.0"); value.Exists() {
-		data.Gateway = types.StringValue(value.String())
+	if value := res.Get("response.gateways"); value.Exists() && len(value.Array()) > 0 {
+		data.Gateway = helpers.GetStringSet(value.Array())
 	} else {
-		data.Gateway = types.StringNull()
+		data.Gateway = types.SetNull(types.StringType)
 	}
 	if value := res.Get("response.dhcpServerIps"); value.Exists() && len(value.Array()) > 0 {
 		data.DhcpServerIps = helpers.GetStringSet(value.Array())
@@ -127,15 +142,25 @@ func (data *IPPool) updateFromBody(ctx context.Context, res gjson.Result) {
 	} else {
 		data.Name = types.StringNull()
 	}
+	if value := res.Get("IpAddressSpace"); value.Exists() && !data.IpAddressSpace.IsNull() {
+		data.IpAddressSpace = types.StringValue(value.String())
+	} else if data.IpAddressSpace.ValueString() != "IPv4" {
+		data.IpAddressSpace = types.StringNull()
+	}
+	if value := res.Get("type"); value.Exists() && !data.Type.IsNull() {
+		data.Type = types.StringValue(value.String())
+	} else if data.Type.ValueString() != "generic" {
+		data.Type = types.StringNull()
+	}
 	if value := res.Get("response.ipPoolCidr"); value.Exists() && !data.IpSubnet.IsNull() {
 		data.IpSubnet = types.StringValue(value.String())
 	} else {
 		data.IpSubnet = types.StringNull()
 	}
-	if value := res.Get("response.gateways.0"); value.Exists() && !data.Gateway.IsNull() {
-		data.Gateway = types.StringValue(value.String())
+	if value := res.Get("response.gateways"); value.Exists() && !data.Gateway.IsNull() {
+		data.Gateway = helpers.GetStringSet(value.Array())
 	} else {
-		data.Gateway = types.StringNull()
+		data.Gateway = types.SetNull(types.StringType)
 	}
 	if value := res.Get("response.dhcpServerIps"); value.Exists() && !data.DhcpServerIps.IsNull() {
 		data.DhcpServerIps = helpers.GetStringSet(value.Array())

internal/provider/resource_catalystcenter_ip_pool.go

@@ -88,20 +88,21 @@ func (r *IPPoolResource) Schema(ctx context.Context, req resource.SchemaRequest,
 				Default: stringdefault.StaticString("IPv4"),
 			},
 			"type": schema.StringAttribute{
-				MarkdownDescription: helpers.NewAttributeDescription("Choose `Tunnel` to assign IP addresses to site-to-site VPN for IPSec tunneling. Choose `Generic` for all other network types.").AddStringEnumDescription("Generic", "Tunnel").AddDefaultValueDescription("Generic").String,
+				MarkdownDescription: helpers.NewAttributeDescription("Choose `Tunnel` to assign IP addresses to site-to-site VPN for IPSec tunneling. Choose `Generic` for all other network types.").AddStringEnumDescription("generic", "tunnel").AddDefaultValueDescription("generic").String,
 				Optional:            true,
 				Computed:            true,
 				Validators: []validator.String{
-					stringvalidator.OneOf("Generic", "Tunnel"),
+					stringvalidator.OneOf("generic", "tunnel"),
 				},
-				Default: stringdefault.StaticString("Generic"),
+				Default: stringdefault.StaticString("generic"),
 			},
 			"ip_subnet": schema.StringAttribute{
 				MarkdownDescription: helpers.NewAttributeDescription("The IP subnet of the IP pool").String,
 				Required:            true,
 			},
-			"gateway": schema.StringAttribute{
+			"gateway": schema.SetAttribute{
 				MarkdownDescription: helpers.NewAttributeDescription("The gateway for the IP pool").String,
+				ElementType:         types.StringType,
 				Optional:            true,
 			},
 			"dhcp_server_ips": schema.SetAttribute{
@@ -128,6 +129,7 @@ func (r *IPPoolResource) Configure(_ context.Context, req resource.ConfigureRequ
 
 // End of section. //template:end model
 
+// Section below is generated&owned by "gen/generator.go". //template:begin create
 func (r *IPPoolResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
 	var plan IPPool
 
@@ -149,8 +151,8 @@ func (r *IPPoolResource) Create(ctx context.Context, req resource.CreateRequest,
 		resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to configure object (POST), got error: %s, %s", err, res.String()))
 		return
 	}
-
-	res, err = r.client.Get("/api/v2/ippool?limit=500")
+	params = ""
+	res, err = r.client.Get(plan.getPath() + params)
 	if err != nil {
 		resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to retrieve object (GET), got error: %s, %s", err, res.String()))
 		return
@@ -163,6 +165,8 @@ func (r *IPPoolResource) Create(ctx context.Context, req resource.CreateRequest,
 	resp.Diagnostics.Append(diags...)
 }
 
+// End of section. //template:end create
+
 // Section below is generated&owned by "gen/generator.go". //template:begin read
 func (r *IPPoolResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) {
 	var state IPPool
@@ -178,7 +182,7 @@ func (r *IPPoolResource) Read(ctx context.Context, req resource.ReadRequest, res
 
 	params := ""
 	params += "/" + url.QueryEscape(state.Id.ValueString())
-	res, err := r.client.Get("/api/v2/ippool" + params)
+	res, err := r.client.Get(state.getPath() + params)
 	if err != nil && strings.Contains(err.Error(), "StatusCode 404") {
 		resp.State.RemoveResource(ctx)
 		return