Modify transit_peer_network resource to add id (#100)

kuba-mazurkiewicz · web-flow · commit 79b20876fce8 · 2024-08-02T12:51:35.000+03:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,6 @@
 ## 0.1.10 (unreleased)
 
+- Add `transitPeerNetworkId` as `id` to `transit_peer_network` resource
 - Add `anycast_gateway` resource and data source, this resource now only works with Catalyst Center version 2.3.7.5+ `/sda/anycastGateways`
 - BREAKING CHANGE: Modified `fabric_site` resource to use `/dna/intent/api/v1/sda/fabricSites` API endpoint, this resource now only works with Catalyst Center version 2.3.7.5+
 - Fix issue with mandatory attributes in `transit_peer_network` resource, [link](https://github.com/CiscoDevNet/terraform-provider-catalystcenter/issues/92)
diff --git a/docs/data-sources/transit_peer_network.md b/docs/data-sources/transit_peer_network.md
@@ -14,21 +14,21 @@ This data source can read the Transit Peer Network.
 
 ```terraform
 data "catalystcenter_transit_peer_network" "example" {
-  id = "TRANSIT_1"
+  transit_peer_network_name = "TRANSIT_1"
 }
 ```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
-### Optional
+### Required
 
-- `id` (String) The id of the object
 - `transit_peer_network_name` (String) Transit Peer Network Name
 
 ### Read-Only
 
 - `autonomous_system_number` (String) Autonomous System Number
+- `id` (String) The id of the object
 - `routing_protocol_name` (String) Routing Protocol Name
 - `transit_control_plane_settings` (Attributes List) Transit Control Plane Settings info (see [below for nested schema](#nestedatt--transit_control_plane_settings))
 - `transit_peer_network_type` (String) Transit Peer Network Type
diff --git a/docs/guides/changelog.md b/docs/guides/changelog.md
@@ -9,6 +9,7 @@ description: |-
 
 ## 0.1.10 (unreleased)
 
+- Add `transitPeerNetworkId` as `id` to `transit_peer_network` resource
 - Add `anycast_gateway` resource and data source, this resource now only works with Catalyst Center version 2.3.7.5+ `/sda/anycastGateways`
 - BREAKING CHANGE: Modified `fabric_site` resource to use `/dna/intent/api/v1/sda/fabricSites` API endpoint, this resource now only works with Catalyst Center version 2.3.7.5+
 - Fix issue with mandatory attributes in `transit_peer_network` resource, [link](https://github.com/CiscoDevNet/terraform-provider-catalystcenter/issues/92)
diff --git a/docs/resources/transit_peer_network.md b/docs/resources/transit_peer_network.md
@@ -18,12 +18,6 @@ resource "catalystcenter_transit_peer_network" "example" {
   transit_peer_network_type = "ip_transit"
   routing_protocol_name     = "BGP"
   autonomous_system_number  = "65010"
-  transit_control_plane_settings = [
-    {
-      site_name_hierarchy          = "Global/Area1"
-      device_management_ip_address = "10.0.0.1"
-    }
-  ]
 }
 ```
 
diff --git a/examples/data-sources/catalystcenter_transit_peer_network/data-source.tf b/examples/data-sources/catalystcenter_transit_peer_network/data-source.tf
@@ -1,3 +1,3 @@
 data "catalystcenter_transit_peer_network" "example" {
-  id = "TRANSIT_1"
+  transit_peer_network_name = "TRANSIT_1"
 }
diff --git a/examples/resources/catalystcenter_transit_peer_network/resource.tf b/examples/resources/catalystcenter_transit_peer_network/resource.tf
@@ -3,10 +3,4 @@ resource "catalystcenter_transit_peer_network" "example" {
   transit_peer_network_type = "ip_transit"
   routing_protocol_name     = "BGP"
   autonomous_system_number  = "65010"
-  transit_control_plane_settings = [
-    {
-      site_name_hierarchy          = "Global/Area1"
-      device_management_ip_address = "10.0.0.1"
-    }
-  ]
 }
diff --git a/gen/definitions/transit_peer_network.yaml b/gen/definitions/transit_peer_network.yaml
@@ -1,17 +1,20 @@
 ---
 name: Transit Peer Network
 rest_endpoint: /dna/intent/api/v1/business/sda/transit-peer-network
-id_from_attribute: true
-id_query_param: transitPeerNetworkName
-delete_id_query_param: transitPeerNetworkName
+id_from_query_path: .
+id_from_query_path_attribute: transitPeerNetworkId
+import_no_id: true
+data_source_no_id: true
 no_update: true
 skip_minimum_test: true
 doc_category: SDA
 attributes:
   - model_name: transitPeerNetworkName
     type: String
-    id: true
-    data_source_query: true
+    query_param: true
+    delete_query_param: true
+    mandatory: true
+    requires_replace: true
     description: Transit Peer Network Name
     example: TRANSIT_1
   - model_name: transitPeerNetworkType
@@ -37,6 +40,7 @@ attributes:
   - model_name: transitControlPlaneSettings
     data_path: sdaTransitSettings
     write_only: true
+    exclude_test: true
     type: List
     description: Transit Control Plane Settings info
     attributes:
diff --git a/gen/definitions/wireless_profile.yaml b/gen/definitions/wireless_profile.yaml
@@ -13,6 +13,7 @@ doc_category: Wireless
 attributes:
   - model_name: wirelessProfileName
     tf_name: name
+    delete_query_param_name: name
     delete_query_param: true
     type: String
     match_id: true
diff --git a/gen/templates/model.go b/gen/templates/model.go
@@ -307,7 +307,7 @@ func (data {{camelCase .Name}}) toBody(ctx context.Context, state {{camelCase .N
 func (data *{{camelCase .Name}}) fromBody(ctx context.Context, res gjson.Result) {
 	{{- if .DataSourceNoId}}
 	// Retrieve the 'id' attribute, if Data Source doesn't require id
-	if value := res.Get("{{if .IdFromQueryPath}}{{.IdFromQueryPath}}.{{if .IdFromQueryPathAttribute}}{{.IdFromQueryPathAttribute}}{{else}}id{{end}}{{end}}"); value.Exists() {
+	if value := res.Get("{{if .IdFromQueryPath}}{{if eq .IdFromQueryPath "." }}{{else}}{{.IdFromQueryPath}}.{{end}}{{if .IdFromQueryPathAttribute}}{{.IdFromQueryPathAttribute}}{{else}}id{{end}}{{end}}"); value.Exists() {
 		data.Id = types.StringValue(value.String())
 	} else {
 		data.Id = types.StringNull()
diff --git a/gen/templates/resource.go b/gen/templates/resource.go
@@ -457,7 +457,7 @@ func (r *{{camelCase .Name}}Resource) Create(ctx context.Context, req resource.C
 		return
 	}
 	{{- if and .IdFromQueryPathAttribute .IdFromQueryPath (not .GetExtraQueryParams) (not .GetFromAll) }}
-	plan.Id = types.StringValue(res.Get("{{if .IdFromQueryPath}}{{.IdFromQueryPath}}.{{end}}{{.IdFromQueryPathAttribute}}").String())
+	plan.Id = types.StringValue(res.Get("{{if eq .IdFromQueryPath "." }}{{else}}{{.IdFromQueryPath}}.{{end}}{{.IdFromQueryPathAttribute}}").String())
 	{{- else}}
 	plan.Id = types.StringValue(res.Get("{{.IdFromQueryPath}}.#({{if $id.ResponseModelName}}{{$id.ResponseModelName}}{{else}}{{$id.ModelName}}{{end}}==\""+ plan.{{toGoName $id.TfName}}.Value{{$id.Type}}() +"\").{{if .IdFromQueryPathAttribute}}{{.IdFromQueryPathAttribute}}{{else}}id{{end}}").String())
 	{{- end}}
@@ -611,9 +611,12 @@ func (r *{{camelCase .Name}}Resource) Delete(ctx context.Context, req resource.D
 	res, err := r.client.Delete({{if .DeleteRestEndpoint}}state.getPathDelete(){{else}}state.getPath(){{end}})
 	{{- else if .DeleteIdQueryParam}}
 	res, err := r.client.Delete({{if .DeleteRestEndpoint}}state.getPathDelete(){{else}}state.getPath(){{end}} + "?{{.DeleteIdQueryParam}}=" + url.QueryEscape(state.Id.ValueString()))
-	{{- else if hasDeleteQueryParam .Attributes}}
-		{{- $deleteQueryParam := getDeleteQueryParam .Attributes}}
-	res, err := r.client.Delete({{if .DeleteRestEndpoint}}state.getPathDelete(){{else}}state.getPath(){{end}} + "?{{$deleteQueryParam.TfName}}=" + url.QueryEscape(state.{{toGoName $deleteQueryParam.TfName}}.Value{{$deleteQueryParam.Type}}()))
+	{{- else if hasDeleteQueryParam .Attributes }}
+	{{- $queryParams := generateQueryParamString "DELETE" "state" .Attributes }}
+	{{- if $queryParams }}
+	params := {{$queryParams}}
+	{{- end}}
+	res, err := r.client.Delete({{if .DeleteRestEndpoint}}state.getPathDelete(){{else}}state.getPath(){{end}} + params)
 	{{- else}}
 	res, err := r.client.Delete({{if .DeleteRestEndpoint}}state.getPathDelete(){{else}}state.getPath(){{end}} + "/" + url.QueryEscape(state.Id.ValueString()))
 	{{- end}}
diff --git a/internal/provider/data_source_catalystcenter_transit_peer_network.go b/internal/provider/data_source_catalystcenter_transit_peer_network.go
@@ -23,14 +23,10 @@ import (
 	"fmt"
 	"net/url"
 
-	"github.com/hashicorp/terraform-plugin-framework-validators/datasourcevalidator"
 	"github.com/hashicorp/terraform-plugin-framework/datasource"
 	"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
-	"github.com/hashicorp/terraform-plugin-framework/path"
-	"github.com/hashicorp/terraform-plugin-framework/types"
 	"github.com/hashicorp/terraform-plugin-log/tflog"
 	cc "github.com/netascode/go-catalystcenter"
-	"github.com/tidwall/gjson"
 )
 
 // End of section. //template:end imports
@@ -63,13 +59,11 @@ func (d *TransitPeerNetworkDataSource) Schema(ctx context.Context, req datasourc
 		Attributes: map[string]schema.Attribute{
 			"id": schema.StringAttribute{
 				MarkdownDescription: "The id of the object",
-				Optional:            true,
 				Computed:            true,
 			},
 			"transit_peer_network_name": schema.StringAttribute{
 				MarkdownDescription: "Transit Peer Network Name",
-				Optional:            true,
-				Computed:            true,
+				Required:            true,
 			},
 			"transit_peer_network_type": schema.StringAttribute{
 				MarkdownDescription: "Transit Peer Network Type",
@@ -102,14 +96,6 @@ func (d *TransitPeerNetworkDataSource) Schema(ctx context.Context, req datasourc
 		},
 	}
 }
-func (d *TransitPeerNetworkDataSource) ConfigValidators(ctx context.Context) []datasource.ConfigValidator {
-	return []datasource.ConfigValidator{
-		datasourcevalidator.ExactlyOneOf(
-			path.MatchRoot("id"),
-			path.MatchRoot("transit_peer_network_name"),
-		),
-	}
-}
 
 func (d *TransitPeerNetworkDataSource) Configure(_ context.Context, req datasource.ConfigureRequest, _ *datasource.ConfigureResponse) {
 	if req.ProviderData == nil {
@@ -133,31 +119,9 @@ func (d *TransitPeerNetworkDataSource) Read(ctx context.Context, req datasource.
 	}
 
 	tflog.Debug(ctx, fmt.Sprintf("%s: Beginning Read", config.Id.String()))
-	if config.Id.IsNull() && !config.TransitPeerNetworkName.IsNull() {
-		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
-		}
-		if value := res; len(value.Array()) > 0 {
-			value.ForEach(func(k, v gjson.Result) bool {
-				if config.TransitPeerNetworkName.ValueString() == v.Get("transitPeerNetworkName").String() {
-					config.Id = types.StringValue(v.Get("id").String())
-					tflog.Debug(ctx, fmt.Sprintf("%s: Found object with transitPeerNetworkName '%v', id: %v", config.Id.String(), config.TransitPeerNetworkName.ValueString(), config.Id.String()))
-					return false
-				}
-				return true
-			})
-		}
-
-		if config.Id.IsNull() {
-			resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to find object with transitPeerNetworkName: %s", config.TransitPeerNetworkName.ValueString()))
-			return
-		}
-	}
 
 	params := ""
-	params += "?transitPeerNetworkName=" + url.QueryEscape(config.Id.ValueString())
+	params += "?transitPeerNetworkName=" + url.QueryEscape(config.TransitPeerNetworkName.ValueString())
 	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))
diff --git a/internal/provider/data_source_catalystcenter_transit_peer_network_test.go b/internal/provider/data_source_catalystcenter_transit_peer_network_test.go
@@ -57,15 +57,12 @@ func testAccDataSourceCcTransitPeerNetworkConfig() string {
 	config += `	transit_peer_network_type = "ip_transit"` + "\n"
 	config += `	routing_protocol_name = "BGP"` + "\n"
 	config += `	autonomous_system_number = "65010"` + "\n"
-	config += `	transit_control_plane_settings = [{` + "\n"
-	config += `	  site_name_hierarchy = "Global/Area1"` + "\n"
-	config += `	  device_management_ip_address = "10.0.0.1"` + "\n"
-	config += `	}]` + "\n"
 	config += `}` + "\n"
 
 	config += `
 		data "catalystcenter_transit_peer_network" "test" {
 			id = catalystcenter_transit_peer_network.test.id
+			transit_peer_network_name = "TRANSIT_1"
 		}
 	`
 	return config
diff --git a/internal/provider/model_catalystcenter_transit_peer_network.go b/internal/provider/model_catalystcenter_transit_peer_network.go
@@ -96,6 +96,12 @@ func (data TransitPeerNetwork) toBody(ctx context.Context, state TransitPeerNetw
 
 // Section below is generated&owned by "gen/generator.go". //template:begin fromBody
 func (data *TransitPeerNetwork) fromBody(ctx context.Context, res gjson.Result) {
+	// Retrieve the 'id' attribute, if Data Source doesn't require id
+	if value := res.Get("transitPeerNetworkId"); value.Exists() {
+		data.Id = types.StringValue(value.String())
+	} else {
+		data.Id = types.StringNull()
+	}
 	if value := res.Get("transitPeerNetworkName"); value.Exists() {
 		data.TransitPeerNetworkName = types.StringValue(value.String())
 	} else {
diff --git a/internal/provider/resource_catalystcenter_transit_peer_network.go b/internal/provider/resource_catalystcenter_transit_peer_network.go
@@ -162,7 +162,14 @@ func (r *TransitPeerNetworkResource) Create(ctx context.Context, req resource.Cr
 		resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to configure object (POST), got error: %s, %s", err, res.String()))
 		return
 	}
-	plan.Id = types.StringValue(fmt.Sprint(plan.TransitPeerNetworkName.ValueString()))
+	params = ""
+	params += "?transitPeerNetworkName=" + url.QueryEscape(plan.TransitPeerNetworkName.ValueString())
+	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
+	}
+	plan.Id = types.StringValue(res.Get("transitPeerNetworkId").String())
 
 	tflog.Debug(ctx, fmt.Sprintf("%s: Create finished successfully", plan.Id.ValueString()))
 
@@ -186,7 +193,7 @@ func (r *TransitPeerNetworkResource) Read(ctx context.Context, req resource.Read
 	tflog.Debug(ctx, fmt.Sprintf("%s: Beginning Read", state.Id.String()))
 
 	params := ""
-	params += "?transitPeerNetworkName=" + url.QueryEscape(state.Id.ValueString())
+	params += "?transitPeerNetworkName=" + url.QueryEscape(state.TransitPeerNetworkName.ValueString())
 	res, err := r.client.Get(state.getPath() + params)
 	if err != nil && strings.Contains(err.Error(), "StatusCode 404") {
 		resp.State.RemoveResource(ctx)
@@ -250,7 +257,8 @@ func (r *TransitPeerNetworkResource) Delete(ctx context.Context, req resource.De
 	}
 
 	tflog.Debug(ctx, fmt.Sprintf("%s: Beginning Delete", state.Id.ValueString()))
-	res, err := r.client.Delete(state.getPath() + "?transitPeerNetworkName=" + url.QueryEscape(state.Id.ValueString()))
+	params := "?transitPeerNetworkName=" + url.QueryEscape(state.TransitPeerNetworkName.ValueString())
+	res, err := r.client.Delete(state.getPath() + params)
 	if err != nil {
 		resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to delete object (DELETE), got error: %s, %s", err, res.String()))
 		return
@@ -275,7 +283,6 @@ func (r *TransitPeerNetworkResource) ImportState(ctx context.Context, req resour
 		return
 	}
 	resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("transit_peer_network_name"), idParts[0])...)
-	resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("id"), idParts[0])...)
 }
 
 // End of section. //template:end import
diff --git a/internal/provider/resource_catalystcenter_transit_peer_network_test.go b/internal/provider/resource_catalystcenter_transit_peer_network_test.go
@@ -39,10 +39,6 @@ func TestAccCcTransitPeerNetwork(t *testing.T) {
 		Config: testAccCcTransitPeerNetworkConfig_all(),
 		Check:  resource.ComposeTestCheckFunc(checks...),
 	})
-	steps = append(steps, resource.TestStep{
-		ResourceName: "catalystcenter_transit_peer_network.test",
-		ImportState:  true,
-	})
 
 	resource.Test(t, resource.TestCase{
 		PreCheck:                 func() { testAccPreCheck(t) },
@@ -74,10 +70,6 @@ func testAccCcTransitPeerNetworkConfig_all() string {
 	config += `	transit_peer_network_type = "ip_transit"` + "\n"
 	config += `	routing_protocol_name = "BGP"` + "\n"
 	config += `	autonomous_system_number = "65010"` + "\n"
-	config += `	transit_control_plane_settings = [{` + "\n"
-	config += `	  site_name_hierarchy = "Global/Area1"` + "\n"
-	config += `	  device_management_ip_address = "10.0.0.1"` + "\n"
-	config += `	}]` + "\n"
 	config += `}` + "\n"
 	return config
 }
diff --git a/internal/provider/resource_catalystcenter_wireless_profile.go b/internal/provider/resource_catalystcenter_wireless_profile.go
@@ -249,7 +249,8 @@ func (r *WirelessProfileResource) Delete(ctx context.Context, req resource.Delet
 	}
 
 	tflog.Debug(ctx, fmt.Sprintf("%s: Beginning Delete", state.Id.ValueString()))
-	res, err := r.client.Delete(state.getPath() + "?name=" + url.QueryEscape(state.Name.ValueString()))
+	params := "?name=" + url.QueryEscape(state.Name.ValueString())
+	res, err := r.client.Delete(state.getPath() + params)
 	if err != nil {
 		resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to delete object (DELETE), got error: %s, %s", err, res.String()))
 		return
diff --git a/templates/guides/changelog.md.tmpl b/templates/guides/changelog.md.tmpl
@@ -9,6 +9,7 @@ description: |-
 
 ## 0.1.10 (unreleased)
 
+- Add `transitPeerNetworkId` as `id` to `transit_peer_network` resource
 - Add `anycast_gateway` resource and data source, this resource now only works with Catalyst Center version 2.3.7.5+ `/sda/anycastGateways`
 - BREAKING CHANGE: Modified `fabric_site` resource to use `/dna/intent/api/v1/sda/fabricSites` API endpoint, this resource now only works with Catalyst Center version 2.3.7.5+
 - Fix issue with mandatory attributes in `transit_peer_network` resource, [link](https://github.com/CiscoDevNet/terraform-provider-catalystcenter/issues/92)

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`data "catalystcenter_transit_peer_network" "example" {`
`2`		`- id = "TRANSIT_1"`
	`2`	`+ transit_peer_network_name = "TRANSIT_1"`
`3`	`3`	`}`