Skip to content

fwserver: add list resources to GetProviderSchema #1152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 5, 2025
Merged

fwserver: add list resources to GetProviderSchema #1152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7a0dfb3
fwserver: add list resources to GetMetadata
bbasata May 30, 2025
7691bb8
fwserver: add list resources to GetProviderSchema
bbasata Jun 2, 2025
2e16310
Merge branch 'main' into add-list-to-fwserver-part-ii
bbasata Jun 5, 2025
c4204ce
tidy: remove list.Schema.Version
bbasata Jun 5, 2025
ee50ee7
tidy: consistent comments
bbasata Jun 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions internal/fwserver/server_getmetadata.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,8 @@ func (s *Server) GetMetadata(ctx context.Context, req *GetMetadataRequest, resp
resp.Diagnostics.Append(diags...)

// Metadata for list resources must be retrieved after metadata for managed
// resources. Server.ListResourceMetadatas checks that each list resource
// type nane matches a known managed Resource type name.
// resources. Server.ListResourceFuncs checks that each list resource type
// name matches a known managed resource type name.
listResourceMetadatas, diags := s.ListResourceMetadatas(ctx)
resp.Diagnostics.Append(diags...)

Expand Down
29 changes: 11 additions & 18 deletions internal/fwserver/server_getproviderschema.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ type GetProviderSchemaResponse struct {
DataSourceSchemas map[string]fwschema.Schema
EphemeralResourceSchemas map[string]fwschema.Schema
FunctionDefinitions map[string]function.Definition
ListResourceSchemas map[string]fwschema.Schema
Diagnostics diag.Diagnostics
}

Expand All @@ -33,62 +34,54 @@ func (s *Server) GetProviderSchema(ctx context.Context, req *GetProviderSchemaRe
resp.ServerCapabilities = s.ServerCapabilities()

providerSchema, diags := s.ProviderSchema(ctx)

resp.Diagnostics.Append(diags...)

if diags.HasError() {
return
}

resp.Provider = providerSchema

providerMetaSchema, diags := s.ProviderMetaSchema(ctx)

resp.Diagnostics.Append(diags...)

if diags.HasError() {
return
}

resp.ProviderMeta = providerMetaSchema

resourceSchemas, diags := s.ResourceSchemas(ctx)

resp.Diagnostics.Append(diags...)

if resp.Diagnostics.HasError() {
return
}

resp.ResourceSchemas = resourceSchemas

dataSourceSchemas, diags := s.DataSourceSchemas(ctx)

resp.Diagnostics.Append(diags...)

if resp.Diagnostics.HasError() {
return
}

resp.DataSourceSchemas = dataSourceSchemas

functions, diags := s.FunctionDefinitions(ctx)

resp.Diagnostics.Append(diags...)

if resp.Diagnostics.HasError() {
return
}

resp.FunctionDefinitions = functions

ephemeralResourceSchemas, diags := s.EphemeralResourceSchemas(ctx)

resp.Diagnostics.Append(diags...)

if resp.Diagnostics.HasError() {
return
}

resp.EphemeralResourceSchemas = ephemeralResourceSchemas

// Schemas for list resources must be retrieved after schemas for managed
// resources. Server.ListResourceFuncs checks that each list resource type
// name matches a known managed resource type name.
listResourceSchemas, diags := s.ListResourceSchemas(ctx)
resp.Diagnostics.Append(diags...)
if resp.Diagnostics.HasError() {
return
}
resp.ListResourceSchemas = listResourceSchemas
}
168 changes: 166 additions & 2 deletions internal/fwserver/server_getproviderschema_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ import (
"github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
"github.com/hashicorp/terraform-plugin-framework/internal/fwserver"
"github.com/hashicorp/terraform-plugin-framework/internal/testing/testprovider"
"github.com/hashicorp/terraform-plugin-framework/list"
listschema "github.com/hashicorp/terraform-plugin-framework/list/schema"
"github.com/hashicorp/terraform-plugin-framework/provider"
"github.com/hashicorp/terraform-plugin-framework/provider/metaschema"
providerschema "github.com/hashicorp/terraform-plugin-framework/provider/schema"
Expand All @@ -41,6 +43,7 @@ func TestServerGetProviderSchema(t *testing.T) {
DataSourceSchemas: map[string]fwschema.Schema{},
EphemeralResourceSchemas: map[string]fwschema.Schema{},
FunctionDefinitions: map[string]function.Definition{},
ListResourceSchemas: map[string]fwschema.Schema{},
Provider: providerschema.Schema{},
ResourceSchemas: map[string]fwschema.Schema{},
ServerCapabilities: &fwserver.ServerCapabilities{
Expand Down Expand Up @@ -111,6 +114,7 @@ func TestServerGetProviderSchema(t *testing.T) {
},
EphemeralResourceSchemas: map[string]fwschema.Schema{},
FunctionDefinitions: map[string]function.Definition{},
ListResourceSchemas: map[string]fwschema.Schema{},
Provider: providerschema.Schema{},
ResourceSchemas: map[string]fwschema.Schema{},
ServerCapabilities: &fwserver.ServerCapabilities{
Expand Down Expand Up @@ -318,6 +322,7 @@ func TestServerGetProviderSchema(t *testing.T) {
},
EphemeralResourceSchemas: map[string]fwschema.Schema{},
FunctionDefinitions: map[string]function.Definition{},
ListResourceSchemas: map[string]fwschema.Schema{},
Provider: providerschema.Schema{},
ResourceSchemas: map[string]fwschema.Schema{},
ServerCapabilities: &fwserver.ServerCapabilities{
Expand Down Expand Up @@ -388,6 +393,7 @@ func TestServerGetProviderSchema(t *testing.T) {
},
},
FunctionDefinitions: map[string]function.Definition{},
ListResourceSchemas: map[string]fwschema.Schema{},
Provider: providerschema.Schema{},
ResourceSchemas: map[string]fwschema.Schema{},
ServerCapabilities: &fwserver.ServerCapabilities{
Expand Down Expand Up @@ -601,6 +607,7 @@ func TestServerGetProviderSchema(t *testing.T) {
},
},
FunctionDefinitions: map[string]function.Definition{},
ListResourceSchemas: map[string]fwschema.Schema{},
Provider: providerschema.Schema{},
ResourceSchemas: map[string]fwschema.Schema{},
ServerCapabilities: &fwserver.ServerCapabilities{
Expand Down Expand Up @@ -655,8 +662,9 @@ func TestServerGetProviderSchema(t *testing.T) {
Return: function.StringReturn{},
},
},
Provider: providerschema.Schema{},
ResourceSchemas: map[string]fwschema.Schema{},
ListResourceSchemas: map[string]fwschema.Schema{},
Provider: providerschema.Schema{},
ResourceSchemas: map[string]fwschema.Schema{},
ServerCapabilities: &fwserver.ServerCapabilities{
GetProviderSchemaOptional: true,
MoveResourceState: true,
Expand Down Expand Up @@ -808,6 +816,158 @@ func TestServerGetProviderSchema(t *testing.T) {
},
},
},
"listresource-schemas": {
server: &fwserver.Server{
Provider: &testprovider.Provider{
ListResourcesMethod: func(_ context.Context) []func() list.ListResource {
return []func() list.ListResource{
func() list.ListResource {
return &testprovider.ListResource{
ListResourceConfigSchemaMethod: func(_ context.Context, _ list.ListResourceSchemaRequest, resp *list.ListResourceSchemaResponse) {
resp.Schema = listschema.Schema{
Attributes: map[string]listschema.Attribute{
"test1": listschema.StringAttribute{
Required: true,
},
},
}
},
MetadataMethod: func(_ context.Context, _ resource.MetadataRequest, resp *resource.MetadataResponse) {
resp.TypeName = "test_resource"
},
}
},
}
},
ResourcesMethod: func(_ context.Context) []func() resource.Resource {
return []func() resource.Resource{
func() resource.Resource {
return &testprovider.Resource{
SchemaMethod: func(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
resp.Schema = resourceschema.Schema{
Attributes: map[string]resourceschema.Attribute{
"test1": resourceschema.StringAttribute{
Required: true,
},
},
}
},
MetadataMethod: func(_ context.Context, _ resource.MetadataRequest, resp *resource.MetadataResponse) {
resp.TypeName = "test_resource"
},
}
},
}
},
},
},
request: &fwserver.GetProviderSchemaRequest{},
expectedResponse: &fwserver.GetProviderSchemaResponse{
DataSourceSchemas: map[string]fwschema.Schema{},
EphemeralResourceSchemas: map[string]fwschema.Schema{},
FunctionDefinitions: map[string]function.Definition{},
ListResourceSchemas: map[string]fwschema.Schema{
"test_resource": listschema.Schema{
Attributes: map[string]listschema.Attribute{
"test1": listschema.StringAttribute{
Required: true,
},
},
},
},
Provider: providerschema.Schema{},
ResourceSchemas: map[string]fwschema.Schema{
"test_resource": resourceschema.Schema{
Attributes: map[string]resourceschema.Attribute{
"test1": resourceschema.StringAttribute{
Required: true,
},
},
},
},
ServerCapabilities: &fwserver.ServerCapabilities{
GetProviderSchemaOptional: true,
MoveResourceState: true,
PlanDestroy: true,
},
},
},
"listresource-schemas-invalid-attribute-name": {
server: &fwserver.Server{
Provider: &testprovider.Provider{
ListResourcesMethod: func(_ context.Context) []func() list.ListResource {
return []func() list.ListResource{
func() list.ListResource {
return &testprovider.ListResource{
ListResourceConfigSchemaMethod: func(_ context.Context, _ list.ListResourceSchemaRequest, resp *list.ListResourceSchemaResponse) {
resp.Schema = listschema.Schema{
Attributes: map[string]listschema.Attribute{
"$filter": listschema.StringAttribute{
Required: true,
},
},
}
},
MetadataMethod: func(_ context.Context, _ resource.MetadataRequest, resp *resource.MetadataResponse) {
resp.TypeName = "test_resource"
},
}
},
}
},
ResourcesMethod: func(_ context.Context) []func() resource.Resource {
return []func() resource.Resource{
func() resource.Resource {
return &testprovider.Resource{
SchemaMethod: func(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
resp.Schema = resourceschema.Schema{
Attributes: map[string]resourceschema.Attribute{
"name": resourceschema.StringAttribute{
Required: true,
},
},
}
},
MetadataMethod: func(_ context.Context, _ resource.MetadataRequest, resp *resource.MetadataResponse) {
resp.TypeName = "test_resource"
},
}
},
}
},
},
},
request: &fwserver.GetProviderSchemaRequest{},
expectedResponse: &fwserver.GetProviderSchemaResponse{
Provider: providerschema.Schema{},
DataSourceSchemas: map[string]fwschema.Schema{},
EphemeralResourceSchemas: map[string]fwschema.Schema{},
FunctionDefinitions: map[string]function.Definition{},
ResourceSchemas: map[string]fwschema.Schema{
"test_resource": resourceschema.Schema{
Attributes: map[string]resourceschema.Attribute{
"name": resourceschema.StringAttribute{
Required: true,
},
},
},
},
ServerCapabilities: &fwserver.ServerCapabilities{
GetProviderSchemaOptional: true,
MoveResourceState: true,
PlanDestroy: true,
},
Diagnostics: diag.Diagnostics{
diag.NewErrorDiagnostic(
"Invalid Attribute/Block Name",
"When validating the schema, an implementation issue was found. "+
"This is always an issue with the provider and should be reported to the provider developers.\n\n"+
"\"$filter\" at schema path \"$filter\" is an invalid attribute/block name. "+
"Names must only contain lowercase alphanumeric characters (a-z, 0-9) and underscores (_).",
),
},
},
},
"provider": {
server: &fwserver.Server{
Provider: &testprovider.Provider{
Expand All @@ -827,6 +987,7 @@ func TestServerGetProviderSchema(t *testing.T) {
DataSourceSchemas: map[string]fwschema.Schema{},
EphemeralResourceSchemas: map[string]fwschema.Schema{},
FunctionDefinitions: map[string]function.Definition{},
ListResourceSchemas: map[string]fwschema.Schema{},
Provider: providerschema.Schema{
Attributes: map[string]providerschema.Attribute{
"test": providerschema.StringAttribute{
Expand Down Expand Up @@ -894,6 +1055,7 @@ func TestServerGetProviderSchema(t *testing.T) {
DataSourceSchemas: map[string]fwschema.Schema{},
EphemeralResourceSchemas: map[string]fwschema.Schema{},
FunctionDefinitions: map[string]function.Definition{},
ListResourceSchemas: map[string]fwschema.Schema{},
Provider: providerschema.Schema{},
ProviderMeta: metaschema.Schema{
Attributes: map[string]metaschema.Attribute{
Expand Down Expand Up @@ -990,6 +1152,7 @@ func TestServerGetProviderSchema(t *testing.T) {
DataSourceSchemas: map[string]fwschema.Schema{},
EphemeralResourceSchemas: map[string]fwschema.Schema{},
FunctionDefinitions: map[string]function.Definition{},
ListResourceSchemas: map[string]fwschema.Schema{},
Provider: providerschema.Schema{},
ResourceSchemas: map[string]fwschema.Schema{
"test_resource1": resourceschema.Schema{
Expand Down Expand Up @@ -1203,6 +1366,7 @@ func TestServerGetProviderSchema(t *testing.T) {
DataSourceSchemas: map[string]fwschema.Schema{},
EphemeralResourceSchemas: map[string]fwschema.Schema{},
FunctionDefinitions: map[string]function.Definition{},
ListResourceSchemas: map[string]fwschema.Schema{},
Provider: providerschema.Schema{},
ResourceSchemas: map[string]fwschema.Schema{
"testprovidertype_resource": resourceschema.Schema{
Expand Down
Loading
Loading