fabric_provision_device

CHANGELOG.md

@@ -1,5 +1,6 @@
 ## 0.1.10 (unreleased)
 
+- Add `fabric_provision_device` resource and data source
 - Add `assign_templates_to_tag` resource and data source
 - Add `tag` resource and data source
 - Add `pnp_import_devices` resource

docs/data-sources/fabric_provision_device.md

@@ -0,0 +1,32 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "catalystcenter_fabric_provision_device Data Source - terraform-provider-catalystcenter"
+subcategory: "SDA"
+description: |-
+  This data source can read the Fabric Provision Device.
+---
+
+# catalystcenter_fabric_provision_device (Data Source)
+
+This data source can read the Fabric Provision Device.
+
+## Example Usage
+
+```terraform
+data "catalystcenter_fabric_provision_device" "example" {
+  site_id           = "5e6f7b3a-2b0b-4a7d-8b1c-0d4b1cd5e1b1"
+  network_device_id = "4cb565d3-1944-42be-be9f-a87cff79e831"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `network_device_id` (String) ID of network device to be provisioned
+- `site_id` (String) ID of the site this network device needs to be provisioned
+
+### Read-Only
+
+- `id` (String) The id of the object

docs/guides/changelog.md

@@ -9,6 +9,7 @@ description: |-
 
 ## 0.1.10 (unreleased)
 
+- Add `fabric_provision_device` resource and data source
 - Add `assign_templates_to_tag` resource and data source
 - Add `tag` resource and data source
 - Add `pnp_import_devices` resource

docs/resources/fabric_provision_device.md

@@ -0,0 +1,40 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "catalystcenter_fabric_provision_device Resource - terraform-provider-catalystcenter"
+subcategory: "SDA"
+description: |-
+  This resource can manage a Fabric Provision Device.
+---
+
+# catalystcenter_fabric_provision_device (Resource)
+
+This resource can manage a Fabric Provision Device.
+
+## Example Usage
+
+```terraform
+resource "catalystcenter_fabric_provision_device" "example" {
+  site_id           = "5e6f7b3a-2b0b-4a7d-8b1c-0d4b1cd5e1b1"
+  network_device_id = "4cb565d3-1944-42be-be9f-a87cff79e831"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `network_device_id` (String) ID of network device to be provisioned
+- `site_id` (String) ID of the site this network device needs to be provisioned
+
+### Read-Only
+
+- `id` (String) The id of the object
+
+## Import
+
+Import is supported using the following syntax:
+
+```shell
+terraform import catalystcenter_fabric_provision_device.example "<site_id>,<network_device_id>"
+```

examples/data-sources/catalystcenter_fabric_provision_device/data-source.tf

@@ -0,0 +1,4 @@
+data "catalystcenter_fabric_provision_device" "example" {
+  site_id           = "5e6f7b3a-2b0b-4a7d-8b1c-0d4b1cd5e1b1"
+  network_device_id = "4cb565d3-1944-42be-be9f-a87cff79e831"
+}

examples/resources/catalystcenter_fabric_provision_device/import.sh

@@ -0,0 +1 @@
+terraform import catalystcenter_fabric_provision_device.example "<site_id>,<network_device_id>"

examples/resources/catalystcenter_fabric_provision_device/resource.tf

@@ -0,0 +1,4 @@
+resource "catalystcenter_fabric_provision_device" "example" {
+  site_id           = "5e6f7b3a-2b0b-4a7d-8b1c-0d4b1cd5e1b1"
+  network_device_id = "4cb565d3-1944-42be-be9f-a87cff79e831"
+}

gen/definitions/fabric_provision_device.yaml

@@ -0,0 +1,43 @@
+---
+name: Fabric Provision Device
+rest_endpoint: /dna/intent/api/v1/sda/provisionDevices
+id_from_query_path: response.0
+id_from_query_path_attribute: id
+import_no_id: true
+data_source_no_id: true
+put_id_include_path: "0.id"
+put_no_id: true
+max_async_wait_time: 120
+doc_category: SDA
+test_tags: [SDA]
+attributes:
+  - model_name: siteId
+    requires_replace: true
+    data_path: '0'
+    query_param: true
+    response_data_path: response.0.siteId
+    mandatory: true
+    description: ID of the site this network device needs to be provisioned
+    type: String
+    example: 5e6f7b3a-2b0b-4a7d-8b1c-0d4b1cd5e1b1
+    test_value: catalystcenter_area.test.id
+  - model_name: networkDeviceId
+    requires_replace: true
+    data_path: '0'
+    query_param: true
+    response_data_path: response.0.networkDeviceId
+    mandatory: true
+    description: ID of network device to be provisioned
+    type: String
+    example: 4cb565d3-1944-42be-be9f-a87cff79e831
+test_prerequisites: |
+  resource "catalystcenter_area" "test" {
+    name        = "Area1"
+    parent_name = "Global"
+  }
+  resource "catalystcenter_fabric_site" "test" {
+    site_id                     = catalystcenter_area.test.id
+    pub_sub_enabled             = false
+    authentication_profile_name = "No Authentication"
+    depends_on = [catalystcenter_area.test]
+  }

internal/provider/data_source_catalystcenter_fabric_provision_device.go

@@ -0,0 +1,115 @@
+// Copyright © 2023 Cisco Systems, Inc. and its affiliates.
+// All rights reserved.
+//
+// Licensed under the Mozilla Public License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://mozilla.org/MPL/2.0/
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// SPDX-License-Identifier: MPL-2.0
+
+package provider
+
+// Section below is generated&owned by "gen/generator.go". //template:begin imports
+import (
+	"context"
+	"fmt"
+	"net/url"
+
+	"github.com/hashicorp/terraform-plugin-framework/datasource"
+	"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
+	"github.com/hashicorp/terraform-plugin-log/tflog"
+	cc "github.com/netascode/go-catalystcenter"
+)
+
+// End of section. //template:end imports
+
+// Section below is generated&owned by "gen/generator.go". //template:begin model
+
+// Ensure the implementation satisfies the expected interfaces.
+var (
+	_ datasource.DataSource              = &FabricProvisionDeviceDataSource{}
+	_ datasource.DataSourceWithConfigure = &FabricProvisionDeviceDataSource{}
+)
+
+func NewFabricProvisionDeviceDataSource() datasource.DataSource {
+	return &FabricProvisionDeviceDataSource{}
+}
+
+type FabricProvisionDeviceDataSource struct {
+	client *cc.Client
+}
+
+func (d *FabricProvisionDeviceDataSource) Metadata(_ context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
+	resp.TypeName = req.ProviderTypeName + "_fabric_provision_device"
+}
+
+func (d *FabricProvisionDeviceDataSource) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse) {
+	resp.Schema = schema.Schema{
+		// This description is used by the documentation generator and the language server.
+		MarkdownDescription: "This data source can read the Fabric Provision Device.",
+
+		Attributes: map[string]schema.Attribute{
+			"id": schema.StringAttribute{
+				MarkdownDescription: "The id of the object",
+				Computed:            true,
+			},
+			"site_id": schema.StringAttribute{
+				MarkdownDescription: "ID of the site this network device needs to be provisioned",
+				Required:            true,
+			},
+			"network_device_id": schema.StringAttribute{
+				MarkdownDescription: "ID of network device to be provisioned",
+				Required:            true,
+			},
+		},
+	}
+}
+
+func (d *FabricProvisionDeviceDataSource) Configure(_ context.Context, req datasource.ConfigureRequest, _ *datasource.ConfigureResponse) {
+	if req.ProviderData == nil {
+		return
+	}
+
+	d.client = req.ProviderData.(*CcProviderData).Client
+}
+
+// End of section. //template:end model
+
+// Section below is generated&owned by "gen/generator.go". //template:begin read
+func (d *FabricProvisionDeviceDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
+	var config FabricProvisionDevice
+
+	// Read config
+	diags := req.Config.Get(ctx, &config)
+	resp.Diagnostics.Append(diags...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	tflog.Debug(ctx, fmt.Sprintf("%s: Beginning Read", config.Id.String()))
+
+	params := ""
+	params += "?siteId=" + url.QueryEscape(config.SiteId.ValueString()) + "&networkDeviceId=" + url.QueryEscape(config.NetworkDeviceId.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))
+		return
+	}
+
+	config.fromBody(ctx, res)
+
+	tflog.Debug(ctx, fmt.Sprintf("%s: Read finished successfully", config.Id.ValueString()))
+
+	diags = resp.State.Set(ctx, &config)
+	resp.Diagnostics.Append(diags...)
+}
+
+// End of section. //template:end read

internal/provider/data_source_catalystcenter_fabric_provision_device_test.go

@@ -0,0 +1,84 @@
+// Copyright © 2023 Cisco Systems, Inc. and its affiliates.
+// All rights reserved.
+//
+// Licensed under the Mozilla Public License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     https://mozilla.org/MPL/2.0/
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// SPDX-License-Identifier: MPL-2.0
+
+package provider
+
+// Section below is generated&owned by "gen/generator.go". //template:begin imports
+import (
+	"os"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
+)
+
+// End of section. //template:end imports
+
+// Section below is generated&owned by "gen/generator.go". //template:begin testAccDataSource
+func TestAccDataSourceCcFabricProvisionDevice(t *testing.T) {
+	if os.Getenv("SDA") == "" {
+		t.Skip("skipping test, set environment variable SDA")
+	}
+	var checks []resource.TestCheckFunc
+	checks = append(checks, resource.TestCheckResourceAttr("data.catalystcenter_fabric_provision_device.test", "network_device_id", "4cb565d3-1944-42be-be9f-a87cff79e831"))
+	resource.Test(t, resource.TestCase{
+		PreCheck:                 func() { testAccPreCheck(t) },
+		ProtoV6ProviderFactories: testAccProtoV6ProviderFactories,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccDataSourceCcFabricProvisionDevicePrerequisitesConfig + testAccDataSourceCcFabricProvisionDeviceConfig(),
+				Check:  resource.ComposeTestCheckFunc(checks...),
+			},
+		},
+	})
+}
+
+// End of section. //template:end testAccDataSource
+
+// Section below is generated&owned by "gen/generator.go". //template:begin testPrerequisites
+const testAccDataSourceCcFabricProvisionDevicePrerequisitesConfig = `
+resource "catalystcenter_area" "test" {
+  name        = "Area1"
+  parent_name = "Global"
+}
+resource "catalystcenter_fabric_site" "test" {
+  site_id                     = catalystcenter_area.test.id
+  pub_sub_enabled             = false
+  authentication_profile_name = "No Authentication"
+  depends_on = [catalystcenter_area.test]
+}
+`
+
+// End of section. //template:end testPrerequisites
+
+// Section below is generated&owned by "gen/generator.go". //template:begin testAccDataSourceConfig
+func testAccDataSourceCcFabricProvisionDeviceConfig() string {
+	config := `resource "catalystcenter_fabric_provision_device" "test" {` + "\n"
+	config += `	site_id = catalystcenter_area.test.id` + "\n"
+	config += `	network_device_id = "4cb565d3-1944-42be-be9f-a87cff79e831"` + "\n"
+	config += `}` + "\n"
+
+	config += `
+		data "catalystcenter_fabric_provision_device" "test" {
+			id = catalystcenter_fabric_provision_device.test.id
+			site_id = catalystcenter_area.test.id
+			network_device_id = "4cb565d3-1944-42be-be9f-a87cff79e831"
+		}
+	`
+	return config
+}
+
+// End of section. //template:end testAccDataSourceConfig