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/database/datasource.go

@@ -26,17 +26,21 @@ func NewDatabaseDataSource() datasource.DataSource {
 	return &databaseDataSource{}
 }
 
+type dataSourceModel struct {
+	sqlserverflexbetaGen.DatabaseModel
+	TfId types.String `tfsdk:"id"`
+}
+
 type databaseDataSource struct {
 	client       *sqlserverflexbetaPkg.APIClient
 	providerData core.ProviderData
 }
 
-type dsModel struct {
-	sqlserverflexbetaGen.DatabaseModel
-	TfId types.String `tfsdk:"id"`
-}
-
-func (d *databaseDataSource) Metadata(_ context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
+func (d *databaseDataSource) Metadata(
+	_ context.Context,
+	req datasource.MetadataRequest,
+	resp *datasource.MetadataResponse,
+) {
 	resp.TypeName = req.ProviderTypeName + "_sqlserverflexbeta_database"
 }
 
@@ -92,7 +96,7 @@ func (d *databaseDataSource) Configure(
 }
 
 func (d *databaseDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
-	var data dsModel
+	var data dataSourceModel
 	readErr := "Read DB error"
 
 	// Read Terraform configuration data into the model

stackit/internal/services/sqlserverflexbeta/database/planModifiers.yaml

@@ -0,0 +1,50 @@
+fields:
+  - name: 'id'
+    modifiers:
+      - 'UseStateForUnknown'
+
+  - name: 'instance_id'
+    validators:
+      - validate.NoSeparator
+      - validate.UUID
+    modifiers:
+      - 'RequiresReplace'
+
+  - name: 'project_id'
+    validators:
+      - validate.NoSeparator
+      - validate.UUID
+    modifiers:
+      - 'RequiresReplace'
+
+  - name: 'region'
+    modifiers:
+      - 'RequiresReplace'
+
+  - name: 'name'
+    modifiers:
+      - 'RequiresReplace'
+
+  - name: 'collation'
+    modifiers:
+      - 'RequiresReplace'
+
+  - name: 'owner'
+    modifiers:
+      - 'RequiresReplace'
+
+  - name: 'database_name'
+    modifiers:
+      - 'UseStateForUnknown'
+
+  - name: 'collation_name'
+    modifiers:
+      - 'UseStateForUnknown'
+
+  - name: 'compatibility'
+    modifiers:
+      - 'RequiresReplace'
+  
+  - name: 'compatibility_level'
+    modifiers:
+      - 'UseStateForUnknown'

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

@@ -2,6 +2,7 @@ package sqlserverflexbeta
 
 import (
 	"context"
+	_ "embed"
 	"fmt"
 	"strings"
 	"time"
@@ -35,6 +36,9 @@ func NewDatabaseResource() resource.Resource {
 	return &databaseResource{}
 }
 
+// resourceModel describes the resource data model.
+type resourceModel = sqlserverflexbetaResGen.DatabaseModel
+
 type databaseResource struct {
 	client       *sqlserverflexbeta.APIClient
 	providerData core.ProviderData
@@ -47,15 +51,40 @@ type DatabaseResourceIdentityModel struct {
 	DatabaseName types.String `tfsdk:"database_name"`
 }
 
-func (r *databaseResource) Metadata(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
+func (r *databaseResource) Metadata(
+	ctx context.Context,
+	req resource.MetadataRequest,
+	resp *resource.MetadataResponse,
+) {
 	resp.TypeName = req.ProviderTypeName + "_sqlserverflexbeta_database"
 }
 
+//go:embed planModifiers.yaml
+var modifiersFileByte []byte
+
 func (r *databaseResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) {
-	resp.Schema = sqlserverflexbetaResGen.DatabaseResourceSchema(ctx)
+
+	s := sqlserverflexbetaResGen.DatabaseResourceSchema(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 *databaseResource) IdentitySchema(_ context.Context, _ resource.IdentitySchemaRequest, resp *resource.IdentitySchemaResponse) {
+func (r *databaseResource) IdentitySchema(
+	_ context.Context,
+	_ resource.IdentitySchemaRequest,
+	resp *resource.IdentitySchemaResponse,
+) {
 	resp.IdentitySchema = identityschema.Schema{
 		Attributes: map[string]identityschema.Attribute{
 			"project_id": identityschema.StringAttribute{
@@ -91,7 +120,10 @@ func (r *databaseResource) 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()))
 	}
@@ -111,7 +143,7 @@ func (r *databaseResource) Configure(
 }
 
 func (r *databaseResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
-	var data sqlserverflexbetaResGen.DatabaseModel
+	var data resourceModel
 	createErr := "DB create error"
 
 	// Read Terraform plan data into the model
@@ -243,7 +275,7 @@ func (r *databaseResource) Create(ctx context.Context, req resource.CreateReques
 }
 
 func (r *databaseResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) {
-	var data sqlserverflexbetaResGen.DatabaseModel
+	var data resourceModel
 	readErr := "[Database Read]"
 
 	// Read Terraform prior state data into the model
@@ -298,7 +330,7 @@ func (r *databaseResource) Read(ctx context.Context, req resource.ReadRequest, r
 }
 
 func (r *databaseResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) {
-	var data sqlserverflexbetaResGen.DatabaseModel
+	var data resourceModel
 
 	// Read Terraform prior state data into the model
 	resp.Diagnostics.Append(req.State.Get(ctx, &data)...)
@@ -329,7 +361,7 @@ func (r *databaseResource) Update(ctx context.Context, req resource.UpdateReques
 }
 
 func (r *databaseResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse) {
-	var data sqlserverflexbetaResGen.DatabaseModel
+	var data resourceModel
 
 	// Read Terraform prior state data into the model
 	resp.Diagnostics.Append(req.State.Get(ctx, &data)...)
@@ -422,9 +454,13 @@ func (r *databaseResource) ImportState(
 		idParts := strings.Split(req.ID, core.Separator)
 
 		if len(idParts) != 4 || idParts[0] == "" || idParts[1] == "" || idParts[2] == "" || idParts[3] == "" {
-			core.LogAndAddError(ctx, &resp.Diagnostics,
+			core.LogAndAddError(
+				ctx, &resp.Diagnostics,
 				"Error importing database",
-				fmt.Sprintf("Expected import identifier with format: [project_id],[region],[instance_id],[database_name]  Got: %q", req.ID),
+				fmt.Sprintf(
+					"Expected import identifier with format: [project_id],[region],[instance_id],[database_name]  Got: %q",
+					req.ID,
+				),
 			)
 			return
 		}
@@ -449,21 +485,22 @@ func (r *databaseResource) ImportState(
 		return
 	}
 
+	// If no ID is provided, attempt to read identity attributes from the import configuration
 	var identityData DatabaseResourceIdentityModel
 	resp.Diagnostics.Append(req.Identity.Get(ctx, &identityData)...)
 	if resp.Diagnostics.HasError() {
 		return
 	}
 
-	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())...)
-	resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("database_name"), identityData.DatabaseName.ValueString())...)
+	projectId := identityData.ProjectID.ValueString()
+	region := identityData.Region.ValueString()
+	instanceId := identityData.InstanceID.ValueString()
+	databaseName := identityData.DatabaseName.ValueString()
 
-	resp.Diagnostics.Append(resp.Identity.Set(ctx, &identityData)...)
-	if resp.Diagnostics.HasError() {
-		return
-	}
+	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)...)
+	resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("database_name"), databaseName)...)
 
 	tflog.Info(ctx, "Sqlserverflexbeta database state imported")
 }