Initial commit

This commit is contained in:
vicentepinto98 2023-09-07 11:34:45 +01:00
commit e4c8a6fbf4
186 changed files with 29501 additions and 0 deletions

View file

@ -0,0 +1,198 @@
package postgresql
import (
"context"
"fmt"
"github.com/hashicorp/terraform-plugin-framework/datasource"
"github.com/hashicorp/terraform-plugin-framework/schema/validator"
"github.com/hashicorp/terraform-plugin-log/tflog"
"github.com/stackitcloud/terraform-provider-stackit/stackit/core"
"github.com/stackitcloud/terraform-provider-stackit/stackit/validate"
"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
"github.com/hashicorp/terraform-plugin-framework/types"
"github.com/stackitcloud/stackit-sdk-go/core/config"
"github.com/stackitcloud/stackit-sdk-go/services/postgresql"
)
// Ensure the implementation satisfies the expected interfaces.
var (
_ datasource.DataSource = &instanceDataSource{}
)
// NewInstanceDataSource is a helper function to simplify the provider implementation.
func NewInstanceDataSource() datasource.DataSource {
return &instanceDataSource{}
}
// instanceDataSource is the data source implementation.
type instanceDataSource struct {
client *postgresql.APIClient
}
// Metadata returns the resource type name.
func (r *instanceDataSource) Metadata(_ context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
resp.TypeName = req.ProviderTypeName + "_postgresql_instance"
}
// Configure adds the provider configured client to the resource.
func (r *instanceDataSource) 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 {
resp.Diagnostics.AddError("Unexpected Data Source Configure Type", fmt.Sprintf("Expected stackit.ProviderData, got %T. Please report this issue to the provider developers.", req.ProviderData))
return
}
var apiClient *postgresql.APIClient
var err error
if providerData.PostgreSQLCustomEndpoint != "" {
apiClient, err = postgresql.NewAPIClient(
config.WithCustomAuth(providerData.RoundTripper),
config.WithEndpoint(providerData.PostgreSQLCustomEndpoint),
)
} else {
apiClient, err = postgresql.NewAPIClient(
config.WithCustomAuth(providerData.RoundTripper),
config.WithRegion(providerData.Region),
)
}
if err != nil {
resp.Diagnostics.AddError("Could not Configure API Client", err.Error())
return
}
tflog.Info(ctx, "Postgresql zone client configured")
r.client = apiClient
}
// Schema defines the schema for the resource.
func (r *instanceDataSource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
descriptions := map[string]string{
"main": "PostgreSQL instance data source schema.",
"id": "Terraform's internal resource identifier.",
"instance_id": "ID of the PostgreSQL instance.",
"project_id": "STACKIT Project ID to which the instance is associated.",
"name": "Instance name.",
"version": "The service version.",
"plan_name": "The selected plan name.",
"plan_id": "The selected plan ID.",
}
resp.Schema = schema.Schema{
Description: descriptions["main"],
Attributes: map[string]schema.Attribute{
"id": schema.StringAttribute{
Description: descriptions["id"],
Computed: true,
},
"instance_id": schema.StringAttribute{
Description: descriptions["instance_id"],
Required: true,
Validators: []validator.String{
validate.UUID(),
validate.NoSeparator(),
},
},
"project_id": schema.StringAttribute{
Description: descriptions["project_id"],
Required: true,
Validators: []validator.String{
validate.UUID(),
validate.NoSeparator(),
},
},
"name": schema.StringAttribute{
Description: descriptions["name"],
Computed: true,
},
"version": schema.StringAttribute{
Description: descriptions["version"],
Computed: true,
},
"plan_name": schema.StringAttribute{
Description: descriptions["plan_name"],
Computed: true,
},
"plan_id": schema.StringAttribute{
Description: descriptions["plan_id"],
Computed: true,
},
"parameters": schema.SingleNestedAttribute{
Attributes: map[string]schema.Attribute{
"enable_monitoring": schema.BoolAttribute{
Computed: true,
},
"metrics_frequency": schema.Int64Attribute{
Computed: true,
},
"metrics_prefix": schema.StringAttribute{
Computed: true,
},
"monitoring_instance_id": schema.StringAttribute{
Computed: true,
},
"plugins": schema.ListAttribute{
ElementType: types.StringType,
Computed: true,
},
"sgw_acl": schema.StringAttribute{
Computed: true,
},
},
Computed: true,
},
"cf_guid": schema.StringAttribute{
Computed: true,
},
"cf_space_guid": schema.StringAttribute{
Computed: true,
},
"dashboard_url": schema.StringAttribute{
Computed: true,
},
"image_url": schema.StringAttribute{
Computed: true,
},
"organization_guid": schema.StringAttribute{
Computed: true,
},
},
}
}
// Read refreshes the Terraform state with the latest data.
func (r *instanceDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) { // nolint:gocritic // function signature required by Terraform
var state Model
diags := req.Config.Get(ctx, &state)
resp.Diagnostics.Append(diags...)
if resp.Diagnostics.HasError() {
return
}
projectId := state.ProjectId.ValueString()
instanceId := state.InstanceId.ValueString()
ctx = tflog.SetField(ctx, "project_id", projectId)
ctx = tflog.SetField(ctx, "instance_id", instanceId)
instanceResp, err := r.client.GetInstance(ctx, projectId, instanceId).Execute()
if err != nil {
core.LogAndAddError(ctx, &resp.Diagnostics, "Unable to read instance", err.Error())
return
}
err = mapFields(instanceResp, &state)
if err != nil {
core.LogAndAddError(ctx, &resp.Diagnostics, "Mapping fields", err.Error())
return
}
// Set refreshed state
diags = resp.State.Set(ctx, &state)
resp.Diagnostics.Append(diags...)
tflog.Info(ctx, "Postgresql instance read")
}

