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.

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

Normalize block values before passing to TF provider #1971

Merged
merged 80 commits into from
Jun 5, 2024

Conversation

VenelinMartinov
Copy link
Contributor

@VenelinMartinov VenelinMartinov commented May 14, 2024

part of #1785

This change adds a normalisation step for collections when recovering cty values to pass to terraform. This ensures we represent them similarly to terraform.

In practice this means that all block collections need to be passed to TF providers as an empty collection instead of nil. This should get rid of quite a few subtle discrepancies in the data we pass to the TF provider code. These sometimes result in panics since we pass unexpected nils.

This gets rid of all known input discrepancies discovered so far through cross-testing.

The full rules for what is a block are here. It is essentially properties with schema: typeList or typeSet with a Resource Elem.

fixes #1970
fixes #1915
fixes #1964
fixes #1767
fixes #1762

TODO: [DONE] remove the MaxItemsOne default hacks introduced in #1725 (opened #2049)

Copy link

codecov bot commented May 14, 2024

Codecov Report

Attention: Patch coverage is 76.25000% with 19 lines in your changes missing coverage. Please review.

Project coverage is 61.51%. Comparing base (a9d0c7c) to head (ed56307).

Files Patch % Lines
pkg/tfshim/sdk-v2/provider2.go 75.32% 14 Missing and 5 partials ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1971      +/-   ##
==========================================
- Coverage   63.31%   61.51%   -1.80%     
==========================================
  Files         333      334       +1     
  Lines       37405    45035    +7630     
==========================================
+ Hits        23682    27704    +4022     
- Misses      12198    15802    +3604     
- Partials     1525     1529       +4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@VenelinMartinov VenelinMartinov changed the title Empty sets cross test Missing set cross test May 14, 2024
@t0yv0 t0yv0 self-requested a review May 14, 2024 17:23
Copy link
Member

@t0yv0 t0yv0 left a comment

Choose a reason for hiding this comment

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

Good test case to add, continues to be surprising.

@VenelinMartinov
Copy link
Contributor Author

VenelinMartinov commented May 14, 2024

Pretty sure this is happening in the else block here:

}
attrs := map[string]cty.Value{}
for attrName, attrType := range aT {
if v, ok := value[attrName]; ok {
var err error
attrs[attrName], err = recoverCtyValue(attrType, v)
if err != nil {
return cty.NilVal, err
}
} else {
attrs[attrName] = cty.NullVal(attrType)
}
}
return cty.ObjectVal(attrs), nil

panic: here!

goroutine 201 [running]:
github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tfshim/sdk-v2.recoverCtyValueOfObjectType({{0x104741db8, 0x14000782f20}}, 0x14000b64ea0)
	/Users/vvm/code/pulumi-terraform-bridge/pkg/tfshim/sdk-v2/cty.go:232 +0x2b0
github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tfshim/sdk-v2.recoverCtyValue({{0x104741db8, 0x14000782f20}}, {0x104336680, 0x14000b64ea0})
	/Users/vvm/code/pulumi-terraform-bridge/pkg/tfshim/sdk-v2/cty.go:122 +0x264
github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tfshim/sdk-v2.recoverAndCoerceCtyValueWithSchema({0x104730060, 0x14000ecbf20}, {0x104336680, 0x14000b64ea0})
	/Users/vvm/code/pulumi-terraform-bridge/pkg/tfshim/sdk-v2/cty.go:94 +0x40
github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tfshim/sdk-v2.(*planResourceChangeImpl).Diff(0x14000996470, {0x1047419e8, 0x14000703a40}, {0x10392c6f9, 0x15}, {0x0?, 0x0?}, {0x10471c9a0?, 0x14000f29ef0?}, {0x0?, ...})
	/Users/vvm/code/pulumi-terraform-bridge/pkg/tfshim/sdk-v2/provider2.go:147 +0x10c
github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tfshim/sdk-v2.(*providerWithPlanResourceChangeDispatch).Diff(0x1400077eb70, {0x1047419e8, 0x14000703a40}, {0x10392c6f9, 0x15}, {0x0, 0x0}, {0x10471c9a0, 0x14000f29ef0}, {0x0?, ...})
	/Users/vvm/code/pulumi-terraform-bridge/pkg/tfshim/sdk-v2/provider2.go:688 +0xb0
github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tfbridge.(*Provider).Create(0x14000bb9988, {0x1047419e8?, 0x14000703380?}, 0x14000777450)
	/Users/vvm/code/pulumi-terraform-bridge/pkg/tfbridge/provider.go:1099 +0x5c0
