feat(gateway): onboard new resource/data-source

internal/provider/provider.go

@@ -41,6 +41,7 @@ import (
 	"github.com/microsoft/terraform-provider-fabric/internal/services/environment"
 	"github.com/microsoft/terraform-provider-fabric/internal/services/eventhouse"
 	"github.com/microsoft/terraform-provider-fabric/internal/services/eventstream"
+	"github.com/microsoft/terraform-provider-fabric/internal/services/gateway"
 	"github.com/microsoft/terraform-provider-fabric/internal/services/kqldatabase"
 	"github.com/microsoft/terraform-provider-fabric/internal/services/kqlqueryset"
 	"github.com/microsoft/terraform-provider-fabric/internal/services/lakehouse"
@@ -402,6 +403,7 @@ func (p *FabricProvider) DataSources(ctx context.Context) []func() datasource.Da
 		func() datasource.DataSource { return eventhouse.NewDataSourceEventhouses(ctx) },
 		eventstream.NewDataSourceEventstream,
 		eventstream.NewDataSourceEventstreams,
+		gateway.NewDataSourceGateway,
 		kqldatabase.NewDataSourceKQLDatabase,
 		kqldatabase.NewDataSourceKQLDatabases,
 		kqlqueryset.NewDataSourceKQLQueryset,

internal/services/gateway/base.go

@@ -0,0 +1,23 @@
+// Copyright (c) Microsoft Corporation
+// SPDX-License-Identifier: MPL-2.0
+
+package gateway
+
+import (
+	"github.com/microsoft/terraform-provider-fabric/internal/common"
+)
+
+const (
+	ItemName           = "Gateway"
+	ItemTFName         = "gateway"
+	ItemsName          = "Gateways"
+	ItemsTFName        = "gateways"
+	ItemDocsSPNSupport = common.DocsSPNSupported
+	ItemDocsURL        = "https://learn.microsoft.com/en-us/power-bi/guidance/powerbi-implementation-planning-data-gateways"
+)
+
+var (
+	PossibleInactivityMinutesBeforeSleepValues = []int32{30, 60, 90, 120, 150, 240, 360, 480, 720, 1440}
+	MinNumberOfMemberGatewaysValues            = int32(1)
+	MaxNumberOfMemberGatewaysValues            = int32(7)
+)

internal/services/gateway/data_gateway.go

@@ -0,0 +1,189 @@
+// Copyright (c) Microsoft Corporation
+// SPDX-License-Identifier: MPL-2.0
+
+package gateway
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/hashicorp/terraform-plugin-framework-timeouts/datasource/timeouts"
+	"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"
+	"github.com/hashicorp/terraform-plugin-framework/path"
+	"github.com/hashicorp/terraform-plugin-log/tflog"
+	fabcore "github.com/microsoft/fabric-sdk-go/fabric/core"
+	supertypes "github.com/orange-cloudavenue/terraform-plugin-framework-supertypes"
+
+	"github.com/microsoft/terraform-provider-fabric/internal/common"
+	"github.com/microsoft/terraform-provider-fabric/internal/framework/customtypes"
+	"github.com/microsoft/terraform-provider-fabric/internal/pkg/utils"
+	pconfig "github.com/microsoft/terraform-provider-fabric/internal/provider/config"
+)
+
+var (
+	_ datasource.DataSourceWithConfigValidators = (*dataSourceGateway)(nil)
+	_ datasource.DataSourceWithConfigure        = (*dataSourceGateway)(nil)
+)
+
+type dataSourceGateway struct {
+	pConfigData *pconfig.ProviderData
+	client      *fabcore.GatewaysClient
+}
+
+func NewDataSourceGateway() datasource.DataSource {
+	return &dataSourceGateway{}
+}
+
+func (d *dataSourceGateway) Metadata(_ context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
+	resp.TypeName = req.ProviderTypeName + "_" + ItemTFName
+}
+
+func (d *dataSourceGateway) Schema(ctx context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
+	resp.Schema = schema.Schema{
+		MarkdownDescription: "Get a Fabric " + ItemName + ".\n\n" +
+			"Use this data source to get [" + ItemName + "](" + ItemDocsURL + ").\n\n" +
+			ItemDocsSPNSupport,
+		Attributes: map[string]schema.Attribute{
+			"id": schema.StringAttribute{
+				MarkdownDescription: "The " + ItemName + " ID.",
+				Optional:            true,
+				Computed:            true,
+				CustomType:          customtypes.UUIDType{},
+			},
+			"display_name": schema.StringAttribute{
+				MarkdownDescription: "The " + ItemName + " display name.",
+				Optional:            true,
+				Computed:            true,
+			},
+			"type": schema.StringAttribute{
+				MarkdownDescription: "The " + ItemName + " type. Possible values: " + utils.ConvertStringSlicesToString(fabcore.PossibleGatewayTypeValues(), true, true),
+				Computed:            true,
+			},
+			"capacity_id": schema.StringAttribute{
+				MarkdownDescription: "The " + ItemName + " capacity ID.",
+				Computed:            true,
+				CustomType:          customtypes.UUIDType{},
+			},
+			"inactivity_minutes_before_sleep": schema.Int32Attribute{
+				MarkdownDescription: "The " + ItemName + " inactivity minutes before sleep. Possible values: " + utils.ConvertStringSlicesToString(PossibleInactivityMinutesBeforeSleepValues, true, true),
+				Computed:            true,
+			},
+			"number_of_member_gateways": schema.Int32Attribute{
+				MarkdownDescription: "The number of member gateways. Possible values: " + fmt.Sprint(MinNumberOfMemberGatewaysValues) + " to " + fmt.Sprint(MaxNumberOfMemberGatewaysValues) + ".",
+				Computed:            true,
+			},
+			"virtual_network_azure_resource": schema.SingleNestedAttribute{
+				MarkdownDescription: "The Azure virtual network resource.",
+				Computed:            true,
+				CustomType:          supertypes.NewSingleNestedObjectTypeOf[virtualNetworkAzureResourceModel](ctx),
+				Attributes: map[string]schema.Attribute{
+					"resource_group_name": schema.StringAttribute{
+						MarkdownDescription: "The resource group name.",
+						Computed:            true,
+					},
+					"subnet_name": schema.StringAttribute{
+						MarkdownDescription: "The subnet name.",
+						Computed:            true,
+					},
+					"subscription_id": schema.StringAttribute{
+						MarkdownDescription: "The subscription ID.",
+						Computed:            true,
+						CustomType:          customtypes.UUIDType{},
+					},
+					"virtual_network_name": schema.StringAttribute{
+						MarkdownDescription: "The virtual network name.",
+						Computed:            true,
+					},
+				},
+			},
+			"timeouts": timeouts.Attributes(ctx),
+		},
+	}
+}
+
+func (d *dataSourceGateway) ConfigValidators(_ context.Context) []datasource.ConfigValidator {
+	return []datasource.ConfigValidator{
+		datasourcevalidator.Conflicting(
+			path.MatchRoot("id"),
+			path.MatchRoot("display_name"),
+		),
+		datasourcevalidator.ExactlyOneOf(
+			path.MatchRoot("id"),
+			path.MatchRoot("display_name"),
+		),
+	}
+}
+
+func (d *dataSourceGateway) Configure(_ context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) {
+	if req.ProviderData == nil {
+		return
+	}
+
+	pConfigData, ok := req.ProviderData.(*pconfig.ProviderData)
+	if !ok {
+		resp.Diagnostics.AddError(
+			common.ErrorDataSourceConfigType,
+			fmt.Sprintf(common.ErrorFabricClientType, req.ProviderData),
+		)
+
+		return
+	}
+
+	d.pConfigData = pConfigData
+	d.client = fabcore.NewClientFactoryWithClient(*pConfigData.FabricClient).NewGatewaysClient()
+}
+
+func (d *dataSourceGateway) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
+	tflog.Debug(ctx, "READ", map[string]any{
+		"action": "start",
+	})
+	tflog.Trace(ctx, "READ", map[string]any{
+		"config": req.Config,
+	})
+
+	var data dataSourceGatewayModel
+
+	if resp.Diagnostics.Append(req.Config.Get(ctx, &data)...); resp.Diagnostics.HasError() {
+		return
+	}
+
+	timeout, diags := data.Timeouts.Read(ctx, d.pConfigData.Timeout)
+	if resp.Diagnostics.Append(diags...); resp.Diagnostics.HasError() {
+		return
+	}
+
+	ctx, cancel := context.WithTimeout(ctx, timeout)
+	defer cancel()
+
+	if resp.Diagnostics.Append(d.get(ctx, &data)...); resp.Diagnostics.HasError() {
+		return
+	}
+
+	resp.Diagnostics.Append(resp.State.Set(ctx, data)...)
+
+	tflog.Debug(ctx, "READ", map[string]any{
+		"action": "end",
+	})
+
+	if resp.Diagnostics.HasError() {
+		return
+	}
+}
+
+func (d *dataSourceGateway) get(ctx context.Context, model *dataSourceGatewayModel) diag.Diagnostics {
+	tflog.Trace(ctx, "GET "+ItemName+" BY ID", map[string]any{
+		"id": model.DisplayName.ValueString(),
+	})
+
+	respGet, err := d.client.GetGateway(ctx, model.ID.ValueString(), nil)
+	if diags := utils.GetDiagsFromError(ctx, err, utils.OperationRead, nil); diags.HasError() {
+		return diags
+	}
+
+	model.set(ctx, respGet.GatewayClassification)
+
+	return nil
+}