feat: add workspace_name to stream connection schema and models

Author: kpatel71716

internal/service/streamconnection/model_stream_connection.go

@@ -123,12 +123,16 @@ func NewStreamConnectionUpdateReq(ctx context.Context, plan *TFStreamConnectionM
 	return streamConnection, nil
 }
 
-func NewTFStreamConnection(ctx context.Context, projID, instanceName string, currAuthConfig *types.Object, apiResp *admin.StreamsConnection) (*TFStreamConnectionModel, diag.Diagnostics) {
+func NewTFStreamConnection(ctx context.Context, projID, workspaceName string, currAuthConfig *types.Object, apiResp *admin.StreamsConnection) (*TFStreamConnectionModel, diag.Diagnostics) {
+	return NewTFStreamConnectionWithInstanceName(ctx, projID, "", workspaceName, currAuthConfig, apiResp)
+}
+
+// determines if the original model was created with instance_name or workspace_name and sets the appropriate field
+func NewTFStreamConnectionWithInstanceName(ctx context.Context, projID, instanceName string, workspaceName string, currAuthConfig *types.Object, apiResp *admin.StreamsConnection) (*TFStreamConnectionModel, diag.Diagnostics) {
 	rID := fmt.Sprintf("%s-%s-%s", instanceName, projID, conversion.SafeString(apiResp.Name))
 	connectionModel := TFStreamConnectionModel{
 		ID:               types.StringValue(rID),
 		ProjectID:        types.StringValue(projID),
-		InstanceName:     types.StringValue(instanceName),
 		ConnectionName:   types.StringPointerValue(apiResp.Name),
 		Type:             types.StringPointerValue(apiResp.Type),
 		ClusterName:      types.StringPointerValue(apiResp.ClusterName),
@@ -137,6 +141,19 @@ func NewTFStreamConnection(ctx context.Context, projID, instanceName string, cur
 		URL:              types.StringPointerValue(apiResp.Url),
 	}
 
+	if workspaceName != "" && instanceName != "" {
+		return nil, diag.Diagnostics{diag.NewErrorDiagnostic("Attribute \"instance_name\" cannot be specified when \"workspace_name\" is specified", "")}
+	}
+	// Set the appropriate field based on the original model
+	if workspaceName != "" {
+		connectionModel.WorkspaceName = types.StringValue(workspaceName)
+		connectionModel.InstanceName = types.StringNull()
+	} else {
+		// Default to instance_name for backward compatibility
+		connectionModel.InstanceName = types.StringValue(instanceName)
+		connectionModel.WorkspaceName = types.StringNull()
+	}
+
 	authModel, diags := newTFConnectionAuthenticationModel(ctx, currAuthConfig, apiResp.Authentication)
 	if diags.HasError() {
 		return nil, diags
@@ -254,22 +271,30 @@ func NewTFStreamConnections(ctx context.Context,
 	paginatedResult *admin.PaginatedApiStreamsConnection) (*TFStreamConnectionsDSModel, diag.Diagnostics) {
 	input := paginatedResult.GetResults()
 	results := make([]TFStreamConnectionModel, len(input))
+
+	workspaceName := streamConnectionsConfig.WorkspaceName.ValueString()
+	instanceName := streamConnectionsConfig.InstanceName.ValueString()
+	if workspaceName != "" && instanceName != "" {
+		return nil, diag.Diagnostics{diag.NewErrorDiagnostic("Attribute \"instance_name\" cannot be specified when \"workspace_name\" is specified", "")}
+	}
+
 	for i := range input {
 		projectID := streamConnectionsConfig.ProjectID.ValueString()
-		instanceName := streamConnectionsConfig.InstanceName.ValueString()
-		connectionModel, diags := NewTFStreamConnection(ctx, projectID, instanceName, nil, &input[i])
+		connectionModel, diags := NewTFStreamConnectionWithInstanceName(ctx, projectID, instanceName, workspaceName, nil, &input[i])
 		if diags.HasError() {
 			return nil, diags
 		}
 		results[i] = *connectionModel
 	}
+
 	return &TFStreamConnectionsDSModel{
-		ID:           types.StringValue(id.UniqueId()),
-		ProjectID:    streamConnectionsConfig.ProjectID,
-		InstanceName: streamConnectionsConfig.InstanceName,
-		Results:      results,
-		PageNum:      streamConnectionsConfig.PageNum,
-		ItemsPerPage: streamConnectionsConfig.ItemsPerPage,
-		TotalCount:   types.Int64PointerValue(conversion.IntPtrToInt64Ptr(paginatedResult.TotalCount)),
+		ID:            types.StringValue(id.UniqueId()),
+		ProjectID:     streamConnectionsConfig.ProjectID,
+		InstanceName:  streamConnectionsConfig.InstanceName,
+		WorkspaceName: streamConnectionsConfig.WorkspaceName,
+		Results:       results,
+		PageNum:       streamConnectionsConfig.PageNum,
+		ItemsPerPage:  streamConnectionsConfig.ItemsPerPage,
+		TotalCount:    types.Int64PointerValue(conversion.IntPtrToInt64Ptr(paginatedResult.TotalCount)),
 	}, nil
 }

internal/service/streamconnection/model_stream_connection_test.go

@@ -2,6 +2,7 @@ package streamconnection_test
 
 import (
 	"fmt"
+	"strings"
 	"testing"
 
 	"github.com/hashicorp/terraform-plugin-framework/types"
@@ -483,6 +484,25 @@ func TestStreamConnectionsSDKToTFModel(t *testing.T) {
 				Results:      []streamconnection.TFStreamConnectionModel{},
 			},
 		},
+		{
+			name: "With workspace name and no page options",
+			SDKResp: &admin.PaginatedApiStreamsConnection{
+				Results:    &[]admin.StreamsConnection{},
+				TotalCount: admin.PtrInt(0),
+			},
+			providedConfig: &streamconnection.TFStreamConnectionsDSModel{
+				ProjectID:     types.StringValue(dummyProjectID),
+				WorkspaceName: types.StringValue(instanceName),
+			},
+			expectedTFModel: &streamconnection.TFStreamConnectionsDSModel{
+				ProjectID:     types.StringValue(dummyProjectID),
+				WorkspaceName: types.StringValue(instanceName),
+				PageNum:       types.Int64Null(),
+				ItemsPerPage:  types.Int64Null(),
+				TotalCount:    types.Int64Value(0),
+				Results:       []streamconnection.TFStreamConnectionModel{},
+			},
+		},
 	}
 
 	for _, tc := range testCases {
@@ -499,6 +519,44 @@ func TestStreamConnectionsSDKToTFModel(t *testing.T) {
 	}
 }
 
+type connectionsSDKToTFModelErrorTestCase struct {
+	SDKResp             *admin.PaginatedApiStreamsConnection
+	providedConfig      *streamconnection.TFStreamConnectionsDSModel
+	expectedTFModel     *streamconnection.TFStreamConnectionsDSModel
+	expectedErrorString string
+	name                string
+}
+
+func TestStreamConnectionsSDKToTFModelError(t *testing.T) {
+	testCases := []connectionsSDKToTFModelErrorTestCase{
+		{
+			name: "With workspace name and instance name",
+			SDKResp: &admin.PaginatedApiStreamsConnection{
+				Results:    &[]admin.StreamsConnection{},
+				TotalCount: admin.PtrInt(0),
+			},
+			providedConfig: &streamconnection.TFStreamConnectionsDSModel{
+				ProjectID:     types.StringValue(dummyProjectID),
+				WorkspaceName: types.StringValue(instanceName),
+				InstanceName:  types.StringValue(instanceName),
+			},
+			expectedErrorString: "Attribute \"instance_name\" cannot be specified when \"workspace_name\" is specified",
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			_, diags := streamconnection.NewTFStreamConnections(t.Context(), tc.providedConfig, tc.SDKResp)
+			if !diags.HasError() {
+				t.Fatalf("expected error but got none")
+			}
+			if !strings.Contains(diags.Errors()[0].Summary(), tc.expectedErrorString) {
+				t.Fatalf("expected error %s but got %s", tc.expectedErrorString, diags.Errors()[0].Summary())
+			}
+		})
+	}
+}
+
 type tfToSDKCreateModelTestCase struct {
 	tfModel        *streamconnection.TFStreamConnectionModel
 	expectedSDKReq *admin.StreamsConnection

internal/service/streamconnection/resource_schema.go

@@ -4,6 +4,7 @@ import (
 	"context"
 
 	"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
+	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/objectplanmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
@@ -28,10 +29,26 @@ func ResourceSchema(ctx context.Context) schema.Schema {
 				},
 			},
 			"instance_name": schema.StringAttribute{
-				Required: true,
+				Optional: true,
 				PlanModifiers: []planmodifier.String{
 					stringplanmodifier.RequiresReplace(),
 				},
+				Validators: []validator.String{
+					stringvalidator.ConflictsWith(path.Expressions{
+						path.MatchRelative().AtParent().AtName("workspace_name"),
+					}...),
+				},
+			},
+			"workspace_name": schema.StringAttribute{
+				Optional: true,
+				PlanModifiers: []planmodifier.String{
+					stringplanmodifier.RequiresReplace(),
+				},
+				Validators: []validator.String{
+					stringvalidator.ConflictsWith(path.Expressions{
+						path.MatchRelative().AtParent().AtName("instance_name"),
+					}...),
+				},
 			},
 			"connection_name": schema.StringAttribute{
 				Required: true,