extend support for supplying raw schema types to proto6

Author: stephybun

internal/fwserver/server_getmetadata_test.go

@@ -839,7 +839,8 @@ func TestServerGetMetadata(t *testing.T) {
 					diag.NewErrorDiagnostic(
 						"ListResource Type Defined without a Matching Managed Resource Type",
 						"The test_resource_1 ListResource type name was returned, but no matching managed Resource type was defined. "+
-							"If the matching managed Resource type is a legacy resource, ProtoV5Schema and ProtoV5IdentitySchema must be specified in the RawV5Schemas method. "+
+							"If the matching managed Resource type not a framework resource either ProtoV5Schema and ProtoV5IdentitySchema must be specified in the RawV5Schemas method, "+
+							"or ProtoV6Schema and ProtoV6IdentitySchema must be specified in the RawV6Schemas method. "+
 							"This is always an issue with the provider and should be reported to the provider developers.",
 					),
 				},

internal/fwserver/server_listresources.go

@@ -85,18 +85,24 @@ func (s *Server) ListResourceFuncs(ctx context.Context) (map[string]func() list.
 			continue
 		}
 
-		schemasResp := list.SchemaResponse{}
+		rawV5SchemasResp := list.RawV5SchemaResponse{}
 		if listResourceWithSchemas, ok := listResource.(list.ListResourceWithRawV5Schemas); ok {
-			listResourceWithSchemas.RawV5Schemas(ctx, list.SchemaRequest{}, &schemasResp)
+			listResourceWithSchemas.RawV5Schemas(ctx, list.RawV5SchemaRequest{}, &rawV5SchemasResp)
+		}
+
+		rawV6SchemasResp := list.RawV6SchemaResponse{}
+		if listResourceWithSchemas, ok := listResource.(list.ListResourceWithRawV6Schemas); ok {
+			listResourceWithSchemas.RawV6Schemas(ctx, list.RawV6SchemaRequest{}, &rawV6SchemasResp)
 		}
 
 		resourceFuncs, _ := s.ResourceFuncs(ctx)
 		if _, ok := resourceFuncs[typeName]; !ok {
-			if schemasResp.ProtoV5Schema == nil || schemasResp.ProtoV5IdentitySchema == nil {
+			if (rawV5SchemasResp.ProtoV5Schema == nil || rawV5SchemasResp.ProtoV5IdentitySchema == nil) && (rawV6SchemasResp.ProtoV6Schema == nil || rawV6SchemasResp.ProtoV6IdentitySchema == nil) {
 				s.listResourceFuncsDiags.AddError(
 					"ListResource Type Defined without a Matching Managed Resource Type",
 					fmt.Sprintf("The %s ListResource type name was returned, but no matching managed Resource type was defined. ", typeName)+
-						"If the matching managed Resource type is a legacy resource, ProtoV5Schema and ProtoV5IdentitySchema must be specified in the RawV5Schemas method. "+
+						"If the matching managed Resource type not a framework resource either ProtoV5Schema and ProtoV5IdentitySchema must be specified in the RawV5Schemas method, "+
+						"or ProtoV6Schema and ProtoV6IdentitySchema must be specified in the RawV6Schemas method. "+
 						"This is always an issue with the provider and should be reported to the provider developers.",
 				)
 				continue

internal/proto5server/server_listresource.go

@@ -55,9 +55,9 @@ func (s *Server) ListResource(ctx context.Context, protoReq *tfprotov5.ListResou
 		Limit:           protoReq.Limit,
 	}
 
-	schemaResp := list.SchemaResponse{}
+	schemaResp := list.RawV5SchemaResponse{}
 	if listResourceWithProtoSchemas, ok := listResource.(list.ListResourceWithRawV5Schemas); ok {
-		listResourceWithProtoSchemas.RawV5Schemas(ctx, list.SchemaRequest{}, &schemaResp)
+		listResourceWithProtoSchemas.RawV5Schemas(ctx, list.RawV5SchemaRequest{}, &schemaResp)
 	}
 
 	// There's validation in ListResources that ensures both are set if either is provided so it should be sufficient to only nil check Identity
@@ -77,7 +77,6 @@ func (s *Server) ListResource(ctx context.Context, protoReq *tfprotov5.ListResou
 			allDiags.Append(diags...)
 			return ListRequestErrorDiagnostics(ctx, allDiags...)
 		}
-
 	} else {
 		req.ResourceSchema, diags = s.FrameworkServer.ResourceSchema(ctx, protoReq.TypeName)
 		allDiags.Append(diags...)

internal/proto6server/server_listresource.go

@@ -10,6 +10,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/internal/fromproto6"
 	"github.com/hashicorp/terraform-plugin-framework/internal/fwserver"
 	"github.com/hashicorp/terraform-plugin-framework/internal/toproto6"
+	"github.com/hashicorp/terraform-plugin-framework/list"
 	"github.com/hashicorp/terraform-plugin-go/tfprotov6"
 )
 
@@ -47,26 +48,48 @@ func (s *Server) ListResource(ctx context.Context, protoReq *tfprotov6.ListResou
 		return ListRequestErrorDiagnostics(ctx, allDiags...)
 	}
 
-	resourceSchema, diags := s.FrameworkServer.ResourceSchema(ctx, protoReq.TypeName)
-	allDiags.Append(diags...)
-	if diags.HasError() {
-		return ListRequestErrorDiagnostics(ctx, allDiags...)
+	req := &fwserver.ListRequest{
+		Config:          config,
+		ListResource:    listResource,
+		IncludeResource: protoReq.IncludeResource,
+		Limit:           protoReq.Limit,
 	}
 
-	identitySchema, diags := s.FrameworkServer.ResourceIdentitySchema(ctx, protoReq.TypeName)
-	allDiags.Append(diags...)
-	if diags.HasError() {
-		return ListRequestErrorDiagnostics(ctx, allDiags...)
+	schemaResp := list.RawV6SchemaResponse{}
+	if listResourceWithProtoSchemas, ok := listResource.(list.ListResourceWithRawV6Schemas); ok {
+		listResourceWithProtoSchemas.RawV6Schemas(ctx, list.RawV6SchemaRequest{}, &schemaResp)
 	}
 
-	req := &fwserver.ListRequest{
-		Config:                 config,
-		ListResource:           listResource,
-		ResourceSchema:         resourceSchema,
-		ResourceIdentitySchema: identitySchema,
-		IncludeResource:        protoReq.IncludeResource,
-		Limit:                  protoReq.Limit,
+	if schemaResp.ProtoV6IdentitySchema != nil {
+		var err error
+
+		req.ResourceSchema, err = fromproto6.ResourceSchema(ctx, schemaResp.ProtoV6Schema)
+		if err != nil {
+			diags.AddError("Converting Resource Schema", err.Error())
+			allDiags.Append(diags...)
+			return ListRequestErrorDiagnostics(ctx, allDiags...)
+		}
+
+		req.ResourceIdentitySchema, err = fromproto6.IdentitySchema(ctx, schemaResp.ProtoV6IdentitySchema)
+		if err != nil {
+			diags.AddError("Converting Resource Identity Schema", err.Error())
+			allDiags.Append(diags...)
+			return ListRequestErrorDiagnostics(ctx, allDiags...)
+		}
+	} else {
+		req.ResourceSchema, diags = s.FrameworkServer.ResourceSchema(ctx, protoReq.TypeName)
+		allDiags.Append(diags...)
+		if diags.HasError() {
+			return ListRequestErrorDiagnostics(ctx, allDiags...)
+		}
+
+		req.ResourceIdentitySchema, diags = s.FrameworkServer.ResourceIdentitySchema(ctx, protoReq.TypeName)
+		allDiags.Append(diags...)
+		if diags.HasError() {
+			return ListRequestErrorDiagnostics(ctx, allDiags...)
+		}
 	}
+
 	stream := &fwserver.ListResultsStream{}
 
 	s.FrameworkServer.ListResource(ctx, req, stream)

list/list_resource.go

@@ -12,6 +12,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/tfsdk"
 	"github.com/hashicorp/terraform-plugin-go/tfprotov5"
+	"github.com/hashicorp/terraform-plugin-go/tfprotov6"
 	"github.com/hashicorp/terraform-plugin-go/tftypes"
 )
 
@@ -49,7 +50,17 @@ type ListResourceWithRawV5Schemas interface {
 	ListResource
 
 	// RawV5Schemas is called to provide the ProtoV5 representations of the resource and resource identity schemas.
-	RawV5Schemas(context.Context, SchemaRequest, *SchemaResponse)
+	RawV5Schemas(context.Context, RawV5SchemaRequest, *RawV5SchemaResponse)
+}
+
+// ListResourceWithRawV6Schemas is an interface type that extends ListResource to include a method
+// which allows provider developers to supply the ProtoV5 representations of resource and resource identity
+// schemas. This is necessary if list functionality is being used with a legacy resource.
+type ListResourceWithRawV6Schemas interface {
+	ListResource
+
+	// RawV6Schemas is called to provide the ProtoV5 representations of the resource and resource identity schemas.
+	RawV6Schemas(context.Context, RawV6SchemaRequest, *RawV6SchemaResponse)
 }
 
 // ListResourceWithConfigure is an interface type that extends ListResource to include a method
@@ -193,14 +204,14 @@ type ListResult struct {
 	Diagnostics diag.Diagnostics
 }
 
-// SchemaRequest represents a request for the ListResource to return the
+// RawV5SchemaRequest represents a request for the ListResource to return the
 // ProtoV5 schemas. An instance of this request struct is supplied as an argument
 // to the ListResource type RawV5Schemas method.
-type SchemaRequest struct{}
+type RawV5SchemaRequest struct{}
 
-// SchemaResponse represents a response that is populated by the Schemas method
+// RawV5SchemaResponse represents a response that is populated by the Schemas method
 // and is used to pass along the ProtoV5 representations of the resource and resource identity schemas.
-type SchemaResponse struct {
+type RawV5SchemaResponse struct {
 	// ProtoV5IdentitySchema is the ProtoV5 representation of the resource identity
 	// schema. This should only be supplied if framework functionality is being used
 	// with a legacy resource. Currently, this only applies to list.
@@ -212,6 +223,25 @@ type SchemaResponse struct {
 	ProtoV5Schema *tfprotov5.Schema
 }
 
+// RawV6SchemaRequest represents a request for the ListResource to return the
+// ProtoV5 schemas. An instance of this request struct is supplied as an argument
+// to the ListResource type RawV5Schemas method.
+type RawV6SchemaRequest struct{}
+
+// RawV6SchemaResponse represents a response that is populated by the Schemas method
+// and is used to pass along the ProtoV5 representations of the resource and resource identity schemas.
+type RawV6SchemaResponse struct {
+	// ProtoV5IdentitySchema is the ProtoV5 representation of the resource identity
+	// schema. This should only be supplied if framework functionality is being used
+	// with a legacy resource. Currently, this only applies to list.
+	ProtoV6IdentitySchema *tfprotov6.ResourceIdentitySchema
+
+	// ProtoV5Schema is the ProtoV5 representation of the resource schema
+	// This should only be supplied if framework functionality is being used
+	// with a legacy resource. Currently, this only applies to list.
+	ProtoV6Schema *tfprotov6.Schema
+}
+
 // ValidateConfigRequest represents a request to validate the configuration of
 // a list resource. An instance of this request struct is supplied as an
 // argument to the [ListResourceWithValidateConfig.ValidateListResourceConfig]