Apply the DataSource refactor to the InventoryDataSource and related tests

Author: fincamd

docs/data-sources/inventory.md

@@ -1,12 +1,12 @@
 ---
 page_title: "aap_inventory Data Source - terraform-provider-aap"
 description: |-
-  Get an existing inventory.
+  
 ---
 
 # aap_inventory (Data Source)
 
-Get an existing inventory.
+
 
 
 ## Example Usage
@@ -53,17 +53,3 @@ output "inventory_details_with_name_and_org_name" {
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
-
-### Optional
-
-- `id` (Number) Inventory id
-- `name` (String) Name of the inventory
-- `organization_name` (String) The name for the organization to which the inventory belongs
-
-### Read-Only
-
-- `description` (String) Description of the inventory
-- `named_url` (String) The Named Url of the inventory
-- `organization` (Number) Identifier for the organization to which the inventory belongs
-- `url` (String) Url of the inventory
-- `variables` (String) Variables of the inventory. Will be either JSON or YAML string depending on how the variables were entered into AAP.

internal/provider/inventory_data_source.go

@@ -1,230 +1,31 @@
 package provider
 
 import (
-	"context"
-	"encoding/json"
-	"fmt"
-	"path"
-
-	"github.com/ansible/terraform-provider-aap/internal/provider/customtypes"
-	"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/diag"
-	tfpath "github.com/hashicorp/terraform-plugin-framework/path"
-	"github.com/hashicorp/terraform-plugin-framework/types"
 )
 
-// inventoryDataSourceModel maps the data source schema data.
+// Inventory AAP API model
+type InventoryAPIModel struct {
+	BaseDetailAPIModelWithOrg
+}
+
+// InventoryDataSourceModel maps the data source schema data.
 type InventoryDataSourceModel struct {
-	Id               types.Int64                      `tfsdk:"id"`
-	Organization     types.Int64                      `tfsdk:"organization"`
-	OrganizationName types.String                     `tfsdk:"organization_name"`
-	Url              types.String                     `tfsdk:"url"`
-	NamedUrl         types.String                     `tfsdk:"named_url"`
-	Name             types.String                     `tfsdk:"name"`
-	Description      types.String                     `tfsdk:"description"`
-	Variables        customtypes.AAPCustomStringValue `tfsdk:"variables"`
+	BaseDetailDataSourceModelWithOrg
 }
 
 // InventoryDataSource is the data source implementation.
 type InventoryDataSource struct {
-	client ProviderHTTPClient
+	BaseDataSourceWithOrg
 }
 
-// Ensure the implementation satisfies the expected interfaces.
-var (
-	_ datasource.DataSource                     = &InventoryDataSource{}
-	_ datasource.DataSourceWithConfigure        = &InventoryDataSource{}
-	_ datasource.DataSourceWithConfigValidators = &InventoryDataSource{}
-	_ datasource.DataSourceWithValidateConfig   = &InventoryDataSource{}
-)
-
 // NewInventoryDataSource is a helper function to simplify the provider implementation.
 func NewInventoryDataSource() datasource.DataSource {
-	return &InventoryDataSource{}
-}
-
-// Metadata returns the data source type name.
-func (d *InventoryDataSource) Metadata(_ context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
-	resp.TypeName = req.ProviderTypeName + "_inventory"
-}
-
-// Schema defines the schema for the data source.
-func (d *InventoryDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
-	resp.Schema = schema.Schema{
-		Attributes: map[string]schema.Attribute{
-			"id": schema.Int64Attribute{
-				Optional:    true,
-				Description: "Inventory id",
-			},
-			"organization": schema.Int64Attribute{
-				Computed:    true,
-				Description: "Identifier for the organization to which the inventory belongs",
-			},
-			"organization_name": schema.StringAttribute{
-				Computed:    true,
-				Optional:    true,
-				Description: "The name for the organization to which the inventory belongs",
-			},
-			"url": schema.StringAttribute{
-				Computed:    true,
-				Description: "Url of the inventory",
-			},
-			"named_url": schema.StringAttribute{
-				Computed:    true,
-				Description: "The Named Url of the inventory",
-			},
-			"name": schema.StringAttribute{
-				Computed:    true,
-				Optional:    true,
-				Description: "Name of the inventory",
-			},
-			"description": schema.StringAttribute{
-				Computed:    true,
-				Description: "Description of the inventory",
-			},
-			"variables": schema.StringAttribute{
-				Computed:    true,
-				CustomType:  customtypes.AAPCustomStringType{},
-				Description: "Variables of the inventory. Will be either JSON or YAML string depending on how the variables were entered into AAP.",
-			},
-		},
-		Description: `Get an existing inventory.`,
-	}
-}
-
-// Read refreshes the Terraform state with the latest data.
-func (d *InventoryDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
-	var state InventoryDataSourceModel
-	var diags diag.Diagnostics
-
-	// Read Terraform configuration data into the model
-	resp.Diagnostics.Append(req.Config.Get(ctx, &state)...)
-	if resp.Diagnostics.HasError() {
-		return
-	}
-
-	uri := path.Join(d.client.getApiEndpoint(), "inventories")
-	resourceURL, err := ReturnAAPNamedURL(state.Id, state.Name, state.OrganizationName, uri)
-	if err != nil {
-		resp.Diagnostics.AddError("Minimal Data Not Supplied", "Expected either [id] or [name + organization_name] pair")
-		return
-	}
-
-	readResponseBody, diags := d.client.Get(resourceURL)
-	resp.Diagnostics.Append(diags...)
-	if resp.Diagnostics.HasError() {
-		return
-	}
-
-	diags = state.ParseHttpResponse(readResponseBody)
-	resp.Diagnostics.Append(diags...)
-	if resp.Diagnostics.HasError() {
-		return
-	}
-	// Set state
-	// Save updated data into Terraform state
-	resp.Diagnostics.Append(resp.State.Set(ctx, &state)...)
-	if resp.Diagnostics.HasError() {
-		return
-	}
-}
-
-// Configure adds the provider configured client to the data source.
-func (d *InventoryDataSource) Configure(_ context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) {
-	if req.ProviderData == nil {
-		return
-	}
-
-	client, ok := req.ProviderData.(*AAPClient)
-	if !ok {
-		resp.Diagnostics.AddError(
-			"Unexpected Data Source Configure Type",
-			fmt.Sprintf("Expected *AAPClient, got: %T. Please report this issue to the provider developers.", req.ProviderData),
-		)
-
-		return
+	return &InventoryDataSource{
+		BaseDataSourceWithOrg: *NewBaseDataSourceWithOrg(nil, StringDescriptions{
+			MetadataEntitySlug:    "inventory",
+			DescriptiveEntityName: "Inventory",
+			ApiEntitySlug:         "inventories",
+		}),
 	}
-
-	d.client = client
-}
-
-func (d *InventoryDataSource) ConfigValidators(_ context.Context) []datasource.ConfigValidator {
-	// You have at least an id or a name + organization_name pair
-	return []datasource.ConfigValidator{
-		datasourcevalidator.Any(
-			datasourcevalidator.AtLeastOneOf(
-				tfpath.MatchRoot("id")),
-			datasourcevalidator.RequiredTogether(
-				tfpath.MatchRoot("name"),
-				tfpath.MatchRoot("organization_name")),
-		),
-	}
-}
-
-func (d *InventoryDataSource) ValidateConfig(ctx context.Context, req datasource.ValidateConfigRequest, resp *datasource.ValidateConfigResponse) {
-	var data InventoryDataSourceModel
-
-	resp.Diagnostics.Append(req.Config.Get(ctx, &data)...)
-
-	if resp.Diagnostics.HasError() {
-		return
-	}
-
-	if IsValueProvided(data.Id) {
-		return
-	}
-
-	if IsValueProvided(data.Name) && IsValueProvided(data.OrganizationName) {
-		return
-	}
-
-	if !IsValueProvided(data.Id) && !IsValueProvided(data.Name) {
-		resp.Diagnostics.AddAttributeWarning(
-			tfpath.Root("id"),
-			"Missing Attribute Configuration",
-			"Expected either [id] or [name + organization_name] pair",
-		)
-	}
-
-	if IsValueProvided(data.Name) && !IsValueProvided(data.OrganizationName) {
-		resp.Diagnostics.AddAttributeWarning(
-			tfpath.Root("organization_name"),
-			"Missing Attribute Configuration",
-			"Expected organization_name to be configured with name.",
-		)
-	}
-
-	if !IsValueProvided(data.Name) && IsValueProvided(data.OrganizationName) {
-		resp.Diagnostics.AddAttributeWarning(
-			tfpath.Root("name"),
-			"Missing Attribute Configuration",
-			"Expected name to be configured with organization_name.",
-		)
-	}
-}
-
-func (dm *InventoryDataSourceModel) ParseHttpResponse(body []byte) diag.Diagnostics {
-	var diags diag.Diagnostics
-
-	// Unmarshal the JSON response
-	var apiInventory InventoryAPIModel
-	err := json.Unmarshal(body, &apiInventory)
-	if err != nil {
-		diags.AddError("Error parsing JSON response from AAP", err.Error())
-		return diags
-	}
-
-	// Map response to the inventory datesource schema
-	dm.Id = types.Int64Value(apiInventory.Id)
-	dm.Organization = types.Int64Value(apiInventory.Organization)
-	dm.OrganizationName = types.StringValue(apiInventory.SummaryFields.Organization.Name)
-	dm.Url = types.StringValue(apiInventory.Url)
-	dm.NamedUrl = types.StringValue(apiInventory.Related.NamedUrl)
-	dm.Name = ParseStringValue(apiInventory.Name)
-	dm.Description = ParseStringValue(apiInventory.Description)
-	dm.Variables = ParseAAPCustomStringValue(apiInventory.Variables)
-
-	return diags
 }

internal/provider/inventory_data_source_test.go

@@ -55,14 +55,18 @@ func TestInventoryDataSourceParseHttpResponse(t *testing.T) {
 			name:  "missing values",
 			input: []byte(`{"id":1,"organization":2,"url":"/inventories/1/"}`),
 			expected: InventoryDataSourceModel{
-				Id:               types.Int64Value(1),
-				Organization:     types.Int64Value(2),
-				OrganizationName: types.StringValue(""),
-				Url:              types.StringValue("/inventories/1/"),
-				NamedUrl:         types.StringValue(""),
-				Name:             types.StringNull(),
-				Description:      types.StringNull(),
-				Variables:        customtypes.NewAAPCustomStringNull(),
+				BaseDetailDataSourceModelWithOrg: BaseDetailDataSourceModelWithOrg{
+					BaseDetailDataSourceModel: BaseDetailDataSourceModel{
+						Id:          types.Int64Value(1),
+						Name:        types.StringNull(),
+						Description: types.StringNull(),
+						Variables:   customtypes.NewAAPCustomStringNull(),
+						URL:         types.StringValue("/inventories/1/"),
+						NamedUrl:    types.StringNull(),
+					},
+					Organization:     types.Int64Value(2),
+					OrganizationName: types.StringNull(),
+				},
 			},
 			errors: diag.Diagnostics{},
 		},
@@ -72,14 +76,18 @@ func TestInventoryDataSourceParseHttpResponse(t *testing.T) {
 				`{"id":1,"organization":2,"url":"/inventories/1/","name":"my inventory","description":"My Test Inventory","variables":"{\"foo\":\"bar\"}"}`,
 			),
 			expected: InventoryDataSourceModel{
-				Id:               types.Int64Value(1),
-				Organization:     types.Int64Value(2),
-				OrganizationName: types.StringValue(""),
-				Url:              types.StringValue("/inventories/1/"),
-				NamedUrl:         types.StringValue(""),
-				Name:             types.StringValue("my inventory"),
-				Description:      types.StringValue("My Test Inventory"),
-				Variables:        customtypes.NewAAPCustomStringValue("{\"foo\":\"bar\"}"),
+				BaseDetailDataSourceModelWithOrg: BaseDetailDataSourceModelWithOrg{
+					BaseDetailDataSourceModel: BaseDetailDataSourceModel{
+						Id:          types.Int64Value(1),
+						Name:        types.StringValue("my inventory"),
+						Description: types.StringValue("My Test Inventory"),
+						URL:         types.StringValue("/inventories/1/"),
+						NamedUrl:    types.StringNull(),
+						Variables:   customtypes.NewAAPCustomStringValue("{\"foo\":\"bar\"}"),
+					},
+					Organization:     types.Int64Value(2),
+					OrganizationName: types.StringNull(),
+				},
 			},
 			errors: diag.Diagnostics{},
 		},