feat: Onboard IaaS Public IP range datasource (#633)

* Add "stackit_public_ip_range" datasource
  * Add docs and example

docs/data-sources/public_ip_ranges.md

@@ -0,0 +1,35 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "stackit_public_ip_ranges Data Source - stackit"
+subcategory: ""
+description: |-
+  A list of all public IP ranges that STACKIT uses.
+  ~> This resource is in beta and may be subject to breaking changes in the future. Use with caution. See our guide https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/guides/opting_into_beta_resources for how to opt-in to use beta resources.
+---
+
+# stackit_public_ip_ranges (Data Source)
+
+A list of all public IP ranges that STACKIT uses.
+
+~> This resource is in beta and may be subject to breaking changes in the future. Use with caution. See our [guide](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs/guides/opting_into_beta_resources) for how to opt-in to use beta resources.
+
+## Example Usage
+
+```terraform
+data "stackit_public_ip_ranges" "example" {}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Read-Only
+
+- `id` (String) Terraform's internal resource ID. It takes the values of "`public_ip_ranges.*.cidr`".
+- `public_ip_ranges` (Attributes List) A list of all public IP ranges. (see [below for nested schema](#nestedatt--public_ip_ranges))
+
+<a id="nestedatt--public_ip_ranges"></a>
+### Nested Schema for `public_ip_ranges`
+
+Read-Only:
+
+- `cidr` (String) Classless Inter-Domain Routing (CIDR)

examples/data-sources/stackit_public_ip_ranges/data-source.tf

@@ -0,0 +1 @@
+data "stackit_public_ip_ranges" "example" {}

stackit/internal/services/iaas/publicipranges/datasource.go

@@ -0,0 +1,230 @@
+package publicipranges
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+	"sort"
+	"strings"
+
+	"github.com/stackitcloud/stackit-sdk-go/services/iaas"
+	"github.com/stackitcloud/terraform-provider-stackit/stackit/internal/core"
+	"github.com/stackitcloud/terraform-provider-stackit/stackit/internal/features"
+	"github.com/stackitcloud/terraform-provider-stackit/stackit/internal/validate"
+
+	"github.com/hashicorp/terraform-plugin-framework-validators/listvalidator"
+	"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/schema/validator"
+	"github.com/hashicorp/terraform-plugin-framework/types"
+	"github.com/hashicorp/terraform-plugin-log/tflog"
+	"github.com/stackitcloud/stackit-sdk-go/core/config"
+	"github.com/stackitcloud/stackit-sdk-go/core/oapierror"
+)
+
+// publicIpRangesDataSourceBetaCheckDone is used to prevent multiple checks for beta resources.
+// This is a workaround for the lack of a global state in the provider and
+// needs to exist because the Configure method is called twice.
+var publicIpRangesDataSourceBetaCheckDone bool
+
+// Ensure the implementation satisfies the expected interfaces.
+var (
+	_ datasource.DataSource = &publicIpRangesDataSource{}
+)
+
+// NewPublicIpRangesDataSource is a helper function to simplify the provider implementation.
+func NewPublicIpRangesDataSource() datasource.DataSource {
+	return &publicIpRangesDataSource{}
+}
+
+// publicIpRangesDataSource is the data source implementation.
+type publicIpRangesDataSource struct {
+	client *iaas.APIClient
+}
+
+type Model struct {
+	Id             types.String `tfsdk:"id"` // needed by TF
+	PublicIpRanges types.List   `tfsdk:"public_ip_ranges"`
+}
+
+var publicIpRangesTypes = map[string]attr.Type{
+	"cidr": types.StringType,
+}
+
+// Metadata returns the data source type name.
+func (d *publicIpRangesDataSource) Metadata(_ context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
+	resp.TypeName = req.ProviderTypeName + "_public_ip_ranges"
+}
+
+func (d *publicIpRangesDataSource) Configure(ctx context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) {
+	// Prevent panic if the provider has not been configured.
+	if req.ProviderData == nil {
+		return
+	}
+
+	providerData, ok := req.ProviderData.(core.ProviderData)
+	if !ok {
+		core.LogAndAddError(ctx, &resp.Diagnostics, "Error configuring API client", fmt.Sprintf("Expected configure type stackit.ProviderData, got %T", req.ProviderData))
+		return
+	}
+
+	if !publicIpRangesDataSourceBetaCheckDone {
+		features.CheckBetaResourcesEnabled(ctx, &providerData, &resp.Diagnostics, "stackit_public_ip_ranges", "data source")
+		if resp.Diagnostics.HasError() {
+			return
+		}
+		publicIpRangesDataSourceBetaCheckDone = true
+	}
+
+	var apiClient *iaas.APIClient
+	var err error
+	if providerData.IaaSCustomEndpoint != "" {
+		apiClient, err = iaas.NewAPIClient(
+			config.WithCustomAuth(providerData.RoundTripper),
+			config.WithEndpoint(providerData.IaaSCustomEndpoint),
+		)
+	} else {
+		apiClient, err = iaas.NewAPIClient(
+			config.WithCustomAuth(providerData.RoundTripper),
+			config.WithRegion(providerData.Region),
+		)
+	}
+	if err != nil {
+		core.LogAndAddError(ctx, &resp.Diagnostics, "Error configuring API client", fmt.Sprintf("Configuring client: %v. This is an error related to the provider configuration, not to the data source configuration", err))
+		return
+	}
+
+	d.client = apiClient
+	tflog.Info(ctx, "iaas client configured")
+}
+
+// Schema defines the schema for the resource.
+func (d *publicIpRangesDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
+	description := "A list of all public IP ranges that STACKIT uses."
+
+	resp.Schema = schema.Schema{
+		MarkdownDescription: features.AddBetaDescription(description),
+		Description:         description,
+		Attributes: map[string]schema.Attribute{
+			"id": schema.StringAttribute{
+				Description: "Terraform's internal resource ID. It takes the values of \"`public_ip_ranges.*.cidr`\".",
+				Computed:    true,
+				Optional:    false,
+			},
+			"public_ip_ranges": schema.ListNestedAttribute{
+				Description: "A list of all public IP ranges.",
+				Computed:    true,
+				Optional:    false,
+				Validators: []validator.List{
+					listvalidator.ValueStringsAre(
+						validate.CIDR(),
+					),
+				},
+				NestedObject: schema.NestedAttributeObject{
+					Attributes: map[string]schema.Attribute{
+						"cidr": schema.StringAttribute{
+							Description: "Classless Inter-Domain Routing (CIDR)",
+							Computed:    true,
+						},
+					},
+				},
+			},
+		},
+	}
+}
+
+// Read refreshes the Terraform state with the latest data.
+func (d *publicIpRangesDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) { // nolint:gocritic // function signature required by Terraform
+	var model Model
+	diags := req.Config.Get(ctx, &model)
+	resp.Diagnostics.Append(diags...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+	publicIpRangeResp, err := d.client.ListPublicIpRangesExecute(ctx)
+	if err != nil {
+		oapiErr, ok := err.(*oapierror.GenericOpenAPIError) //nolint:errorlint //complaining that error.As should be used to catch wrapped errors, but this error should not be wrapped
+		if ok && oapiErr.StatusCode == http.StatusNotFound {
+			resp.State.RemoveResource(ctx)
+			return
+		}
+		core.LogAndAddError(ctx, &resp.Diagnostics, "Error reading public IP ranges", fmt.Sprintf("Calling API: %v", err))
+		return
+	}
+
+	// Map response body to schema
+	err = mapFields(ctx, publicIpRangeResp, &model)
+	if err != nil {
+		core.LogAndAddError(ctx, &resp.Diagnostics, "Error reading public IP ranges", fmt.Sprintf("Processing API payload: %v", err))
+		return
+	}
+	diags = resp.State.Set(ctx, model)
+	resp.Diagnostics.Append(diags...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+	tflog.Info(ctx, "read public IP ranges")
+}
+
+func mapFields(ctx context.Context, publicIpRangeResp *iaas.PublicNetworkListResponse, model *Model) error {
+	if publicIpRangeResp == nil {
+		return fmt.Errorf("response input is nil")
+	}
+	if model == nil {
+		return fmt.Errorf("model input is nil")
+	}
+
+	err := mapPublicIpRanges(ctx, publicIpRangeResp.Items, model)
+	if err != nil {
+		return fmt.Errorf("error mapping public IP ranges: %w", err)
+	}
+	return nil
+}
+
+// mapPublicIpRanges map the response publicIpRanges to the model
+func mapPublicIpRanges(_ context.Context, publicIpRanges *[]iaas.PublicNetwork, model *Model) error {
+	if publicIpRanges == nil {
+		return fmt.Errorf("publicIpRanges input is nil")
+	}
+	if len(*publicIpRanges) == 0 {
+		model.PublicIpRanges = types.ListNull(types.ObjectType{AttrTypes: publicIpRangesTypes})
+		return nil
+	}
+
+	var apiIpRanges []string
+	for _, ipRange := range *publicIpRanges {
+		if ipRange.Cidr != nil || *ipRange.Cidr != "" {
+			apiIpRanges = append(apiIpRanges, *ipRange.Cidr)
+		}
+	}
+
+	// Sort to prevent unnecessary recreation of dependent resources due to order changes.
+	sort.Strings(apiIpRanges)
+
+	modelId := strings.Join(apiIpRanges, ",")
+	model.Id = types.StringValue(modelId)
+
+	var ipRangesList []attr.Value
+	for _, cidr := range apiIpRanges {
+		ipRangeValues := map[string]attr.Value{
+			"cidr": types.StringValue(cidr),
+		}
+		ipRangeObject, diag := types.ObjectValue(publicIpRangesTypes, ipRangeValues)
+		if diag.HasError() {
+			return core.DiagsToError(diag)
+		}
+		ipRangesList = append(ipRangesList, ipRangeObject)
+	}
+
+	ipRangesTF, diags := types.ListValue(
+		types.ObjectType{AttrTypes: publicIpRangesTypes},
+		ipRangesList,
+	)
+	if diags.HasError() {
+		return core.DiagsToError(diags)
+	}
+
+	model.PublicIpRanges = ipRangesTF
+	return nil
+}

stackit/provider.go

@@ -24,6 +24,7 @@ import (
 	iaasNetworkInterfaceAttach "github.com/stackitcloud/terraform-provider-stackit/stackit/internal/services/iaas/networkinterfaceattach"
 	iaasPublicIp "github.com/stackitcloud/terraform-provider-stackit/stackit/internal/services/iaas/publicip"
 	iaasPublicIpAssociate "github.com/stackitcloud/terraform-provider-stackit/stackit/internal/services/iaas/publicipassociate"
+	iaasPublicIpRanges "github.com/stackitcloud/terraform-provider-stackit/stackit/internal/services/iaas/publicipranges"
 	iaasSecurityGroup "github.com/stackitcloud/terraform-provider-stackit/stackit/internal/services/iaas/securitygroup"
 	iaasSecurityGroupRule "github.com/stackitcloud/terraform-provider-stackit/stackit/internal/services/iaas/securitygrouprule"
 	iaasServer "github.com/stackitcloud/terraform-provider-stackit/stackit/internal/services/iaas/server"
@@ -422,6 +423,7 @@ func (p *Provider) DataSources(_ context.Context) []func() datasource.DataSource
 		iaasNetworkInterface.NewNetworkInterfaceDataSource,
 		iaasVolume.NewVolumeDataSource,
 		iaasPublicIp.NewPublicIpDataSource,
+		iaasPublicIpRanges.NewPublicIpRangesDataSource,
 		iaasKeyPair.NewKeyPairDataSource,
 		iaasServer.NewServerDataSource,
 		iaasSecurityGroup.NewSecurityGroupDataSource,