View file

@ -0,0 +1,704 @@
package postgresql
import (
"context"
"fmt"
"strings"
"time"
"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
"github.com/hashicorp/terraform-plugin-framework/attr"
"github.com/hashicorp/terraform-plugin-framework/diag"
"github.com/hashicorp/terraform-plugin-framework/path"
"github.com/hashicorp/terraform-plugin-framework/resource"
"github.com/hashicorp/terraform-plugin-framework/resource/schema"
"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier"
"github.com/hashicorp/terraform-plugin-framework/schema/validator"
"github.com/hashicorp/terraform-plugin-framework/types"
"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
"github.com/hashicorp/terraform-plugin-log/tflog"
"github.com/stackitcloud/stackit-sdk-go/core/config"
"github.com/stackitcloud/stackit-sdk-go/services/postgresql"
"github.com/stackitcloud/terraform-provider-stackit/stackit/conversion"
"github.com/stackitcloud/terraform-provider-stackit/stackit/core"
"github.com/stackitcloud/terraform-provider-stackit/stackit/validate"
)
// Ensure the implementation satisfies the expected interfaces.
var (
_ resource.Resource = &instanceResource{}
_ resource.ResourceWithConfigure = &instanceResource{}
_ resource.ResourceWithImportState = &instanceResource{}
)
type Model struct {
Id types.String `tfsdk:"id"` // needed by TF
InstanceId types.String `tfsdk:"instance_id"`
ProjectId types.String `tfsdk:"project_id"`
CfGuid types.String `tfsdk:"cf_guid"`
CfSpaceGuid types.String `tfsdk:"cf_space_guid"`
DashboardUrl types.String `tfsdk:"dashboard_url"`
ImageUrl types.String `tfsdk:"image_url"`
Name types.String `tfsdk:"name"`
OrganizationGuid types.String `tfsdk:"organization_guid"`
Parameters types.Object `tfsdk:"parameters"`
Version types.String `tfsdk:"version"`
PlanName types.String `tfsdk:"plan_name"`
PlanId types.String `tfsdk:"plan_id"`
}
// Struct corresponding to DataSourceModel.Parameters
type parametersModel struct {
EnableMonitoring types.Bool `tfsdk:"enable_monitoring"`
MetricsFrequency types.Int64 `tfsdk:"metrics_frequency"`
MetricsPrefix types.String `tfsdk:"metrics_prefix"`
MonitoringInstanceId types.String `tfsdk:"monitoring_instance_id"`
Plugins types.List `tfsdk:"plugins"`
SgwAcl types.String `tfsdk:"sgw_acl"`
}
// Types corresponding to parametersModel
var parametersTypes = map[string]attr.Type{
"enable_monitoring": basetypes.BoolType{},
"metrics_frequency": basetypes.Int64Type{},
"metrics_prefix": basetypes.StringType{},
"monitoring_instance_id": basetypes.StringType{},
"plugins": basetypes.ListType{ElemType: types.StringType},
"sgw_acl": basetypes.StringType{},
}
// NewInstanceResource is a helper function to simplify the provider implementation.
func NewInstanceResource() resource.Resource {
return &instanceResource{}
}
// instanceResource is the resource implementation.
type instanceResource struct {
client *postgresql.APIClient
}
// Metadata returns the resource type name.
func (r *instanceResource) Metadata(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
resp.TypeName = req.ProviderTypeName + "_postgresql_instance"
}
// Configure adds the provider configured client to the resource.
func (r *instanceResource) Configure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse) {
// Prevent panic if the provider has not been configured.
if req.ProviderData == nil {
return
}
providerData, ok := req.ProviderData.(core.ProviderData)
if !ok {
resp.Diagnostics.AddError("Unexpected Resource Configure Type", fmt.Sprintf("Expected stackit.ProviderData, got %T. Please report this issue to the provider developers.", req.ProviderData))
return
}
var apiClient *postgresql.APIClient
var err error
if providerData.PostgreSQLCustomEndpoint != "" {
apiClient, err = postgresql.NewAPIClient(
config.WithCustomAuth(providerData.RoundTripper),
config.WithEndpoint(providerData.PostgreSQLCustomEndpoint),
)
} else {
apiClient, err = postgresql.NewAPIClient(
config.WithCustomAuth(providerData.RoundTripper),
config.WithRegion(providerData.Region),
)
}
if err != nil {
resp.Diagnostics.AddError("Could not Configure API Client", err.Error())
return
}
tflog.Info(ctx, "Postgresql zone client configured")
r.client = apiClient
}
// Schema defines the schema for the resource.
func (r *instanceResource) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
descriptions := map[string]string{
"main": "PostgreSQL instance resource schema.",
"id": "Terraform's internal resource ID.",
"instance_id": "ID of the PostgreSQL instance.",
"project_id": "STACKIT project ID to which the instance is associated.",
"name": "Instance name.",
"version": "The service version.",
"plan_name": "The selected plan name.",
"plan_id": "The selected plan ID.",
}
resp.Schema = schema.Schema{
Description: descriptions["main"],
Attributes: map[string]schema.Attribute{
"id": schema.StringAttribute{
Description: descriptions["id"],
Computed: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.UseStateForUnknown(),
},
},
"instance_id": schema.StringAttribute{
Description: descriptions["instance_id"],
Computed: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.UseStateForUnknown(),
},
Validators: []validator.String{
validate.UUID(),
validate.NoSeparator(),
},
},
"project_id": schema.StringAttribute{
Description: descriptions["project_id"],
Required: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.RequiresReplace(),
stringplanmodifier.UseStateForUnknown(),
},
Validators: []validator.String{
validate.UUID(),
validate.NoSeparator(),
},
},
"name": schema.StringAttribute{
Description: descriptions["name"],
Required: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.RequiresReplace(),
stringplanmodifier.UseStateForUnknown(),
},
Validators: []validator.String{
stringvalidator.LengthAtLeast(1),
},
},
"version": schema.StringAttribute{
Description: descriptions["version"],
Required: true,
},
"plan_name": schema.StringAttribute{
Description: descriptions["plan_name"],
Required: true,
},
"plan_id": schema.StringAttribute{
Description: descriptions["plan_id"],
Computed: true,
},
"parameters": schema.SingleNestedAttribute{
Attributes: map[string]schema.Attribute{
"enable_monitoring": schema.BoolAttribute{
Optional: true,
},
"metrics_frequency": schema.Int64Attribute{
Optional: true,
},
"metrics_prefix": schema.StringAttribute{
Optional: true,
},
"monitoring_instance_id": schema.StringAttribute{
Optional: true,
},
"plugins": schema.ListAttribute{
ElementType: types.StringType,
Optional: true,
},
"sgw_acl": schema.StringAttribute{
Optional: true,
Computed: true,
},
},
Optional: true,
Computed: true,
},
"cf_guid": schema.StringAttribute{
Computed: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.UseStateForUnknown(),
},
},
"cf_space_guid": schema.StringAttribute{
Computed: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.UseStateForUnknown(),
},
},
"dashboard_url": schema.StringAttribute{
Computed: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.UseStateForUnknown(),
},
},
"image_url": schema.StringAttribute{
Computed: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.UseStateForUnknown(),
},
},
"organization_guid": schema.StringAttribute{
Computed: true,
PlanModifiers: []planmodifier.String{
stringplanmodifier.UseStateForUnknown(),
},
},
},
}
}
// Create creates the resource and sets the initial Terraform state.
func (r *instanceResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) { // nolint:gocritic // function signature required by Terraform
// Retrieve values from plan
var model Model
diags := req.Plan.Get(ctx, &model)
resp.Diagnostics.Append(diags...)
if resp.Diagnostics.HasError() {
return
}
projectId := model.ProjectId.ValueString()
ctx = tflog.SetField(ctx, "project_id", projectId)
r.loadPlanId(ctx, &resp.Diagnostics, &model)
if diags.HasError() {
core.LogAndAddError(ctx, &diags, "Failed to load PostgreSQL service plan", "plan "+model.PlanName.ValueString())
return
}
var parameters = &parametersModel{}
var parametersPlugins *[]string
if !(model.Parameters.IsNull() || model.Parameters.IsUnknown()) {
diags = model.Parameters.As(ctx, parameters, basetypes.ObjectAsOptions{})
resp.Diagnostics.Append(diags...)
if resp.Diagnostics.HasError() {
return
}
if !(parameters.Plugins.IsNull() || parameters.Plugins.IsUnknown()) {
var pp []types.String
var res []string
diags = parameters.Plugins.ElementsAs(ctx, &pp, false)
resp.Diagnostics.Append(diags...)
for _, v := range pp {
res = append(res, v.ValueString())
}
parametersPlugins = &res
}
if resp.Diagnostics.HasError() {
return
}
}
// Generate API request body from model
payload, err := toCreatePayload(&model, parameters, parametersPlugins)
if err != nil {
core.LogAndAddError(ctx, &resp.Diagnostics, "Error creating instance", fmt.Sprintf("Creating API payload: %v", err))
return
}
// Create new instance
createResp, err := r.client.CreateInstance(ctx, projectId).CreateInstancePayload(*payload).Execute()
if err != nil {
core.LogAndAddError(ctx, &resp.Diagnostics, "Error creating instance", fmt.Sprintf("Calling API: %v", err))
return
}
instanceId := *createResp.InstanceId
ctx = tflog.SetField(ctx, "instance_id", instanceId)
wr, err := postgresql.CreateInstanceWaitHandler(ctx, r.client, projectId, instanceId).SetTimeout(15 * time.Minute).WaitWithContext(ctx)
if err != nil {
core.LogAndAddError(ctx, &resp.Diagnostics, "Error creating instance", fmt.Sprintf("Instance creation waiting: %v", err))
return
}
got, ok := wr.(*postgresql.Instance)
if !ok {
core.LogAndAddError(ctx, &resp.Diagnostics, "Error creating instance", fmt.Sprintf("Wait result conversion, got %+v", got))
return
}
// Map response body to schema and populate Computed attribute values
err = mapFields(got, &model)
if err != nil {
core.LogAndAddError(ctx, &resp.Diagnostics, "Error mapping fields", err.Error())
return
}
// Set state to fully populated data
diags = resp.State.Set(ctx, model)
resp.Diagnostics.Append(diags...)
tflog.Info(ctx, "Postgresql instance created")
}
func toCreatePayload(model *Model, parameters *parametersModel, parametersPlugins *[]string) (*postgresql.CreateInstancePayload, error) {
if model == nil {
return nil, fmt.Errorf("nil model")
}
if parameters == nil {
return &postgresql.CreateInstancePayload{
InstanceName: model.Name.ValueStringPointer(),
PlanId: model.PlanId.ValueStringPointer(),
}, nil
}
return &postgresql.CreateInstancePayload{
InstanceName: model.Name.ValueStringPointer(),
Parameters: &postgresql.InstanceParameters{
EnableMonitoring: parameters.EnableMonitoring.ValueBoolPointer(),
MetricsFrequency: conversion.ToPtrInt32(parameters.MetricsFrequency),
MetricsPrefix: parameters.MetricsPrefix.ValueStringPointer(),
MonitoringInstanceId: parameters.MonitoringInstanceId.ValueStringPointer(),
Plugins: parametersPlugins,
SgwAcl: parameters.SgwAcl.ValueStringPointer(),
},
PlanId: model.PlanId.ValueStringPointer(),
}, nil
}
// Read refreshes the Terraform state with the latest data.
func (r *instanceResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) { // nolint:gocritic // function signature required by Terraform
var state Model
diags := req.State.Get(ctx, &state)
resp.Diagnostics.Append(diags...)
if resp.Diagnostics.HasError() {
return
}
projectId := state.ProjectId.ValueString()
instanceId := state.InstanceId.ValueString()
ctx = tflog.SetField(ctx, "project_id", projectId)
ctx = tflog.SetField(ctx, "instance_id", instanceId)
instanceResp, err := r.client.GetInstance(ctx, projectId, instanceId).Execute()
if err != nil {
core.LogAndAddError(ctx, &resp.Diagnostics, "Error reading instances", err.Error())
return
}
// Map response body to schema and populate Computed attribute values
err = mapFields(instanceResp, &state)
if err != nil {
core.LogAndAddError(ctx, &resp.Diagnostics, "Error mapping fields", err.Error())
return
}
// Set refreshed state
diags = resp.State.Set(ctx, state)
resp.Diagnostics.Append(diags...)
tflog.Info(ctx, "Postgresql instance read")
}
// Update updates the resource and sets the updated Terraform state on success.
func (r *instanceResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) { // nolint:gocritic // function signature required by Terraform
var model Model
diags := req.Plan.Get(ctx, &model)
resp.Diagnostics.Append(diags...)
if resp.Diagnostics.HasError() {
return
}
projectId := model.ProjectId.ValueString()
instanceId := model.InstanceId.ValueString()
ctx = tflog.SetField(ctx, "project_id", projectId)
ctx = tflog.SetField(ctx, "instance_id", instanceId)
r.loadPlanId(ctx, &resp.Diagnostics, &model)
if diags.HasError() {
core.LogAndAddError(ctx, &diags, "Failed to load PostgreSQL service plan", "plan "+model.PlanName.ValueString())
return
}
var parameters = &parametersModel{}
var parametersPlugins *[]string
if !(model.Parameters.IsNull() || model.Parameters.IsUnknown()) {
diags = model.Parameters.As(ctx, parameters, basetypes.ObjectAsOptions{})
resp.Diagnostics.Append(diags...)
if resp.Diagnostics.HasError() {
return
}
if !(parameters.Plugins.IsNull() || parameters.Plugins.IsUnknown()) {
var pp []types.String
var res []string
diags = parameters.Plugins.ElementsAs(ctx, &pp, false)
resp.Diagnostics.Append(diags...)
for _, v := range pp {
res = append(res, v.ValueString())
}
parametersPlugins = &res
}
}
// Generate API request body from model
payload, err := toUpdatePayload(&model, parameters, parametersPlugins)
if err != nil {
core.LogAndAddError(ctx, &resp.Diagnostics, "Error updating instance", fmt.Sprintf("Could not create API payload: %v", err))
return
}
// Update existing instance
err = r.client.UpdateInstance(ctx, projectId, instanceId).UpdateInstancePayload(*payload).Execute()
if err != nil {
core.LogAndAddError(ctx, &resp.Diagnostics, "Error updating instance", err.Error())
return
}
wr, err := postgresql.UpdateInstanceWaitHandler(ctx, r.client, projectId, instanceId).SetTimeout(15 * time.Minute).WaitWithContext(ctx)
if err != nil {
core.LogAndAddError(ctx, &resp.Diagnostics, "Error updating instance", fmt.Sprintf("Instance update waiting: %v", err))
return
}
got, ok := wr.(*postgresql.Instance)
if !ok {
core.LogAndAddError(ctx, &resp.Diagnostics, "Error updating instance", fmt.Sprintf("Wait result conversion, got %+v", got))
return
}
// Map response body to schema and populate Computed attribute values
err = mapFields(got, &model)
if err != nil {
core.LogAndAddError(ctx, &resp.Diagnostics, "Error mapping fields in update", err.Error())
return
}
diags = resp.State.Set(ctx, model)
resp.Diagnostics.Append(diags...)
tflog.Info(ctx, "Postgresql instance updated")
}
func toUpdatePayload(model *Model, parameters *parametersModel, parametersPlugins *[]string) (*postgresql.UpdateInstancePayload, error) {
if model == nil {
return nil, fmt.Errorf("nil model")
}
if parameters == nil {
return &postgresql.UpdateInstancePayload{
PlanId: model.PlanId.ValueStringPointer(),
}, nil
}
return &postgresql.UpdateInstancePayload{
Parameters: &postgresql.InstanceParameters{
EnableMonitoring: parameters.EnableMonitoring.ValueBoolPointer(),
MetricsFrequency: conversion.ToPtrInt32(parameters.MetricsFrequency),
MetricsPrefix: parameters.MetricsPrefix.ValueStringPointer(),
MonitoringInstanceId: parameters.MonitoringInstanceId.ValueStringPointer(),
Plugins: parametersPlugins,
SgwAcl: parameters.SgwAcl.ValueStringPointer(),
},
PlanId: model.PlanId.ValueStringPointer(),
}, nil
}
// Delete deletes the resource and removes the Terraform state on success.
func (r *instanceResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse) { // nolint:gocritic // function signature required by Terraform
// Retrieve values from state
var model Model
diags := req.State.Get(ctx, &model)
resp.Diagnostics.Append(diags...)
if resp.Diagnostics.HasError() {
return
}
projectId := model.ProjectId.ValueString()
instanceId := model.InstanceId.ValueString()
ctx = tflog.SetField(ctx, "project_id", projectId)
ctx = tflog.SetField(ctx, "instance_id", instanceId)
// Delete existing instance
err := r.client.DeleteInstance(ctx, projectId, instanceId).Execute()
if err != nil {
core.LogAndAddError(ctx, &resp.Diagnostics, "Error deleting instance", err.Error())
return
}
_, err = postgresql.DeleteInstanceWaitHandler(ctx, r.client, projectId, instanceId).SetTimeout(15 * time.Minute).WaitWithContext(ctx)
if err != nil {
core.LogAndAddError(ctx, &resp.Diagnostics, "Error deleting instance", fmt.Sprintf("Instance deletion waiting: %v", err))
return
}
tflog.Info(ctx, "Postgresql instance deleted")
}
// ImportState imports a resource into the Terraform state on success.
// The expected format of the resource import identifier is: project_id,instance_id
func (r *instanceResource) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse) {
idParts := strings.Split(req.ID, core.Separator)
if len(idParts) != 2 || idParts[0] == "" || idParts[1] == "" {
resp.Diagnostics.AddError(
"Unexpected Import Identifier",
fmt.Sprintf("Expected import identifier with format: [project_id],[instance_id] Got: %q", req.ID),
)
return
}
resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("project_id"), idParts[0])...)
resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("instance_id"), idParts[1])...)
tflog.Info(ctx, "Postgresql instance state imported")
}
func mapFields(instance *postgresql.Instance, model *Model) error {
if instance == nil {
return fmt.Errorf("response input is nil")
}
if model == nil {
return fmt.Errorf("model input is nil")
}
var instanceId string
if model.InstanceId.ValueString() != "" {
instanceId = model.InstanceId.ValueString()
} else if instance.InstanceId != nil {
instanceId = *instance.InstanceId
} else {
return fmt.Errorf("instance id not present")
}
idParts := []string{
model.ProjectId.ValueString(),
instanceId,
}
model.Id = types.StringValue(
strings.Join(idParts, core.Separator),
)
model.InstanceId = types.StringValue(instanceId)
model.PlanId = types.StringPointerValue(instance.PlanId)
model.CfGuid = types.StringPointerValue(instance.CfGuid)
model.CfSpaceGuid = types.StringPointerValue(instance.CfSpaceGuid)
model.DashboardUrl = types.StringPointerValue(instance.DashboardUrl)
model.ImageUrl = types.StringPointerValue(instance.ImageUrl)
model.Name = types.StringPointerValue(instance.Name)
model.OrganizationGuid = types.StringPointerValue(instance.OrganizationGuid)
if instance.Parameters == nil {
model.Parameters = types.ObjectNull(parametersTypes)
} else {
parameters, err := mapParameters(*instance.Parameters)
if err != nil {
return fmt.Errorf("mapping parameters: %w", err)
}
model.Parameters = parameters
}
return nil
}
func mapParameters(params map[string]interface{}) (types.Object, error) {
attributes := map[string]attr.Value{}
for attribute := range parametersTypes {
valueInterface, ok := params[attribute]
if !ok {
// All fields are optional, so this is ok
// Set the value as nil, will be handled accordingly
valueInterface = nil
}
var value attr.Value
switch parametersTypes[attribute].(type) {
default:
return types.ObjectNull(parametersTypes), fmt.Errorf("found unexpected attribute type '%T'", parametersTypes[attribute])
case basetypes.StringType:
if valueInterface == nil {
value = types.StringNull()
} else {
valueString, ok := valueInterface.(string)
if !ok {
return types.ObjectNull(parametersTypes), fmt.Errorf("found attribute '%s' of type %T, failed to assert as string", attribute, valueInterface)
}
value = types.StringValue(valueString)
}
case basetypes.BoolType:
if valueInterface == nil {
value = types.BoolNull()
} else {
valueBool, ok := valueInterface.(bool)
if !ok {
return types.ObjectNull(parametersTypes), fmt.Errorf("found attribute '%s' of type %T, failed to assert as bool", attribute, valueInterface)
}
value = types.BoolValue(valueBool)
}
case basetypes.Int64Type:
if valueInterface == nil {
value = types.Int64Null()
} else {
// This may be int64, int32, int or float64
// We try to assert all 4
var valueInt64 int64
switch temp := valueInterface.(type) {
default:
return types.ObjectNull(parametersTypes), fmt.Errorf("found attribute '%s' of type %T, failed to assert as int", attribute, valueInterface)
case int64:
valueInt64 = temp
case int32:
valueInt64 = int64(temp)
case int:
valueInt64 = int64(temp)
case float64:
valueInt64 = int64(temp)
}
value = types.Int64Value(valueInt64)
}
case basetypes.ListType: // Assumed to be a list of strings
if valueInterface == nil {
value = types.ListNull(types.StringType)
} else {
// This may be []string{} or []interface{}
// We try to assert all 2
var valueList []attr.Value
switch temp := valueInterface.(type) {
default:
return types.ObjectNull(parametersTypes), fmt.Errorf("found attribute '%s' of type %T, failed to assert as array of interface", attribute, valueInterface)
case []string:
for _, x := range temp {
valueList = append(valueList, types.StringValue(x))
}
case []interface{}:
for _, x := range temp {
xString, ok := x.(string)
if !ok {
return types.ObjectNull(parametersTypes), fmt.Errorf("found attribute '%s' with element '%s' of type %T, failed to assert as string", attribute, x, x)
}
valueList = append(valueList, types.StringValue(xString))
}
}
temp2, diags := types.ListValue(types.StringType, valueList)
if diags.HasError() {
return types.ObjectNull(parametersTypes), fmt.Errorf("failed to map %s: %w", attribute, core.DiagsToError(diags))
}
value = temp2
}
}
attributes[attribute] = value
}
output, diags := types.ObjectValue(parametersTypes, attributes)
if diags.HasError() {
return types.ObjectNull(parametersTypes), fmt.Errorf("failed to create object: %w", core.DiagsToError(diags))
}
return output, nil
}
func (r *instanceResource) loadPlanId(ctx context.Context, diags *diag.Diagnostics, model *Model) {
projectId := model.ProjectId.ValueString()
res, err := r.client.GetOfferings(ctx, projectId).Execute()
if err != nil {
diags.AddError("Failed to list PostgreSQL offerings", err.Error())
return
}
version := model.Version.ValueString()
planName := model.PlanName.ValueString()
availableVersions := ""
availablePlanNames := ""
isValidVersion := false
for _, offer := range *res.Offerings {
if !strings.EqualFold(*offer.Version, version) {
availableVersions = fmt.Sprintf("%s\n- %s", availableVersions, *offer.Version)
continue
}
isValidVersion = true
for _, plan := range *offer.Plans {
if plan.Name == nil {
continue
}
if strings.EqualFold(*plan.Name, planName) && plan.Id != nil {
model.PlanId = types.StringPointerValue(plan.Id)
return
}
availablePlanNames = fmt.Sprintf("%s\n- %s", availablePlanNames, *plan.Name)
}
}
if !isValidVersion {
diags.AddError("Invalid version", fmt.Sprintf("Couldn't find version '%s', available versions are:%s", version, availableVersions))
return
}
diags.AddError("Invalid plan_name", fmt.Sprintf("Couldn't find plan_name '%s' for version %s, available names are:%s", planName, version, availablePlanNames))
}

