Update get provider schema to include state store information (#36834)

* Update `GetProviderSchema` in .proto files to include state store schemas

* make protobuf

* Update GetProviderSchemaResponse struct

* `terraform` provider reports it has no state stores

* Update grpcwrap

* Uncertain TODO comments

* Apply suggestions from code review

Co-authored-by: Radek Simko <[email protected]>

* Update to StateStoreSchemas

* make protobuf

* Update to "StateStoreSchemas"

* Add ephemeral resource and state store processing to protocol 5 grpcwrap

* fix name in comment

---------

Co-authored-by: Radek Simko <[email protected]>
Co-authored-by: Radek Simko <[email protected]>

Author: SarahFrench

docs/plugin-protocol/tfplugin5.10.proto

@@ -412,6 +412,7 @@ message GetProviderSchema {
         map<string, Schema> data_source_schemas = 3;
         map<string, Function> functions = 7;
         map<string, Schema> ephemeral_resource_schemas = 8;
+        map<string, Schema> state_store_schemas = 9;
         repeated Diagnostic diagnostics = 4;
         Schema provider_meta = 5;
         ServerCapabilities server_capabilities = 6;

docs/plugin-protocol/tfplugin6.10.proto

@@ -430,6 +430,7 @@ message GetProviderSchema {
         map<string, Schema> data_source_schemas = 3;
         map<string, Function> functions = 7;
         map<string, Schema> ephemeral_resource_schemas = 8;
+        map<string, Schema> state_store_schemas = 9;
         repeated Diagnostic diagnostics = 4;
         Schema provider_meta = 5;
         ServerCapabilities server_capabilities = 6;

internal/builtin/providers/terraform/provider.go

@@ -72,6 +72,7 @@ func (p *Provider) GetProviderSchema() providers.GetProviderSchemaResponse {
 				ReturnType: cty.String,
 			},
 		},
+		StateStoreSchemas: map[string]providers.Schema{},
 	}
 	providers.SchemaCache.Set(tfaddr.NewProvider(tfaddr.BuiltInProviderHost, tfaddr.BuiltInProviderNamespace, "terraform"), resp)
 	return resp

internal/command/testing/test_provider.go

@@ -90,6 +90,7 @@ var (
 				ReturnType: cty.Bool,
 			},
 		},
+		// TODO - add a State Stores map here?
 	}
 )
 

internal/grpcwrap/provider.go

@@ -45,6 +45,7 @@ func (p *provider) GetSchema(_ context.Context, req *tfplugin5.GetProviderSchema
 		ResourceSchemas:          make(map[string]*tfplugin5.Schema),
 		DataSourceSchemas:        make(map[string]*tfplugin5.Schema),
 		EphemeralResourceSchemas: make(map[string]*tfplugin5.Schema),
+		StateStoreSchemas:        make(map[string]*tfplugin5.Schema),
 	}
 
 	resp.Provider = &tfplugin5.Schema{
@@ -79,6 +80,12 @@ func (p *provider) GetSchema(_ context.Context, req *tfplugin5.GetProviderSchema
 			Block:   convert.ConfigSchemaToProto(dat.Body),
 		}
 	}
+	for typ, dat := range p.schema.StateStoreSchemas {
+		resp.StateStoreSchemas[typ] = &tfplugin5.Schema{
+			Version: int64(dat.Version),
+			Block:   convert.ConfigSchemaToProto(dat.Body),
+		}
+	}
 	if decls, err := convert.FunctionDeclsToProto(p.schema.Functions); err == nil {
 		resp.Functions = decls
 	} else {

internal/grpcwrap/provider6.go

@@ -47,6 +47,7 @@ func (p *provider6) GetProviderSchema(_ context.Context, req *tfplugin6.GetProvi
 		DataSourceSchemas:        make(map[string]*tfplugin6.Schema),
 		EphemeralResourceSchemas: make(map[string]*tfplugin6.Schema),
 		Functions:                make(map[string]*tfplugin6.Function),
+		StateStoreSchemas:        make(map[string]*tfplugin6.Schema),
 	}
 
 	resp.Provider = &tfplugin6.Schema{
@@ -81,6 +82,12 @@ func (p *provider6) GetProviderSchema(_ context.Context, req *tfplugin6.GetProvi
 			Block:   convert.ConfigSchemaToProto(dat.Body),
 		}
 	}
+	for typ, dat := range p.schema.StateStoreSchemas {
+		resp.StateStoreSchemas[typ] = &tfplugin6.Schema{
+			Version: int64(dat.Version),
+			Block:   convert.ConfigSchemaToProto(dat.Body),
+		}
+	}
 	if decls, err := convert.FunctionDeclsToProto(p.schema.Functions); err == nil {
 		resp.Functions = decls
 	} else {

internal/providers/provider.go

@@ -142,9 +142,8 @@ type GetProviderSchemaResponse struct {
 	// prefix) to the declaration of a function.
 	Functions map[string]FunctionDecl
 
-	// TODO
-	// Backends maps the backend type name to that type's schema.
-	// Backends map[string]Schema
+	// StateStoreSchemas maps the backend type name to that type's schema.
+	StateStoreSchemas map[string]Schema
 
 	// Diagnostics contains any warnings or errors from the method call.
 	Diagnostics tfdiags.Diagnostics

internal/providers/testing/provider_mock.go

@@ -149,6 +149,7 @@ func (p *MockProvider) getProviderSchema() providers.GetProviderSchemaResponse {
 		Provider:      providers.Schema{},
 		DataSources:   map[string]providers.Schema{},
 		ResourceTypes: map[string]providers.Schema{},
+		// TODO - any update needed here?
 	}
 }
 

internal/stacks/stackruntime/testing/provider.go

@@ -210,6 +210,7 @@ func NewProviderWithData(t *testing.T, store *ResourceStore) *MockProvider {
 				ServerCapabilities: providers.ServerCapabilities{
 					MoveResourceState: true,
 				},
+				// TODO - state store here?
 			},
 			PlanResourceChangeFn: func(request providers.PlanResourceChangeRequest) providers.PlanResourceChangeResponse {
 				return getResource(request.TypeName).Plan(request, store)