Skip to content

Fix nested attribute name and generated custom value method name conflicts #81

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 8 commits into from
Nov 14, 2023
Merged

Fix nested attribute name and generated custom value method name conflicts #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
bdee822
Prefixing nested attribute names with the name of the parent attribut…
bendbennett Oct 26, 2023
0902b4d
Adding changelog (#76)
bendbennett Oct 26, 2023
0f2f1bf
Renaming input arg (#76)
bendbennett Oct 27, 2023
f2b3c9b
Merge remote-tracking branch 'origin/main' into bendbennett/issues-76-#2
bendbennett Nov 6, 2023
f3d6d32
Updating tests (#76)
bendbennett Nov 6, 2023
1c500c6
Add naming collision handling for collection and object attributes (#76)
bendbennett Nov 7, 2023
a9f283e
Merge remote-tracking branch 'origin/main' into bendbennett/issues-76-#2
bendbennett Nov 7, 2023
36b4867
Merge branch 'main' into bendbennett/issues-76-#2
bendbennett Nov 14, 2023
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
5 changes: 5 additions & 0 deletions .changes/unreleased/BUG FIXES-20231026-133048.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
kind: BUG FIXES
body: Fix nested attribute name and generated custom value method name conflicts
time: 2023-10-26T13:30:48.63762+01:00
custom:
Issue: "81"
9 changes: 9 additions & 0 deletions internal/datasource_generate/object_attribute.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"strings"
"text/template"

"github.com/hashicorp/terraform-plugin-codegen-spec/code"
specschema "github.com/hashicorp/terraform-plugin-codegen-spec/schema"
"github.com/hashicorp/terraform-plugin-framework/datasource/schema"

Expand Down Expand Up @@ -55,6 +56,14 @@ func (g GeneratorObjectAttribute) Imports() *generatorschema.Imports {

imports.Append(g.AssociatedExternalType.Imports())

for _, v := range g.AttrTypes() {
if v.Number != nil && g.AssociatedExternalType == nil {
imports.Add(code.Import{
Path: generatorschema.MathBigImport,
})
}
}

return imports
}

Expand Down
60 changes: 60 additions & 0 deletions internal/datasource_generate/object_attribute_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,29 @@ func TestGeneratorObjectAttribute_Imports(t *testing.T) {
},
},
},
// verifies that math/big is imported when object has
// attribute type that is number type.
"object-with-attr-type-number": {
input: GeneratorObjectAttribute{
AttributeTypes: specschema.ObjectAttributeTypes{
{
Name: "number",
Number: &specschema.NumberType{},
},
},
},
expected: []code.Import{
{
Path: generatorschema.TypesImport,
},
{
Path: generatorschema.AttrImport,
},
{
Path: generatorschema.MathBigImport,
},
},
},
"object-with-attr-type-bool-with-import": {
input: GeneratorObjectAttribute{
AttributeTypes: specschema.ObjectAttributeTypes{
Expand Down Expand Up @@ -361,6 +384,43 @@ func TestGeneratorObjectAttribute_Imports(t *testing.T) {
},
},
},
// verifies that math/big is not imported when associated external type
// is specified.
"associated-external-type-with-number-attribute": {
input: GeneratorObjectAttribute{
AssociatedExternalType: &generatorschema.AssocExtType{
AssociatedExternalType: &specschema.AssociatedExternalType{
Type: "*api.ObjectAttribute",
},
},
AttributeTypes: specschema.ObjectAttributeTypes{
{
Name: "number",
Number: &specschema.NumberType{},
},
},
},
expected: []code.Import{
{
Path: "github.com/hashicorp/terraform-plugin-framework/types",
},
{
Path: "github.com/hashicorp/terraform-plugin-framework/attr",
},
{
Path: "fmt",
},
{
Path: "github.com/hashicorp/terraform-plugin-framework/diag",
},
{
Path: "github.com/hashicorp/terraform-plugin-go/tftypes",
},
{
Path: "github.com/hashicorp/terraform-plugin-framework/types/basetypes",
},
},
},
}

for name, testCase := range testCases {
Expand Down
9 changes: 9 additions & 0 deletions internal/provider_generate/object_attribute.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"strings"
"text/template"

"github.com/hashicorp/terraform-plugin-codegen-spec/code"
specschema "github.com/hashicorp/terraform-plugin-codegen-spec/schema"
"github.com/hashicorp/terraform-plugin-framework/provider/schema"

Expand Down Expand Up @@ -55,6 +56,14 @@ func (g GeneratorObjectAttribute) Imports() *generatorschema.Imports {

imports.Append(g.AssociatedExternalType.Imports())

for _, v := range g.AttrTypes() {
if v.Number != nil && g.AssociatedExternalType == nil {
imports.Add(code.Import{
Path: generatorschema.MathBigImport,
})
}
}

return imports
}

Expand Down
60 changes: 60 additions & 0 deletions internal/provider_generate/object_attribute_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,29 @@ func TestGeneratorObjectAttribute_Imports(t *testing.T) {
},
},
},
// verifies that math/big is imported when object has
// attribute type that is number type.
"object-with-attr-type-number": {
input: GeneratorObjectAttribute{
AttributeTypes: specschema.ObjectAttributeTypes{
{
Name: "number",
Number: &specschema.NumberType{},
},
},
},
expected: []code.Import{
{
Path: generatorschema.TypesImport,
},
{
Path: generatorschema.AttrImport,
},
{
Path: generatorschema.MathBigImport,
},
},
},
"object-with-attr-type-bool-with-import": {
input: GeneratorObjectAttribute{
AttributeTypes: specschema.ObjectAttributeTypes{
Expand Down Expand Up @@ -361,6 +384,43 @@ func TestGeneratorObjectAttribute_Imports(t *testing.T) {
},
},
},
// verifies that math/big is not imported when associated external type
// is specified.
"associated-external-type-with-number-attribute": {
input: GeneratorObjectAttribute{
AssociatedExternalType: &generatorschema.AssocExtType{
AssociatedExternalType: &specschema.AssociatedExternalType{
Type: "*api.ObjectAttribute",
},
},
AttributeTypes: specschema.ObjectAttributeTypes{
{
Name: "number",
Number: &specschema.NumberType{},
},
},
},
expected: []code.Import{
{
Path: "github.com/hashicorp/terraform-plugin-framework/types",
},
{
Path: "github.com/hashicorp/terraform-plugin-framework/attr",
},
{
Path: "fmt",
},
{
Path: "github.com/hashicorp/terraform-plugin-framework/diag",
},
{
Path: "github.com/hashicorp/terraform-plugin-go/tftypes",
},
{
Path: "github.com/hashicorp/terraform-plugin-framework/types/basetypes",
},
},
},
}

for name, testCase := range testCases {
Expand Down
9 changes: 9 additions & 0 deletions internal/resource_generate/object_attribute.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"strings"
"text/template"

"github.com/hashicorp/terraform-plugin-codegen-spec/code"
specschema "github.com/hashicorp/terraform-plugin-codegen-spec/schema"
"github.com/hashicorp/terraform-plugin-framework/resource/schema"

Expand Down Expand Up @@ -67,6 +68,14 @@ func (g GeneratorObjectAttribute) Imports() *generatorschema.Imports {

imports.Append(g.AssociatedExternalType.Imports())

for _, v := range g.AttrTypes() {
if v.Number != nil && g.AssociatedExternalType == nil {
imports.Add(code.Import{
Path: generatorschema.MathBigImport,
})
}
}

return imports
}

Expand Down
60 changes: 60 additions & 0 deletions internal/resource_generate/object_attribute_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,29 @@ func TestGeneratorObjectAttribute_Imports(t *testing.T) {
},
},
},
// verifies that math/big is imported when object has
// attribute type that is number type.
"object-with-attr-type-number": {
input: GeneratorObjectAttribute{
AttributeTypes: specschema.ObjectAttributeTypes{
{
Name: "number",
Number: &specschema.NumberType{},
},
},
},
expected: []code.Import{
{
Path: generatorschema.TypesImport,
},
{
Path: generatorschema.AttrImport,
},
{
Path: generatorschema.MathBigImport,
},
},
},
"object-with-attr-type-bool-with-import": {
input: GeneratorObjectAttribute{
AttributeTypes: specschema.ObjectAttributeTypes{
Expand Down Expand Up @@ -514,6 +537,43 @@ func TestGeneratorObjectAttribute_Imports(t *testing.T) {
},
},
},
// verifies that math/big is not imported when associated external type
// is specified.
"associated-external-type-with-number-attribute": {
input: GeneratorObjectAttribute{
AssociatedExternalType: &generatorschema.AssocExtType{
AssociatedExternalType: &specschema.AssociatedExternalType{
Type: "*api.ObjectAttribute",
},
},
AttributeTypes: specschema.ObjectAttributeTypes{
{
Name: "number",
Number: &specschema.NumberType{},
},
},
},
expected: []code.Import{
{
Path: "github.com/hashicorp/terraform-plugin-framework/types",
},
{
Path: "github.com/hashicorp/terraform-plugin-framework/attr",
},
{
Path: "fmt",
},
{
Path: "github.com/hashicorp/terraform-plugin-framework/diag",
},
{
Path: "github.com/hashicorp/terraform-plugin-go/tftypes",
},
{
Path: "github.com/hashicorp/terraform-plugin-framework/types/basetypes",
},
},
},
}

for name, testCase := range testCases {
Expand Down
Loading