Skip to content
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

Jump to bottom

resource/schema: Initial package #558

Merged
merged 5 commits into from Nov 29, 2022
Merged

resource/schema: Initial package #558

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
00e2251
resource/schema/planmodifier: New type-specific plan modifiers package
bflad Nov 29, 2022
f5ab529
Update CHANGELOG for #557
bflad Nov 29, 2022
782d611
resource/schema: Initial package
bflad Nov 29, 2022
6d9b1d8
Merge branch 'main' into bflad/resource-schema-package
bflad Nov 29, 2022
6e00938
Update CHANGELOG for #558
bflad Nov 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changelog/558.txt
View file
Open in desktop
@@ -0,0 +1,7 @@
```release-note:note
resource: The `Resource` type `GetSchema` method has been deprecated. Use the `Schema` method instead.
```

```release-note:feature
resource/schema: New package which contains schema interfaces and types relevant to resources
```
41 changes: 33 additions & 8 deletions internal/fwserver/server.go
View file
Open in desktop
Expand Up @@ -452,17 +452,42 @@ func (s *Server) ResourceSchemas(ctx context.Context) (map[string]fwschema.Schem
for resourceTypeName, resourceFunc := range resourceFuncs {
res := resourceFunc()

logging.FrameworkDebug(ctx, "Calling provider defined Resource GetSchema", map[string]interface{}{logging.KeyResourceType: resourceTypeName})
schema, diags := res.GetSchema(ctx)
logging.FrameworkDebug(ctx, "Called provider defined Resource GetSchema", map[string]interface{}{logging.KeyResourceType: resourceTypeName})
switch resourceIface := res.(type) {
case resource.ResourceWithSchema:
schemaReq := resource.SchemaRequest{}
schemaResp := resource.SchemaResponse{}

s.resourceSchemasDiags.Append(diags...)
logging.FrameworkDebug(ctx, "Calling provider defined Resource Schema", map[string]interface{}{logging.KeyResourceType: resourceTypeName})
resourceIface.Schema(ctx, schemaReq, &schemaResp)
logging.FrameworkDebug(ctx, "Called provider defined Resource Schema", map[string]interface{}{logging.KeyResourceType: resourceTypeName})

if s.resourceSchemasDiags.HasError() {
return s.resourceSchemas, s.resourceSchemasDiags
}
s.resourceSchemasDiags.Append(schemaResp.Diagnostics...)

if s.resourceSchemasDiags.HasError() {
return s.resourceSchemas, s.resourceSchemasDiags
}

s.resourceSchemas[resourceTypeName] = schema
s.resourceSchemas[resourceTypeName] = schemaResp.Schema
case resource.ResourceWithGetSchema:
logging.FrameworkDebug(ctx, "Calling provider defined Resource GetSchema", map[string]interface{}{logging.KeyResourceType: resourceTypeName})
schema, diags := resourceIface.GetSchema(ctx) //nolint:staticcheck // Required internal usage until removal
logging.FrameworkDebug(ctx, "Called provider defined Resource GetSchema", map[string]interface{}{logging.KeyResourceType: resourceTypeName})

s.resourceSchemasDiags.Append(diags...)

if s.resourceSchemasDiags.HasError() {
return s.resourceSchemas, s.resourceSchemasDiags
}

s.resourceSchemas[resourceTypeName] = schema
default:
s.resourceSchemasDiags.AddError(
"Resource Missing Schema",
"While attempting to load provider resource schemas, a resource was missing a Schema method. "+
"This is always an issue in the provider and should be reported to the provider developers.\n\n"+
"Resource Type Name: "+resourceTypeName,
)
}
}

return s.resourceSchemas, s.resourceSchemasDiags
Expand Down
77 changes: 35 additions & 42 deletions internal/fwserver/server_getproviderschema_test.go
View file
Open in desktop
Expand Up @@ -14,6 +14,7 @@ import (
"github.com/hashicorp/terraform-plugin-framework/provider"
providerschema "github.com/hashicorp/terraform-plugin-framework/provider/schema"
"github.com/hashicorp/terraform-plugin-framework/resource"
resourceschema "github.com/hashicorp/terraform-plugin-framework/resource/schema"
"github.com/hashicorp/terraform-plugin-framework/tfsdk"
"github.com/hashicorp/terraform-plugin-framework/types"
)
Expand Down Expand Up @@ -316,15 +317,14 @@ func TestServerGetProviderSchema(t *testing.T) {
return []func() resource.Resource{
func() resource.Resource {
return &testprovider.Resource{
GetSchemaMethod: func(_ context.Context) (tfsdk.Schema, diag.Diagnostics) {
return tfsdk.Schema{
Attributes: map[string]tfsdk.Attribute{
"test1": {
SchemaMethod: func(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
resp.Schema = resourceschema.Schema{
Attributes: map[string]resourceschema.Attribute{
"test1": resourceschema.StringAttribute{
Required: true,
Type: types.StringType,
},
},
}, nil
}
},
MetadataMethod: func(_ context.Context, _ resource.MetadataRequest, resp *resource.MetadataResponse) {
resp.TypeName = "test_resource1"
Expand All @@ -333,15 +333,14 @@ func TestServerGetProviderSchema(t *testing.T) {
},
func() resource.Resource {
return &testprovider.Resource{
GetSchemaMethod: func(_ context.Context) (tfsdk.Schema, diag.Diagnostics) {
return tfsdk.Schema{
Attributes: map[string]tfsdk.Attribute{
"test2": {
SchemaMethod: func(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
resp.Schema = resourceschema.Schema{
Attributes: map[string]resourceschema.Attribute{
"test2": resourceschema.StringAttribute{
Required: true,
Type: types.StringType,
},
},
}, nil
}
},
MetadataMethod: func(_ context.Context, _ resource.MetadataRequest, resp *resource.MetadataResponse) {
resp.TypeName = "test_resource2"
Expand All @@ -357,19 +356,17 @@ func TestServerGetProviderSchema(t *testing.T) {
DataSourceSchemas: map[string]fwschema.Schema{},
Provider: providerschema.Schema{},
ResourceSchemas: map[string]fwschema.Schema{
"test_resource1": tfsdk.Schema{
Attributes: map[string]tfsdk.Attribute{
"test1": {
"test_resource1": resourceschema.Schema{
Attributes: map[string]resourceschema.Attribute{
"test1": resourceschema.StringAttribute{
Required: true,
Type: types.StringType,
},
},
},
"test_resource2": tfsdk.Schema{
Attributes: map[string]tfsdk.Attribute{
"test2": {
"test_resource2": resourceschema.Schema{
Attributes: map[string]resourceschema.Attribute{
"test2": resourceschema.StringAttribute{
Required: true,
Type: types.StringType,
},
},
},
Expand All @@ -386,15 +383,14 @@ func TestServerGetProviderSchema(t *testing.T) {
return []func() resource.Resource{
func() resource.Resource {
return &testprovider.Resource{
GetSchemaMethod: func(_ context.Context) (tfsdk.Schema, diag.Diagnostics) {
return tfsdk.Schema{
Attributes: map[string]tfsdk.Attribute{
"test1": {
SchemaMethod: func(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
resp.Schema = resourceschema.Schema{
Attributes: map[string]resourceschema.Attribute{
"test1": resourceschema.StringAttribute{
Required: true,
Type: types.StringType,
},
},
}, nil
}
},
MetadataMethod: func(_ context.Context, _ resource.MetadataRequest, resp *resource.MetadataResponse) {
resp.TypeName = "test_resource"
Expand All @@ -403,15 +399,14 @@ func TestServerGetProviderSchema(t *testing.T) {
},
func() resource.Resource {
return &testprovider.Resource{
GetSchemaMethod: func(_ context.Context) (tfsdk.Schema, diag.Diagnostics) {
return tfsdk.Schema{
Attributes: map[string]tfsdk.Attribute{
"test2": {
SchemaMethod: func(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
resp.Schema = resourceschema.Schema{
Attributes: map[string]resourceschema.Attribute{
"test2": resourceschema.StringAttribute{
Required: true,
Type: types.StringType,
},
},
}, nil
}
},
MetadataMethod: func(_ context.Context, _ resource.MetadataRequest, resp *resource.MetadataResponse) {
resp.TypeName = "test_resource"
Expand Down Expand Up @@ -484,15 +479,14 @@ func TestServerGetProviderSchema(t *testing.T) {
return []func() resource.Resource{
func() resource.Resource {
return &testprovider.Resource{
GetSchemaMethod: func(_ context.Context) (tfsdk.Schema, diag.Diagnostics) {
return tfsdk.Schema{
Attributes: map[string]tfsdk.Attribute{
"test": {
SchemaMethod: func(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
resp.Schema = resourceschema.Schema{
Attributes: map[string]resourceschema.Attribute{
"test": resourceschema.StringAttribute{
Required: true,
Type: types.StringType,
},
},
}, nil
}
},
MetadataMethod: func(_ context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse) {
resp.TypeName = req.ProviderTypeName + "_resource"
Expand All @@ -509,11 +503,10 @@ func TestServerGetProviderSchema(t *testing.T) {
DataSourceSchemas: map[string]fwschema.Schema{},
Provider: providerschema.Schema{},
ResourceSchemas: map[string]fwschema.Schema{
"testprovidertype_resource": tfsdk.Schema{
Attributes: map[string]tfsdk.Attribute{
"test": {
"testprovidertype_resource": resourceschema.Schema{
Attributes: map[string]resourceschema.Attribute{
"test": resourceschema.StringAttribute{
Required: true,
Type: types.StringType,
},
},
},
Expand Down