add GenerateResourceConfig RPC to tf5server

Author: stephybun

internal/logging/context.go

@@ -109,6 +109,15 @@ func ActionContext(ctx context.Context, action string) context.Context {
 	return ctx
 }
 
+// GenerateResourceConfig injects the resource type into logger contexts.
+func GenerateResourceConfigContext(ctx context.Context, action string) context.Context {
+	ctx = tfsdklog.SetField(ctx, KeyGenerateResourceConfigType, action)
+	ctx = tfsdklog.SubsystemSetField(ctx, SubsystemProto, KeyGenerateResourceConfigType, action)
+	ctx = tflog.SetField(ctx, KeyGenerateResourceConfigType, action)
+
+	return ctx
+}
+
 // RpcContext injects the RPC name into logger contexts.
 func RpcContext(ctx context.Context, rpc string) context.Context {
 	ctx = tfsdklog.SetField(ctx, KeyRPC, rpc)

internal/logging/keys.go

@@ -66,6 +66,9 @@ const (
 	// The action being operated on
 	KeyActionType = "tf_action_type"
 
+	// The type of resource being operated on
+	KeyGenerateResourceConfigType = "tf_generate_resource_config_type"
+
 	// Path to protocol data file, such as "/tmp/example.json"
 	KeyProtocolDataFile = "tf_proto_data_file"
 

tfprotov5/generate_resource_config.go

@@ -1,9 +1,5 @@
 package tfprotov5
 
-import (
-	"context"
-)
-
 // GenerateResourceConfigRequest is the request Terraform sends when it wants to generate configuration
 // from a resource's state value.
 type GenerateResourceConfigRequest struct {
@@ -26,8 +22,3 @@ type GenerateResourceConfigResponse struct {
 	// Diagnostics report errors or warnings related to the creation of the config value.
 	Diagnostics []*Diagnostic
 }
-
-// GenerateResourceConfigServer is an interface containing the method to generate resource config.
-type GenerateResourceConfigServer interface {
-	GenerateResourceConfig(context.Context, *GenerateResourceConfigRequest) (*GenerateResourceConfigResponse, error)
-}

tfprotov5/internal/toproto/generate_resource_config.go

@@ -5,7 +5,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-go/tfprotov5/internal/tfplugin5"
 )
 
-func GenerateResourceConfigResponse(in *tfprotov5.GenerateResourceConfigResponse) *tfplugin5.GenerateResourceConfig_Response {
+func GenerateResourceConfig_Response(in *tfprotov5.GenerateResourceConfigResponse) *tfplugin5.GenerateResourceConfig_Response {
 	if in == nil {
 		return nil
 	}

tfprotov5/internal/toproto/generate_resource_config_test.go

@@ -59,7 +59,7 @@ func TestGenerateResourceConfig_Response(t *testing.T) {
 		t.Run(name, func(t *testing.T) {
 			t.Parallel()
 
-			got := toproto.GenerateResourceConfigResponse(testCase.in)
+			got := toproto.GenerateResourceConfig_Response(testCase.in)
 
 			// Protocol Buffers generated types must have unexported fields
 			// ignored or cmp.Diff() will raise an error. This is easier than

tfprotov5/provider.go

@@ -109,21 +109,6 @@ type ProviderServerWithActions interface {
 	ActionServer
 }
 
-// ProviderServerWithGenerateResourceConfig is a temporary interface for servers
-// to implement the GenerateResourceConfig RPC.
-//
-// - GenerateResourceConfig
-//
-// Deprecated: This method will be moved into the
-// ProviderServer interface and this interface will be removed in a future
-// version.
-type ProviderServerWithGenerateResourceConfig interface {
-	ProviderServer
-
-	// GenerateResourceConfigServer is an interface containing the method to generate resource config.
-	GenerateResourceConfigServer
-}
-
 // GetMetadataRequest represents a GetMetadata RPC request.
 type GetMetadataRequest struct{}
 

tfprotov5/resource.go

@@ -69,6 +69,15 @@ type ResourceServer interface {
 	// current version. It is the provider's responsibility to modify the
 	// identity state to upgrade it to the latest state schema.
 	UpgradeResourceIdentity(context.Context, *UpgradeResourceIdentityRequest) (*UpgradeResourceIdentityResponse, error)
+
+	// GenerateResourceConfig is called when Terraform wants to generate a resource
+	// configuration for importing to a resource address that doesn't exist yet.
+	// It is called during a plan when the -generate-config-out flag is provided.
+	//
+	// This functionality is only supported in Terraform 1.14 and later. The
+	// provider must have enabled the GenerateResourceConfig server capability to
+	// enable these requests.
+	GenerateResourceConfig(context.Context, *GenerateResourceConfigRequest) (*GenerateResourceConfigResponse, error)
 }
 
 // ValidateResourceTypeConfigRequest is the request Terraform sends when it

tfprotov5/tf5server/server.go

@@ -1484,6 +1484,36 @@ func (s *server) InvokeAction(protoReq *tfplugin5.InvokeAction_Request, protoStr
 	return nil
 }
 
+func (s *server) GenerateResourceConfig(ctx context.Context, protoReq *tfplugin5.GenerateResourceConfig_Request) (protoResp *tfplugin5.GenerateResourceConfig_Response, err error) {
+	rpc := "GenerateResourceConfig"
+	ctx = s.loggingContext(ctx)
+	ctx = logging.RpcContext(ctx, rpc)
+	ctx = logging.GenerateResourceConfigContext(ctx, protoReq.TypeName)
+	ctx = s.stoppableContext(ctx)
+	logging.ProtocolTrace(ctx, "Received request")
+	defer logging.ProtocolTrace(ctx, "Served request")
+
+	req := fromproto.GenerateResourceConfigRequest(protoReq)
+
+	logging.ProtocolData(ctx, s.protocolDataDir, rpc, "Request", "State", req.State)
+
+	ctx = tf5serverlogging.DownstreamRequest(ctx)
+
+	resp, err := s.downstream.GenerateResourceConfig(ctx, req)
+	if err != nil {
+		logging.ProtocolError(ctx, "Error from downstream", map[string]any{logging.KeyError: err})
+		return nil, err
+	}
+
+	tf5serverlogging.DownstreamResponse(ctx, resp.Diagnostics)
+
+	logging.ProtocolData(ctx, s.protocolDataDir, rpc, "Response", "Config", resp.Config)
+
+	protoResp = toproto.GenerateResourceConfig_Response(resp)
+
+	return protoResp, nil
+}
+
 func invalidDeferredResponseDiag(reason tfprotov5.DeferredReason) *tfprotov5.Diagnostic {
 	return &tfprotov5.Diagnostic{
 		Severity: tfprotov5.DiagnosticSeverityError,