tfprovider.Provider adds a new method ImportManagedResourceState

tfprovider/common.go

@@ -34,6 +34,8 @@ type ManagedResourceType = common.ManagedResourceType
 
 type DataResourceType = common.DataResourceType
 
+type ImportedResource = common.ImportedResource
+
 type ManagedResourceReadRequest = common.ManagedResourceReadRequest
 
 type ManagedResourceReadResponse = common.ManagedResourceReadResponse

tfprovider/internal/common/resource_types.go

@@ -2,6 +2,8 @@ package common
 
 import (
 	"context"
+
+	"github.com/zclconf/go-cty/cty"
 )
 
 // ManagedResourceType represents a managed resource type belonging to a
@@ -36,3 +38,19 @@ type DataResourceType interface {
 	// plugin protocol features.
 	Sealed() Sealed
 }
+
+// ImportedResource represents an object being imported.
+type ImportedResource struct {
+	// TypeName is the name of the resource type associated with the
+	// returned state.
+	TypeName string
+
+	// State is the state of the remote object being imported. This may not be
+	// complete, but must contain enough information to uniquely identify the
+	// resource.
+	State cty.Value
+
+	// Private is an opaque blob that will be stored in state along with the
+	// resource. It is intended only for interpretation by the provider itself.
+	OpaquePrivate []byte
+}

tfprovider/internal/protocol5/provider.go

@@ -2,6 +2,7 @@ package protocol5
 
 import (
 	"context"
+	"fmt"
 	"sync"
 
 	"github.com/apparentlymart/terraform-provider/internal/tfplugin5"
@@ -33,10 +34,11 @@ func NewProvider(ctx context.Context, plugin *rpcplugin.Plugin, clientProxy inte
 	}
 
 	return &Provider{
-		client:     client,
-		plugin:     plugin,
-		schema:     schema,
-		configured: false,
+		client:       client,
+		plugin:       plugin,
+		schema:       schema,
+		configured:   false,
+		configuredMu: &sync.Mutex{},
 	}, nil
 }
 
@@ -150,6 +152,43 @@ func (p *Provider) ManagedResourceType(typeName string) common.ManagedResourceTy
 	}
 }
 
+func (p *Provider) ImportManagedResourceState(ctx context.Context, typeName string, id string) ([]common.ImportedResource, common.Diagnostics) {
+	p.configuredMu.Lock()
+	if !p.configured {
+		return nil, nil
+	}
+	p.configuredMu.Unlock()
+
+	var diags common.Diagnostics
+	resp, err := p.client.ImportResourceState(ctx, &tfplugin5.ImportResourceState_Request{
+		TypeName: typeName,
+		Id:       id,
+	})
+	diags = append(diags, common.RPCErrorDiagnostics(err)...)
+	if err != nil {
+		return nil, diags
+	}
+	diags = append(diags, decodeDiagnostics(resp.Diagnostics)...)
+
+	var resources []common.ImportedResource
+	for _, raw := range resp.ImportedResources {
+		resource := common.ImportedResource{
+			TypeName:      raw.TypeName,
+			OpaquePrivate: raw.Private,
+		}
+		schema, ok := p.schema.ManagedResourceTypes[raw.TypeName]
+		if !ok {
+			diags = append(diags, common.RPCErrorDiagnostics(fmt.Errorf("unknown resource type %q", raw.TypeName))...)
+			continue
+		}
+		state, moreDiags := decodeDynamicValue(raw.State, schema.Content)
+		resource.State = state
+		diags = append(diags, moreDiags...)
+		resources = append(resources, resource)
+	}
+	return resources, diags
+}
+
 func (p *Provider) Close() error {
 	return p.plugin.Close()
 }

tfprovider/internal/protocol5/schema.go

@@ -124,7 +124,7 @@ func decodeDynamicValue(raw *tfplugin5.DynamicValue, schema *tfschema.Block) (ct
 		}
 		return val, nil
 	case len(raw.Msgpack) > 0:
-		val, err := ctymsgpack.Unmarshal(raw.Json, ty)
+		val, err := ctymsgpack.Unmarshal(raw.Msgpack, ty)
 		if err != nil {
 			return cty.DynamicVal, common.ErrorDiagnostics(
 				"Provider returned invalid object",

tfprovider/internal/protocol6/provider.go

@@ -2,6 +2,7 @@ package protocol6
 
 import (
 	"context"
+	"fmt"
 	"sync"
 
 	"github.com/apparentlymart/terraform-provider/internal/tfplugin6"
@@ -33,10 +34,11 @@ func NewProvider(ctx context.Context, plugin *rpcplugin.Plugin, clientProxy inte
 	}
 
 	return &Provider{
-		client:     client,
-		plugin:     plugin,
-		schema:     schema,
-		configured: false,
+		client:       client,
+		plugin:       plugin,
+		schema:       schema,
+		configured:   false,
+		configuredMu: &sync.Mutex{},
 	}, nil
 }
 
@@ -141,6 +143,37 @@ func (p *Provider) ManagedResourceType(typeName string) common.ManagedResourceTy
 	}
 }
 
+func (p *Provider) ImportManagedResourceState(ctx context.Context, typeName string, id string) ([]common.ImportedResource, common.Diagnostics) {
+	var diags common.Diagnostics
+	resp, err := p.client.ImportResourceState(ctx, &tfplugin6.ImportResourceState_Request{
+		TypeName: typeName,
+		Id:       id,
+	})
+	diags = append(diags, common.RPCErrorDiagnostics(err)...)
+	if err != nil {
+		return nil, diags
+	}
+	diags = append(diags, decodeDiagnostics(resp.Diagnostics)...)
+
+	var resources []common.ImportedResource
+	for _, raw := range resp.ImportedResources {
+		resource := common.ImportedResource{
+			TypeName:      raw.TypeName,
+			OpaquePrivate: raw.Private,
+		}
+		schema, ok := p.schema.ManagedResourceTypes[raw.TypeName]
+		if !ok {
+			diags = append(diags, common.RPCErrorDiagnostics(fmt.Errorf("unknown resource type %q", raw.TypeName))...)
+			continue
+		}
+		state, moreDiags := decodeDynamicValue(raw.State, schema.Content)
+		resource.State = state
+		diags = append(diags, moreDiags...)
+		resources = append(resources, resource)
+	}
+	return resources, diags
+}
+
 func (p *Provider) Close() error {
 	return p.plugin.Close()
 }

tfprovider/internal/protocol6/schema.go

@@ -124,7 +124,7 @@ func decodeDynamicValue(raw *tfplugin6.DynamicValue, schema *tfschema.Block) (ct
 		}
 		return val, nil
 	case len(raw.Msgpack) > 0:
-		val, err := ctymsgpack.Unmarshal(raw.Json, ty)
+		val, err := ctymsgpack.Unmarshal(raw.Msgpack, ty)
 		if err != nil {
 			return cty.DynamicVal, common.ErrorDiagnostics(
 				"Provider returned invalid object",

tfprovider/tfprovider.go

@@ -58,6 +58,11 @@ type Provider interface {
 	// method. An unconfigured provider always returns nil.
 	ManagedResourceType(name string) ManagedResourceType
 
+	// ImportManagedResourceState requests that the given resource be imported.
+	// It's possible for providers to import multiple related types with a single
+	// import request.
+	ImportManagedResourceState(ctx context.Context, typeName string, id string) ([]ImportedResource, Diagnostics)
+
 	// Close kills the child process for this provider plugin, rendering the
 	// reciever unusable. Any further calls on the object after Close returns
 	// cause undefined behavior.