View file

@ -0,0 +1,435 @@
package postgresql
import (
"testing"
"github.com/google/go-cmp/cmp"
"github.com/hashicorp/terraform-plugin-framework/attr"
"github.com/hashicorp/terraform-plugin-framework/types"
"github.com/stackitcloud/stackit-sdk-go/core/utils"
"github.com/stackitcloud/stackit-sdk-go/services/postgresql"
)
func TestMapFields(t *testing.T) {
tests := []struct {
description string
input *postgresql.Instance
expected Model
isValid bool
}{
{
"default_values",
&postgresql.Instance{},
Model{
Id: types.StringValue("pid,iid"),
InstanceId: types.StringValue("iid"),
ProjectId: types.StringValue("pid"),
PlanId: types.StringNull(),
Name: types.StringNull(),
CfGuid: types.StringNull(),
CfSpaceGuid: types.StringNull(),
DashboardUrl: types.StringNull(),
ImageUrl: types.StringNull(),
OrganizationGuid: types.StringNull(),
Parameters: types.ObjectNull(parametersTypes),
},
true,
},
{
"simple_values",
&postgresql.Instance{
PlanId: utils.Ptr("plan"),
CfGuid: utils.Ptr("cf"),
CfSpaceGuid: utils.Ptr("space"),
DashboardUrl: utils.Ptr("dashboard"),
ImageUrl: utils.Ptr("image"),
InstanceId: utils.Ptr("iid"),
Name: utils.Ptr("name"),
OrganizationGuid: utils.Ptr("org"),
Parameters: &map[string]interface{}{
"enable_monitoring": true,
"metrics_frequency": 1234,
"plugins": []string{
"plugin_1",
"plugin_2",
"",
},
},
},
Model{
Id: types.StringValue("pid,iid"),
InstanceId: types.StringValue("iid"),
ProjectId: types.StringValue("pid"),
PlanId: types.StringValue("plan"),
Name: types.StringValue("name"),
CfGuid: types.StringValue("cf"),
CfSpaceGuid: types.StringValue("space"),
DashboardUrl: types.StringValue("dashboard"),
ImageUrl: types.StringValue("image"),
OrganizationGuid: types.StringValue("org"),
Parameters: types.ObjectValueMust(parametersTypes, map[string]attr.Value{
"enable_monitoring": types.BoolValue(true),
"metrics_frequency": types.Int64Value(1234),
"metrics_prefix": types.StringNull(),
"monitoring_instance_id": types.StringNull(),
"plugins": types.ListValueMust(types.StringType, []attr.Value{
types.StringValue("plugin_1"),
types.StringValue("plugin_2"),
types.StringValue(""),
}),
"sgw_acl": types.StringNull(),
}),
},
true,
},
{
"nil_response",
nil,
Model{},
false,
},
{
"no_resource_id",
&postgresql.Instance{},
Model{},
false,
},
{
"wrong_param_types_1",
&postgresql.Instance{
Parameters: &map[string]interface{}{
"enable_monitoring": "true",
},
},
Model{},
false,
},
{
"wrong_param_types_2",
&postgresql.Instance{
Parameters: &map[string]interface{}{
"metrics_frequency": true,
},
},
Model{},
false,
},
{
"wrong_param_types_3",
&postgresql.Instance{
Parameters: &map[string]interface{}{
"metrics_frequency": 12.34,
},
},
Model{},
false,
},
{
"wrong_param_types_4",
&postgresql.Instance{
Parameters: &map[string]interface{}{
"plugins": "foo",
},
},
Model{},
false,
},
{
"wrong_param_types_5",
&postgresql.Instance{
Parameters: &map[string]interface{}{
"plugins": []bool{
true,
},
},
},
Model{},
false,
},
}
for _, tt := range tests {
t.Run(tt.description, func(t *testing.T) {
state := &Model{
ProjectId: tt.expected.ProjectId,
InstanceId: tt.expected.InstanceId,
}
err := mapFields(tt.input, state)
if !tt.isValid && err == nil {
t.Fatalf("Should have failed")
}
if tt.isValid && err != nil {
t.Fatalf("Should not have failed: %v", err)
}
if tt.isValid {
diff := cmp.Diff(state, &tt.expected)
if diff != "" {
t.Fatalf("Data does not match: %s", diff)
}
}
})
}
}
func TestToCreatePayload(t *testing.T) {
tests := []struct {
description string
input *Model
inputParameters *parametersModel
inputParametersPlugins *[]string
expected *postgresql.CreateInstancePayload
isValid bool
}{
{
"default_values",
&Model{},
&parametersModel{},
&[]string{},
&postgresql.CreateInstancePayload{
Parameters: &postgresql.InstanceParameters{
Plugins: &[]string{},
},
},
true,
},
{
"nil_values",
&Model{},
&parametersModel{},
nil,
&postgresql.CreateInstancePayload{
Parameters: &postgresql.InstanceParameters{
Plugins: nil,
},
},
true,
},
{
"simple_values",
&Model{
Name: types.StringValue("name"),
PlanId: types.StringValue("plan"),
},
&parametersModel{
EnableMonitoring: types.BoolValue(true),
MetricsFrequency: types.Int64Value(123),
MetricsPrefix: types.StringValue("prefix"),
MonitoringInstanceId: types.StringValue("monitoring"),
SgwAcl: types.StringValue("sgw"),
},
&[]string{
"plugin_1",
"plugin_2",
},
&postgresql.CreateInstancePayload{
InstanceName: utils.Ptr("name"),
Parameters: &postgresql.InstanceParameters{
EnableMonitoring: utils.Ptr(true),
MetricsFrequency: utils.Ptr(int32(123)),
MetricsPrefix: utils.Ptr("prefix"),
MonitoringInstanceId: utils.Ptr("monitoring"),
Plugins: &[]string{
"plugin_1",
"plugin_2",
},
SgwAcl: utils.Ptr("sgw"),
},
PlanId: utils.Ptr("plan"),
},
true,
},
{
"null_fields_and_int_conversions",
&Model{
Name: types.StringValue(""),
PlanId: types.StringValue(""),
},
&parametersModel{
EnableMonitoring: types.BoolNull(),
MetricsFrequency: types.Int64Value(2123456789),
MetricsPrefix: types.StringNull(),
MonitoringInstanceId: types.StringNull(),
SgwAcl: types.StringNull(),
},
&[]string{
"",
},
&postgresql.CreateInstancePayload{
InstanceName: utils.Ptr(""),
Parameters: &postgresql.InstanceParameters{
EnableMonitoring: nil,
MetricsFrequency: utils.Ptr(int32(2123456789)),
MetricsPrefix: nil,
MonitoringInstanceId: nil,
Plugins: &[]string{
"",
},
SgwAcl: nil,
},
PlanId: utils.Ptr(""),
},
true,
},
{
"nil_model",
nil,
&parametersModel{},
&[]string{},
nil,
false,
},
{
"nil_parameters",
&Model{
Name: types.StringValue("name"),
PlanId: types.StringValue("plan"),
},
nil,
nil,
&postgresql.CreateInstancePayload{
InstanceName: utils.Ptr("name"),
PlanId: utils.Ptr("plan"),
},
true,
},
}
for _, tt := range tests {
t.Run(tt.description, func(t *testing.T) {
output, err := toCreatePayload(tt.input, tt.inputParameters, tt.inputParametersPlugins)
if !tt.isValid && err == nil {
t.Fatalf("Should have failed")
}
if tt.isValid && err != nil {
t.Fatalf("Should not have failed: %v", err)
}
if tt.isValid {
diff := cmp.Diff(output, tt.expected)
if diff != "" {
t.Fatalf("Data does not match: %s", diff)
}
}
})
}
}
func TestToUpdatePayload(t *testing.T) {
tests := []struct {
description string
input *Model
inputParameters *parametersModel
inputParametersPlugins *[]string
expected *postgresql.UpdateInstancePayload
isValid bool
}{
{
"default_values",
&Model{},
&parametersModel{},
&[]string{},
&postgresql.UpdateInstancePayload{
Parameters: &postgresql.InstanceParameters{
Plugins: &[]string{},
},
},
true,
},
{
"simple_values",
&Model{
PlanId: types.StringValue("plan"),
},
&parametersModel{
EnableMonitoring: types.BoolValue(true),
MetricsFrequency: types.Int64Value(123),
MetricsPrefix: types.StringValue("prefix"),
MonitoringInstanceId: types.StringValue("monitoring"),
SgwAcl: types.StringValue("sgw"),
},
&[]string{
"plugin_1",
"plugin_2",
},
&postgresql.UpdateInstancePayload{
Parameters: &postgresql.InstanceParameters{
EnableMonitoring: utils.Ptr(true),
MetricsFrequency: utils.Ptr(int32(123)),
MetricsPrefix: utils.Ptr("prefix"),
MonitoringInstanceId: utils.Ptr("monitoring"),
Plugins: &[]string{
"plugin_1",
"plugin_2",
},
SgwAcl: utils.Ptr("sgw"),
},
PlanId: utils.Ptr("plan"),
},
true,
},
{
"null_fields_and_int_conversions",
&Model{
PlanId: types.StringValue(""),
},
&parametersModel{
EnableMonitoring: types.BoolNull(),
MetricsFrequency: types.Int64Value(2123456789),
MetricsPrefix: types.StringNull(),
MonitoringInstanceId: types.StringNull(),
SgwAcl: types.StringNull(),
},
&[]string{
"",
},
&postgresql.UpdateInstancePayload{
Parameters: &postgresql.InstanceParameters{
EnableMonitoring: nil,
MetricsFrequency: utils.Ptr(int32(2123456789)),
MetricsPrefix: nil,
MonitoringInstanceId: nil,
Plugins: &[]string{
"",
},
SgwAcl: nil,
},
PlanId: utils.Ptr(""),
},
true,
},
{
"nil_model",
nil,
&parametersModel{},
&[]string{},
nil,
false,
},
{
"nil_parameters",
&Model{
PlanId: types.StringValue("plan"),
},
nil,
nil,
&postgresql.UpdateInstancePayload{
PlanId: utils.Ptr("plan"),
},
true,
},
}
for _, tt := range tests {
t.Run(tt.description, func(t *testing.T) {
output, err := toUpdatePayload(tt.input, tt.inputParameters, tt.inputParametersPlugins)
if !tt.isValid && err == nil {
t.Fatalf("Should have failed")
}
if tt.isValid && err != nil {
t.Fatalf("Should not have failed: %v", err)
}
if tt.isValid {
diff := cmp.Diff(output, tt.expected)
if diff != "" {
t.Fatalf("Data does not match: %s", diff)
}
}
})
}
}