fixup! fixup! Check that a ListResource type has a matching Resource type

Author: bbasata

internal/testing/testprovider/list_resource.go

@@ -0,0 +1,47 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package testprovider
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-framework/list"
+	"github.com/hashicorp/terraform-plugin-framework/resource"
+)
+
+var _ list.ListResource = &ListResource{}
+
+// Declarative list.ListResource for unit testing.
+type ListResource struct {
+	// ListResource interface methods
+	MetadataMethod                 func(context.Context, resource.MetadataRequest, *resource.MetadataResponse)
+	ListResourceConfigSchemaMethod func(context.Context, list.ListResourceSchemaRequest, *list.ListResourceSchemaResponse)
+	ListResourceMethod             func(context.Context, list.ListResourceRequest, *list.ListResourceResponse)
+}
+
+// Metadata satisfies the list.ListResource interface.
+func (r *ListResource) Metadata(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
+	if r.MetadataMethod == nil {
+		return
+	}
+
+	r.MetadataMethod(ctx, req, resp)
+}
+
+// ListResourceConfigSchema satisfies the list.ListResource interface.
+func (r *ListResource) ListResourceConfigSchema(ctx context.Context, req list.ListResourceSchemaRequest, resp *list.ListResourceSchemaResponse) {
+	if r.ListResourceConfigSchemaMethod == nil {
+		return
+	}
+
+	r.ListResourceConfigSchemaMethod(ctx, req, resp)
+}
+
+// ListResource satisfies the list.ListResource interface.
+func (r *ListResource) ListResource(ctx context.Context, req list.ListResourceRequest, resp *list.ListResourceResponse) {
+	if r.ListResourceMethod == nil {
+		return
+	}
+	r.ListResourceMethod(ctx, req, resp)
+}

internal/testing/testprovider/resource.go

@@ -6,42 +6,72 @@ package testprovider
 import (
 	"context"
 
-	"github.com/hashicorp/terraform-plugin-framework/list"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 )
 
-var _ list.ListResource = &ListResource{}
+var _ resource.Resource = &Resource{}
 
-// Declarative list.ListResource for unit testing.
-type ListResource struct {
-	// ListResource interface methods
-	MetadataMethod                 func(context.Context, resource.MetadataRequest, *resource.MetadataResponse)
-	ListResourceConfigSchemaMethod func(context.Context, resource.SchemaRequest, *resource.SchemaResponse)
-	ListResourceMethod             func(context.Context, list.ListResourceRequest, *list.ListResourceResponse)
+// Declarative resource.Resource for unit testing.
+type Resource struct {
+	// Resource interface methods
+	MetadataMethod func(context.Context, resource.MetadataRequest, *resource.MetadataResponse)
+	SchemaMethod   func(context.Context, resource.SchemaRequest, *resource.SchemaResponse)
+	CreateMethod   func(context.Context, resource.CreateRequest, *resource.CreateResponse)
+	DeleteMethod   func(context.Context, resource.DeleteRequest, *resource.DeleteResponse)
+	ReadMethod     func(context.Context, resource.ReadRequest, *resource.ReadResponse)
+	UpdateMethod   func(context.Context, resource.UpdateRequest, *resource.UpdateResponse)
 }
 
-// Metadata satisfies the list.ListResource interface.
-func (r *ListResource) Metadata(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
+// Metadata satisfies the resource.Resource interface.
+func (r *Resource) Metadata(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
 	if r.MetadataMethod == nil {
 		return
 	}
 
 	r.MetadataMethod(ctx, req, resp)
 }
 
-// ListResourceConfigSchema satisfies the list.ListResource interface.
-func (r *ListResource) ListResourceConfigSchema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) {
-	if r.ListResourceConfigSchemaMethod == nil {
+// Schema satisfies the resource.Resource interface.
+func (r *Resource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) {
+	if r.SchemaMethod == nil {
 		return
 	}
 
-	r.ListResourceConfigSchemaMethod(ctx, req, resp)
+	r.SchemaMethod(ctx, req, resp)
 }
 
-// ListResource satisfies the list.ListResource interface.
-func (r *ListResource) ListResource(ctx context.Context, req list.ListResourceRequest, resp *list.ListResourceResponse) {
-	if r.ListResourceMethod == nil {
+// Create satisfies the resource.Resource interface.
+func (r *Resource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse) {
+	if r.CreateMethod == nil {
 		return
 	}
-	r.ListResourceMethod(ctx, req, resp)
+
+	r.CreateMethod(ctx, req, resp)
+}
+
+// Delete satisfies the resource.Resource interface.
+func (r *Resource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse) {
+	if r.DeleteMethod == nil {
+		return
+	}
+
+	r.DeleteMethod(ctx, req, resp)
+}
+
+// Read satisfies the resource.Resource interface.
+func (r *Resource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) {
+	if r.ReadMethod == nil {
+		return
+	}
+
+	r.ReadMethod(ctx, req, resp)
+}
+
+// Update satisfies the resource.Resource interface.
+func (r *Resource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) {
+	if r.UpdateMethod == nil {
+		return
+	}
+
+	r.UpdateMethod(ctx, req, resp)
 }

list/list_resource.go

@@ -26,7 +26,7 @@ type ListResource interface {
 	Metadata(context.Context, resource.MetadataRequest, *resource.MetadataResponse)
 
 	// ListConfigSchema should return the schema for list blocks.
-	ListResourceConfigSchema(context.Context, resource.SchemaRequest, *resource.SchemaResponse) // TODO: list.Schema{Request,Response}
+	ListResourceConfigSchema(context.Context, ListResourceSchemaRequest, *ListResourceSchemaResponse)
 
 	// ListResource is called when the provider must list instances of a
 	// managed resource type that satisfy a user-provided request.

list/list_resource_test.go

@@ -24,7 +24,7 @@ type ComputeInstanceWithListResourceConfigValidators struct {
 func (c *ComputeInstance) Configure(_ context.Context, _ resource.ConfigureRequest, _ *resource.ConfigureResponse) {
 }
 
-func (c *ComputeInstance) ListResourceConfigSchema(_ context.Context, _ resource.SchemaRequest, _ *resource.SchemaResponse) {
+func (c *ComputeInstance) ListResourceConfigSchema(_ context.Context, _ list.ListResourceSchemaRequest, _ *list.ListResourceSchemaResponse) {
 }
 
 func (c *ComputeInstance) ListResource(_ context.Context, _ list.ListResourceRequest, _ *list.ListResourceResponse) {

list/schema.go

@@ -0,0 +1,24 @@
+package list
+
+import (
+	"github.com/hashicorp/terraform-plugin-framework/diag"
+	"github.com/hashicorp/terraform-plugin-framework/provider/schema"
+)
+
+// ListResourceSchemaRequest represents a request for the ListResource to
+// return its schema.  An instance of this request struct is supplied as an
+// argument to the ListResource type ListResourceSchema method.
+type ListResourceSchemaRequest struct{}
+
+// ListResourceSchemaResponse represents a response to a
+// ListResourceSchemaRequest. An instance of this response struct is supplied
+// as an argument to the ListResource type ListResourceResourceSchema method.
+type ListResourceSchemaResponse struct {
+	// Schema is the schema of the list resource.
+	Schema schema.Schema
+
+	// Diagnostics report errors or warnings related to retrieving the list
+	// resource schema. An empty slice indicates success, with no warnings
+	// or errors generated.
+	Diagnostics diag.Diagnostics
+}

list/schema/schema.go

@@ -0,0 +1,4 @@
+package schema
+
+type Schema struct {
+}