Skip to content

Commit 7894a36

Browse files
rainkwanaustinvalle
rainkwan
authored and
austinvalle
committed
Renaming to UpgradeIdentity confirmed to fail corner tests
1 parent b0913a0 commit 7894a36

20 files changed

+199
-199
lines changed

‎internal/fromproto5/upgraderesourceidentity.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ import (
1313
"github.com/hashicorp/terraform-plugin-go/tfprotov6"
1414
)
1515

16-
// UpgradeIdentityRequest returns the *fwserver.UpgradeIdentityRequest
16+
// UpgradeResourceIdentityRequest returns the *fwserver.UpgradeResourceIdentityRequest
1717
// equivalent of a *tfprotov5.UpgradeResourceIdentityRequest.
18-
func UpgradeIdentityRequest(ctx context.Context, proto5 *tfprotov5.UpgradeResourceIdentityRequest, resource resource.Resource, identitySchema fwschema.Schema) (*fwserver.UpgradeIdentityRequest, diag.Diagnostics) {
18+
func UpgradeResourceIdentityRequest(ctx context.Context, proto5 *tfprotov5.UpgradeResourceIdentityRequest, resource resource.Resource, identitySchema fwschema.Schema) (*fwserver.UpgradeResourceIdentityRequest, diag.Diagnostics) {
1919
if proto5 == nil {
2020
return nil, nil
2121
}
@@ -36,7 +36,7 @@ func UpgradeIdentityRequest(ctx context.Context, proto5 *tfprotov5.UpgradeResour
3636
return nil, diags
3737
}
3838

39-
fw := &fwserver.UpgradeIdentityRequest{
39+
fw := &fwserver.UpgradeResourceIdentityRequest{
4040
RawState: (*tfprotov6.RawState)(proto5.RawIdentity),
4141
IdentitySchema: identitySchema,
4242
Resource: resource,

‎internal/fromproto5/upgraderesourceidentity_test.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import (
1818
"github.com/hashicorp/terraform-plugin-go/tfprotov5"
1919
)
2020

21-
func TestUpgradeIdentityRequest(t *testing.T) {
21+
func TestUpgradeResourceIdentityRequest(t *testing.T) {
2222
t.Parallel()
2323

2424
testIdentitySchema := identityschema.Schema{
@@ -33,7 +33,7 @@ func TestUpgradeIdentityRequest(t *testing.T) {
3333
input *tfprotov5.UpgradeResourceIdentityRequest
3434
identitySchema fwschema.Schema
3535
resource resource.Resource
36-
expected *fwserver.UpgradeIdentityRequest
36+
expected *fwserver.UpgradeResourceIdentityRequest
3737
expectedDiagnostics diag.Diagnostics
3838
}{
3939
"nil": {
@@ -47,7 +47,7 @@ func TestUpgradeIdentityRequest(t *testing.T) {
4747
}),
4848
},
4949
identitySchema: testIdentitySchema,
50-
expected: &fwserver.UpgradeIdentityRequest{
50+
expected: &fwserver.UpgradeResourceIdentityRequest{
5151
RawState: testNewTfprotov6RawState(t, map[string]interface{}{
5252
"test_attribute": "test-value",
5353
}),
@@ -57,7 +57,7 @@ func TestUpgradeIdentityRequest(t *testing.T) {
5757
"resourceschema": {
5858
input: &tfprotov5.UpgradeResourceIdentityRequest{},
5959
identitySchema: testIdentitySchema,
60-
expected: &fwserver.UpgradeIdentityRequest{
60+
expected: &fwserver.UpgradeResourceIdentityRequest{
6161
IdentitySchema: testIdentitySchema,
6262
},
6363
},
@@ -79,7 +79,7 @@ func TestUpgradeIdentityRequest(t *testing.T) {
7979
Version: 123,
8080
},
8181
identitySchema: testIdentitySchema,
82-
expected: &fwserver.UpgradeIdentityRequest{
82+
expected: &fwserver.UpgradeResourceIdentityRequest{
8383
IdentitySchema: testIdentitySchema,
8484
Version: 123,
8585
},
@@ -90,7 +90,7 @@ func TestUpgradeIdentityRequest(t *testing.T) {
9090
t.Run(name, func(t *testing.T) {
9191
t.Parallel()
9292

93-
got, diags := fromproto5.UpgradeIdentityRequest(context.Background(), testCase.input, testCase.resource, testCase.identitySchema)
93+
got, diags := fromproto5.UpgradeResourceIdentityRequest(context.Background(), testCase.input, testCase.resource, testCase.identitySchema)
9494

9595
if diff := cmp.Diff(got, testCase.expected); diff != "" {
9696
t.Errorf("unexpected difference: %s", diff)

‎internal/fromproto6/upgraderesourceidentity.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ import (
1212
"github.com/hashicorp/terraform-plugin-go/tfprotov6"
1313
)
1414

15-
// UpgradeIdentityRequest returns the *fwserver.UpgradeIdentityRequest
15+
// UpgradeResourceIdentityRequest returns the *fwserver.UpgradeResourceIdentityRequest
1616
// equivalent of a *tfprotov6.UpgradeResourceIdentityRequest.
17-
func UpgradeIdentityRequest(ctx context.Context, proto6 *tfprotov6.UpgradeResourceIdentityRequest, resource resource.Resource, identitySchema fwschema.Schema) (*fwserver.UpgradeIdentityRequest, diag.Diagnostics) {
17+
func UpgradeResourceIdentityRequest(ctx context.Context, proto6 *tfprotov6.UpgradeResourceIdentityRequest, resource resource.Resource, identitySchema fwschema.Schema) (*fwserver.UpgradeResourceIdentityRequest, diag.Diagnostics) {
1818
if proto6 == nil {
1919
return nil, nil
2020
}
@@ -35,7 +35,7 @@ func UpgradeIdentityRequest(ctx context.Context, proto6 *tfprotov6.UpgradeResour
3535
return nil, diags
3636
}
3737

38-
fw := &fwserver.UpgradeIdentityRequest{
38+
fw := &fwserver.UpgradeResourceIdentityRequest{
3939
RawState: proto6.RawIdentity,
4040
IdentitySchema: identitySchema,
4141
Resource: resource,

‎internal/fromproto6/upgraderesourceidentity_test.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import (
1818
"github.com/hashicorp/terraform-plugin-go/tfprotov6"
1919
)
2020

21-
func TestUpgradeIdentityRequest(t *testing.T) {
21+
func TestUpgradeResourceIdentityRequest(t *testing.T) {
2222
t.Parallel()
2323

2424
testIdentitySchema := identityschema.Schema{
@@ -33,7 +33,7 @@ func TestUpgradeIdentityRequest(t *testing.T) {
3333
input *tfprotov6.UpgradeResourceIdentityRequest
3434
identitySchema fwschema.Schema
3535
resource resource.Resource
36-
expected *fwserver.UpgradeIdentityRequest
36+
expected *fwserver.UpgradeResourceIdentityRequest
3737
expectedDiagnostics diag.Diagnostics
3838
}{
3939
"nil": {
@@ -47,7 +47,7 @@ func TestUpgradeIdentityRequest(t *testing.T) {
4747
}),
4848
},
4949
identitySchema: testIdentitySchema,
50-
expected: &fwserver.UpgradeIdentityRequest{
50+
expected: &fwserver.UpgradeResourceIdentityRequest{
5151
RawState: testNewRawState(t, map[string]interface{}{
5252
"test_attribute": "test-value",
5353
}),
@@ -57,7 +57,7 @@ func TestUpgradeIdentityRequest(t *testing.T) {
5757
"resourceschema": {
5858
input: &tfprotov6.UpgradeResourceIdentityRequest{},
5959
identitySchema: testIdentitySchema,
60-
expected: &fwserver.UpgradeIdentityRequest{
60+
expected: &fwserver.UpgradeResourceIdentityRequest{
6161
IdentitySchema: testIdentitySchema,
6262
},
6363
},
@@ -79,7 +79,7 @@ func TestUpgradeIdentityRequest(t *testing.T) {
7979
Version: 123,
8080
},
8181
identitySchema: testIdentitySchema,
82-
expected: &fwserver.UpgradeIdentityRequest{
82+
expected: &fwserver.UpgradeResourceIdentityRequest{
8383
IdentitySchema: testIdentitySchema,
8484
Version: 123,
8585
},
@@ -90,7 +90,7 @@ func TestUpgradeIdentityRequest(t *testing.T) {
9090
t.Run(name, func(t *testing.T) {
9191
t.Parallel()
9292

93-
got, diags := fromproto6.UpgradeIdentityRequest(context.Background(), testCase.input, testCase.resource, testCase.identitySchema)
93+
got, diags := fromproto6.UpgradeResourceIdentityRequest(context.Background(), testCase.input, testCase.resource, testCase.identitySchema)
9494

9595
if diff := cmp.Diff(got, testCase.expected); diff != "" {
9696
t.Errorf("unexpected difference: %s", diff)

‎internal/fwserver/server_upgraderesourceidentity.go‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ import (
1616
"github.com/hashicorp/terraform-plugin-framework/tfsdk"
1717
)
1818

19-
// UpgradeIdentityRequest is the framework server request for the
20-
// UpgradeIdentity RPC.
21-
type UpgradeIdentityRequest struct {
19+
// UpgradeResourceIdentityRequest is the framework server request for the
20+
// UpgradeResourceIdentity RPC.
21+
type UpgradeResourceIdentityRequest struct {
2222
Resource resource.Resource
2323
IdentitySchema fwschema.Schema
2424
// TypeName is the type of resource that Terraform needs to upgrade the
@@ -36,15 +36,15 @@ type UpgradeIdentityRequest struct {
3636
RawState *tfprotov6.RawState
3737
}
3838

39-
// UpgradeIdentityResponse is the framework server response for the
40-
// UpgradeIdentity RPC.
41-
type UpgradeIdentityResponse struct {
39+
// UpgradeResourceIdentityResponse is the framework server response for the
40+
// UpgradeResourceIdentity RPC.
41+
type UpgradeResourceIdentityResponse struct {
4242
UpgradedIdentity *tfsdk.ResourceIdentity
4343
Diagnostics diag.Diagnostics
4444
}
4545

46-
// UpgradeIdentity implements the framework server UpgradeIdentity RPC.
47-
func (s *Server) UpgradeIdentity(ctx context.Context, req *UpgradeIdentityRequest, resp *UpgradeIdentityResponse) {
46+
// UpgradeResourceIdentity implements the framework server UpgradeResourceIdentity RPC.
47+
func (s *Server) UpgradeResourceIdentity(ctx context.Context, req *UpgradeResourceIdentityRequest, resp *UpgradeResourceIdentityResponse) {
4848
if req == nil {
4949
return
5050
}
@@ -68,7 +68,7 @@ func (s *Server) UpgradeIdentity(ctx context.Context, req *UpgradeIdentityReques
6868
if req.Version == req.IdentitySchema.GetVersion() {
6969
resp.Diagnostics.AddError(
7070
"Unexpected Identity Upgrade Request",
71-
"Terraform Core invoked UpgradeIdentity even though the stored identity schema version matches the current version. "+
71+
"Terraform Core invoked UpgradeResourceIdentity even though the stored identity schema version matches the current version. "+
7272
"This likely indicates a bug in the Terraform provider framework or Terraform Core. "+
7373
"Please report this issue to the provider developer.",
7474
)
@@ -94,23 +94,23 @@ func (s *Server) UpgradeIdentity(ctx context.Context, req *UpgradeIdentityReques
9494
}
9595
}
9696

97-
resourceWithUpgradeIdentity, ok := req.Resource.(resource.ResourceWithUpgradeIdentity)
97+
resourceWithUpgradeResourceIdentity, ok := req.Resource.(resource.ResourceWithUpgradeResourceIdentity)
9898

9999
if !ok {
100100
resp.Diagnostics.AddError(
101101
"Unable to Upgrade Resource Identity",
102-
"This resource was implemented without an UpgradeIdentity() method, "+
102+
"This resource was implemented without an UpgradeResourceIdentity() method, "+
103103
fmt.Sprintf("however Terraform was expecting an implementation for version %d upgrade.\n\n", req.Version)+
104104
"This is always an issue with the Terraform Provider and should be reported to the provider developer.",
105105
)
106106
return
107107
}
108108

109-
logging.FrameworkTrace(ctx, "Resource implements ResourceWithUpgradeIdentity")
109+
logging.FrameworkTrace(ctx, "Resource implements ResourceWithUpgradeResourceIdentity")
110110

111-
logging.FrameworkTrace(ctx, "Calling provider defined Resource UpgradeIdentity")
112-
resourceIdentityUpgraders := resourceWithUpgradeIdentity.UpgradeIdentity(ctx)
113-
logging.FrameworkTrace(ctx, "Called provider defined Resource UpgradeIdentity")
111+
logging.FrameworkTrace(ctx, "Calling provider defined Resource UpgradeResourceIdentity")
112+
resourceIdentityUpgraders := resourceWithUpgradeResourceIdentity.UpgradeResourceIdentity(ctx)
113+
logging.FrameworkTrace(ctx, "Called provider defined Resource UpgradeResourceIdentity")
114114

115115
// Panic prevention
116116
if resourceIdentityUpgraders == nil {
@@ -122,41 +122,41 @@ func (s *Server) UpgradeIdentity(ctx context.Context, req *UpgradeIdentityReques
122122
if !ok {
123123
resp.Diagnostics.AddError(
124124
"Unable to Upgrade Resource Identity",
125-
"This resource was implemented with an UpgradeIdentity() method, "+
125+
"This resource was implemented with an UpgradeResourceIdentity() method, "+
126126
fmt.Sprintf("however Terraform was expecting an implementation for version %d upgrade.\n\n", req.Version)+
127127
"This is always an issue with the Terraform Provider and should be reported to the provider developer.",
128128
)
129129
return
130130
}
131131

132-
UpgradeIdentityRequest := resource.UpgradeIdentityRequest{
132+
UpgradeResourceIdentityRequest := resource.UpgradeResourceIdentityRequest{
133133
RawIdentity: req.RawState,
134134
}
135135

136136
if resourceIdentityUpgrader.PriorSchema != nil {
137-
logging.FrameworkTrace(ctx, "Initializing populated UpgradeIdentityRequest Identity from provider defined prior schema and request RawState")
137+
logging.FrameworkTrace(ctx, "Initializing populated UpgradeResourceIdentityRequest Identity from provider defined prior schema and request RawState")
138138

139139
priorSchemaType := resourceIdentityUpgrader.PriorSchema.Type().TerraformType(ctx)
140140

141141
rawIdentityValue, err := req.RawState.UnmarshalWithOpts(priorSchemaType, unmarshalOpts)
142142

143143
if err != nil {
144144
resp.Diagnostics.AddError(
145-
"Unable to Read Previously Saved Identity for UpgradeIdentity",
145+
"Unable to Read Previously Saved Identity for UpgradeResourceIdentity",
146146
fmt.Sprintf("There was an error reading the saved resource Identity using the prior resource schema defined for version %d upgrade.\n\n", req.Version)+
147147
"Please report this to the provider developer:\n\n"+err.Error(),
148148
)
149149
return
150150
}
151151

152-
UpgradeIdentityRequest.Identity = &tfsdk.ResourceIdentity{
152+
UpgradeResourceIdentityRequest.Identity = &tfsdk.ResourceIdentity{
153153
Raw: rawIdentityValue, // from the output of req.RawState.UnmarshalWithOpts
154154
Schema: *resourceIdentityUpgrader.PriorSchema,
155155
}
156156

157157
}
158158

159-
UpgradeIdentityResponse := resource.UpgradeIdentityResponse{
159+
UpgradeResourceIdentityResponse := resource.UpgradeResourceIdentityResponse{
160160
Identity: &tfsdk.ResourceIdentity{
161161
Schema: req.IdentitySchema,
162162
// Raw is intentionally not set.
@@ -169,16 +169,16 @@ func (s *Server) UpgradeIdentity(ctx context.Context, req *UpgradeIdentityReques
169169
// any errors.
170170

171171
logging.FrameworkTrace(ctx, "Calling provider defined IdentityUpgrader")
172-
resourceIdentityUpgrader.IdentityUpgrader(ctx, UpgradeIdentityRequest, &UpgradeIdentityResponse)
172+
resourceIdentityUpgrader.IdentityUpgrader(ctx, UpgradeResourceIdentityRequest, &UpgradeResourceIdentityResponse)
173173
logging.FrameworkTrace(ctx, "Called provider defined IdentityUpgrader")
174174

175-
resp.Diagnostics.Append(UpgradeIdentityResponse.Diagnostics...)
175+
resp.Diagnostics.Append(UpgradeResourceIdentityResponse.Diagnostics...)
176176

177177
if resp.Diagnostics.HasError() {
178178
return
179179
}
180180

181-
if UpgradeIdentityResponse.Identity.Raw.Type() == nil || UpgradeIdentityResponse.Identity.Raw.IsNull() {
181+
if UpgradeResourceIdentityResponse.Identity.Raw.Type() == nil || UpgradeResourceIdentityResponse.Identity.Raw.IsNull() {
182182
resp.Diagnostics.AddError(
183183
"Missing Upgraded Resource Identity",
184184
fmt.Sprintf("After attempting a resource Identity upgrade to version %d, the provider did not return any Identity data. ", req.Version)+
@@ -188,5 +188,5 @@ func (s *Server) UpgradeIdentity(ctx context.Context, req *UpgradeIdentityReques
188188
return
189189
}
190190

191-
resp.UpgradedIdentity = UpgradeIdentityResponse.Identity
191+
resp.UpgradedIdentity = UpgradeResourceIdentityResponse.Identity
192192
}

0 commit comments

Comments
 (0)