github.com/pulumi/pulumi/sdk/v3/proto/go._ResourceProvider_Create_Handler({0x1046c0e40, 0x14000bb9988}, {0x1047419e8, 0x14000703380}, 0x14000a79080, 0x0)
	/Users/vvm/go/pkg/mod/github.com/pulumi/pulumi/sdk/[email protected]/proto/go/provider_grpc.pb.go:586 +0x1c0
google.golang.org/grpc.(*Server).processUnaryRPC(0x14000aa2a00, {0x1047419e8, 0x140007032f0}, {0x1047553e0, 0x1400117a180}, 0x140003acd80, 0x14000ac47b0, 0x105986f00, 0x0)
	/Users/vvm/go/pkg/mod/google.golang.org/[email protected]/server.go:1369 +0xb58
google.golang.org/grpc.(*Server).handleStream(0x14000aa2a00, {0x1047553e0, 0x1400117a180}, 0x140003acd80)
	/Users/vvm/go/pkg/mod/google.golang.org/[email protected]/server.go:1780 +0xb20
google.golang.org/grpc.(*Server).serveStreams.func2.1()
	/Users/vvm/go/pkg/mod/google.golang.org/[email protected]/server.go:1019 +0x8c
created by google.golang.org/grpc.(*Server).serveStreams.func2 in goroutine 191
	/Users/vvm/go/pkg/mod/google.golang.org/[email protected]/server.go:1030 +0x13c
exit status 2
FAIL	github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tests/cross-tests	1.771s

@t0yv0
Copy link
Member

t0yv0 commented May 14, 2024

attrs[attrName] = cty.NullVal(attrType) is a correct representation AFAIK, digging in.

@VenelinMartinov
Copy link
Contributor Author

VenelinMartinov commented May 14, 2024

In the cross tests this is flagged as a diff:

TF value cty.ObjectVal(map[string]cty.Value{"f0":cty.SetValEmpty(cty.Object(map[string]cty.Type{"x":cty.String})), "id":cty.UnknownVal(cty.String)})
PU value cty.ObjectVal(map[string]cty.Value{"f0":cty.NullVal(cty.Set(cty.Object(map[string]cty.Type{"x":cty.String}))), "id":cty.NullVal(cty.String)})

@t0yv0
Copy link
Member

t0yv0 commented May 14, 2024

Yeah this is plausible.

    input_check.go:41: TF value cty.ObjectVal(map[string]cty.Value{"f0":cty.SetValEmpty(cty.Object(map[string]cty.Type{"x":cty.String})), "id":cty.NullVal(cty.String)})
    input_check.go:42: PU value cty.ObjectVal(map[string]cty.Value{"f0":cty.NullVal(cty.Set(cty.Object(map[string]cty.Type{"x":cty.String}))), "id":cty.NullVal(cty.String)})

Perhaps this comes back to the fact that null values aren't representable in TF for set-nested blocks. Therefore it's an automatic empty set aka [].

@VenelinMartinov
Copy link
Contributor Author

Yeah and I think this is were it gets really messy with SchemaConfigMode, since they are representable if ConfigModeAttr is set.

@VenelinMartinov
Copy link
Contributor Author

I ran into some trouble with proposed_new.go - not obvious how to convert the element type between hcty and cty

@t0yv0
Copy link
Member

t0yv0 commented May 14, 2024

True - this is just saying the fix need to accommodate both for both cases:

  • your code is testing a Set-nested block
  • if is also possible to have a Set({foo: string}) attribute in TF, we should test that we pass that too

I tried a quick fix quickly - sorry accidentally pushed a commit to this branch. Meant a separate branch t0yv0/empty_set_cross_test

I can get the quick fix to pass RawConfig test but curiously NOT the RawPlan test. This makes me wonder what's going on there. Could this be because we'e linking in outdated code for planning the change compared to TF CLI? It's a bit unfortunate that in this test setup we cannot debug into TF CLI to see what is it doing .

@t0yv0
Copy link
Member

t0yv0 commented May 14, 2024

I'd also wager my fix doesn't cut it for the attribute case which might need to actually return null not [].

@t0yv0
Copy link
Member

t0yv0 commented May 14, 2024

BTW the reason this may be less impactful than it seems is that few providers consult RawPlan and RawConfig on Create, they mostly consult the ResourceData. So issues of this sort remain unfixed.

@VenelinMartinov
Copy link
Contributor Author

I think the attribute case is completely unhandled but let's fix that seprately.

Isn't there the same issue in

@t0yv0
Copy link
Member

t0yv0 commented May 14, 2024

Well that one looks fine? hcty2ctyWithType converts between two equivalent representations cty.Value and hcty.Value, converting null to null is reasonable, why do we have null passed into that in the first place would be the question?

