expected 1 list result; got 0 list results

Author: bbasata

internal/fwserver/server_listresources.go

@@ -82,16 +82,7 @@ func (s *Server) ListResourceFuncs(ctx context.Context) (map[string]func() list.
 					"ListResource type names must be unique. "+
 					"This is always an issue with the provider and should be reported to the provider developers.",
 			)
-			continue
-		}
-
-		resourceFuncs, _ := s.ResourceFuncs(ctx)
-		if _, ok := resourceFuncs[typeName]; !ok {
-			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)+
-					"This is always an issue with the provider and should be reported to the provider developers.",
-			)
+			fmt.Printf("The %s ListResource type name was returned for multiple list resources. ", typeName)
 			continue
 		}
 

internal/proto5server/server_listresource.go

@@ -11,6 +11,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/internal/fwserver"
 	"github.com/hashicorp/terraform-plugin-framework/internal/toproto5"
 	"github.com/hashicorp/terraform-plugin-go/tfprotov5"
+	sdk "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
 // ListRequestErrorDiagnostics returns a value suitable for
@@ -25,6 +26,21 @@ func ListRequestErrorDiagnostics(ctx context.Context, diags ...diag.Diagnostic)
 	}, nil
 }
 
+type SDKContext string
+
+var SDKResourceKey SDKContext = "sdk_resource"
+
+// NewContextWithSDKResource returns a new Context that carries value r
+func NewContextWithSDKResource(ctx context.Context, r *sdk.Resource) context.Context {
+	return context.WithValue(ctx, SDKResourceKey, r)
+}
+
+// FromContext returns the SDK Resource value stored in ctx, if any.
+func SDKResourceFromContext(ctx context.Context) (*sdk.Resource, bool) {
+	r, ok := ctx.Value(SDKResourceKey).(*sdk.Resource)
+	return r, ok
+}
+
 func (s *Server) ListResource(ctx context.Context, protoReq *tfprotov5.ListResourceRequest) (*tfprotov5.ListResourceServerStream, error) {
 	protoStream := &tfprotov5.ListResourceServerStream{Results: tfprotov5.NoListResults}
 	allDiags := diag.Diagnostics{}
@@ -47,43 +63,52 @@ func (s *Server) ListResource(ctx context.Context, protoReq *tfprotov5.ListResou
 		return ListRequestErrorDiagnostics(ctx, allDiags...)
 	}
 
-	resourceSchema, diags := s.FrameworkServer.ResourceSchema(ctx, protoReq.TypeName)
-	allDiags.Append(diags...)
-	if diags.HasError() {
-		return ListRequestErrorDiagnostics(ctx, allDiags...)
-	}
+	_, ok := SDKResourceFromContext(ctx)
+	switch ok {
+	case true:
+		protoStream.Results = func(push func(tfprotov5.ListResourceResult) bool) {
+			listResult := tfprotov5.ListResourceResult{}
+			push(listResult)
+		}
+	case false:
+		resourceSchema, diags := s.FrameworkServer.ResourceSchema(ctx, protoReq.TypeName)
+		allDiags.Append(diags...)
+		if diags.HasError() {
+			return ListRequestErrorDiagnostics(ctx, allDiags...)
+		}
 
-	identitySchema, diags := s.FrameworkServer.ResourceIdentitySchema(ctx, protoReq.TypeName)
-	allDiags.Append(diags...)
-	if diags.HasError() {
-		return ListRequestErrorDiagnostics(ctx, allDiags...)
-	}
+		identitySchema, diags := s.FrameworkServer.ResourceIdentitySchema(ctx, protoReq.TypeName)
+		allDiags.Append(diags...)
+		if diags.HasError() {
+			return ListRequestErrorDiagnostics(ctx, allDiags...)
+		}
 
-	req := &fwserver.ListRequest{
-		Config:                 config,
-		ListResource:           listResource,
-		ResourceSchema:         resourceSchema,
-		ResourceIdentitySchema: identitySchema,
-		IncludeResource:        protoReq.IncludeResource,
-	}
-	stream := &fwserver.ListResultsStream{}
+		req := &fwserver.ListRequest{
+			Config:                 config,
+			ListResource:           listResource,
+			ResourceSchema:         resourceSchema,
+			ResourceIdentitySchema: identitySchema,
+			IncludeResource:        protoReq.IncludeResource,
+		}
+		stream := &fwserver.ListResultsStream{}
 
-	err := s.FrameworkServer.ListResource(ctx, req, stream)
-	if err != nil {
-		return protoStream, err
-	}
+		err := s.FrameworkServer.ListResource(ctx, req, stream)
+		if err != nil {
+			return protoStream, err
+		}
 
-	protoStream.Results = func(push func(tfprotov5.ListResourceResult) bool) {
-		for result := range stream.Results {
-			var protoResult tfprotov5.ListResourceResult
-			if req.IncludeResource {
-				protoResult = toproto5.ListResourceResultWithResource(ctx, &result)
-			} else {
-				protoResult = toproto5.ListResourceResult(ctx, &result)
-			}
+		protoStream.Results = func(push func(tfprotov5.ListResourceResult) bool) {
+			for result := range stream.Results {
+				var protoResult tfprotov5.ListResourceResult
+				if req.IncludeResource {
+					protoResult = toproto5.ListResourceResultWithResource(ctx, &result)
+				} else {
+					protoResult = toproto5.ListResourceResult(ctx, &result)
+				}
 
-			if !push(protoResult) {
-				return
+				if !push(protoResult) {
+					return
+				}
 			}
 		}
 	}

internal/proto5server/server_listresource_test.go

@@ -282,10 +282,6 @@ func TestServerListResource(t *testing.T) {
 	}
 }
 
-type SDKContext string
-
-var SDKResource SDKContext = "sdk_resource"
-
 // a resource type defined in SDKv2
 var sdkResource sdk.Resource = sdk.Resource{
 	Schema: map[string]*sdk.Schema{
@@ -328,8 +324,10 @@ func TestServerListResourceProto5ToProto5(t *testing.T) {
 	aServer := server(listResource)
 
 	ctx := context.Background()
-	ctx = context.WithValue(ctx, SDKResource, sdkResource)
-	req := &tfprotov5.ListResourceRequest{}
+	ctx = NewContextWithSDKResource(ctx, &sdkResource)
+	req := &tfprotov5.ListResourceRequest{
+		TypeName: "test_resource",
+	}
 
 	stream, err := aServer.ListResource(ctx, req)
 	if err != nil {
@@ -346,6 +344,10 @@ func TestServerListResourceProto5ToProto5(t *testing.T) {
 		}
 	}
 
+	if len(values) == 0 {
+		t.Fatalf("expected 1 list result; got 0 list results")
+	}
+
 	// 2: from the resource type, we can obtain an initialized ResourceData value
 	d := sdkResource.Data(&terraformsdk.InstanceState{ID: "#groot"})