Support imports on plugin framework index

Author: tobio

internal/elasticsearch/index/index/raw_settings_modifier.go

@@ -0,0 +1,48 @@
+package index
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-framework/attr"
+	"github.com/hashicorp/terraform-plugin-framework/path"
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
+	"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
+)
+
+type rawSettingsPlanModifier struct{}
+
+func (p rawSettingsPlanModifier) PlanModifyString(ctx context.Context, req planmodifier.StringRequest, resp *planmodifier.StringResponse) {
+	for _, key := range dynamicSettingsKeys {
+		attrPath := path.Root(convertSettingsKeyToTFFieldKey(key))
+		var cfgValue, stateValue attr.Value
+
+		resp.Diagnostics.Append(req.Config.GetAttribute(ctx, attrPath, &cfgValue)...)
+		if resp.Diagnostics.HasError() {
+			return
+		}
+
+		resp.Diagnostics.Append(req.State.GetAttribute(ctx, attrPath, &stateValue)...)
+		if resp.Diagnostics.HasError() {
+			return
+		}
+
+		if cfgValue.IsUnknown() {
+			continue
+		}
+
+		if cfgValue.Equal(stateValue) {
+			continue
+		}
+
+		resp.PlanValue = basetypes.NewStringUnknown()
+		return
+	}
+}
+
+func (p rawSettingsPlanModifier) Description(_ context.Context) string {
+	return "Sets the value to Unknown only if any dynamic settings have been changed"
+}
+
+func (p rawSettingsPlanModifier) MarkdownDescription(ctx context.Context) string {
+	return p.Description(ctx)
+}

internal/elasticsearch/index/index/resource.go

@@ -5,9 +5,15 @@ import (
 
 	"github.com/elastic/terraform-provider-elasticstack/internal/clients"
 	"github.com/hashicorp/terraform-plugin-framework/diag"
+	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 )
 
+// Ensure provider defined types fully satisfy framework interfaces
+var _ resource.Resource = &Resource{}
+var _ resource.ResourceWithConfigure = &Resource{}
+var _ resource.ResourceWithImportState = &Resource{}
+
 type Resource struct {
 	client *clients.ApiClient
 }
@@ -33,3 +39,8 @@ func (r *Resource) Configure(ctx context.Context, request resource.ConfigureRequ
 func (r *Resource) Metadata(ctx context.Context, request resource.MetadataRequest, response *resource.MetadataResponse) {
 	response.TypeName = request.ProviderTypeName + "_elasticsearch_index"
 }
+
+func (r *Resource) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse) {
+	// Retrieve import ID and save to id attribute
+	resource.ImportStatePassthroughID(ctx, path.Root("id"), req, resp)
+}

internal/elasticsearch/index/index/schema.go

@@ -26,12 +26,6 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/types"
 )
 
-// Ensure provider defined types fully satisfy framework interfaces
-var _ resource.Resource = &Resource{}
-var _ resource.ResourceWithConfigure = &Resource{}
-
-// var _ resource.ResourceWithImportState = &Resource{}
-
 func (r *Resource) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
 	resp.Schema = getSchema()
 }

internal/utils/planmodifiers/attribute_changed.go

@@ -0,0 +1,43 @@
+// Licensed to Elasticsearch B.V. under one or more contributor
+// license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright
+// ownership. Elasticsearch B.V. licenses this file to you under
+// the Apache License, Version 2.0 (the "License"); you may
+// not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package planmodifiers
+
+import (
+	"context"
+
+	"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/tfsdk"
+)
+
+func AttributeChanged(ctx context.Context, p path.Path, plan tfsdk.Plan, state tfsdk.State) (bool, diag.Diagnostics) {
+	var planValue attr.Value
+
+	if diags := plan.GetAttribute(ctx, p, &planValue); diags.HasError() {
+		return false, diags
+	}
+
+	var stateValue attr.Value
+
+	if diags := state.GetAttribute(ctx, p, &stateValue); diags.HasError() {
+		return false, diags
+	}
+
+	return !planValue.Equal(stateValue), nil
+}

internal/utils/planmodifiers/bool_default.go

@@ -0,0 +1,39 @@
+package planmodifiers
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
+	"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
+)
+
+func BoolUseDefaultIfUnknown(defaultValue bool) boolDefault {
+	return boolDefault{defaultValue: defaultValue}
+}
+
+type boolDefault struct {
+	defaultValue bool
+}
+
+func (bd boolDefault) PlanModifyBool(ctx context.Context, req planmodifier.BoolRequest, resp *planmodifier.BoolResponse) {
+	// Do nothing if there is a known planned value.
+	if !req.PlanValue.IsUnknown() {
+		return
+	}
+
+	// Do nothing if there is an unknown configuration value, otherwise interpolation gets messed up.
+	if req.ConfigValue.IsUnknown() {
+		return
+	}
+
+	resp.PlanValue = basetypes.NewBoolValue(bd.defaultValue)
+}
+
+func (bd boolDefault) Description(context.Context) string {
+	return fmt.Sprintf("Sets the value to [%t] if unknown", bd.defaultValue)
+}
+
+func (bd boolDefault) MarkdownDescription(ctx context.Context) string {
+	return bd.Description(ctx)
+}

internal/utils/planmodifiers/string_default.go

@@ -0,0 +1,39 @@
+package planmodifiers
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier"
+	"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
+)
+
+func StringUseDefaultIfUnknown(defaultValue string) stringDefault {
+	return stringDefault{defaultValue: defaultValue}
+}
+
+type stringDefault struct {
+	defaultValue string
+}
+
+func (bd stringDefault) PlanModifyString(ctx context.Context, req planmodifier.StringRequest, resp *planmodifier.StringResponse) {
+	// Do nothing if there is a known planned value.
+	if !req.PlanValue.IsUnknown() {
+		return
+	}
+
+	// Do nothing if there is an unknown configuration value, otherwise interpolation gets messed up.
+	if req.ConfigValue.IsUnknown() {
+		return
+	}
+
+	resp.PlanValue = basetypes.NewStringValue(bd.defaultValue)
+}
+
+func (bd stringDefault) Description(context.Context) string {
+	return fmt.Sprintf("Sets the value to [%s] if unknown", bd.defaultValue)
+}
+
+func (bd stringDefault) MarkdownDescription(ctx context.Context) string {
+	return bd.Description(ctx)
+}