tidy

Author: bbasata

internal/fwserver/server_listresource.go

@@ -5,6 +5,7 @@ package fwserver
 
 import (
 	"context"
+	"fmt"
 	"iter"
 
 	"github.com/hashicorp/terraform-plugin-framework/diag"
@@ -22,8 +23,7 @@ type ListRequest struct {
 
 	// Config is the configuration the user supplied for listing resource
 	// instances.
-	Config tfsdk.Config
-	// TODO: Config *tfsdk.Config
+	Config *tfsdk.Config
 
 	// IncludeResource indicates whether the provider should populate the
 	// Resource field in the ListResult struct.
@@ -75,8 +75,12 @@ type ListResult struct {
 func (s *Server) ListResource(ctx context.Context, fwReq *ListRequest, fwStream *ListResultsStream) error {
 	listResource := fwReq.ListResource
 
+	if fwReq.Config == nil {
+		return fmt.Errorf("request config is nil") // TODO: nicer error
+	}
+
 	req := list.ListRequest{
-		Config:                 fwReq.Config,
+		Config:                 *fwReq.Config,
 		IncludeResource:        fwReq.IncludeResource,
 		ResourceSchema:         fwReq.ResourceSchema,
 		ResourceIdentitySchema: fwReq.ResourceIdentitySchema,
@@ -110,7 +114,7 @@ func processListResults(req list.ListRequest, stream iter.Seq[list.ListResult])
 // processListResult validates the content of a list.ListResult and returns a
 // ListResult
 func processListResult(req list.ListRequest, result list.ListResult) ListResult {
-	if !result.Diagnostics.HasError() && result.Identity == nil { // TODO: write a test
+	if !result.Diagnostics.HasError() && result.Identity == nil {
 		return ListResult{
 			Diagnostics: diag.Diagnostics{
 				diag.NewErrorDiagnostic(
@@ -121,7 +125,7 @@ func processListResult(req list.ListRequest, result list.ListResult) ListResult
 		}
 	}
 
-	if !result.Diagnostics.HasError() && req.IncludeResource && result.Resource == nil { // TODO: write a test
+	if !result.Diagnostics.HasError() && req.IncludeResource && result.Resource == nil {
 		result.Diagnostics.AddWarning(
 			"Incomplete List Result",
 			"The provider did not populate the Resource field in the ListResourceResult. This may be due to the provider not supporting this functionality or an error in the provider's implementation.",

internal/fwserver/server_listresource_test.go

@@ -81,6 +81,7 @@ func TestServerListResource(t *testing.T) {
 				Provider: &testprovider.Provider{},
 			},
 			request: &fwserver.ListRequest{
+				Config: &tfsdk.Config{},
 				ListResource: &testprovider.ListResource{
 					ListMethod: func(ctx context.Context, req list.ListRequest, resp *list.ListResultsStream) { // TODO
 						resp.Results = list.NoListResults
@@ -94,6 +95,7 @@ func TestServerListResource(t *testing.T) {
 				Provider: &testprovider.Provider{},
 			},
 			request: &fwserver.ListRequest{
+				Config: &tfsdk.Config{},
 				ListResource: &testprovider.ListResource{
 					ListMethod: func(ctx context.Context, req list.ListRequest, resp *list.ListResultsStream) { // TODO
 						// Do nothing, so that resp.Results is nil
@@ -107,6 +109,7 @@ func TestServerListResource(t *testing.T) {
 				Provider: &testprovider.Provider{},
 			},
 			request: &fwserver.ListRequest{
+				Config: &tfsdk.Config{},
 				ListResource: &testprovider.ListResource{
 					ListMethod: func(ctx context.Context, req list.ListRequest, resp *list.ListResultsStream) { // TODO
 						resp.Results = slices.Values([]list.ListResult{
@@ -170,6 +173,7 @@ func TestServerListResource(t *testing.T) {
 				Provider: &testprovider.Provider{},
 			},
 			request: &fwserver.ListRequest{
+				Config: &tfsdk.Config{},
 				ListResource: &testprovider.ListResource{
 					ListMethod: func(ctx context.Context, req list.ListRequest, resp *list.ListResultsStream) { // TODO
 						resp.Results = slices.Values([]list.ListResult{
@@ -201,6 +205,7 @@ func TestServerListResource(t *testing.T) {
 				Provider: &testprovider.Provider{},
 			},
 			request: &fwserver.ListRequest{
+				Config:          &tfsdk.Config{},
 				IncludeResource: true,
 				ListResource: &testprovider.ListResource{
 					ListMethod: func(ctx context.Context, req list.ListRequest, resp *list.ListResultsStream) {

internal/proto5server/server_listresource.go

@@ -44,7 +44,7 @@ func (s *Server) ListResource(ctx context.Context, proto5Req *tfprotov5.ListReso
 
 	req := &fwserver.ListRequest{
 		ListResource:           listResource,
-		Config:                 *config, // TODO: mayBe // this can explode with null input btW
+		Config:                 config,
 		IncludeResource:        proto5Req.IncludeResource,
 		ResourceSchema:         resourceSchema,
 		ResourceIdentitySchema: resourceIdentitySchema,

internal/proto6server/server_listresource.go

@@ -39,7 +39,7 @@ func (s *Server) ListResource(ctx context.Context, proto6Req *tfprotov6.ListReso
 	}
 
 	req := &fwserver.ListRequest{
-		Config:                 *config,
+		Config:                 config,
 		ListResource:           listResource,
 		ResourceSchema:         resourceSchema,
 		ResourceIdentitySchema: identitySchema,

internal/proto6server/server_listresource_test.go

@@ -122,11 +122,7 @@ func TestServerListResource(t *testing.T) {
 		}
 
 		r.ListMethod = func(ctx context.Context, req list.ListRequest, resp *list.ListResultsStream) {
-			result := req.ToResult(
-				ctx,
-				resources["plateau"].ThingResourceIdentity,
-				nil,
-				"plateau")
+			result := req.ToResult(ctx, resources["plateau"].ThingResourceIdentity, nil, "plateau")
 
 			resp.Results = slices.Values([]list.ListResult{result})
 		}