Files
2025-09-22 17:15:20 +03:00

117 lines
4.6 KiB
Go

// Copyright (c) The OpenTofu Authors
// SPDX-License-Identifier: MPL-2.0
// Copyright (c) 2023 HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0
package differ
import (
"github.com/opentofu/opentofu/internal/command/jsonformat/computed/renderers"
"github.com/opentofu/opentofu/internal/command/jsonformat/structured"
"github.com/opentofu/opentofu/internal/plans"
"github.com/zclconf/go-cty/cty"
ctyjson "github.com/zclconf/go-cty/cty/json"
"github.com/opentofu/opentofu/internal/command/jsonformat/computed"
"github.com/opentofu/opentofu/internal/command/jsonprovider"
)
// ComputeDiffForAttribute generates the diff for the change.
// It handles 3 specific cases:
// - When the attribute for which the change is generated is a nested object,
// it generates the diff for each attribute
// of the nested object.
// - If the attribute is write-only, due to the fact that its changes will always be null, we want
// to return a diff with the same action as the parent's.
// If we use change.CalculateAction(), then the action will always be NoOp because of the
// which will skip from showing this in the diff.
// - If none above, it tries to generate the diff by using the specific generator for the attr type.
func ComputeDiffForAttribute(change structured.Change, attribute *jsonprovider.Attribute, parentAction plans.Action) computed.Diff {
if attribute.WriteOnly {
return computeAttributeDiffAsWriteOnly(change, parentAction)
}
if attribute.AttributeNestedType != nil {
return computeDiffForNestedAttribute(change, attribute.AttributeNestedType)
}
return ComputeDiffForType(change, unmarshalAttribute(attribute))
}
func computeDiffForNestedAttribute(change structured.Change, nested *jsonprovider.NestedType) computed.Diff {
if sensitive, ok := checkForSensitiveNestedAttribute(change, nested); ok {
return sensitive
}
if computed, ok := checkForUnknownNestedAttribute(change, nested); ok {
return computed
}
switch NestingMode(nested.NestingMode) {
case nestingModeSingle, nestingModeGroup:
return computeAttributeDiffAsNestedObject(change, nested.Attributes)
case nestingModeMap:
return computeAttributeDiffAsNestedMap(change, nested.Attributes)
case nestingModeList:
return computeAttributeDiffAsNestedList(change, nested.Attributes)
case nestingModeSet:
return computeAttributeDiffAsNestedSet(change, nested.Attributes)
default:
panic("unrecognized nesting mode: " + nested.NestingMode)
}
}
func ComputeDiffForType(change structured.Change, ctype cty.Type) computed.Diff {
if sensitive, ok := checkForSensitiveType(change, ctype); ok {
return sensitive
}
if computed, ok := checkForUnknownType(change, ctype); ok {
return computed
}
switch {
case ctype == cty.NilType, ctype == cty.DynamicPseudoType:
// Forward nil or dynamic types over to be processed as outputs.
// There is nothing particularly special about the way outputs are
// processed that make this unsafe, we could just as easily call this
// function computeChangeForDynamicValues(), but external callers will
// only be in this situation when processing outputs so this function
// is named for their benefit.
return ComputeDiffForOutput(change)
case ctype.IsPrimitiveType():
return computeAttributeDiffAsPrimitive(change, ctype)
case ctype.IsObjectType():
return computeAttributeDiffAsObject(change, ctype.AttributeTypes())
case ctype.IsMapType():
return computeAttributeDiffAsMap(change, ctype.ElementType())
case ctype.IsListType():
return computeAttributeDiffAsList(change, ctype.ElementType())
case ctype.IsTupleType():
return computeAttributeDiffAsTuple(change, ctype.TupleElementTypes())
case ctype.IsSetType():
return computeAttributeDiffAsSet(change, ctype.ElementType())
default:
panic("unrecognized type: " + ctype.FriendlyName())
}
}
func unmarshalAttribute(attribute *jsonprovider.Attribute) cty.Type {
ctyType, err := ctyjson.UnmarshalType(attribute.AttributeType)
if err != nil {
panic("could not unmarshal attribute type: " + err.Error())
}
return ctyType
}
func computeAttributeDiffAsWriteOnly(change structured.Change, parentAction plans.Action) computed.Diff {
// If the provider returned this write-only attribute in the require_replace list,
// we want to be sure that the action is not plans.NoOp.
// plans.Update might be the wrong one
// We want to do this to be sure that the user is informed about the fields that forces
// the replacement of the resource.
if parentAction == plans.NoOp && change.ReplacePaths.Matches() {
parentAction = plans.Update
}
return asDiffWithInheritedAction(change, parentAction, renderers.WriteOnly())
}