Skip to content

internal: Implement fwserver ReadResource testing and update proto6server testing #360

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 2 commits into from
Jun 6, 2022
Merged

internal: Implement fwserver ReadResource testing and update proto6server testing #360

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
da8dc83
internal: Implement fwserver ReadResource testing and update proto6se…
bflad Jun 2, 2022
97b9512
Merge branch 'main' into bflad-readresource-testing
bflad Jun 6, 2022
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
227 changes: 213 additions & 14 deletions internal/fwserver/server_readresource_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,79 @@ import (
"github.com/google/go-cmp/cmp"
"github.com/hashicorp/terraform-plugin-framework/diag"
"github.com/hashicorp/terraform-plugin-framework/internal/fwserver"
"github.com/hashicorp/terraform-plugin-framework/internal/testing/emptyprovider"
"github.com/hashicorp/terraform-plugin-framework/internal/testing/testprovider"
"github.com/hashicorp/terraform-plugin-framework/tfsdk"
"github.com/hashicorp/terraform-plugin-framework/types"
"github.com/hashicorp/terraform-plugin-go/tftypes"
)

// TODO: Migrate tfsdk.Provider bits of proto6server.testProviderServer to
// new internal/testing/provider.Provider that allows customization of all
// method implementations via struct fields. Then, create additional test
// cases in this unit test.
//
// For now this testing is covered by proto6server.ReadResource.
//
// Reference: https://github.com/hashicorp/terraform-plugin-framework/issues/215
func TestServerReadResource(t *testing.T) {
t.Parallel()

testType := tftypes.Object{
AttributeTypes: map[string]tftypes.Type{
"test_computed": tftypes.String,
"test_required": tftypes.String,
},
}

testCurrentStateValue := tftypes.NewValue(testType, map[string]tftypes.Value{
"test_computed": tftypes.NewValue(tftypes.String, nil),
"test_required": tftypes.NewValue(tftypes.String, "test-currentstate-value"),
})

testNewStateValue := tftypes.NewValue(testType, map[string]tftypes.Value{
"test_computed": tftypes.NewValue(tftypes.String, "test-newstate-value"),
"test_required": tftypes.NewValue(tftypes.String, "test-currentstate-value"),
})

testSchema := tfsdk.Schema{
Attributes: map[string]tfsdk.Attribute{
"test_computed": {
Computed: true,
Type: types.StringType,
},
"test_required": {
Required: true,
Type: types.StringType,
},
},
}

testConfig := &tfsdk.Config{
Raw: testCurrentStateValue,
Schema: testSchema,
}

testCurrentState := &tfsdk.State{
Raw: testCurrentStateValue,
Schema: testSchema,
}

testNewState := &tfsdk.State{
Raw: testNewStateValue,
Schema: testSchema,
}

testNewStateRemoved := &tfsdk.State{
Raw: tftypes.NewValue(testType, nil),
Schema: testSchema,
}

testCases := map[string]struct {
server *fwserver.Server
request *fwserver.ReadResourceRequest
expectedResponse *fwserver.ReadResourceResponse
}{
"currentstate-missing": {
"nil": {
server: &fwserver.Server{
Provider: &testprovider.Provider{},
},
expectedResponse: &fwserver.ReadResourceResponse{},
},
"request-currentstate-missing": {
server: &fwserver.Server{
Provider: &emptyprovider.Provider{},
Provider: &testprovider.Provider{},
},
request: &fwserver.ReadResourceRequest{},
expectedResponse: &fwserver.ReadResourceResponse{
Expand All @@ -41,11 +92,159 @@ func TestServerReadResource(t *testing.T) {
},
},
},
"empty-provider": {
"request-currentstate": {
server: &fwserver.Server{
Provider: &emptyprovider.Provider{},
Provider: &testprovider.Provider{},
},
request: &fwserver.ReadResourceRequest{
CurrentState: testCurrentState,
ResourceType: &testprovider.ResourceType{
GetSchemaMethod: func(_ context.Context) (tfsdk.Schema, diag.Diagnostics) {
return testSchema, nil
},
NewResourceMethod: func(_ context.Context, _ tfsdk.Provider) (tfsdk.Resource, diag.Diagnostics) {
return &testprovider.Resource{
ReadMethod: func(ctx context.Context, req tfsdk.ReadResourceRequest, resp *tfsdk.ReadResourceResponse) {
var data struct {
TestComputed types.String `tfsdk:"test_computed"`
TestRequired types.String `tfsdk:"test_required"`
}

resp.Diagnostics.Append(req.State.Get(ctx, &data)...)

if data.TestRequired.Value != "test-currentstate-value" {
resp.Diagnostics.AddError("unexpected req.State value: %s", data.TestRequired.Value)
}
},
}, nil
},
},
},
expectedResponse: &fwserver.ReadResourceResponse{
NewState: testCurrentState,
},
},
"request-providermeta": {
server: &fwserver.Server{
Provider: &testprovider.Provider{},
},
request: &fwserver.ReadResourceRequest{
CurrentState: testCurrentState,
ResourceType: &testprovider.ResourceType{
GetSchemaMethod: func(_ context.Context) (tfsdk.Schema, diag.Diagnostics) {
return testSchema, nil
},
NewResourceMethod: func(_ context.Context, _ tfsdk.Provider) (tfsdk.Resource, diag.Diagnostics) {
return &testprovider.Resource{
ReadMethod: func(ctx context.Context, req tfsdk.ReadResourceRequest, resp *tfsdk.ReadResourceResponse) {
var config struct {
TestComputed types.String `tfsdk:"test_computed"`
TestRequired types.String `tfsdk:"test_required"`
}

resp.Diagnostics.Append(req.ProviderMeta.Get(ctx, &config)...)

if config.TestRequired.Value != "test-currentstate-value" {
resp.Diagnostics.AddError("unexpected req.ProviderMeta value: %s", config.TestRequired.Value)
}
},
}, nil
},
},
ProviderMeta: testConfig,
},
expectedResponse: &fwserver.ReadResourceResponse{
NewState: testCurrentState,
},
},
"response-diagnostics": {
server: &fwserver.Server{
Provider: &testprovider.Provider{},
},
request: &fwserver.ReadResourceRequest{
CurrentState: testCurrentState,
ResourceType: &testprovider.ResourceType{
GetSchemaMethod: func(_ context.Context) (tfsdk.Schema, diag.Diagnostics) {
return testSchema, nil
},
NewResourceMethod: func(_ context.Context, _ tfsdk.Provider) (tfsdk.Resource, diag.Diagnostics) {
return &testprovider.Resource{
ReadMethod: func(ctx context.Context, req tfsdk.ReadResourceRequest, resp *tfsdk.ReadResourceResponse) {
resp.Diagnostics.AddWarning("warning summary", "warning detail")
resp.Diagnostics.AddError("error summary", "error detail")
},
}, nil
},
},
},
expectedResponse: &fwserver.ReadResourceResponse{
Diagnostics: diag.Diagnostics{
diag.NewWarningDiagnostic(
"warning summary",
"warning detail",
),
diag.NewErrorDiagnostic(
"error summary",
"error detail",
),
},
NewState: testCurrentState,
},
},
"response-state": {
server: &fwserver.Server{
Provider: &testprovider.Provider{},
},
request: &fwserver.ReadResourceRequest{
CurrentState: testCurrentState,
ResourceType: &testprovider.ResourceType{
GetSchemaMethod: func(_ context.Context) (tfsdk.Schema, diag.Diagnostics) {
return testSchema, nil
},
NewResourceMethod: func(_ context.Context, _ tfsdk.Provider) (tfsdk.Resource, diag.Diagnostics) {
return &testprovider.Resource{
ReadMethod: func(ctx context.Context, req tfsdk.ReadResourceRequest, resp *tfsdk.ReadResourceResponse) {
var data struct {
TestComputed types.String `tfsdk:"test_computed"`
TestRequired types.String `tfsdk:"test_required"`
}

resp.Diagnostics.Append(req.State.Get(ctx, &data)...)

data.TestComputed = types.String{Value: "test-newstate-value"}

resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
},
}, nil
},
},
},
expectedResponse: &fwserver.ReadResourceResponse{
NewState: testNewState,
},
},
"response-state-removeresource": {
server: &fwserver.Server{
Provider: &testprovider.Provider{},
},
request: &fwserver.ReadResourceRequest{
CurrentState: testCurrentState,
ResourceType: &testprovider.ResourceType{
GetSchemaMethod: func(_ context.Context) (tfsdk.Schema, diag.Diagnostics) {
return testSchema, nil
},
NewResourceMethod: func(_ context.Context, _ tfsdk.Provider) (tfsdk.Resource, diag.Diagnostics) {
return &testprovider.Resource{
ReadMethod: func(ctx context.Context, req tfsdk.ReadResourceRequest, resp *tfsdk.ReadResourceResponse) {
resp.State.RemoveResource(ctx)
},
}, nil
},
},
},
expectedResponse: &fwserver.ReadResourceResponse{
NewState: testNewStateRemoved,
},
expectedResponse: &fwserver.ReadResourceResponse{},
},
}

Expand Down
Loading