-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move property path code to separate file (#2497)
This is a pure refactor and just moves the propertyPath-related code to a new file. This is a separate PR to make reviewing easier. Stacked on #2515, #2516 and #2496
- Loading branch information
1 parent
2cdff49
commit ef94e28
Showing
2 changed files
with
108 additions
and
102 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| package tfbridge | ||
|
|
||
| import ( | ||
| "github.com/pulumi/pulumi/sdk/v3/go/common/resource" | ||
| "github.com/pulumi/pulumi/sdk/v3/go/common/util/contract" | ||
|
|
||
| "github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tfbridge/info" | ||
| shim "github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tfshim" | ||
| "github.com/pulumi/pulumi-terraform-bridge/v3/unstable/propertyvalue" | ||
| ) | ||
|
|
||
| type propertyPath resource.PropertyPath | ||
|
|
||
| func isForceNew(tfs shim.Schema, ps *SchemaInfo) bool { | ||
| return (tfs != nil && tfs.ForceNew()) || | ||
| (ps != nil && ps.ForceNew != nil && *ps.ForceNew) | ||
| } | ||
|
|
||
| func newPropertyPath(root resource.PropertyKey) propertyPath { | ||
| return propertyPath{string(root)} | ||
| } | ||
|
|
||
| func (k propertyPath) String() string { | ||
| return resource.PropertyPath(k).String() | ||
| } | ||
|
|
||
| func (k propertyPath) Key() detailedDiffKey { | ||
| return detailedDiffKey(k.String()) | ||
| } | ||
|
|
||
| func (k propertyPath) append(subkey interface{}) propertyPath { | ||
| return append(k, subkey) | ||
| } | ||
|
|
||
| func (k propertyPath) Subpath(subkey string) propertyPath { | ||
| return k.append(subkey) | ||
| } | ||
|
|
||
| func (k propertyPath) Index(i int) propertyPath { | ||
| return k.append(i) | ||
| } | ||
|
|
||
| func (k propertyPath) IsReservedKey() bool { | ||
| leaf := k[len(k)-1] | ||
| return leaf == "__meta" || leaf == "__defaults" | ||
| } | ||
|
|
||
| func lookupSchemas( | ||
| path propertyPath, tfs shim.SchemaMap, ps map[string]*info.Schema, | ||
| ) (shim.Schema, *info.Schema, error) { | ||
| schemaPath := PropertyPathToSchemaPath(resource.PropertyPath(path), tfs, ps) | ||
| return LookupSchemas(schemaPath, tfs, ps) | ||
| } | ||
|
|
||
| func propertyPathTriggersReplacement( | ||
| path propertyPath, rootTFSchema shim.SchemaMap, rootPulumiSchema map[string]*info.Schema, | ||
| ) bool { | ||
| // A change on a property might trigger a replacement if: | ||
| // - The property itself is marked as ForceNew | ||
| // - The direct parent property is a collection (list, set, map) and is marked as ForceNew | ||
| // See pkg/cross-tests/diff_cross_test.go | ||
| // TestAttributeCollectionForceNew, TestBlockCollectionForceNew, TestBlockCollectionElementForceNew | ||
| // for a full case study of replacements in TF | ||
| tfs, ps, err := lookupSchemas(path, rootTFSchema, rootPulumiSchema) | ||
| if err != nil { | ||
| return false | ||
| } | ||
| if isForceNew(tfs, ps) { | ||
| return true | ||
| } | ||
|
|
||
| if len(path) == 1 { | ||
| return false | ||
| } | ||
|
|
||
| parent := path[:len(path)-1] | ||
| tfs, ps, err = lookupSchemas(parent, rootTFSchema, rootPulumiSchema) | ||
| if err != nil { | ||
| return false | ||
| } | ||
| // Note this is mimicking the TF behaviour, so the effective type is not considered here. | ||
| if tfs.Type() != shim.TypeList && tfs.Type() != shim.TypeSet && tfs.Type() != shim.TypeMap { | ||
| return false | ||
| } | ||
| return isForceNew(tfs, ps) | ||
| } | ||
|
|
||
| func propertyValueTriggersReplacement( | ||
| path propertyPath, value resource.PropertyValue, tfs shim.SchemaMap, ps map[string]*info.Schema, | ||
| ) bool { | ||
| replacement := false | ||
| visitor := func(subpath resource.PropertyPath, val resource.PropertyValue) (resource.PropertyValue, error) { | ||
| if propertyPathTriggersReplacement(propertyPath(subpath), tfs, ps) { | ||
| replacement = true | ||
| } | ||
| return val, nil | ||
| } | ||
|
|
||
| _, err := propertyvalue.TransformPropertyValue( | ||
| resource.PropertyPath(path), | ||
| visitor, | ||
| value, | ||
| ) | ||
| contract.AssertNoErrorf(err, "TransformPropertyValue should not return an error") | ||
|
|
||
| return replacement | ||
| } |