warehouse_metadata_data_source.go

package provider

import (
	"context"
	"fmt"

	"github.com/segmentio/terraform-provider-segment/internal/provider/models"

	"github.com/segmentio/public-api-sdk-go/api"

	"github.com/hashicorp/terraform-plugin-framework-jsontypes/jsontypes"
	"github.com/hashicorp/terraform-plugin-framework/datasource"
	"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
)

// Ensure the implementation satisfies the expected interfaces.
var (
	_ datasource.DataSource              = &warehouseMetadataDataSource{}
	_ datasource.DataSourceWithConfigure = &warehouseMetadataDataSource{}
)

// NewWarehouseMetadataDataSource is a helper function to simplify the provider implementation.
func NewWarehouseMetadataDataSource() datasource.DataSource {
	return &warehouseMetadataDataSource{}
}

// warehouseMetadataDataSource is the data source implementation.
type warehouseMetadataDataSource struct {
	client      *api.APIClient
	authContext context.Context
}

func warehouseMetadataSchema() map[string]schema.Attribute {
	return map[string]schema.Attribute{
		"id": schema.StringAttribute{
			Required:    true,
			Description: "The id of this object.",
		},
		"name": schema.StringAttribute{
			Computed:    true,
			Description: "The name of this object.",
		},
		"slug": schema.StringAttribute{
			Computed:    true,
			Description: "A human-readable, unique identifier for object.",
		},
		"description": schema.StringAttribute{
			Computed:    true,
			Description: "A description, in English, of this object.",
		},
		"logos": schema.SingleNestedAttribute{
			Computed:    true,
			Description: "Logo information for this object.",
			Attributes: map[string]schema.Attribute{
				"default": schema.StringAttribute{
					Computed:    true,
					Description: "The default URL for this logo.",
				},
				"mark": schema.StringAttribute{
					Computed:    true,
					Description: "The logo mark.",
				},
				"alt": schema.StringAttribute{
					Computed:    true,
					Description: "The alternative text for this logo.",
				},
			},
		},
		"options": schema.ListNestedAttribute{
			Computed:    true,
			Description: "The Integration options for this object.",
			NestedObject: schema.NestedAttributeObject{
				Attributes: map[string]schema.Attribute{
					"name": schema.StringAttribute{
						Computed:    true,
						Description: "The name identifying this option in the context of a Segment Integration.",
					},
					"type": schema.StringAttribute{
						Computed:    true,
						Description: "Defines the type for this option in the schema.",
					},
					"required": schema.BoolAttribute{
						Computed:    true,
						Description: "Whether this is a required option when setting up the Integration.",
					},
					"description": schema.StringAttribute{
						Computed:    true,
						Description: "An optional short text description of the field.",
					},
					"default_value": schema.StringAttribute{
						CustomType:  jsontypes.NormalizedType{},
						Computed:    true,
						Description: "An optional default value for the field.",
					},
					"label": schema.StringAttribute{
						Computed:    true,
						Description: "An optional label for this field.",
					},
				},
			},
		},
	}
}

// Metadata returns the data source type name.
func (d *warehouseMetadataDataSource) Metadata(_ context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
	resp.TypeName = req.ProviderTypeName + "_warehouse_metadata"
}

// Read refreshes the Terraform state with the latest data.
func (d *warehouseMetadataDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
	var state models.WarehouseMetadataState

	diags := req.Config.Get(ctx, &state)

	resp.Diagnostics.Append(diags...)
	if resp.Diagnostics.HasError() {
		return
	}

	id := state.ID.ValueString()
	if id == "" {
		resp.Diagnostics.AddError("Unable to read Warehouse metadata", "ID is empty")

		return
	}

	response, body, err := d.client.CatalogAPI.GetWarehouseMetadata(d.authContext, state.ID.ValueString()).Execute()
	if body != nil {
		defer body.Body.Close()
	}
	if err != nil {
		resp.Diagnostics.AddError(
			"Unable to Read Warehouse metadata",
			getError(err, body),
		)

		return
	}

	warehouseMetadata := response.Data.WarehouseMetadata

	err = state.Fill(warehouseMetadata)
	if err != nil {
		resp.Diagnostics.AddError(
			"Unable to Read Warehouse metadata",
			err.Error(),
		)

		return
	}

	diags = resp.State.Set(ctx, &state)
	resp.Diagnostics.Append(diags...)
	if resp.Diagnostics.HasError() {
		return
	}
}

// Schema defines the schema for the data source.
func (d *warehouseMetadataDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
	resp.Schema = schema.Schema{
		Description: "Reads a Warehouse metadata. For more information, visit the [Segment docs](https://segment.com/docs/connections/storage/catalog/).",
		Attributes:  warehouseMetadataSchema(),
	}
}

// Configure adds the provider configured client to the data source.
func (d *warehouseMetadataDataSource) Configure(_ context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) {
	if req.ProviderData == nil {
		return
	}

	clientInfo, ok := req.ProviderData.(*ClientInfo)
	if !ok {
		resp.Diagnostics.AddError(
			"Unexpected Data Source Configure Type",
			fmt.Sprintf("Expected *ClientInfo, got: %T. Please report this issue to the provider developers.", req.ProviderData),
		)

		return
	}

	d.client = clientInfo.client
	d.authContext = clientInfo.authContext
}