Perhaps we need to fix at the level of MakeTerraformInputs?

What is not yet tested that's really interesting to test, even more fundamentally important than RawConfig/RawPLan parity, is whether the two paths get the same answer to this:

tfResData.Get("f0")
tfResData.GetChange("f0")

@VenelinMartinov
Copy link
Contributor Author

VenelinMartinov commented May 16, 2024

I believe I found two other places where the state is populated with nulls instead of empty collections:

stateValue: cty.NullVal(ty),

and

newInstanceState, err := upgradeResourceState(ctx, p.tf, res, instanceState)

The first one is fairly straight-forward to fix but the upgradeState stuff might be better fixed by calling a higher level function in the plugin-sdk -it looks to me like we are doing multiple passes back and forth between instanceState and cty values both in the bridge code and then in the plugin-sdk.

Investigating...

@VenelinMartinov
Copy link
Contributor Author

Fairly sure we are loosing the value here:

newState, err := res.ShimInstanceStateFromValue(v)

the v returned from NormalizeObjectFromLegacySDK is correct but then newState becomes newState=&terraform.InstanceState{}

which is then converted to stateValue=cty.ObjectVal(map[string]cty.Value{"f0":cty.NullVal(cty.Set(cty.Object(map[string]cty.Type{"x":cty.String}))), "id":cty.NullVal(cty.String)})

@VenelinMartinov
Copy link
Contributor Author

VenelinMartinov commented May 16, 2024

Ah, I think we are missing a null normalization after calling AttrsAsObjectValue

In the plugin-sdk: https://github.com/hashicorp/terraform-plugin-sdk/blob/70fb6b9b15e8e5fc73f424e24084c28fedd1e013/helper/schema/grpc_provider.go#L1100-L1106

StateValueFromInstanceState is just a wrapper around AttrsAsObjectValue and note that normalizeNullValues is called after.

But in provider2.go:

stateValue, err := newInstanceState.AttrsAsObjectValue(ty)

we don't then normalize the nulls to empty collections after calling AttrsAsObjectValue

@t0yv0 t0yv0 self-requested a review June 4, 2024 14:23
@t0yv0
Copy link
Member

t0yv0 commented Jun 4, 2024

Verified that [unk] to unk floating happens inside PlanResourceChange method so this is something programmed in TF it seems, we cannot easily avoid this without digging further. Let's not block on it but accept as is for now.

@t0yv0
Copy link
Member

t0yv0 commented Jun 4, 2024

Let's check that "listBlockProps":"04da6b54-80e4-46f7-96ec-b56ff0331ba9" top-level unknown gives something reasonable and if so LGTM!

@VenelinMartinov
Copy link
Contributor Author

VenelinMartinov commented Jun 4, 2024

I've extracted the unknown tests in #2054

There are some failures in the new code related to unknowns - I'll address these next.

Appreciate the input here 🙏


Should be fixed - we no longer panic on unknown collections - instead we return the unknown as is.

@VenelinMartinov VenelinMartinov changed the base branch from master to vvm/unknown_tests June 4, 2024 16:21
@@ -5484,7 +5484,7 @@ func TestPlanResourceChangeUnknowns(t *testing.T) {
"maxItemsOneProp":null,
"setBlockProps":[],
"listBlockProps":[],
"nestedListBlockProps":[{"nestedProps":null}],
"nestedListBlockProps":[{"nestedProps":[]}],
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is the only change in behaviour to current master related to unknowns and it seems reasonable to me - nestedProps is a list type so should not be nil.

Copy link
Member

Choose a reason for hiding this comment

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

Yeah looks like MakeTerraformInputs substituted "04da6b54-80e4-46f7-96ec-b56ff0331ba9" into "nestedListBlockProps":[{"nestedProps":null}], and then the newly added pass corrected that to []. This is fine.. we're already in heuristic land in this case. Good to have it covered!!

@t0yv0
Copy link
Member

t0yv0 commented Jun 4, 2024

:shipit:

@VenelinMartinov VenelinMartinov mentioned this pull request Jun 4, 2024
Base automatically changed from vvm/unknown_tests to master June 5, 2024 14:22
@VenelinMartinov VenelinMartinov merged commit 98f15a1 into master Jun 5, 2024
11 checks passed
@VenelinMartinov VenelinMartinov deleted the vvm/empty_set_cross_test branch June 5, 2024 14:46
VenelinMartinov added a commit that referenced this pull request Jul 22, 2024
This was missed in
#2049

The code was never used and instead the problem was fixed in
#1971 at the root.

Simplify schema.go a bit as it is complicated enough already.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants