feat: switch to generate model in cluster datasource

Realized I could make a small change to the generateModel function call that would allow me to use it in datasource, permitting the removal of a lot of code.

Author: gene-redpanda

redpanda/resources/cluster/data_cluster.go

@@ -20,10 +20,8 @@ package cluster
 import (
 	"context"
 	"fmt"
-	"time"
 
 	controlplanev1beta2 "buf.build/gen/go/redpandadata/cloud/protocolbuffers/go/redpanda/api/controlplane/v1beta2"
-	"github.com/hashicorp/terraform-plugin-framework/attr"
 	"github.com/hashicorp/terraform-plugin-framework/datasource"
 	"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/types"
@@ -86,135 +84,21 @@ func (d *DataSourceCluster) Read(ctx context.Context, req datasource.ReadRequest
 	}
 
 	// Convert cloud provider tags to Terraform map
-	tags := make(map[string]attr.Value)
-	for k, v := range cluster.CloudProviderTags {
-		tags[k] = types.StringValue(v)
-	}
-	tagsValue, diags := types.MapValue(types.StringType, tags)
-	if diags.HasError() {
-		resp.Diagnostics.AddError("unable to parse Cloud tags", utils.DeserializeGrpcError(err))
-		return
-	}
-
-	// Create persistence model
-	persist := &models.Cluster{
-		Name:                  types.StringValue(cluster.Name),
-		ConnectionType:        types.StringValue(utils.ConnectionTypeToString(cluster.ConnectionType)),
-		CloudProvider:         types.StringValue(utils.CloudProviderToString(cluster.CloudProvider)),
-		ClusterType:           types.StringValue(utils.ClusterTypeToString(cluster.Type)),
-		RedpandaVersion:       types.StringValue(cluster.RedpandaVersion),
-		ThroughputTier:        types.StringValue(cluster.ThroughputTier),
-		Region:                types.StringValue(cluster.Region),
-		ResourceGroupID:       types.StringValue(cluster.ResourceGroupId),
-		NetworkID:             types.StringValue(cluster.NetworkId),
-		ID:                    types.StringValue(cluster.Id),
-		Tags:                  tagsValue,
-		Zones:                 utils.StringSliceToTypeList(cluster.Zones),
-		ReadReplicaClusterIDs: utils.StringSliceToTypeList(cluster.ReadReplicaClusterIds),
-		AllowDeletion:         types.BoolValue(true), // Default to true for data source
-		State:                 types.StringValue(cluster.State.String()),
-	}
-
-	if cluster.HasCreatedAt() {
-		persist.CreatedAt = types.StringValue(cluster.CreatedAt.AsTime().Format(time.RFC3339))
-	}
-
-	if cluster.HasStateDescription() {
-		stateDescription, dg := generateModelStateDescription(cluster, diags)
-		if dg.HasError() {
-			resp.Diagnostics.Append(dg...)
-			return
-		}
-		persist.StateDescription = stateDescription
-	}
-
-	if cluster.HasDataplaneApi() {
-		persist.ClusterAPIURL = types.StringValue(cluster.DataplaneApi.Url)
-	}
-
-	kafkaAPI, dg := generateModelKafkaAPI(cluster, diags)
-	if dg.HasError() {
-		resp.Diagnostics.Append(dg...)
-		return
-	}
-	persist.KafkaAPI = kafkaAPI
-
-	httpProxy, dg := generateModelHTTPProxy(cluster, diags)
-	if dg.HasError() {
-		resp.Diagnostics.Append(dg...)
-		return
-	}
-	persist.HTTPProxy = httpProxy
-
-	schemaRegistry, dg := generateModelSchemaRegistry(cluster, diags)
-	if dg.HasError() {
-		resp.Diagnostics.Append(dg...)
-		return
-	}
-	persist.SchemaRegistry = schemaRegistry
-
-	console, dg := generateModelRedpandaConsole(cluster, diags)
-	if dg.HasError() {
-		resp.Diagnostics.Append(dg...)
-		return
-	}
-	persist.RedpandaConsole = console
-
-	prometheus, dg := generateModelPrometheus(cluster, diags)
-	if dg.HasError() {
-		resp.Diagnostics.Append(dg...)
-		return
-	}
-	persist.Prometheus = prometheus
-
-	window, dg := generateModelMaintenanceWindow(cluster, diags)
-	if dg.HasError() {
-		resp.Diagnostics.Append(dg...)
-		return
-	}
-	persist.MaintenanceWindowConfig = window
-
-	awsPrivateLink, dg := generateModelAWSPrivateLink(cluster, resp.Diagnostics)
-	if dg.HasError() {
-		resp.Diagnostics.Append(dg...)
-		return
-	}
-	persist.AwsPrivateLink = awsPrivateLink
-
-	gcpPSC, dg := generateModelGCPPrivateServiceConnect(cluster, resp.Diagnostics)
-	if dg.HasError() {
-		resp.Diagnostics.Append(dg...)
-		return
-	}
-	persist.GcpPrivateServiceConnect = gcpPSC
-
-	azurePrivateLink, dg := generateModelAzurePrivateLink(cluster, resp.Diagnostics)
-	if dg.HasError() {
-		resp.Diagnostics.Append(dg...)
-		return
-	}
-	persist.AzurePrivateLink = azurePrivateLink
-
-	connectivity, dg := generateModelConnectivity(cluster, resp.Diagnostics)
-	if dg.HasError() {
-		resp.Diagnostics.Append(dg...)
-		return
-	}
-	persist.Connectivity = connectivity
-
-	kafkaConnect, dg := generateModelKafkaConnect(cluster, resp.Diagnostics)
-	if dg.HasError() {
-		resp.Diagnostics.Append(dg...)
+	tags, err := utils.StringMapToTypesMap(cluster.GetCloudProviderTags())
+	if err != nil {
+		resp.Diagnostics.AddError("error converting tags to MapType", err.Error())
 		return
 	}
-	persist.KafkaConnect = kafkaConnect
 
-	cmr, dg := generateModelCMR(cluster, resp.Diagnostics)
+	persist, dg := generateModel(cluster, modelOrAPI{
+		RedpandaVersion: types.StringValue(cluster.RedpandaVersion),
+		Tags:            tags,
+	}, resp.Diagnostics)
 	if dg.HasError() {
+		resp.Diagnostics.AddError("error generating model", "failed to generate model in cluster datasource read")
 		resp.Diagnostics.Append(dg...)
 		return
 	}
-	persist.CustomerManagedResources = cmr
 
 	resp.Diagnostics.Append(resp.State.Set(ctx, persist)...)
 }

redpanda/resources/cluster/proto_to_model.go

@@ -12,19 +12,26 @@ import (
 	"github.com/redpanda-data/terraform-provider-redpanda/redpanda/utils"
 )
 
+// used as an input to generateModel to allow populating these fields with either the model or the API
+type modelOrAPI struct {
+	RedpandaVersion types.String
+	AllowDeletion   types.Bool
+	Tags            types.Map
+}
+
 // generateModel populates the Cluster model to be persisted to state for Create, Read and Update operations. It is also indirectly used by Import
-func generateModel(cfg models.Cluster, cluster *controlplanev1beta2.Cluster, diagnostics diag.Diagnostics) (*models.Cluster, diag.Diagnostics) {
+func generateModel(cluster *controlplanev1beta2.Cluster, contingent modelOrAPI, diagnostics diag.Diagnostics) (*models.Cluster, diag.Diagnostics) {
 	output := &models.Cluster{
 		Name:                  types.StringValue(cluster.GetName()),
 		ID:                    types.StringValue(cluster.GetId()),
 		ConnectionType:        types.StringValue(utils.ConnectionTypeToString(cluster.GetConnectionType())),
 		CloudProvider:         types.StringValue(utils.CloudProviderToString(cluster.GetCloudProvider())),
 		ClusterType:           types.StringValue(utils.ClusterTypeToString(cluster.GetType())),
-		RedpandaVersion:       cfg.RedpandaVersion,
+		RedpandaVersion:       contingent.RedpandaVersion,
 		ThroughputTier:        types.StringValue(cluster.GetThroughputTier()),
 		Region:                types.StringValue(cluster.GetRegion()),
-		AllowDeletion:         cfg.AllowDeletion,
-		Tags:                  cfg.Tags,
+		AllowDeletion:         contingent.AllowDeletion,
+		Tags:                  contingent.Tags,
 		ResourceGroupID:       types.StringValue(cluster.GetResourceGroupId()),
 		NetworkID:             types.StringValue(cluster.GetNetworkId()),
 		ReadReplicaClusterIDs: utils.StringSliceToTypeList(cluster.GetReadReplicaClusterIds()),

redpanda/resources/cluster/resource_cluster.go

@@ -126,7 +126,11 @@ func (c *Cluster) Create(ctx context.Context, req resource.CreateRequest, resp *
 
 	// there are various states where cluster can be nil in which case we should default to the minimal model already persisted
 	if cluster != nil {
-		p, dg := generateModel(model, cluster, resp.Diagnostics)
+		p, dg := generateModel(cluster, modelOrAPI{
+			RedpandaVersion: model.RedpandaVersion,
+			AllowDeletion:   model.AllowDeletion,
+			Tags:            model.Tags,
+		}, resp.Diagnostics)
 		if dg.HasError() {
 			// append minimal state because we failed
 			resp.Diagnostics.Append(resp.State.Set(ctx, generateMinimalModel(clusterID))...)
@@ -161,7 +165,11 @@ func (c *Cluster) Read(ctx context.Context, req resource.ReadRequest, resp *reso
 		return
 	}
 
-	persist, d := generateModel(model, cluster, resp.Diagnostics)
+	persist, d := generateModel(cluster, modelOrAPI{
+		RedpandaVersion: model.RedpandaVersion,
+		AllowDeletion:   model.AllowDeletion,
+		Tags:            model.Tags,
+	}, resp.Diagnostics)
 	if d.HasError() {
 		resp.Diagnostics.AddError("failed to generate model for state during cluster.Read", "")
 		resp.Diagnostics.Append(d...)
@@ -203,7 +211,11 @@ func (c *Cluster) Update(ctx context.Context, req resource.UpdateRequest, resp *
 		return
 	}
 
-	persist, d := generateModel(plan, cluster, resp.Diagnostics)
+	persist, d := generateModel(cluster, modelOrAPI{
+		RedpandaVersion: plan.RedpandaVersion,
+		AllowDeletion:   plan.AllowDeletion,
+		Tags:            plan.Tags,
+	}, resp.Diagnostics)
 	if d.HasError() {
 		resp.Diagnostics.AddError("failed to generate model for state during cluster.Update", "")
 		resp.Diagnostics.Append(d...)