chore: changed and refactored providers (#36)

## Description

<!-- **Please link some issue here describing what you are trying to achieve.**

In case there is no issue present for your PR, please consider creating one.
At least please give us some description what you are trying to achieve and why your change is needed. -->

relates to #1234

## Checklist

- [ ] Issue was linked above
- [ ] Code format was applied: `make fmt`
- [ ] Examples were added / adjusted (see `examples/` directory)
- [x] Docs are up-to-date: `make generate-docs` (will be checked by CI)
- [ ] Unit tests got implemented or updated
- [ ] Acceptance tests got implemented or updated (see e.g. [here](f5f99d1709/stackit/internal/services/dns/dns_acc_test.go))
- [x] Unit tests are passing: `make test` (will be checked by CI)
- [x] No linter issues: `make lint` (will be checked by CI)

Co-authored-by: Marcel S. Henselin <marcel.henselin@stackit.cloud>
Reviewed-on: #36
Reviewed-by: Marcel_Henselin <marcel.henselin@stackit.cloud>
Co-authored-by: Andre Harms <andre.harms@stackit.cloud>
Co-committed-by: Andre Harms <andre.harms@stackit.cloud>

stackit/internal/services/sqlserverflexbeta/instance/datasource.go

@@ -6,6 +6,7 @@ import (
 	"net/http"
 
 	"github.com/hashicorp/terraform-plugin-framework/datasource"
+	"github.com/hashicorp/terraform-plugin-framework/types"
 	"github.com/hashicorp/terraform-plugin-log/tflog"
 	"github.com/stackitcloud/stackit-sdk-go/core/config"
 	"tf-provider.git.onstackit.cloud/stackit-dev-tools/terraform-provider-stackitprivatepreview/stackit/internal/conversion"
@@ -25,12 +26,22 @@ func NewInstanceDataSource() datasource.DataSource {
 	return &instanceDataSource{}
 }
 
+// dataSourceModel maps the data source schema data.
+type dataSourceModel struct {
+	sqlserverflexbetaGen.InstanceModel
+	TerraformID types.String `tfsdk:"id"`
+}
+
 type instanceDataSource struct {
 	client       *sqlserverflexbetaPkg.APIClient
 	providerData core.ProviderData
 }
 
-func (d *instanceDataSource) Metadata(_ context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
+func (d *instanceDataSource) Metadata(
+	_ context.Context,
+	req datasource.MetadataRequest,
+	resp *datasource.MetadataResponse,
+) {
 	resp.TypeName = req.ProviderTypeName + "_sqlserverflexbeta_instance"
 }
 
@@ -81,7 +92,7 @@ func (d *instanceDataSource) Configure(
 }
 
 func (d *instanceDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
-	var data sqlserverflexbetaGen.InstanceModel
+	var data dataSourceModel
 
 	// Read Terraform configuration data into the model
 	resp.Diagnostics.Append(req.Config.Get(ctx, &data)...)

stackit/internal/services/sqlserverflexbeta/instance/datasources_gen/instance_data_source_gen.go

@@ -65,7 +65,7 @@ func InstanceDataSourceSchema(ctx context.Context) schema.Schema {
 				Description:         "The id of the instance flavor.",
 				MarkdownDescription: "The id of the instance flavor.",
 			},
-			"id": schema.StringAttribute{
+			"tf_original_api_id": schema.StringAttribute{
 				Computed:            true,
 				Description:         "The ID of the instance.",
 				MarkdownDescription: "The ID of the instance.",
@@ -178,7 +178,7 @@ type InstanceModel struct {
 	Edition        types.String    `tfsdk:"edition"`
 	Encryption     EncryptionValue `tfsdk:"encryption"`
 	FlavorId       types.String    `tfsdk:"flavor_id"`
-	Id             types.String    `tfsdk:"id"`
+	Id             types.String    `tfsdk:"tf_original_api_id"`
 	InstanceId     types.String    `tfsdk:"instance_id"`
 	IsDeletable    types.Bool      `tfsdk:"is_deletable"`
 	Name           types.String    `tfsdk:"name"`

stackit/internal/services/sqlserverflexbeta/instance/functions.go

@@ -84,7 +84,7 @@ func mapResponseToModel(
 func mapDataResponseToModel(
 	ctx context.Context,
 	resp *sqlserverflexbeta.GetInstanceResponse,
-	m *sqlserverflexbetaDataGen.InstanceModel,
+	m *dataSourceModel,
 	tfDiags diag.Diagnostics,
 ) error {
 	m.BackupSchedule = types.StringValue(resp.GetBackupSchedule())
@@ -181,7 +181,7 @@ func handleEncryption(
 }
 
 func handleDSEncryption(
-	m *sqlserverflexbetaDataGen.InstanceModel,
+	m *dataSourceModel,
 	resp *sqlserverflexbeta.GetInstanceResponse,
 ) sqlserverflexbetaDataGen.EncryptionValue {
 	if !resp.HasEncryption() ||

stackit/internal/services/sqlserverflexbeta/instance/resource.go

@@ -43,21 +43,48 @@ type instanceResource struct {
 	providerData core.ProviderData
 }
 
+// resourceModel describes the resource data model.
+type resourceModel = sqlserverflexbetaResGen.InstanceModel
+
 type InstanceResourceIdentityModel struct {
 	ProjectID  types.String `tfsdk:"project_id"`
 	Region     types.String `tfsdk:"region"`
 	InstanceID types.String `tfsdk:"instance_id"`
 }
 
-func (r *instanceResource) Metadata(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
+func (r *instanceResource) Metadata(
+	ctx context.Context,
+	req resource.MetadataRequest,
+	resp *resource.MetadataResponse,
+) {
 	resp.TypeName = req.ProviderTypeName + "_sqlserverflexbeta_instance"
 }
 
+//go:embed planModifiers.yaml
+var modifiersFileByte []byte
+
 func (r *instanceResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) {
-	resp.Schema = sqlserverflexbetaResGen.InstanceResourceSchema(ctx)
+	s := sqlserverflexbetaResGen.InstanceResourceSchema(ctx)
+
+	fields, err := utils.ReadModifiersConfig(modifiersFileByte)
+	if err != nil {
+		resp.Diagnostics.AddError("error during read modifiers config file", err.Error())
+		return
+	}
+
+	err = utils.AddPlanModifiersToResourceSchema(fields, &s)
+	if err != nil {
+		resp.Diagnostics.AddError("error adding plan modifiers", err.Error())
+		return
+	}
+	resp.Schema = s
 }
 
-func (r *instanceResource) IdentitySchema(_ context.Context, _ resource.IdentitySchemaRequest, resp *resource.IdentitySchemaResponse) {
+func (r *instanceResource) IdentitySchema(
+	_ context.Context,
+	_ resource.IdentitySchemaRequest,
+	resp *resource.IdentitySchemaResponse,
+) {
 	resp.IdentitySchema = identityschema.Schema{
 		Attributes: map[string]identityschema.Attribute{
 			"project_id": identityschema.StringAttribute{
@@ -90,7 +117,10 @@ func (r *instanceResource) Configure(
 		utils.UserAgentConfigOption(r.providerData.Version),
 	}
 	if r.providerData.SQLServerFlexCustomEndpoint != "" {
-		apiClientConfigOptions = append(apiClientConfigOptions, config.WithEndpoint(r.providerData.SQLServerFlexCustomEndpoint))
+		apiClientConfigOptions = append(
+			apiClientConfigOptions,
+			config.WithEndpoint(r.providerData.SQLServerFlexCustomEndpoint),
+		)
 	} else {
 		apiClientConfigOptions = append(apiClientConfigOptions, config.WithRegion(r.providerData.GetRegion()))
 	}
@@ -121,7 +151,7 @@ func (r *instanceResource) ModifyPlan(
 	if req.Config.Raw.IsNull() {
 		return
 	}
-	var configModel sqlserverflexbetaResGen.InstanceModel
+	var configModel resourceModel
 	resp.Diagnostics.Append(req.Config.Get(ctx, &configModel)...)
 	if resp.Diagnostics.HasError() {
 		return
@@ -147,11 +177,8 @@ func (r *instanceResource) ModifyPlan(
 	}
 }
 
-//go:embed planModifiers.yaml
-var modifiersFileByte []byte
-
 func (r *instanceResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
-	var data sqlserverflexbetaResGen.InstanceModel
+	var data resourceModel
 	crateErr := "[SQL Server Flex BETA - Create] error"
 
 	// Read Terraform plan data into the model
@@ -257,7 +284,7 @@ func (r *instanceResource) Create(ctx context.Context, req resource.CreateReques
 }
 
 func (r *instanceResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) {
-	var data sqlserverflexbetaResGen.InstanceModel
+	var data resourceModel
 
 	// Read Terraform prior state data into the model
 	resp.Diagnostics.Append(req.State.Get(ctx, &data)...)
@@ -324,7 +351,7 @@ func (r *instanceResource) Read(ctx context.Context, req resource.ReadRequest, r
 }
 
 func (r *instanceResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) {
-	var data sqlserverflexbetaResGen.InstanceModel
+	var data resourceModel
 	updateInstanceError := "Error updating instance"
 
 	resp.Diagnostics.Append(req.Plan.Get(ctx, &data)...)
@@ -411,7 +438,7 @@ func (r *instanceResource) Update(ctx context.Context, req resource.UpdateReques
 }
 
 func (r *instanceResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse) {
-	var data sqlserverflexbetaResGen.InstanceModel
+	var data resourceModel
 
 	// Read Terraform prior state data into the model
 	resp.Diagnostics.Append(req.State.Get(ctx, &data)...)
@@ -484,9 +511,13 @@ func (r *instanceResource) ImportState(
 		idParts := strings.Split(req.ID, core.Separator)
 
 		if len(idParts) != 3 || idParts[0] == "" || idParts[1] == "" || idParts[2] == "" {
-			core.LogAndAddError(ctx, &resp.Diagnostics,
+			core.LogAndAddError(
+				ctx, &resp.Diagnostics,
 				"Error importing instance",
-				fmt.Sprintf("Expected import identifier with format: [project_id],[region],[instance_id]  Got: %q", req.ID),
+				fmt.Sprintf(
+					"Expected import identifier with format: [project_id],[region],[instance_id]  Got: %q",
+					req.ID,
+				),
 			)
 			return
 		}
@@ -497,25 +528,20 @@ func (r *instanceResource) ImportState(
 		return
 	}
 
+	// If no ID is provided, attempt to read identity attributes from the import configuration
 	var identityData InstanceResourceIdentityModel
 	resp.Diagnostics.Append(req.Identity.Get(ctx, &identityData)...)
 	if resp.Diagnostics.HasError() {
 		return
 	}
 
-	resp.Diagnostics.Append(
-		resp.State.SetAttribute(
-			ctx,
-			path.Root("id"),
-			utils.BuildInternalTerraformId(
-				identityData.ProjectID.ValueString(),
-				identityData.Region.ValueString(),
-				identityData.InstanceID.ValueString(),
-			),
-		)...)
-	resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("project_id"), identityData.ProjectID.ValueString())...)
-	resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("region"), identityData.Region.ValueString())...)
-	resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("instance_id"), identityData.InstanceID.ValueString())...)
+	projectId := identityData.ProjectID.ValueString()
+	region := identityData.Region.ValueString()
+	instanceId := identityData.InstanceID.ValueString()
+
+	resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("project_id"), projectId)...)
+	resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("region"), region)...)
+	resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("instance_id"), instanceId)...)
 
 	tflog.Info(ctx, "Sqlserverflexbeta instance state imported")
 }

stackit/internal/services/sqlserverflexbeta/instance/resource_test.go

@@ -13,6 +13,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-testing/helper/acctest"
 	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
 	"github.com/hashicorp/terraform-plugin-testing/knownvalue"
+	"github.com/hashicorp/terraform-plugin-testing/plancheck"
 	"github.com/hashicorp/terraform-plugin-testing/statecheck"
 	"github.com/hashicorp/terraform-plugin-testing/terraform"
 	"github.com/hashicorp/terraform-plugin-testing/tfjsonpath"
@@ -160,6 +161,12 @@ func TestAccResourceExample_basic(t *testing.T) {
 			// test create
 			{
 				Config: exBefore,
+				ConfigPlanChecks: resource.ConfigPlanChecks{
+					PreApply: []plancheck.PlanCheck{
+						plancheck.ExpectResourceAction(resName, plancheck.ResourceActionCreate),
+						plancheck.ExpectNonEmptyPlan(),
+					},
+				},
 				ConfigStateChecks: []statecheck.StateCheck{
 					compareValuesSame.AddStateValue(
 						resName,