Merge pull request #25857 from hashicorp/jbardin/data-diffs
allow plan data state comparison with legacy SDK
This commit is contained in:
James Bardin
GitHub
commit
7ef4e7f6ad
|
|
@ -7,6 +7,7 @@ import (
|
|||
|
||||
"github.com/zclconf/go-cty/cty"
|
||||
|
||||
"github.com/hashicorp/terraform/configs/configschema"
|
||||
"github.com/hashicorp/terraform/plans"
|
||||
"github.com/hashicorp/terraform/plans/objchange"
|
||||
"github.com/hashicorp/terraform/states"
|
||||
|
|
@ -101,22 +102,18 @@ func (n *evalReadDataPlan) Eval(ctx EvalContext) (interface{}, error) {
|
|||
return nil, diags.ErrWithWarnings()
|
||||
}
|
||||
|
||||
var proposedVal cty.Value
|
||||
|
||||
// If we have a stored state we may not need to re-read the data source.
|
||||
// Check the config against the state to see if there are any difference.
|
||||
if !priorVal.IsNull() {
|
||||
// Applying the configuration to the prior state lets us see if there
|
||||
// are any differences.
|
||||
proposedVal = objchange.ProposedNewObject(schema, priorVal, configVal)
|
||||
if proposedVal.Equals(priorVal).True() {
|
||||
log.Printf("[TRACE] evalReadDataPlan: %s no change detected, using existing state", absAddr)
|
||||
// state looks up to date, and must have been read during refresh
|
||||
return nil, diags.ErrWithWarnings()
|
||||
}
|
||||
log.Printf("[TRACE] evalReadDataPlan: %s configuration changed, planning data source", absAddr)
|
||||
proposedVal, hasChanges := dataObjectHasChanges(schema, priorVal, configVal)
|
||||
|
||||
if !hasChanges {
|
||||
log.Printf("[TRACE] evalReadDataPlan: %s no change detected, using existing state", absAddr)
|
||||
// state looks up to date, and must have been read during refresh
|
||||
return nil, diags.ErrWithWarnings()
|
||||
}
|
||||
|
||||
log.Printf("[TRACE] evalReadDataPlan: %s configuration changed, planning data source", absAddr)
|
||||
|
||||
newVal, readDiags := n.readDataSource(ctx, configVal)
|
||||
diags = diags.Append(readDiags)
|
||||
if diags.HasErrors() {
|
||||
|
|
@ -132,7 +129,7 @@ func (n *evalReadDataPlan) Eval(ctx EvalContext) (interface{}, error) {
|
|||
// compatible with the config+schema. Since we can't detect the legacy
|
||||
// type system, we can only warn about this for now.
|
||||
var buf strings.Builder
|
||||
fmt.Fprintf(&buf, "[WARN] Provider %q produced an unexpected new value for %s."+
|
||||
fmt.Fprintf(&buf, "[WARN] Provider %q produced an unexpected new value for %s.",
|
||||
n.ProviderAddr.Provider.String(), absAddr)
|
||||
for _, err := range errs {
|
||||
fmt.Fprintf(&buf, "\n - %s", tfdiags.FormatError(err))
|
||||
|
|
@ -191,3 +188,97 @@ func (n *evalReadDataPlan) forcePlanRead(ctx EvalContext) bool {
|
|||
}
|
||||
return false
|
||||
}
|
||||
|
||||
// dataObjectHasChanges determines if the newly evaluated config would cause
|
||||
// any changes in the stored value, indicating that we need to re-read this
|
||||
// data source. The proposed value is returned for validation against the
|
||||
// ReadDataSource response.
|
||||
func dataObjectHasChanges(schema *configschema.Block, priorVal, configVal cty.Value) (proposedVal cty.Value, hasChanges bool) {
|
||||
if priorVal.IsNull() {
|
||||
return priorVal, true
|
||||
}
|
||||
|
||||
// Applying the configuration to the stored state will allow us to detect any changes.
|
||||
proposedVal = objchange.ProposedNewObject(schema, priorVal, configVal)
|
||||
|
||||
if !configVal.IsWhollyKnown() {
|
||||
// Config should have been known here, but handle it the same as ProposedNewObject
|
||||
return proposedVal, true
|
||||
}
|
||||
|
||||
// Normalize the prior value so we can correctly compare the two even if
|
||||
// the prior value came through the legacy SDK.
|
||||
priorVal = createEmptyBlocks(schema, priorVal)
|
||||
|
||||
return proposedVal, proposedVal.Equals(priorVal).False()
|
||||
}
|
||||
|
||||
// createEmptyBlocks will fill in null TypeList or TypeSet blocks with Empty
|
||||
// values. Our decoder will always decode blocks as empty containers, but the
|
||||
// legacy SDK may replace those will null values. Normalizing these values
|
||||
// allows us to correctly compare the ProposedNewObject value in
|
||||
// dataObjectyHasChanges.
|
||||
func createEmptyBlocks(schema *configschema.Block, val cty.Value) cty.Value {
|
||||
if val.IsNull() || !val.IsKnown() {
|
||||
return val
|
||||
}
|
||||
if !val.Type().IsObjectType() {
|
||||
panic(fmt.Sprintf("unexpected type %#v\n", val.Type()))
|
||||
}
|
||||
|
||||
// if there are no blocks, don't bother recreating the cty.Value
|
||||
if len(schema.BlockTypes) == 0 {
|
||||
return val
|
||||
}
|
||||
|
||||
objMap := val.AsValueMap()
|
||||
|
||||
for name, blockType := range schema.BlockTypes {
|
||||
block, ok := objMap[name]
|
||||
if !ok {
|
||||
continue
|
||||
}
|
||||
|
||||
ety := block.Type().ElementType()
|
||||
|
||||
// helper to build the recursive block values
|
||||
nextBlocks := func() []cty.Value {
|
||||
// this is only called once we know this is a non-null List or Set
|
||||
// with a length > 0
|
||||
newVals := make([]cty.Value, 0, block.LengthInt())
|
||||
for it := block.ElementIterator(); it.Next(); {
|
||||
_, val := it.Element()
|
||||
newVals = append(newVals, createEmptyBlocks(&blockType.Block, val))
|
||||
}
|
||||
return newVals
|
||||
}
|
||||
|
||||
// Blocks are always decoded as empty containers, but the legacy
|
||||
// SDK may return null when they are empty.
|
||||
switch blockType.Nesting {
|
||||
// We are only concerned with block types that can come from the legacy
|
||||
// sdk, which means TypeList or TypeSet.
|
||||
case configschema.NestingList:
|
||||
switch {
|
||||
case block.IsNull():
|
||||
objMap[name] = cty.ListValEmpty(ety)
|
||||
case block.LengthInt() == 0:
|
||||
continue
|
||||
default:
|
||||
objMap[name] = cty.ListVal(nextBlocks())
|
||||
}
|
||||
|
||||
case configschema.NestingSet:
|
||||
switch {
|
||||
case block.IsNull():
|
||||
objMap[name] = cty.SetValEmpty(ety)
|
||||
case block.LengthInt() == 0:
|
||||
continue
|
||||
default:
|
||||
objMap[name] = cty.SetVal(nextBlocks())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return cty.ObjectVal(objMap)
|
||||
}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,341 @@
|
|||
package terraform
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/hashicorp/terraform/configs/configschema"
|
||||
"github.com/zclconf/go-cty/cty"
|
||||
)
|
||||
|
||||
func TestReadDataCreateEmptyBlocks(t *testing.T) {
|
||||
setSchema := &configschema.Block{
|
||||
BlockTypes: map[string]*configschema.NestedBlock{
|
||||
"set": {
|
||||
Nesting: configschema.NestingSet,
|
||||
Block: configschema.Block{
|
||||
Attributes: map[string]*configschema.Attribute{
|
||||
"attr": {
|
||||
Type: cty.String,
|
||||
Optional: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
nestedSetSchema := &configschema.Block{
|
||||
BlockTypes: map[string]*configschema.NestedBlock{
|
||||
"set": {
|
||||
Nesting: configschema.NestingSet,
|
||||
Block: configschema.Block{
|
||||
BlockTypes: map[string]*configschema.NestedBlock{
|
||||
"nested-set": {
|
||||
Nesting: configschema.NestingSet,
|
||||
Block: configschema.Block{
|
||||
Attributes: map[string]*configschema.Attribute{
|
||||
"attr": {
|
||||
Type: cty.String,
|
||||
Optional: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
listSchema := &configschema.Block{
|
||||
BlockTypes: map[string]*configschema.NestedBlock{
|
||||
"list": {
|
||||
Nesting: configschema.NestingList,
|
||||
Block: configschema.Block{
|
||||
Attributes: map[string]*configschema.Attribute{
|
||||
"attr": {
|
||||
Type: cty.String,
|
||||
Optional: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
nestedListSchema := &configschema.Block{
|
||||
BlockTypes: map[string]*configschema.NestedBlock{
|
||||
"list": {
|
||||
Nesting: configschema.NestingList,
|
||||
Block: configschema.Block{
|
||||
BlockTypes: map[string]*configschema.NestedBlock{
|
||||
"nested-list": {
|
||||
Nesting: configschema.NestingList,
|
||||
Block: configschema.Block{
|
||||
Attributes: map[string]*configschema.Attribute{
|
||||
"attr": {
|
||||
Type: cty.String,
|
||||
Optional: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range []struct {
|
||||
name string
|
||||
schema *configschema.Block
|
||||
val cty.Value
|
||||
expect cty.Value
|
||||
}{
|
||||
{
|
||||
"set-block",
|
||||
setSchema,
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"set": cty.SetVal([]cty.Value{
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"attr": cty.StringVal("ok"),
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"set": cty.SetVal([]cty.Value{
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"attr": cty.StringVal("ok"),
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
},
|
||||
{
|
||||
"set-block-empty",
|
||||
setSchema,
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"set": cty.SetValEmpty(
|
||||
cty.Object(map[string]cty.Type{
|
||||
"attr": cty.String,
|
||||
}),
|
||||
),
|
||||
}),
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"set": cty.SetValEmpty(
|
||||
cty.Object(map[string]cty.Type{
|
||||
"attr": cty.String,
|
||||
}),
|
||||
),
|
||||
}),
|
||||
},
|
||||
{
|
||||
"set-block-null",
|
||||
setSchema,
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"set": cty.NullVal(cty.Set(
|
||||
cty.Object(map[string]cty.Type{
|
||||
"attr": cty.String,
|
||||
}),
|
||||
)),
|
||||
}),
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"set": cty.SetValEmpty(
|
||||
cty.Object(map[string]cty.Type{
|
||||
"attr": cty.String,
|
||||
}),
|
||||
),
|
||||
}),
|
||||
},
|
||||
{
|
||||
"list-block",
|
||||
listSchema,
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"list": cty.ListVal([]cty.Value{
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"attr": cty.StringVal("ok"),
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"list": cty.ListVal([]cty.Value{
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"attr": cty.StringVal("ok"),
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
},
|
||||
{
|
||||
"list-block-empty",
|
||||
listSchema,
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"list": cty.ListValEmpty(
|
||||
cty.Object(map[string]cty.Type{
|
||||
"attr": cty.String,
|
||||
}),
|
||||
),
|
||||
}),
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"list": cty.ListValEmpty(
|
||||
cty.Object(map[string]cty.Type{
|
||||
"attr": cty.String,
|
||||
}),
|
||||
),
|
||||
}),
|
||||
},
|
||||
{
|
||||
"list-block-null",
|
||||
listSchema,
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"list": cty.NullVal(cty.List(
|
||||
cty.Object(map[string]cty.Type{
|
||||
"attr": cty.String,
|
||||
}),
|
||||
)),
|
||||
}),
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"list": cty.ListValEmpty(
|
||||
cty.Object(map[string]cty.Type{
|
||||
"attr": cty.String,
|
||||
}),
|
||||
),
|
||||
}),
|
||||
},
|
||||
{
|
||||
"nested-set-block",
|
||||
nestedSetSchema,
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"set": cty.SetVal([]cty.Value{
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"nested-set": cty.SetVal([]cty.Value{
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"attr": cty.StringVal("ok"),
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"set": cty.SetVal([]cty.Value{
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"nested-set": cty.SetVal([]cty.Value{
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"attr": cty.StringVal("ok"),
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
},
|
||||
{
|
||||
"nested-set-block-empty",
|
||||
nestedSetSchema,
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"set": cty.SetVal([]cty.Value{
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"nested-set": cty.SetValEmpty(
|
||||
cty.Object(map[string]cty.Type{
|
||||
"attr": cty.String,
|
||||
}),
|
||||
),
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"set": cty.SetVal([]cty.Value{
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"nested-set": cty.SetValEmpty(
|
||||
cty.Object(map[string]cty.Type{
|
||||
"attr": cty.String,
|
||||
}),
|
||||
),
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
},
|
||||
{
|
||||
"nested-set-block-null",
|
||||
nestedSetSchema,
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"set": cty.SetVal([]cty.Value{
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"nested-set": cty.NullVal(cty.Set(
|
||||
cty.Object(map[string]cty.Type{
|
||||
"attr": cty.String,
|
||||
}),
|
||||
)),
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"set": cty.SetVal([]cty.Value{
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"nested-set": cty.SetValEmpty(
|
||||
cty.Object(map[string]cty.Type{
|
||||
"attr": cty.String,
|
||||
}),
|
||||
),
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
},
|
||||
{
|
||||
"nested-list-block-empty",
|
||||
nestedListSchema,
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"list": cty.ListVal([]cty.Value{
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"nested-list": cty.ListValEmpty(
|
||||
cty.Object(map[string]cty.Type{
|
||||
"attr": cty.String,
|
||||
}),
|
||||
),
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"list": cty.ListVal([]cty.Value{
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"nested-list": cty.ListValEmpty(
|
||||
cty.Object(map[string]cty.Type{
|
||||
"attr": cty.String,
|
||||
}),
|
||||
),
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
},
|
||||
{
|
||||
"nested-list-block-null",
|
||||
nestedListSchema,
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"list": cty.ListVal([]cty.Value{
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"nested-list": cty.NullVal(cty.List(
|
||||
cty.Object(map[string]cty.Type{
|
||||
"attr": cty.String,
|
||||
}),
|
||||
)),
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"list": cty.ListVal([]cty.Value{
|
||||
cty.ObjectVal(map[string]cty.Value{
|
||||
"nested-list": cty.ListValEmpty(
|
||||
cty.Object(map[string]cty.Type{
|
||||
"attr": cty.String,
|
||||
}),
|
||||
),
|
||||
}),
|
||||
}),
|
||||
}),
|
||||
},
|
||||
} {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
val := createEmptyBlocks(tc.schema, tc.val)
|
||||
if !tc.expect.Equals(val).True() {
|
||||
t.Fatalf("\nexpected: %#v\ngot : %#v\n", tc.expect, val)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue