feat: provider | integrate agent GET

pkg/config-api-provider/provider/resources/agent.go

@@ -3,7 +3,9 @@ package resources
 import (
 	"context"
 
-	// "github.com/aruba-uxi/configuration-api-terraform-provider/pkg/config-api-client"
+	"github.com/aruba-uxi/configuration-api-terraform-provider/pkg/config-api-client"
+	"github.com/aruba-uxi/configuration-api-terraform-provider/pkg/terraform-provider-configuration/provider/util"
+
 	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
@@ -48,7 +50,9 @@ func NewAgentResource() resource.Resource {
 	return &agentResource{}
 }
 
-type agentResource struct{}
+type agentResource struct {
+	client *config_api_client.APIClient
+}
 
 func (r *agentResource) Metadata(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
 	resp.TypeName = req.ProviderTypeName + "_agent"
@@ -77,7 +81,23 @@ func (r *agentResource) Schema(_ context.Context, _ resource.SchemaRequest, resp
 }
 
 func (r *agentResource) Configure(_ context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse) {
+	// Add a nil check when handling ProviderData because Terraform
+	// sets that data after it calls the ConfigureProvider RPC.
+	if req.ProviderData == nil {
+		return
+	}
 
+	client, ok := req.ProviderData.(*config_api_client.APIClient)
+
+	if !ok {
+		resp.Diagnostics.AddError(
+			"Unexpected Data Source Configure Type",
+			"Resource type: Group. Please report this issue to the provider developers.",
+		)
+		return
+	}
+
+	r.client = client
 }
 
 func (r *agentResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
@@ -89,22 +109,36 @@ func (r *agentResource) Create(ctx context.Context, req resource.CreateRequest,
 }
 
 func (r *agentResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) {
-	// Get current state
 	var state agentResourceModel
 	diags := req.State.Get(ctx, &state)
 	resp.Diagnostics.Append(diags...)
 	if resp.Diagnostics.HasError() {
 		return
 	}
 
-	response := GetAgent(state.ID.ValueString())
+	request := r.client.ConfigurationAPI.
+		AgentsGet(ctx).
+		Id(state.ID.ValueString())
+	sensorResponse, response, err := util.RetryFor429(request.Execute)
+	errorPresent, errorDetail := util.RaiseForStatus(response, err)
+
+	errorSummary := util.GenerateErrorSummary("read", "uxi_agent")
 
-	// Update state from client response
-	state.Name = types.StringValue(response.Name)
-	state.Notes = types.StringValue(response.Notes)
-	state.PCapMode = types.StringValue(response.PCapMode)
+	if errorPresent {
+		resp.Diagnostics.AddError(errorSummary, errorDetail)
+		return
+	}
+
+	if len(sensorResponse.Items) != 1 {
+		resp.State.RemoveResource(ctx)
+		return
+	}
+	sensor := sensorResponse.Items[0]
+
+	state.Name = types.StringValue(sensor.Name)
+	state.Notes = types.StringPointerValue(sensor.Notes.Get())
+	state.PCapMode = types.StringPointerValue(sensor.PcapMode.Get())
 
-	// Set refreshed state
 	diags = resp.State.Set(ctx, &state)
 	resp.Diagnostics.Append(diags...)
 	if resp.Diagnostics.HasError() {
@@ -158,22 +192,6 @@ func (r *agentResource) ImportState(ctx context.Context, req resource.ImportStat
 	resource.ImportStatePassthroughID(ctx, path.Root("id"), req, resp)
 }
 
-// Get the agent using the configuration-api client
-var GetAgent = func(uid string) AgentResponseModel {
-	// TODO: Query the agent using the client
-
-	return AgentResponseModel{
-		UID:                uid,
-		Serial:             "mock_serial",
-		Name:               "mock_name",
-		ModelNumber:        "mock_model_number",
-		WifiMacAddress:     "mock_wifi_mac_address",
-		EthernetMacAddress: "mock_ethernet_mac_address",
-		Notes:              "mock_notes",
-		PCapMode:           "mock_pcap_mode",
-	}
-}
-
 // Update the agent using the configuration-api client
 var UpdateAgent = func(request AgentUpdateRequestModel) AgentResponseModel {
 	// TODO: Query the agent using the client

pkg/config-api-provider/test/resources/agent_group_assignment_test.go

@@ -21,9 +21,11 @@ func TestAgentGroupAssignmentResource(t *testing.T) {
 			{
 				PreConfig: func() {
 					// required for agent import
-					resources.GetAgent = func(uid string) resources.AgentResponseModel {
-						return util.GenerateAgentResponseModel(uid, "")
-					}
+					util.MockGetAgent(
+						"uid",
+						util.GeneratePaginatedResponse([]map[string]interface{}{util.GenerateAgentResponseModel("uid", "")}),
+						2,
+					)
 
 					// required for group create
 					util.MockPostGroup(
@@ -83,13 +85,16 @@ func TestAgentGroupAssignmentResource(t *testing.T) {
 			// Update and Read testing
 			{
 				PreConfig: func() {
-					resources.GetAgent = func(uid string) resources.AgentResponseModel {
-						if uid == "agent_uid" {
-							return util.GenerateAgentResponseModel(uid, "")
-						} else {
-							return util.GenerateAgentResponseModel(uid, "_2")
-						}
-					}
+					util.MockGetAgent(
+						"agent_uid_2",
+						util.GeneratePaginatedResponse([]map[string]interface{}{util.GenerateAgentResponseModel("agent_uid_2", "_2")}),
+						2,
+					)
+					util.MockGetAgent(
+						"agent_uid",
+						util.GeneratePaginatedResponse([]map[string]interface{}{util.GenerateAgentResponseModel("agent_uid", "")}),
+						2,
+					)
 					util.MockGetGroup(
 						"group_uid_2",
 						util.GeneratePaginatedResponse([]map[string]interface{}{util.GenerateGroupResponseModel("group_uid_2", "_2", "_2")}),
@@ -169,6 +174,16 @@ func TestAgentGroupAssignmentResource(t *testing.T) {
 			// Delete testing automatically occurs in TestCase
 			{
 				PreConfig: func() {
+					util.MockGetAgent(
+						"agent_uid",
+						util.GeneratePaginatedResponse([]map[string]interface{}{util.GenerateAgentResponseModel("agent_uid", "")}),
+						1,
+					)
+					util.MockGetAgent(
+						"agent_uid_2",
+						util.GeneratePaginatedResponse([]map[string]interface{}{util.GenerateAgentResponseModel("agent_uid_2", "_2")}),
+						1,
+					)
 					util.MockGetGroup(
 						"group_uid",
 						util.GeneratePaginatedResponse([]map[string]interface{}{util.GenerateGroupResponseModel("group_uid", "", "")}),

pkg/config-api-provider/test/resources/agent_test.go

@@ -1,7 +1,6 @@
 package resource_test
 
 import (
-	"github.com/aruba-uxi/configuration-api-terraform-provider/pkg/terraform-provider-configuration/provider/resources"
 	"github.com/aruba-uxi/configuration-api-terraform-provider/pkg/terraform-provider-configuration/test/provider"
 	"github.com/aruba-uxi/configuration-api-terraform-provider/pkg/terraform-provider-configuration/test/util"
 	"github.com/h2non/gock"
@@ -31,9 +30,11 @@ func TestAgentResource(t *testing.T) {
 			// Importing an agent
 			{
 				PreConfig: func() {
-					resources.GetAgent = func(uid string) resources.AgentResponseModel {
-						return util.GenerateAgentResponseModel(uid, "")
-					}
+					util.MockGetAgent(
+						"uid",
+						util.GeneratePaginatedResponse([]map[string]interface{}{util.GenerateAgentResponseModel("uid", "")}),
+						2,
+					)
 				},
 				Config: provider.ProviderConfig + `
 					resource "uxi_agent" "my_agent" {
@@ -56,16 +57,32 @@ func TestAgentResource(t *testing.T) {
 			},
 			// ImportState testing
 			{
+				PreConfig: func() {
+					util.MockGetAgent(
+						"uid",
+						util.GeneratePaginatedResponse([]map[string]interface{}{util.GenerateAgentResponseModel("uid", "")}),
+						1,
+					)
+				},
 				ResourceName:      "uxi_agent.my_agent",
 				ImportState:       true,
 				ImportStateVerify: true,
 			},
 			// Update and Read testing
 			{
 				PreConfig: func() {
-					resources.GetAgent = func(uid string) resources.AgentResponseModel {
-						return util.GenerateAgentResponseModel(uid, "_2")
-					}
+					// original
+					util.MockGetAgent(
+						"uid",
+						util.GeneratePaginatedResponse([]map[string]interface{}{util.GenerateAgentResponseModel("uid", "")}),
+						1,
+					)
+					// updated
+					util.MockGetAgent(
+						"uid",
+						util.GeneratePaginatedResponse([]map[string]interface{}{util.GenerateAgentResponseModel("uid", "_2")}),
+						1,
+					)
 				},
 				Config: provider.ProviderConfig + `
 				resource "uxi_agent" "my_agent" {

pkg/config-api-provider/test/util/utils.go

@@ -25,7 +25,21 @@ func GenerateSensorResponseModel(uid string, postfix string) map[string]interfac
 	}
 }
 
-func GenerateAgentResponseModel(uid string, postfix string) resources.AgentResponseModel {
+func GenerateAgentResponseModel(uid string, postfix string) map[string]interface{} {
+	return map[string]interface{}{
+		"id":                 uid,
+		"serial":             "serial" + postfix,
+		"name":               "name" + postfix,
+		"modelNumber":        "model_number" + postfix,
+		"wifiMacAddress":     "wifi_mac_address" + postfix,
+		"ethernetMacAddress": "ethernet_mac_address" + postfix,
+		"notes":              "notes" + postfix,
+		"pcapMode":           "light" + postfix,
+		"type":               "networking-uxi/sensor",
+	}
+}
+
+func GenerateMockedAgentResponseModel(uid string, postfix string) resources.AgentResponseModel {
 	return resources.AgentResponseModel{
 		UID:                uid,
 		Serial:             "serial" + postfix,
@@ -192,6 +206,16 @@ func MockOAuth() *gock.Response {
 
 }
 
+func MockGetAgent(uid string, response map[string]interface{}, times int) {
+	gock.New("https://test.api.capenetworks.com").
+		Get("/networking-uxi/v1alpha1/agents").
+		MatchHeader("Authorization", "mock_token").
+		MatchParam("id", uid).
+		Times(times).
+		Reply(200).
+		JSON(response)
+}
+
 func MockPostGroup(request map[string]interface{}, response map[string]interface{}, times int) {
 	gock.New("https://test.api.capenetworks.com").
 		Post("/networking-uxi/v1alpha1/groups").