Refactoring and cleanup of new resources and data sources

Author: lranjbar

internal/provider/client.go

@@ -25,6 +25,15 @@ type ProviderHTTPClient interface {
 	getApiEndpoint() string
 }
 
+// Client -
+type AAPClient struct {
+	HostURL     string
+	Username    *string
+	Password    *string
+	httpClient  *http.Client
+	ApiEndpoint string
+}
+
 type AAPApiEndpointResponse struct {
 	Apis struct {
 		Controller string `json:"controller"`
@@ -68,15 +77,6 @@ func readApiEndpoint(client ProviderHTTPClient) (string, diag.Diagnostics) {
 	return response.CurrentVersion, diags
 }
 
-// Client -
-type AAPClient struct {
-	HostURL     string
-	Username    *string
-	Password    *string
-	httpClient  *http.Client
-	ApiEndpoint string
-}
-
 // NewClient - create new AAPClient instance
 func NewClient(host string, username *string, password *string, insecureSkipVerify bool, timeout int64) (*AAPClient, diag.Diagnostics) {
 	hostURL, _ := url.JoinPath(host, "/")

internal/provider/customtypes/aapcustomstring_type_test.go

@@ -82,6 +82,16 @@ func TestAAPCustomStringTypeValueFromTerraform(t *testing.T) {
 		expectation attr.Value
 		expectedErr string
 	}{
+		"yaml string no newline": {
+			in: tftypes.NewValue(tftypes.String, `<<-EOT
+			os: Linux
+			automation: ansible-devel
+			EOT`),
+			expectation: customtypes.NewAAPCustomStringValue(`<<-EOT
+			os: Linux
+			automation: ansible-devel
+			EOT2`),
+		},
 		"true": {
 			in:          tftypes.NewValue(tftypes.String, `{"hello":"world"}`),
 			expectation: customtypes.NewAAPCustomStringValue(`{"hello":"world"}`),
@@ -119,7 +129,7 @@ func TestAAPCustomStringTypeValueFromTerraform(t *testing.T) {
 				t.Fatalf("Expected error to be %q, didn't get an error", testCase.expectedErr)
 			}
 			if !got.Equal(testCase.expectation) {
-				t.Errorf("Expected %+v, got %+v", testCase.expectation, got)
+				t.Errorf("Expected %d, got %d", testCase.expectation, got)
 			}
 			if testCase.expectation.IsNull() != testCase.in.IsNull() {
 				t.Errorf("Expected null-ness match: expected %t, got %t", testCase.expectation.IsNull(), testCase.in.IsNull())

internal/provider/inventory_data_source.go

@@ -3,33 +3,50 @@ package provider
 import (
 	"context"
 	"encoding/json"
+	"errors"
 	"fmt"
 	"path"
 	"strings"
 
 	"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/provider"
 	"github.com/hashicorp/terraform-plugin-framework/types"
 )
 
+// 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"`
+}
+
+// InventoryDataSource is the data source implementation.
+type InventoryDataSource struct {
+	client ProviderHTTPClient
+}
+
 // Ensure the implementation satisfies the expected interfaces.
 var (
-	_ datasource.DataSource              = &InventoryDataSource{}
-	_ datasource.DataSourceWithConfigure = &InventoryDataSource{}
+	_ datasource.DataSource                     = &InventoryDataSource{}
+	_ datasource.DataSourceWithConfigure        = &InventoryDataSource{}
+	_ datasource.DataSourceWithConfigValidators = &InventoryDataSource{}
 )
 
 // NewInventoryDataSource is a helper function to simplify the provider implementation.
 func NewInventoryDataSource() datasource.DataSource {
 	return &InventoryDataSource{}
 }
 
-// inventoryDataSource is the data source implementation.
-type InventoryDataSource struct {
-	client *AAPClient
-}
-
 // Metadata returns the data source type name.
 func (d *InventoryDataSource) Metadata(_ context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
 	resp.TypeName = req.ProviderTypeName + "_inventory"
@@ -40,16 +57,16 @@ func (d *InventoryDataSource) Schema(_ context.Context, _ datasource.SchemaReque
 	resp.Schema = schema.Schema{
 		Attributes: map[string]schema.Attribute{
 			"id": schema.Int64Attribute{
-				Optional: true,
+				Optional:    true,
 				Description: "Inventory id",
 			},
 			"organization": schema.Int64Attribute{
-				Computed: true,
+				Computed:    true,
 				Description: "Identifier for the organization to which the inventory belongs",
 			},
 			"organization_name": schema.StringAttribute{
-				Computed: true,
-				Optional: true,
+				Computed:    true,
+				Optional:    true,
 				Description: "The name for the organization to which the inventory belongs",
 			},
 			"url": schema.StringAttribute{
@@ -62,7 +79,7 @@ func (d *InventoryDataSource) Schema(_ context.Context, _ datasource.SchemaReque
 			},
 			"name": schema.StringAttribute{
 				Computed:    true,
-				Optional: true,
+				Optional:    true,
 				Description: "Name of the inventory",
 			},
 			"description": schema.StringAttribute{
@@ -90,18 +107,9 @@ func (d *InventoryDataSource) Read(ctx context.Context, req datasource.ReadReque
 		return
 	}
 
-	//Here is where we can get the "named" inventory, which is "Inventory Name"++"Organization Name" to derive uniqueness
-	//we will take precedence if the Id is set to use that over the named_url attempt.
-
-	resourceURL := ""
-
-	if state.Id.String() != "<null>" {
-		resourceURL = path.Join(d.client.getApiEndpoint(), "inventories", state.Id.String())
-	} else if state.Name.String() != "<null>" && state.OrganizationName.String() != "<null>"{
-		namedUrl := strings.Join([]string{state.Name.String()[1 : len(state.Name.String()) - 1], "++", state.OrganizationName.String()[1 : len(state.OrganizationName.String()) - 1]}, "")
-		resourceURL = path.Join(d.client.getApiEndpoint(), "inventories", namedUrl)
-	} else { 
-		resp.Diagnostics.AddError("Minimal Data Not Supplied", "Require [id] or [name and organization_name]")
+	resourceURL, err := state.ResourceUrlFromParameters(d)
+	if err != nil {
+		resp.Diagnostics.AddError("Minimal Data Not Supplied", "Expected either [id] or [name + organization_name] pair")
 		return
 	}
 
@@ -143,19 +151,55 @@ func (d *InventoryDataSource) Configure(_ context.Context, req datasource.Config
 	d.client = client
 }
 
-// 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"`
+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 provider.ValidateConfigRequest, resp *provider.ValidateConfigResponse) {
+	var data InventoryDataSourceModel
+
+	resp.Diagnostics.Append(req.Config.Get(ctx, &data)...)
+
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	if !data.Id.IsNull() {
+		return
+	}
+
+	if !data.Name.IsNull() && !data.OrganizationName.IsNull() {
+		return
+	}
+
+	if data.Id.IsNull() && data.Name.IsNull() {
+		resp.Diagnostics.AddAttributeWarning(
+			tfpath.Root("id"),
+			"Missing Atribute Configuration",
+			"Expected either [id] or [name + organization_name] pair",
+		)
+	}
+
+	if !data.Name.IsNull() && data.OrganizationName.IsNull() {
+		resp.Diagnostics.AddAttributeWarning(
+			tfpath.Root("organization_name"),
+			"Missing Attribute Configuration",
+			"Expected organization_name to be configured with name.",
+		)
+	}
+
 }
 
-func (d *InventoryDataSourceModel) ParseHttpResponse(body []byte) diag.Diagnostics {
+func (dm *InventoryDataSourceModel) ParseHttpResponse(body []byte) diag.Diagnostics {
 	var diags diag.Diagnostics
 
 	// Unmarshal the JSON response
@@ -167,14 +211,29 @@ func (d *InventoryDataSourceModel) ParseHttpResponse(body []byte) diag.Diagnosti
 	}
 
 	// Map response to the inventory datesource schema
-	d.Id = types.Int64Value(apiInventory.Id)
-	d.Organization = types.Int64Value(apiInventory.Organization)
-	d.OrganizationName = types.StringValue(apiInventory.SummaryFields.Organization.Name)
-	d.Url = types.StringValue(apiInventory.Url)
-	d.NamedUrl = types.StringValue(apiInventory.Related.NamedUrl)
-	d.Name = ParseStringValue(apiInventory.Name)
-	d.Description = ParseStringValue(apiInventory.Description)
-	d.Variables = ParseAAPCustomStringValue(apiInventory.Variables)
+	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
 }
+
+// ResourceUrlFromParameters Given the provided parameters and return the appropriate resource url
+func (dm *InventoryDataSourceModel) ResourceUrlFromParameters(datasource *InventoryDataSource) (string, error) {
+	//Here is where we can get the "named" inventory, which is "Inventory Name"++"Organization Name" to derive uniqueness
+	//We will take precedence if the Id is set to use that over the named_url attempt.
+	if !dm.Id.IsNull() {
+		return path.Join(datasource.client.getApiEndpoint(), "inventories", dm.Id.String()), nil
+	} else if !dm.Name.IsNull() && !dm.OrganizationName.IsNull() {
+		namedUrl := strings.Join([]string{dm.Name.String()[1 : len(dm.Name.String())-1], "++", dm.OrganizationName.String()[1 : len(dm.OrganizationName.String())-1]}, "")
+		return path.Join(datasource.client.getApiEndpoint(), "inventories", namedUrl), nil
+	} else {
+		return types.StringNull().String(), errors.New("invalid inventory lookup parameters")
+	}
+
+}

internal/provider/inventory_data_source_test.go

@@ -55,12 +55,14 @@ 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),
-				Url:          types.StringValue("/inventories/1/"),
-				Name:         types.StringNull(),
-				Description:  types.StringNull(),
-				Variables:    customtypes.NewAAPCustomStringNull(),
+				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(),
 			},
 			errors: diag.Diagnostics{},
 		},
@@ -70,12 +72,14 @@ 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),
-				Url:          types.StringValue("/inventories/1/"),
-				Name:         types.StringValue("my inventory"),
-				Description:  types.StringValue("My Test Inventory"),
-				Variables:    customtypes.NewAAPCustomStringValue("{\"foo\":\"bar\"}"),
+				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\"}"),
 			},
 			errors: diag.Diagnostics{},
 		},