Skip to content

Add more shim layer tests for pf #2231

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

Closed
wants to merge 2 commits into from
Closed

Add more shim layer tests for pf #2231

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b816056
add more shim layer tests for pf
VenelinMartinov Jul 23, 2024
e46106b
todo
VenelinMartinov Jul 23, 2024
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
252 changes: 218 additions & 34 deletions pf/tests/schemashim_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ import (

// Test how various PF-based schemata translate to the shim.Schema layer.
func TestSchemaShimRepresentations(t *testing.T) {

type testCase struct {
name string
provider provider.Provider
Expand All @@ -41,16 +40,38 @@ func TestSchemaShimRepresentations(t *testing.T) {

testCases := []testCase{
{
"single-nested-block",
"simple-attribute",
&pb.Provider{
AllResources: []pb.Resource{{
ResourceSchema: schema.Schema{
Blocks: map[string]schema.Block{
"single_nested_block": schema.SingleNestedBlock{
Attributes: map[string]schema.Attribute{
"a1": schema.Float64Attribute{
Optional: true,
},
Attributes: map[string]schema.Attribute{
"simple_attribute": schema.StringAttribute{
Optional: true,
},
},
},
}},
},
autogold.Expect(`{
"resources": {
"_": {
"simple_attribute": {
"optional": true,
"type": 4
}
}
}
}`),
},
{
"object-attribute",
&pb.Provider{
AllResources: []pb.Resource{{
ResourceSchema: schema.Schema{
Attributes: map[string]schema.Attribute{
"object_attribute": schema.ObjectAttribute{
AttributeTypes: map[string]attr.Type{
"a1": types.StringType,
},
},
},
Expand All @@ -60,51 +81,132 @@ func TestSchemaShimRepresentations(t *testing.T) {
autogold.Expect(`{
"resources": {
"_": {
"single_nested_block": {
"object_attribute": {
"element": {
"resource": {
"a1": {
"optional": true,
"type": 3
"type": 4
}
}
},
"optional": true,
"type": 6
}
}
}
}`),
},
{
"list-nested-block",
"list-attribute",
&pb.Provider{
AllResources: []pb.Resource{{
ResourceSchema: schema.Schema{
Blocks: map[string]schema.Block{
"list_nested_block": schema.ListNestedBlock{
NestedObject: schema.NestedBlockObject{
Attributes: map[string]schema.Attribute{
"a1": schema.Float64Attribute{
Optional: true,
AllResources: []pb.Resource{
{
ResourceSchema: schema.Schema{
Attributes: map[string]schema.Attribute{
"list_attribute": schema.ListAttribute{
Optional: true,
ElementType: types.StringType,
},
},
},
},
},
},
autogold.Expect(`{
"resources": {
"_": {
"list_attribute": {
"element": {
"schema": {
"type": 4
}
},
"optional": true,
"type": 5
}
}
}
}`),
},
{
"list-attribute-object-element",
&pb.Provider{
AllResources: []pb.Resource{
{
ResourceSchema: schema.Schema{
Attributes: map[string]schema.Attribute{
"list_attribute": schema.ListAttribute{
Optional: true,
ElementType: types.ObjectType{
AttrTypes: map[string]attr.Type{
"a1": types.StringType,
},
},
},
},
},
},
}},
},
},
autogold.Expect(`{
"resources": {
"_": {
"list_nested_block": {
"list_attribute": {
"element": {
"resource": {
"a1": {
"optional": true,
"type": 3
}
"schema": {
"element": {
"resource": {
"a1": {
"type": 4
}
}
},
"type": 6
}
},
"optional": true,
"type": 5
}
}
}
}`),
},
{
"list-nested-attribute",
&pb.Provider{
AllResources: []pb.Resource{
{
ResourceSchema: schema.Schema{
Attributes: map[string]schema.Attribute{
"list_nested_attribute": schema.ListNestedAttribute{
Optional: true,
NestedObject: schema.NestedAttributeObject{
Attributes: map[string]schema.Attribute{
"a1": schema.StringAttribute{
Optional: true,
},
},
},
},
},
},
},
},
},
autogold.Expect(`{
"resources": {
"_": {
"list_nested_attribute": {
"element": {
"schema": {
"element": {
"resource": {
"a1": {
"optional": true,
"type": 4
}
}
},
"type": 6
}
},
"optional": true,
Expand Down Expand Up @@ -157,14 +259,55 @@ func TestSchemaShimRepresentations(t *testing.T) {
}`),
},
{
"object-attribute",
"single-nested-attribute",
&pb.Provider{
AllResources: []pb.Resource{
{
ResourceSchema: schema.Schema{
Attributes: map[string]schema.Attribute{
"single_nested_attribute": schema.SingleNestedAttribute{
Optional: true,
Attributes: map[string]schema.Attribute{
"a1": schema.StringAttribute{
Optional: true,
},
},
},
},
},
},
},
},
autogold.Expect(`{
"resources": {
"_": {
"single_nested_attribute": {
"element": {
"resource": {
"a1": {
"optional": true,
"type": 4
}
}
},
"optional": true,
"type": 6
}
}
}
}`),
},
{
"single-nested-block",
&pb.Provider{
AllResources: []pb.Resource{{
ResourceSchema: schema.Schema{
Attributes: map[string]schema.Attribute{
"object_attribute": schema.ObjectAttribute{
AttributeTypes: map[string]attr.Type{
"a1": types.StringType,
Blocks: map[string]schema.Block{
"single_nested_block": schema.SingleNestedBlock{
Attributes: map[string]schema.Attribute{
"a1": schema.StringAttribute{
Optional: true,
},
},
},
},
Expand All @@ -174,18 +317,59 @@ func TestSchemaShimRepresentations(t *testing.T) {
autogold.Expect(`{
"resources": {
"_": {
"object_attribute": {
"single_nested_block": {
"element": {
"resource": {
"a1": {
"optional": true,
"type": 4
}
}
},
"optional": true,
"type": 6
}
}
}
}`),
},
{
"list-nested-block",
&pb.Provider{
AllResources: []pb.Resource{{
ResourceSchema: schema.Schema{
Blocks: map[string]schema.Block{
"list_nested_block": schema.ListNestedBlock{
NestedObject: schema.NestedBlockObject{
Attributes: map[string]schema.Attribute{
"a1": schema.StringAttribute{
Optional: true,
},
},
},
},
},
},
}},
},
// TODO: Why is this different to list-nested-attribute? Should it be?
Copy link
Contributor Author

@VenelinMartinov VenelinMartinov Jul 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this expected? I wonder why the list-nested-attribute has 2 more layers of nesting in the shim layer.

Copy link
Contributor Author

@VenelinMartinov VenelinMartinov Jul 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, this is probably elemSchemas

pulumi-terraform-bridge/pkg/tfbridge/schema.go

Line 268 in c9ce9b5

func elemSchemas(sch shim.Schema, ps *SchemaInfo) (shim.Schema, *SchemaInfo) {

Copy link
Contributor Author

@VenelinMartinov VenelinMartinov Jul 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or not, elemSchemas is called after the shim schema is constructed.

Copy link
Contributor Author

@VenelinMartinov VenelinMartinov Jul 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Found it in

pulumi-terraform-bridge/pf/internal/schemashim/attr_schema.go

Line 85 in 18db7c5

func (s *attrSchema) Elem() interface{} {

vs blocks:

pulumi-terraform-bridge/pf/internal/schemashim/block_schema.go

Line 56 in 18db7c5

func (s *blockSchema) Elem() interface{} {

Trying to see what happens if attr shims match the block ones here: #2232

Copy link
Contributor Author

@VenelinMartinov VenelinMartinov Jul 23, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Explored further in #2232, seems plausible that these should actually match and the attribute one seems wrong here. Wondering how this affects schema.go

Copy link
Member

@iwahbe iwahbe Aug 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you reach a conclusion here?

autogold.Expect(`{
"resources": {
"_": {
"list_nested_block": {
"element": {
"resource": {
"a1": {
"optional": true,
"type": 4
}
}
},
"optional": true,
"type": 5
Copy link
Contributor Author

@VenelinMartinov VenelinMartinov Jul 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note this is a list type - this means that the CastToTypeObject

pulumi-terraform-bridge/pkg/tfshim/util/types.go

Line 36 in 48fd41b

func CastToTypeObject(tfs shim.Schema) (shim.SchemaMap, bool) {
is wrong for both PF and SDKv2 - list types CAN have a resource elem in PF, like in SDKv2

This is the root cause of #2180 fixed in #2181

Copy link
Member

@iwahbe iwahbe Aug 8, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this out of date?

}
}
}
}`),
},
}
Expand Down