schema.go

// Copyright 2016-2018, Pulumi Corporation.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package tfbridge

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	"reflect"
	"sort"
	"strconv"
	"strings"

	"github.com/golang/glog"
	pbstruct "github.com/golang/protobuf/ptypes/struct"
	"github.com/pkg/errors"

	"github.com/pulumi/pulumi/sdk/v3/go/common/resource"
	"github.com/pulumi/pulumi/sdk/v3/go/common/resource/plugin"
	"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"

	shim "github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tfshim"
	"github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tfshim/schema"
	shimutil "github.com/pulumi/pulumi-terraform-bridge/v3/pkg/tfshim/util"
)

// This file deals with translating between the Pulumi representations of a resource's configuration and state and the
// Terraform shim's representations of the same.
//
// # Terraform Representations
//
// The Terraform shim represents a resource's configuration and state as plain-old Go values. These values may be
// any of the following types:
//
//     - nil
//     - bool
//     - int
//     - float64
//     - string
//     - []interface{}
//     - map[string]interface{}
//     - Set (state only; exact type varies between shim implementations; see shim.Provider.IsSet)
//
// Unknown values are represented using a sentinel string value (see TerraformUnknownVariableValue).
//
// The Terraform shim also records a schema for each resource & data source that is used to guide the conversion
// process. The schema indicates the type or sub-schema for each of the resource's properties. The schema types
// and their corresponding value types are given below.
//
//     Schema Type | TF type                | Notes
//     ------------+------------------------+------------
//        TypeBool |                   bool |
//         TypeInt |                    int |
//       TypeFloat |                  float |
//      TypeString |                 string |
//        TypeList |          []interface{} |
//         TypeMap | map[string]interface{} | See below for a special case involving object types
//         TypeSet |     []interface{}, Set | Set values are only present in state
//
// Note that object types are not present in the set of schema types. Instead, they exist either at the resource level
// or as the element type of a List, Map, or Set (concretely, the type of schema.Elem() will be shim.Resource). As a
// special case, the value of a TypeMap property with an object element type is represented as a single-element
// []interface{} where the single element is the object value.
//
// # Pulumi Representations
//
// Pulumi represents a resource's configuration and state as resource.PropertyValue values. These values are
// JSON-like with a few extensions. The only extensions that are relevant to this code are unknowns, assets, and
// archives. Unknowns represent unknown values, while assets and archives represent flat binary or archive data
// (e.g. .tar or .zip files), respectively.
//
// To improve the user experience of the generated SDKs, the bridge also carries optional overlays for resources.
// These overlays control various aspects of the conversion process, notably name translation, asset translation,
// and single-element list projection.
//
// # Conversion Process
//
// The conversion process is informed by the kind of conversion to perform, the Terraform schema for the value,
// and the tfbridge overlays for the value.
//
// In most cases, mapping between the value spaces is straightforward, and follows these rules:
//
//     Pulumi type | TF type(s)                 | Notes
//     ------------+----------------------------+-----------------------
//            null |                        nil |
//            bool |                       bool |
//          number |               float64, int | for config conversion, numbers are converted per the TF schema
//          string | string, bool, float64, int | for state conversion, strings may be coerced per schema+overlays
//           array |              []interface{} |
//          object |     map[string]interface{} | keys may be mapped between snake and Pascal case per schema+overlays
//           asset |             string, []byte | file path or literal contents per overlays
//         archive |             string, []byte | file path or literal contents per overlays
//         unknown |                     string | always the unknown sentinel string value
//
// Certain properties that are represented by the shim as single-element `[]interface{}` values may be represented by
// Pulumi as their single element. This is controlled by the Terraform schema and the tfbridge overlays (see
// IsMaxItemsOne for details).
//
// ## Pulumi Inputs -> TF Config Conversion
//
// In addition to the usual conversion operation, config conversion has the onerous task of applying default values
// for missing properties if a default is present in the TF schema or tfbridge overlays. Default application is a
// relatively complex process. To determine the default value for a missing property:
//
//     1. If setting a value for the property would cause a conflict with other properties per the TF schema,
//        then the property has no default value.
//     2. If the property is marked as removed, it has no default value.
//     3. If the property's overlay contains default value information:
//         a. If there is an old value for property and that value was a default value, use the old value.
//            This ensures that non-deterministic defaults (e.g. autonames) are not recalculated.
//         b. If the default value is sourced from an envvar, read the envvar.
//         c. If the default value is source from provider config, grab it from the indicated config value.
//         d. If the default value is literal, use the literal value.
//         e. If the default value is computed by a function, call the function.
//     4. If the property's TF schema has a default value:
//         a. If there is an old value for property and that value was a default value, use the old value.
//            This ensures that non-deterministic defaults (e.g. autonames) are not recalculated.
//         b. Otherwise, the value is literal. Use the literal value.
//
// Each object-typed value contains metadata about the properties that were set using default values under a
// special key ("__defaults"). This information is consulted in steps 3a and 4a to determine whether or not to
// propagate the old value for a property as a default.
//
// Config conversion also records which properties were originally assets or archives so that the state converter
// can round-trip the values of those properties as assets/archives.
//
// The entry point for input to config conversion is MakeTerraformConfig.
//
// ## TF State/Config -> Pulumi Outputs Conversion
//
// In order to provide full-fidelity round-tripping of properties that were presented in the config as assets or
// archives, the state converter accepts a mapping from properties to asset/archive values. The converter consults
// consults
//
// The entry point for state/config to output conversion is MakeTerraformResult.
//
// ## Pulumi Outputs -> TF State Conversion
//
// Output to state conversion follows the same rules as input to config conversion, but does not apply defaults or
// record asset and archive values.
//
// # Additional Notes
//
// The process for converting between Pulumi and Terraform values is rather complicated, and occasionally has some
// pretty frustrating impedance mismatches with Terraform itself. These mismatches have become more pronounced as
// Terraform has evolved, and mostly seem to be due to the fact that tfbridge interfaces with Terraform providers
// at a different layer than Terraform itself. Terraform speaks to resource providers over a well-defined gRPC
// interface that as of TF 0.12 provides access to the provider's schema as well as config validation, plan, and
// apply operations (plus a few other sundries). tfbridge, however, interacts with the Terraform plugin SDK, which
// sits on top of the gRPC interface. As a result, the inputs tfbridge passes to the plugin SDK's APIs are not
// subject to the preprocessing that is performed when Terraform interacts with the provider via the gRPC API.
//
// If tfbridge also used the gRPC interface (ideally in-memory or in-process), its implementation may be simpler.
// With that approach, tfbridge would be responsible for producing config and state in the same shape as the Terraform
// CLI and expected by the gRPC interface, and that config and state would be subject to the same pipeline as that
// produced by the Terraform CLI. The major blocker to this design is our current approach to default values, which
// relies on visibility into default values and `ConflictsWith` information that is not exposed by the gRPC-level
// provider schema. It is unclear what the overall effect of dropping this approach to default values would be, but
// one very likely change is that default values from providers would no longer be rendered as part of diffs in the
// Pulumi CLI. It may be possible to remedy that experience through changes to the CLI.
//
// There is something approaching a prototype of the above approach in pkg/tfshim/tfplugin5. That code has bitrotted
// somewhat since its creation, as it is not actively used in production.

// TerraformUnknownVariableValue is the sentinal defined in github.com/hashicorp/terraform/configs/hcl2shim,
// representing a variable whose value is not known at some particular time. The value is duplicated here in
// order to prevent an additional dependency - it is unlikely to ever change upstream since that would break
// rather a lot of things.
const TerraformUnknownVariableValue = "74D93920-ED26-11E3-AC10-0800200C9A66"

// defaultsKey is the name of the input property that is used to track which property keys were populated using
// default values from the resource's schema. This information is used to inform which input properties should be
// populated using old defaults in subsequent updates. When populating the default value for an input property, the
// property's old value will only be used as the default if the property's key is present in the defaults list for
// the old property bag.
const defaultsKey = "__defaults"

// AssetTable is used to record which properties in a call to MakeTerraformInputs were assets so that they can be
// marshaled back to assets by MakeTerraformOutputs.
type AssetTable map[*SchemaInfo]resource.PropertyValue

// ErrSchemaDefaultValue is used internally to avoid a panic in pf/schemashim.DefaultValue().
// See https://github.com/pulumi/pulumi-terraform-bridge/issues/1329
var ErrSchemaDefaultValue = fmt.Errorf("default values not supported")

// nameRequiresDeleteBeforeReplace returns true if the given set of resource inputs includes an autonameable
// property with a value that was not populated by the autonamer.
func nameRequiresDeleteBeforeReplace(news resource.PropertyMap, olds resource.PropertyMap,
	tfs shim.SchemaMap, resourceInfo *ResourceInfo) bool {
	fields := resourceInfo.Fields

	defaults, hasDefaults := news[defaultsKey]
	if !hasDefaults || !defaults.IsArray() {
		// If there is no list of properties that were populated using defaults, consider the resource autonamed.
		// This avoids setting delete-before-replace for resources that were created before the defaults list existed.
		return false
	}

	hasDefault := map[resource.PropertyKey]bool{}
	for _, key := range defaults.ArrayValue() {
		if !key.IsString() {
			continue
		}
		hasDefault[resource.PropertyKey(key.StringValue())] = true
	}

	// These are a list of Pulumi named fields that we care about comparing to try
	// and override the deleteBeforeReplace e.g. name or namePrefix
	// if any of these values change then we can assume we can
	if len(resourceInfo.UniqueNameFields) > 0 {
		for _, name := range resourceInfo.UniqueNameFields {
			key := resource.PropertyKey(name)
			_, _, psi := getInfoFromPulumiName(key, tfs, fields)

			oldVal := olds[key]
			newVal := news[key]

			if !oldVal.DeepEquals(newVal) {
				return false
			}

			if psi != nil && psi.HasDefault() && psi.Default.AutoNamed && hasDefault[key] {
				return false
			}
		}

		return true
	}

	for key := range news {
		_, _, psi := getInfoFromPulumiName(key, tfs, fields)
		if psi != nil && psi.HasDefault() && psi.Default.AutoNamed && !hasDefault[key] {
			return true
		}
	}

	return false
}

func multiEnvDefault(names []string, dv interface{}) interface{} {
	for _, n := range names {
		if v := os.Getenv(n); v != "" {
			return v
		}
	}
	return dv
}

func getSchema(m shim.SchemaMap, key string) shim.Schema {
	if m == nil {
		return nil
	}
	return m.Get(key)
}

func elemSchemas(sch shim.Schema, ps *SchemaInfo) (shim.Schema, *SchemaInfo) {
	var esch shim.Schema
	if sch != nil {
		switch e := sch.Elem().(type) {
		case shim.Schema:
			esch = e
		case shim.Resource:
			esch = (&schema.Schema{Elem: e}).Shim()
		default:
			esch = nil
		}
	}

	var eps *SchemaInfo
	if ps != nil {
		eps = ps.Elem
	}

	return esch, eps
}

type conversionContext struct {
	Ctx                      context.Context
	ComputeDefaultOptions    ComputeDefaultOptions
	ProviderConfig           resource.PropertyMap
	ApplyDefaults            bool
	ApplyTFDefaults          bool
	ApplyMaxItemsOneDefaults bool
	Assets                   AssetTable
}

type makeTerraformInputsOptions struct {
	DisableDefaults           bool
	DisableTFDefaults         bool
	EnableMaxItemsOneDefaults bool
}

func makeTerraformInputsWithOptions(
	ctx context.Context, instance *PulumiResource, config resource.PropertyMap,
	olds, news resource.PropertyMap, tfs shim.SchemaMap, ps map[string]*SchemaInfo,
	opts makeTerraformInputsOptions,
) (map[string]interface{}, AssetTable, error) {
	cdOptions := ComputeDefaultOptions{}
	if instance != nil {
		cdOptions = ComputeDefaultOptions{
			PriorState: olds,
			Properties: instance.Properties,
			Seed:       instance.Seed,
			URN:        instance.URN,
		}
	}

	cctx := &conversionContext{
		Ctx:                      ctx,
		ComputeDefaultOptions:    cdOptions,
		ProviderConfig:           config,
		ApplyDefaults:            !opts.DisableDefaults,
		ApplyTFDefaults:          !opts.DisableTFDefaults,
		ApplyMaxItemsOneDefaults: opts.EnableMaxItemsOneDefaults,
		Assets:                   AssetTable{},
	}

	inputs, err := cctx.makeTerraformInputs(olds, news, tfs, ps)
	if err != nil {
		return nil, nil, err
	}
	return inputs, cctx.Assets, err
}

func MakeTerraformInputs(
	ctx context.Context, instance *PulumiResource, config resource.PropertyMap,
	olds, news resource.PropertyMap, tfs shim.SchemaMap, ps map[string]*SchemaInfo,
) (map[string]interface{}, AssetTable, error) {
	return makeTerraformInputsWithOptions(ctx, instance, config, olds, news, tfs, ps, makeTerraformInputsOptions{})
}

// makeTerraformInput takes a single property plus custom schema info and does whatever is necessary
// to prepare it for use by Terraform. Note that this function may have side effects, for instance
// if it is necessary to spill an asset to disk in order to create a name out of it. Please take
// care not to call it superfluously!
func (ctx *conversionContext) makeTerraformInput(
	name string,
	old, v resource.PropertyValue,
	tfs shim.Schema,
	ps *SchemaInfo,
) (interface{}, error) {
	// For TypeList or TypeSet with MaxItems==1, we will have projected as a scalar
	// nested value, and need to wrap it into a single-element array before passing to
	// Terraform.
	if IsMaxItemsOne(tfs, ps) {
		wrap := func(val resource.PropertyValue) resource.PropertyValue {
			if val.IsNull() {
				return resource.NewArrayProperty([]resource.PropertyValue{})
			}

			// If we are expecting a value of type `[T]` where `T != TypeList`
			// and we already see `[T]`, we see that `v` is already the right
			// shape and return as is.
			//
			// This is possible when the old state is from a previous version
			// with `MaxItemsOne=false` but the new state has
			// `MaxItemsOne=true`.
			if elem := tfs.Elem(); elem != nil {
				if elem, ok := elem.(shim.Schema); ok &&
					// If the underlying type is not a list or set,
					// but the value is a list, we just return as is.
					!(elem.Type() == shim.TypeList || elem.Type() == shim.TypeSet) &&
					val.IsArray() {
					return val
				}
			}

			return resource.NewArrayProperty([]resource.PropertyValue{val})
		}
		old = wrap(old)
		v = wrap(v)
	}

	wrapError := func(v any, err error) (any, error) {
		if err == nil {
			return v, nil
		}

		return v, fmt.Errorf("%s: %w", name, err)
	}

	// If there is a custom transform for this value, run it before processing the value.
	if ps != nil && ps.Transform != nil {
		nv, err := ps.Transform(v)
		if err != nil {
			return wrapError(nv, err)
		}
		v = nv
	}

	if tfs == nil {
		tfs = (&schema.Schema{}).Shim()
	}

	switch {
	case v.IsNull():
		return nil, nil
	case v.IsBool():
		switch tfs.Type() {
		case shim.TypeString:
			if v.BoolValue() {
				return "true", nil
			}
			return "false", nil
		default:
			return v.BoolValue(), nil
		}
	case v.IsNumber():
		switch tfs.Type() {
		case shim.TypeFloat:
			return v.NumberValue(), nil
		case shim.TypeString:
			return strconv.FormatFloat(v.NumberValue(), 'f', -1, 64), nil
		default: // By default, we return ints
			return int(v.NumberValue()), nil
		}
	case v.IsString():
		switch tfs.Type() {
		case shim.TypeInt:
			v, err := wrapError(strconv.ParseInt(v.StringValue(), 10, 64))
			// The plugin sdk asserts against the type - need this to be an int.
			return int(v.(int64)), err
		default:
			return v.StringValue(), nil
		}
	case v.IsArray():
		var oldArr []resource.PropertyValue
		if old.IsArray() {
			oldArr = old.ArrayValue()
		}

		etfs, eps := elemSchemas(tfs, ps)

		var arr []interface{}
		for i, elem := range v.ArrayValue() {
			var oldElem resource.PropertyValue
			if i < len(oldArr) {
				oldElem = oldArr[i]
			}
			elemName := fmt.Sprintf("%v[%v]", name, i)
			e, err := ctx.makeTerraformInput(elemName, oldElem, elem, etfs, eps)
			if err != nil {
				return nil, err
			}

			if ps != nil && ps.SuppressEmptyMapElements != nil && *ps.SuppressEmptyMapElements {
				if eMap, ok := e.(map[string]interface{}); ok && len(eMap) > 0 {
					arr = append(arr, e)
				}
			} else {
				arr = append(arr, e)
			}
		}
		return arr, nil
	case v.IsAsset():
		// We require that there be asset information, otherwise an error occurs.
		if ps == nil || ps.Asset == nil {
			return nil, errors.Errorf("unexpected asset %s", name)
		} else if !ps.Asset.IsAsset() {
			return nil, errors.Errorf("expected an asset, but %s is not an asset", name)
		}
		if ctx.Assets != nil {
			_, has := ctx.Assets[ps]
			contract.Assertf(!has, "duplicate schema info for asset")
			ctx.Assets[ps] = v
		}
		return ps.Asset.TranslateAsset(v.AssetValue())
	case v.IsArchive():
		// We require that there be archive information, otherwise an error occurs.
		if ps == nil || ps.Asset == nil {
			return nil, errors.Errorf("unexpected archive %s", name)
		}
		if ctx.Assets != nil {
			_, has := ctx.Assets[ps]
			contract.Assertf(!has, "duplicate schema info for asset")
			ctx.Assets[ps] = v
		}
		return ps.Asset.TranslateArchive(v.ArchiveValue())
	case v.IsObject():
		var oldObject resource.PropertyMap
		if old.IsObject() {
			oldObject = old.ObjectValue()
		}

		var tfflds shim.SchemaMap

		// We cannot use [shimutil.CastToTypeObject] because we have machinery that constructs invalid
		// resource objects, such as [elemSchemas].
		if tfs != nil {
			if r, ok := tfs.Elem().(shim.Resource); ok {
				tfflds = r.Schema()
			}
		}

		if tfflds != nil {
			var psflds map[string]*SchemaInfo
			if ps != nil {
				psflds = ps.Fields
			}
			obj, err := ctx.makeObjectTerraformInputs(oldObject, v.ObjectValue(), tfflds, psflds)
			if err != nil {
				return nil, err
			}

			if tfs.Type() == shim.TypeMap {
				// If we have schema information that indicates that this value is being
				// presented to a map-typed field whose Elem is a shim.Resource, wrap the
				// value in an array in order to work around a bug in Terraform.
				//
				// TODO[pulumi/pulumi-terraform-bridge#1828]: This almost certainly stems from
				// a bug in the bridge's implementation and not terraform's implementation.
				return []interface{}{obj}, nil
			}
			return obj, nil
		}

		etfs, eps := elemSchemas(tfs, ps)
		return ctx.makeMapTerraformInputs(oldObject, v.ObjectValue(), etfs, eps)
	case v.IsComputed() || v.IsOutput():
		// If any variables are unknown, we need to mark them in the inputs so the config map treats it right.  This
		// requires the use of the special UnknownVariableValue sentinel in Terraform, which is how it internally stores
		// interpolated variables whose inputs are currently unknown.
		return makeTerraformUnknown(tfs), nil
	default:
		contract.Failf("Unexpected value marshaled: %v", v)
		return nil, nil
	}
}

// makeTerraformInputs takes a property map plus custom schema info and does whatever is necessary
// to prepare it for use by Terraform.  Note that this function may have side effects, for instance
// if it is necessary to spill an asset to disk in order to create a name out of it.  Please take
// care not to call it superfluously!
func (ctx *conversionContext) makeTerraformInputs(
	olds, news resource.PropertyMap,
	tfs shim.SchemaMap,
	ps map[string]*SchemaInfo,
) (map[string]interface{}, error) {
	return ctx.makeObjectTerraformInputs(olds, news, tfs, ps)
}

// Should only be called from inside makeTerraformInputs. Variation for makeTerraformInputs used
// when the schema indicates that the code is handling a map[string,X] case and not an object.
func (ctx *conversionContext) makeMapTerraformInputs(
	olds, news resource.PropertyMap,
	tfsElement shim.Schema,
	psElement *SchemaInfo,
) (map[string]interface{}, error) {
	result := make(map[string]interface{})

	for key, value := range news {
		// Map keys always preserved as-is, no translation necessary.
		name := string(key)

		var old resource.PropertyValue
		if ctx.ApplyDefaults && olds != nil {
			old = olds[key]
		}

		v, err := ctx.makeTerraformInput(name, old, value, tfsElement, psElement)
		if err != nil {
			return nil, err
		}
		result[name] = v
		glog.V(9).Infof("Created Terraform input: %v = %v", name, v)
	}

	if glog.V(5) {
		for k, v := range result {
			glog.V(5).Infof("Terraform input %v = %#v", k, v)
		}
	}

	return result, nil
}

// Should only be called from inside makeTerraformInputs. This variation should only be
// handling the case when an object type is expected. The case when map types are expected
// or the schema is lost and the translation is not sure of the expected type is handled
// by makeMapTerraformInputs.
func (ctx *conversionContext) makeObjectTerraformInputs(
	olds, news resource.PropertyMap,
	tfs shim.SchemaMap,
	ps map[string]*SchemaInfo,
) (map[string]interface{}, error) {
	result := make(map[string]interface{})
	tfAttributesToPulumiProperties := make(map[string]string)

	// Enumerate the inputs provided and add them to the map using their Terraform names.
	for key, value := range news {
		// If this is a reserved property, ignore it.
		switch key {
		case defaultsKey, metaKey:
			continue
		}

		// First translate the Pulumi property name to a Terraform name.
		name, tfi, psi := getInfoFromPulumiName(key, tfs, ps)
		contract.Assertf(name != "", `Object properties cannot be empty`)

		if _, duplicate := result[name]; duplicate {
			// If multiple Pulumi `key`s map to the same Terraform attribute `name`, then
			// this function's output is dependent on the iteration order of `news`, and
			// thus non-deterministic. Values clober each other when assigning to
			// `result[name]`.
			//
			// We fail with an "internal" error because this duplication should have been
			// caught when `make tfgen` was run.
			//
			// For context, see:
			// - https://github.com/pulumi/pulumi-terraform-bridge/issues/774
			// - https://github.com/pulumi/pulumi-terraform-bridge/issues/773
			return nil, fmt.Errorf(
				"internal: Pulumi property '%s' mapped non-uniquely to Terraform attribute '%s' (duplicates Pulumi key '%s')",
				key, name, tfAttributesToPulumiProperties[name])
		}
		tfAttributesToPulumiProperties[name] = string(key)
		var old resource.PropertyValue
		if ctx.ApplyDefaults && olds != nil {
			old = olds[key]
		}

		// And then translate the property value.
		v, err := ctx.makeTerraformInput(name, old, value, tfi, psi)
		if err != nil {
			return nil, err
		}
		result[name] = v
		glog.V(9).Infof("Created Terraform input: %v = %v", name, v)
	}

	// Now enumerate and propagate defaults if the corresponding values are still missing.
	if err := ctx.applyDefaults(result, olds, news, tfs, ps); err != nil {
		return nil, err
	}

	if tfs != nil && ctx.ApplyMaxItemsOneDefaults {
		// Iterate over the TF schema and add an empty array for each nil MaxItemsOne property.
		tfs.Range(func(key string, value shim.Schema) bool {
			// First do a lookup of the name/info.
			_, tfi, psi := getInfoFromTerraformName(key, tfs, ps, false)
			if IsMaxItemsOne(tfi, psi) && result[key] == nil {
				result[key] = []interface{}{}
			}
			return true
		})
	}

	if glog.V(5) {
		for k, v := range result {
			glog.V(5).Infof("Terraform input %v = %#v", k, v)
		}
	}

	return result, nil
}

func buildExactlyOneOfsWith(result map[string]interface{}, tfs shim.SchemaMap) map[string]struct{} {
	exactlyOneOf := make(map[string]struct{})
	if tfs != nil {
		tfs.Range(func(name string, sch shim.Schema) bool {
			if _, has := result[name]; has {
				// `name` is present, so mark any names that are declared to
				// exactlyOneOf with `name` for exclusion.
				for _, exclusion := range sch.ExactlyOneOf() {
					exactlyOneOf[exclusion] = struct{}{}
				}
			} else {
				// `name` is not present, so mark it for exclusion if any fields
				// that exactlyOneOf with `name` are present.
				for _, exclusion := range sch.ExactlyOneOf() {
					if _, has := result[exclusion]; has {
						exactlyOneOf[name] = struct{}{}
						break
					}
				}
			}
			return true
		})
	}

	return exactlyOneOf
}

func buildConflictsWith(result map[string]interface{}, tfs shim.SchemaMap) map[string]struct{} {
	conflictsWith := make(map[string]struct{})
	if tfs != nil {
		tfs.Range(func(name string, sch shim.Schema) bool {
			if _, has := result[name]; has {
				// `name` is present, so mark any names that are declared to
				// conflict with `name` for exclusion.
				for _, conflictingName := range sch.ConflictsWith() {
					conflictsWith[conflictingName] = struct{}{}
				}
			} else {
				// `name` is not present, so mark it for exclusion if any fields
				// that conflict with `name` are present.
				for _, conflictingName := range sch.ConflictsWith() {
					if _, has := result[conflictingName]; has {
						conflictsWith[name] = struct{}{}
						break
					}
				}
			}
			return true
		})
	}

	return conflictsWith
}

func (ctx *conversionContext) applyDefaults(
	result map[string]interface{},
	olds, news resource.PropertyMap,
	tfs shim.SchemaMap,
	ps map[string]*SchemaInfo,
) error {

	if !ctx.ApplyDefaults {
		return nil
	}

	// Create an array to track which properties are defaults.
	newDefaults := []interface{}{}

	// Pull the list of old defaults if any. If there is no list, then we will treat all old values as being usable
	// for new defaults. If there is a list, we will only propagate defaults that were themselves defaults.
	useOldDefault := func(key resource.PropertyKey) bool { return true }
	if oldDefaults, ok := olds[defaultsKey]; ok {
		oldDefaultSet := make(map[resource.PropertyKey]bool)
		for _, k := range oldDefaults.ArrayValue() {
			oldDefaultSet[resource.PropertyKey(k.StringValue())] = true
		}
		useOldDefault = func(key resource.PropertyKey) bool { return oldDefaultSet[key] }
	}

	// Compute any names for which setting a default would cause a conflict.
	conflictsWith := buildConflictsWith(result, tfs)
	exactlyOneOf := buildExactlyOneOfsWith(result, tfs)

	// First, attempt to use the overlays.
	for name, info := range ps {
		if info.Removed {
			continue
		}
		if _, conflicts := conflictsWith[name]; conflicts {
			continue
		}
		if _, exactlyOneOfConflicts := exactlyOneOf[name]; exactlyOneOfConflicts {
			continue
		}
		sch := getSchema(tfs, name)
		if sch != nil && (sch.Removed() != "" || sch.Deprecated() != "" && !sch.Required()) {
			continue
		}

		if _, has := result[name]; !has && info.HasDefault() {
			var defaultValue interface{}
			var source string

			// If we already have a default value from a previous version of this resource, use that instead.
			key, tfi, psi := getInfoFromTerraformName(name, tfs, ps, false)

			if old, hasold := olds[key]; hasold && useOldDefault(key) {
				v, err := ctx.makeTerraformInput(name, resource.PropertyValue{},
					old, tfi, psi)
				if err != nil {
					return err
				}
				defaultValue, source = v, "old default"
			} else if envVars := info.Default.EnvVars; len(envVars) != 0 {
				var err error
				v := multiEnvDefault(envVars, info.Default.Value)
				if str, ok := v.(string); ok && sch != nil {
					switch sch.Type() {
					case shim.TypeBool:
						v = false
						if str != "" {
							if v, err = strconv.ParseBool(str); err != nil {
								return err
							}
						}
					case shim.TypeInt:
						v = int(0)
						if str != "" {
							iv, iverr := strconv.ParseInt(str, 0, 0)
							if iverr != nil {
								return iverr
							}
							v = int(iv)
						}
					case shim.TypeFloat:
						v = float64(0.0)
						if str != "" {
							if v, err = strconv.ParseFloat(str, 64); err != nil {
								return err
							}
						}
					case shim.TypeString:
						// nothing to do
					default:
						return errors.Errorf("unknown type for default value: %v", sch.Type())
					}
				}
				defaultValue, source = v, "env vars"
			} else if configKey := info.Default.Config; configKey != "" {
				if v := ctx.ProviderConfig[resource.PropertyKey(configKey)]; !v.IsNull() {
					tv, err := ctx.makeTerraformInput(name, resource.PropertyValue{}, v, tfi, psi)
					if err != nil {
						return err
					}
					defaultValue, source = tv, "config"
				}
			} else if info.Default.Value != nil {
				v := resource.NewPropertyValue(info.Default.Value)
				tv, err := ctx.makeTerraformInput(name, resource.PropertyValue{}, v, tfi, psi)
				if err != nil {
					return err
				}
				defaultValue, source = tv, "Pulumi schema"
			} else if compute := info.Default.ComputeDefault; compute != nil {
				cdOpts := ctx.ComputeDefaultOptions
				if old, hasold := olds[key]; hasold {
					cdOpts.PriorValue = old
				}
				v, err := compute(ctx.Ctx, cdOpts)
				if err != nil {
					return err
				}
				defaultValue, source = v, "func"
			} else if from := info.Default.From; from != nil {
				v, err := from(&PulumiResource{
					URN:        ctx.ComputeDefaultOptions.URN,
					Properties: ctx.ComputeDefaultOptions.Properties,
					Seed:       ctx.ComputeDefaultOptions.Seed,
				})
				if err != nil {
					return err
				}
				defaultValue, source = v, "func"
			}
			if defaultValue != nil {
				glog.V(9).Infof("Created Terraform input: %v = %v (from %s)", name, defaultValue, source)
				result[name] = defaultValue
				newDefaults = append(newDefaults, key)

				// Expand the conflicts and exactlyOneOf map
				if sch != nil {
					for _, conflictingName := range sch.ConflictsWith() {
						conflictsWith[conflictingName] = struct{}{}
					}

					for _, exactlyOneOfName := range sch.ExactlyOneOf() {
						exactlyOneOf[exactlyOneOfName] = struct{}{}
					}
				}
			}
		}
	}

	// Next, populate defaults from the Terraform schema.
	if tfs != nil && ctx.ApplyTFDefaults {
		var valueErr error
		tfs.Range(func(name string, sch shim.Schema) bool {
			if sch.Removed() != "" {
				return true
			}
			if sch.Deprecated() != "" && !sch.Required() {
				return true
			}
			if _, conflicts := conflictsWith[name]; conflicts {
				return true
			}

			if _, exactlyOneOfConflict := exactlyOneOf[name]; exactlyOneOfConflict {
				return true
			}

			// If a conflicting field has a default value, don't set the default for the current field
			for _, conflictingName := range sch.ConflictsWith() {
				if conflictingSchema, exists := tfs.GetOk(conflictingName); exists {
					dv, _ := conflictingSchema.DefaultValue()
					if dv != nil {
						return true
					}
				}
			}

			for _, exactlyOneOfName := range sch.ExactlyOneOf() {
				// If any *other* ExactlyOneOf keys have a default value, don't set the default for the current field
				if exactlyOneOfName == name {
					continue
				}
				if exactlyOneSchema, exists := tfs.GetOk(exactlyOneOfName); exists {
					dv, _ := exactlyOneSchema.DefaultValue()
					if dv != nil {
						return true
					}
				}
			}

			if _, has := result[name]; !has {
				var source string

				// Check for a default value from Terraform. If there is not default from terraform, skip this name.
				dv, err := sch.DefaultValue()
				if err != nil {
					valueErr = err
					return false
				} else if dv == nil {
					return true
				}

				// Next, if we already have a default value from a previous version of this
				// resource, use that instead.
				key, tfi, psi := getInfoFromTerraformName(name, tfs, ps, false)

				if old, hasold := olds[key]; hasold && useOldDefault(key) {
					v, err := ctx.makeTerraformInput(name, resource.PropertyValue{}, old, tfi, psi)
					if err != nil {
						valueErr = err
						return false
					}
					dv, source = v, "old default"
				} else {
					source = "Terraform schema"
				}

				if dv != nil {
					glog.V(9).Infof("Created Terraform input: %v = %v (from %s)", name, dv, source)
					result[name] = dv
					newDefaults = append(newDefaults, key)
				}
			}

			return true
		})
		if valueErr != nil {
			return valueErr
		}
	}

	sort.Slice(newDefaults, func(i, j int) bool {
		return newDefaults[i].(resource.PropertyKey) < newDefaults[j].(resource.PropertyKey)
	})
	result[defaultsKey] = newDefaults

	return nil
}

// makeTerraformUnknownElement creates an unknown value to be used as an element of a list or set using the given
// element schema to guide the shape of the value.
func makeTerraformUnknownElement(elem interface{}) interface{} {
	// If we have no element schema, just return a simple unknown.
	if elem == nil {
		return TerraformUnknownVariableValue
	}

	switch e := elem.(type) {
	case shim.Schema:
		// If the element uses a normal schema, defer to makeTerraformUnknown.
		return makeTerraformUnknown(e)
	case shim.Resource:
		// If the element uses a resource schema, fill in unknown values for any required properties.
		res := make(map[string]interface{})
		e.Schema().Range(func(k string, v shim.Schema) bool {
			if v.Required() {
				res[k] = makeTerraformUnknown(v)
			}
			return true
		})
		return res
	default:
		return TerraformUnknownVariableValue
	}
}

// makeTerraformUnknown creates an unknown value with the shape indicated by the given schema.
//
// It is important that we use the TF schema (if available) to decide what shape the unknown value should have:
// e.g. TF does not play nicely with unknown lists, instead expecting a list of unknowns.
func makeTerraformUnknown(tfs shim.Schema) interface{} {
	if tfs == nil {
		return TerraformUnknownVariableValue
	}

	switch tfs.Type() {
	case shim.TypeList, shim.TypeSet:
		// TF does not accept unknown lists or sets. Instead, it accepts lists or sets of unknowns.
		count := 1
		if tfs.MinItems() > 0 {
			count = tfs.MinItems()
		}
		arr := make([]interface{}, count)
		for i := range arr {
			arr[i] = makeTerraformUnknownElement(tfs.Elem())
		}
		return arr
	default:
		return TerraformUnknownVariableValue
	}
}

// metaKey is the key in a TF bridge result that is used to store a resource's meta-attributes.
const metaKey = "__meta"

// MakeTerraformResult expands a Terraform state into an expanded Pulumi resource property map.  This respects
// the property maps so that results end up with their correct Pulumi names when shipping back to the engine.
func MakeTerraformResult(
	ctx context.Context,
	p shim.Provider,
	state shim.InstanceState,
	tfs shim.SchemaMap,
	ps map[string]*SchemaInfo,
	assets AssetTable,
	supportsSecrets bool,
) (resource.PropertyMap, error) {

	var outs map[string]interface{}
	if state != nil {
		obj, err := state.Object(tfs)
		if err != nil {
			return nil, err
		}
		outs = obj
	}

	outMap := MakeTerraformOutputs(ctx, p, outs, tfs, ps, assets, supportsSecrets)

	// If there is any Terraform metadata associated with this state, record it.
	if state != nil && len(state.Meta()) != 0 {
		metaJSON, err := json.Marshal(state.Meta())
		contract.Assertf(err == nil, "err == nil")
		outMap[metaKey] = resource.NewStringProperty(string(metaJSON))
	}

	return outMap, nil
}

// MakeTerraformOutputs takes an expanded Terraform property map and returns a Pulumi equivalent.  This respects
// the property maps so that results end up with their correct Pulumi names when shipping back to the engine.
func MakeTerraformOutputs(
	ctx context.Context,
	p shim.Provider,
	outs map[string]interface{},
	tfs shim.SchemaMap,
	ps map[string]*SchemaInfo,
	assets AssetTable,
	supportsSecrets bool,
) resource.PropertyMap {
	result := make(resource.PropertyMap)

	for key, value := range outs {
		// First do a lookup of the name/info.
		name, tfi, psi := getInfoFromTerraformName(key, tfs, ps, false)
		contract.Assertf(name != "", `name != ""`)

		// Next perform a translation of the value accordingly.
		out := MakeTerraformOutput(ctx, p, value, tfi, psi, assets, supportsSecrets)
		//if !out.IsNull() {
		result[name] = out
		//}
	}

	if glog.V(5) {
		for k, v := range result {
			glog.V(5).Infof("Terraform output %v = %v", k, v)
		}
	}

	return result
}

// MakeTerraformOutput takes a single Terraform property and returns the Pulumi equivalent.
func MakeTerraformOutput(
	ctx context.Context,
	p shim.Provider,
	v interface{},
	tfs shim.Schema,
	ps *SchemaInfo,
	assets AssetTable,
	supportsSecrets bool,
) resource.PropertyValue {

	buildOutput := func(p shim.Provider, v interface{},
		tfs shim.Schema, ps *SchemaInfo, assets AssetTable, supportsSecrets bool) resource.PropertyValue {
		if assets != nil && ps != nil && ps.Asset != nil {
			if asset, has := assets[ps]; has {
				// if we have the value, it better actually be an asset or an archive.
				contract.Assertf(asset.IsAsset() || asset.IsArchive(), "asset.IsAsset() || asset.IsArchive()")
				return asset
			}

			// If we don't have the value, it is possible that the user supplied a value that was not an asset. Let the
			// normal marshalling logic handle it in that case.
		}

		if v == nil {
			return resource.NewNullProperty()
		}

		// Marshal sets as their list value.
		if list, ok := p.IsSet(ctx, v); ok {
			v = list
		}

		if ps == nil {
			ps = &SchemaInfo{}
		}

		// We use reflection instead of a type switch so that we can support mapping values whose underlying type is
		// supported into a Pulumi value, even if they stored as a wrapper type (such as a strongly-typed enum).
		//
		// That said, Terraform often returns values of type String for fields whose schema does not indicate that the
		// value is actually a string. If we are given a string, and we'd otherwise return a string property, we'll also
		// inspect the schema if one exists to determine the actual value that we should return.
		val := reflect.ValueOf(v)
		switch val.Kind() {
		case reflect.Bool:
			return resource.NewBoolProperty(val.Bool())
		case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
			switch ps.Type {
			case "string":
				return resource.NewProperty(strconv.FormatInt(val.Int(), 10))
			default:
				return resource.NewNumberProperty(float64(val.Int()))
			}
		case reflect.Float32, reflect.Float64:
			return resource.NewNumberProperty(val.Float())
		case reflect.String:
			// If the string is the special unknown property sentinel, reflect back an unknown computed property.  Note that
			// Terraform doesn't carry the types along with it, so the best we can do is give back a computed string.
			t := val.String()
			if t == TerraformUnknownVariableValue {
				return resource.NewComputedProperty(
					resource.Computed{Element: resource.NewStringProperty("")})
			}

			// Is there a schema available to us? If not, it's definitely just a string.
			if tfs == nil {
				return resource.NewStringProperty(t)
			}

			// Otherwise, it might be a string that needs to be coerced to match the Terraform schema type. Coerce the
			// string to the Go value of the correct type and, if the coercion produced something different than the string
			// value we already have, re-make the output. We need to ensure that we take into account any Pulumi schema
			// overrides as part of this coercion
			coerced, err := CoerceTerraformString(tfs.Type(), ps, t)
			if err != nil || coerced == t {
				return resource.NewStringProperty(t)
			}
			return MakeTerraformOutput(ctx, p, coerced, tfs, ps, assets, supportsSecrets)
		case reflect.Slice:
			elems := []interface{}{}
			for i := 0; i < val.Len(); i++ {
				elems = append(elems, val.Index(i).Interface())
			}

			tfes, pes := elemSchemas(tfs, ps)

			var arr []resource.PropertyValue
			for _, elem := range elems {
				arr = append(arr, MakeTerraformOutput(ctx, p, elem, tfes, pes, assets, supportsSecrets))
			}
			// For TypeList or TypeSet with MaxItems==1, we will have projected as a scalar nested value, so need to extract
			// out the single element (or null).
			if IsMaxItemsOne(tfs, ps) {
				switch len(arr) {
				case 0:
					return resource.NewNullProperty()
				case 1:
					return arr[0]
				default:
					contract.Failf("Unexpected multiple elements in array with MaxItems=1")
				}
			}
			return resource.NewArrayProperty(arr)
		case reflect.Map:
			// Build a go map of output values.
			outs := map[string]any{}
			for _, key := range val.MapKeys() {
				contract.Assertf(key.Kind() == reflect.String, "key.Kind() == reflect.String")
				outs[key.String()] = val.MapIndex(key).Interface()
			}

			if tfs != nil {
				// This is an object, so we need key translations.
				if res, ok := tfs.Elem().(shim.Resource); ok {
					var psflds map[string]*SchemaInfo
					if ps != nil {
						psflds = ps.Fields
					}
					obj := MakeTerraformOutputs(ctx, p, outs,
						res.Schema(), psflds, assets, supportsSecrets)
					return resource.NewObjectProperty(obj)
				}
			}

			// It's not an object, so it must be a map
			obj := make(resource.PropertyMap, len(outs))
			etfs, eps := elemSchemas(tfs, ps)
			for k, v := range outs {
				obj[resource.PropertyKey(k)] = MakeTerraformOutput(ctx, p, v,
					etfs, eps, assets, supportsSecrets)
			}
			return resource.NewObjectProperty(obj)
		default:
			contract.Failf("Unexpected TF output property value: %#v with type %#T", v, v)
			return resource.NewNullProperty()
		}
	}

	output := buildOutput(p, v, tfs, ps, assets, supportsSecrets)

	if tfs != nil && tfs.Sensitive() && supportsSecrets {
		return resource.MakeSecret(output)
	}

	return output
}

type makeTerraformConfigOpts struct {
	EnableMaxItemsOneDefaults bool
}

func makeTerraformConfigWithOpts(ctx context.Context, p *Provider, m resource.PropertyMap,
	tfs shim.SchemaMap, ps map[string]*SchemaInfo, opts makeTerraformConfigOpts) (shim.ResourceConfig, AssetTable, error) {
	inputs, assets, err := makeTerraformInputsWithOptions(ctx, nil, p.configValues, nil, m, tfs, ps,
		makeTerraformInputsOptions{
			DisableDefaults: true, DisableTFDefaults: true, EnableMaxItemsOneDefaults: opts.EnableMaxItemsOneDefaults},
	)
	if err != nil {
		return nil, nil, err
	}
	return MakeTerraformConfigFromInputs(ctx, p.tf, inputs), assets, nil
}

// MakeTerraformConfig creates a Terraform config map, used in state and diff calculations, from a Pulumi property map.
func MakeTerraformConfig(ctx context.Context, p *Provider, m resource.PropertyMap,
	tfs shim.SchemaMap, ps map[string]*SchemaInfo) (shim.ResourceConfig, AssetTable, error) {
	inputs, assets, err := makeTerraformInputsWithOptions(ctx, nil, p.configValues, nil, m, tfs, ps,
		makeTerraformInputsOptions{DisableDefaults: true, DisableTFDefaults: true})
	if err != nil {
		return nil, nil, err
	}
	return MakeTerraformConfigFromInputs(ctx, p.tf, inputs), assets, nil
}

// UnmarshalTerraformConfig creates a Terraform config map from a Pulumi RPC property map.
// Unused internally.
func UnmarshalTerraformConfig(ctx context.Context, p *Provider, m *pbstruct.Struct,
	tfs shim.SchemaMap, ps map[string]*SchemaInfo,
	label string) (shim.ResourceConfig, AssetTable, error) {

	props, err := plugin.UnmarshalProperties(m,
		plugin.MarshalOptions{Label: label, KeepUnknowns: true, SkipNulls: true})
	if err != nil {
		return nil, nil, err
	}
	return MakeTerraformConfig(ctx, p, props, tfs, ps)
}

// makeConfig is a helper for MakeTerraformConfigFromInputs that performs a deep-ish copy of its input, recursively
// removing Pulumi-internal properties as it goes.
func makeConfig(v interface{}) interface{} {
	switch v := v.(type) {
	case []interface{}:
		r := make([]interface{}, len(v))
		for i, e := range v {
			r[i] = makeConfig(e)
		}
		return r
	case map[string]interface{}:
		r := make(map[string]interface{})
		for k, e := range v {
			// If this is a reserved property, ignore it.
			switch k {
			case defaultsKey, metaKey:
				continue
			}
			r[k] = makeConfig(e)
		}
		return r
	default:
		return v
	}
}

// MakeTerraformConfigFromInputs creates a new Terraform configuration object from a set of Terraform inputs.
func MakeTerraformConfigFromInputs(
	ctx context.Context, p shim.Provider, inputs map[string]interface{},
) shim.ResourceConfig {
	raw := makeConfig(inputs).(map[string]interface{})
	return p.NewResourceConfig(ctx, raw)
}

type makeTerraformStateOpts struct {
	EnableMaxItemsOneDefaults bool
}

func makeTerraformStateWithOpts(
	ctx context.Context, res Resource, id string, m resource.PropertyMap, opts makeTerraformStateOpts,
) (shim.InstanceState, error) {
	// Parse out any metadata from the state.
	var meta map[string]interface{}
	if metaProperty, hasMeta := m[metaKey]; hasMeta && metaProperty.IsString() {
		if err := json.Unmarshal([]byte(metaProperty.StringValue()), &meta); err != nil {
			return nil, err
		}
	} else if res.TF.SchemaVersion() > 0 {
		// If there was no metadata in the inputs and this resource has a non-zero
		// schema version, return a meta bag with the current schema version. This
		// helps avoid migration issues.
		meta = map[string]interface{}{"schema_version": strconv.Itoa(res.TF.SchemaVersion())}
	}

	// Turn the resource properties into a map. For the most part, this is a straight
	// Mappable, but we use MapReplace because we use float64s and Terraform uses
	// ints, to represent numbers.
	inputs, _, err := makeTerraformInputsWithOptions(ctx, nil, nil, nil, m, res.TF.Schema(), res.Schema.Fields,
		makeTerraformInputsOptions{
			DisableDefaults: true, DisableTFDefaults: true, EnableMaxItemsOneDefaults: opts.EnableMaxItemsOneDefaults})
	if err != nil {
		return nil, err
	}

	return res.TF.InstanceState(id, inputs, meta)
}

// MakeTerraformState converts a Pulumi property bag into its Terraform equivalent.  This requires
// flattening everything and serializing individual properties as strings.  This is a little awkward, but it's how
// Terraform represents resource properties (schemas are simply sugar on top).
func MakeTerraformState(
	ctx context.Context, res Resource, id string, m resource.PropertyMap,
) (shim.InstanceState, error) {
	return makeTerraformStateWithOpts(ctx, res, id, m, makeTerraformStateOpts{})
}

// UnmarshalTerraformState unmarshals a Terraform instance state from an RPC property map.
func UnmarshalTerraformState(
	ctx context.Context, r Resource, id string, m *pbstruct.Struct, l string,
) (shim.InstanceState, error) {
	props, err := plugin.UnmarshalProperties(m, plugin.MarshalOptions{
		Label:     fmt.Sprintf("%s.state", l),
		SkipNulls: true,
	})
	if err != nil {
		return nil, err
	}

	props, err = transformFromState(ctx, r.Schema, props)
	if err != nil {
		return nil, err
	}

	return makeTerraformStateWithOpts(ctx, r, id, props, makeTerraformStateOpts{})
}

// IsMaxItemsOne returns true if the schema/info pair represents a TypeList or TypeSet which should project
// as a scalar, else returns false.
func IsMaxItemsOne(tfs shim.Schema, info *SchemaInfo) bool {
	if tfs == nil {
		return false
	}
	if tfs.Type() != shim.TypeList && tfs.Type() != shim.TypeSet {
		return false
	}
	if info != nil && info.MaxItemsOne != nil {
		return *info.MaxItemsOne
	}
	return tfs.MaxItems() == 1
}

// getInfoFromTerraformName does a map lookup to find the Pulumi name and schema info, if any.
func getInfoFromTerraformName(key string,
	tfs shim.SchemaMap, ps map[string]*SchemaInfo, rawName bool) (resource.PropertyKey,
	shim.Schema, *SchemaInfo) {
	info := ps[key]

	var name string
	if info != nil {
		name = info.Name
	}
	if name == "" {
		if rawName {
			// If raw names are requested, simply preserve the Terraform name.
			name = key
		} else {
			// If no name override exists, use the default name mangling scheme.
			name = TerraformToPulumiNameV2(key, tfs, ps)
		}
	}

	return resource.PropertyKey(name), getSchema(tfs, key), info
}

// getInfoFromPulumiName does a reverse map lookup to find the Terraform name and schema info for a Pulumi name, if any.
func getInfoFromPulumiName(key resource.PropertyKey,
	tfs shim.SchemaMap, ps map[string]*SchemaInfo) (string,
	shim.Schema, *SchemaInfo) {
	// To do this, we will first look to see if there's a known custom schema that uses this name.  If yes, we
	// prefer to use that.  To do this, we must use a reverse lookup.  (In the future we may want to make a
	// lookaside map to avoid the traversal of this map.)  Otherwise, use the standard name mangling scheme.
	ks := string(key)
	for tfname, schinfo := range ps {
		if schinfo != nil && schinfo.Name == ks {
			return tfname, getSchema(tfs, tfname), schinfo
		}
	}

	// transform the Pulumi name to the Terraform name using the standard mangling scheme.
	name := PulumiToTerraformName(ks, tfs, ps)

	return name, getSchema(tfs, name), ps[name]
}

// CoerceTerraformString coerces a string value to a Go value whose type is the type requested by the Terraform schema
// type or the Pulumi SchemaInfo. We prefer the SchemaInfo overrides as it's an explicit call to action over the
// Terraform Schema. Returns an error if the string can't be successfully coerced to the requested type.
func CoerceTerraformString(schType shim.ValueType, ps *SchemaInfo, stringValue string) (interface{}, error) {
	// check for the override and use that over terraform if available
	// we do this to ensure that we are following the explicit call to action of the override
	// For now, we will only return nil when an override of the type is a boolean and there is no
	// default value supplied - this will allow us to replicate the nullable-esquq bools that Terraform are
	// creating by using strings in place of bools
	// if we return nil for *all* override types when there is an empty string, then we can hit an edge case of
	// breaking overrides where we have a string and a TransformJSONDocument (see pulumi/pulumi#4592)
	if ps != nil && ps.Type != "" {
		switch strings.ToLower(ps.Type.String()) {
		case "bool", "boolean":
			if stringValue == "" {
				return nil, nil
			}
			return convertTfStringToBool(stringValue)
		case "int", "integer":
			return convertTfStringToInt(stringValue)
		case "float":
			return convertTfStringToFloat(stringValue)
		}

		return stringValue, nil
	}

	switch schType {
	case shim.TypeInt:
		return convertTfStringToInt(stringValue)
	case shim.TypeBool:
		return convertTfStringToBool(stringValue)
	case shim.TypeFloat:
		return convertTfStringToFloat(stringValue)
	}

	// Else it's just a string.
	return stringValue, nil
}

func convertTfStringToBool(stringValue string) (interface{}, error) {
	boolVal, err := strconv.ParseBool(stringValue)
	if err != nil {
		return nil, err
	}
	return boolVal, nil
}

func convertTfStringToInt(stringValue string) (interface{}, error) {
	intVal, err := strconv.ParseInt(stringValue, 0, 0)
	if err != nil {
		return nil, err
	}
	return float64(intVal), nil
}

func convertTfStringToFloat(stringValue string) (interface{}, error) {
	floatVal, err := strconv.ParseFloat(stringValue, 64)
	if err != nil {
		return nil, err
	}
	return floatVal, nil
}

func min(a int, b int) int {
	if a < b {
		return a
	}
	return b
}

func extractInputs(
	oldInput, newState resource.PropertyValue, tfs shim.Schema, ps *SchemaInfo,
) (resource.PropertyValue, bool) {

	if IsMaxItemsOne(tfs, ps) {
		tfs, ps = elemSchemas(tfs, ps)
	}

	possibleDefault := true
	switch {
	case oldInput.IsArray() && newState.IsArray():
		etfs, eps := elemSchemas(tfs, ps)

		oldArray, newArray := oldInput.ArrayValue(), newState.ArrayValue()
		for i := range oldArray {
			if i >= len(newArray) {
				possibleDefault = false
				break
			}

			defaultElem := false
			oldArray[i], defaultElem = extractInputs(oldArray[i], newArray[i], etfs, eps)
			if !defaultElem {
				possibleDefault = false
			}
		}

		return resource.NewArrayProperty(oldArray[:min(len(oldArray), len(newArray))]), possibleDefault
	case oldInput.IsObject() && newState.IsObject():
		oldMap, newMap := oldInput.ObjectValue(), newState.ObjectValue()

		if tfs != nil {
			if tfflds, ok := tfs.Elem().(shim.Resource); ok &&
				(tfs.Type() == shim.TypeMap || tfs.Type() == shim.TypeInvalid) {
				var fields map[string]*SchemaInfo
				if ps != nil {
					fields = ps.Fields
				}
				v, possibleDefault := extractInputsObject(oldMap, newMap, tfflds.Schema(), fields)
				return resource.NewObjectProperty(v), possibleDefault
			}
		}

		etfs, eps := elemSchemas(tfs, ps)

		for name, oldValue := range oldMap {
			defaultElem := false
			if newValue, ok := newMap[name]; ok {
				oldMap[name], defaultElem = extractInputs(oldValue, newValue, etfs, eps)
			} else {
				delete(oldMap, name)
			}
			if !defaultElem {
				possibleDefault = false
			}
		}

		return resource.NewObjectProperty(oldMap), possibleDefault
	case oldInput.IsString() && newState.IsString():
		// If this value has a StateFunc, its state value may not be compatible with its
		// input value. Ignore the difference.
		if tfs != nil && tfs.StateFunc() != nil {
			return oldInput, tfs.StateFunc()(oldInput.StringValue()) == newState.StringValue()
		}
		return newState, oldInput.StringValue() == newState.StringValue()
	default:
		return newState, oldInput.DeepEquals(newState)
	}
}

func extractInputsObject(
	oldInput, newState resource.PropertyMap, tfs shim.SchemaMap, ps map[string]*SchemaInfo,
) (resource.PropertyMap, bool) {
	possibleDefault := true
	// If we have a list of inputs that were populated by defaults, filter out any properties that changed and add
	// the result to the new inputs.
	defaultNames, hasOldDefaults := map[string]bool{}, false
	if oldDefaultNames, ok := oldInput[defaultsKey]; ok && oldDefaultNames.IsArray() {
		hasOldDefaults = true
		for _, k := range oldDefaultNames.ArrayValue() {
			if k.IsString() {
				defaultNames[k.StringValue()] = true
			}
		}
	}

	for name, oldValue := range oldInput {
		defaultElem := false
		if newValue, ok := newState[name]; ok {
			_, etfs, eps := getInfoFromPulumiName(name, tfs, ps)
			oldInput[name], defaultElem = extractInputs(oldValue, newValue, etfs, eps)
		} else {
			delete(oldInput, name)
		}
		if !defaultElem {
			possibleDefault = false
			delete(defaultNames, string(name))
		}
	}

	if hasOldDefaults {
		defaults := make([]resource.PropertyValue, 0, len(defaultNames))
		for name := range defaultNames {
			defaults = append(defaults, resource.NewStringProperty(name))
		}
		sort.Slice(defaults, func(i, j int) bool {
			return defaults[i].StringValue() < defaults[j].StringValue()
		})

		oldInput[defaultsKey] = resource.NewArrayProperty(defaults)
	}

	return oldInput, possibleDefault || !hasOldDefaults

}

func getDefaultValue(tfs shim.Schema, ps *SchemaInfo) interface{} {
	dv, err := tfs.DefaultValue()
	if err != nil {
		if errors.Is(err, ErrSchemaDefaultValue) {
			// Log error output but continue otherwise.
			// This avoids a panic on preview. See https://github.com/pulumi/pulumi-terraform-bridge/issues/1329.
			glog.V(9).Infof(err.Error())
		} else {
			return err
		}
	}
	if dv != nil {
		return dv
	}

	// TODO: We should inspect SchemaInfo.Default for the default value as well
	// if ps != nil {
	// 	return ps.Default
	// }
	return nil
}

func isDefaultOrZeroValue(tfs shim.Schema, ps *SchemaInfo, v resource.PropertyValue) bool {
	if dv := getDefaultValue(tfs, ps); dv != nil {
		// For numbers PropertyValue.V will always be a float64, but Schema.DefaultValue() from terraform might be
		// float64 or int.

		if i, ok := dv.(int); ok {
			dv = float64(i)
		}
		return dv == v.V
	}

	switch {
	case v.IsNull():
		return true
	case v.IsBool():
		//nolint:gosimple // This expression is clearer than !v.BoolValue()
		return v.BoolValue() == false
	case v.IsNumber():
		return v.NumberValue() == 0
	case v.IsString():
		return v.StringValue() == ""
	case v.IsArray():
		return len(v.ArrayValue()) == 0
	case v.IsObject():
		obj := v.ObjectValue()
		switch len(obj) {
		case 0:
			return true
		case 1:
			_, ok := obj[defaultsKey]
			return ok
		default:
			return false
		}
	case v.IsSecret():
		secret := v.SecretValue()
		return isDefaultOrZeroValue(tfs, ps, secret.Element)
	default:
		return false
	}
}

func extractSchemaInputs(
	state resource.PropertyValue, tfs shim.Schema, ps *SchemaInfo,
) resource.PropertyValue {

	if ps == nil {
		ps = &SchemaInfo{}
	}

	for IsMaxItemsOne(tfs, ps) {
		ps = ps.Elem
		if ps == nil {
			ps = &SchemaInfo{}
		}

		switch e := tfs.Elem().(type) {
		case shim.Schema:
			tfs = e
		case shim.Resource:
			if state.IsObject() {
				return resource.NewProperty(
					extractSchemaInputsObject(state.ObjectValue(), e.Schema(), ps.Fields),
				)
			} else {
				// The shape of state and tfs have de-synchronized, so we
				// just return state as is.
				return state
			}
		}
	}

	switch {
	case state.IsArray():
		etfs, eps := elemSchemas(tfs, ps)

		a := state.ArrayValue()
		v := make([]resource.PropertyValue, len(a))
		for i := range a {
			v[i] = extractSchemaInputs(a[i], etfs, eps)
		}
		return resource.NewArrayProperty(v)
	case state.IsObject():
		obj := state.ObjectValue()
		if tfflds, ok := shimutil.CastToTypeObject(tfs); ok {
			return resource.NewProperty(
				extractSchemaInputsObject(obj, tfflds, ps.Fields),
			)
		}

		// state does not represent an object, so it represents a map.
		//
		// That means that state's keys don't have special semantics.
		v := make(map[resource.PropertyKey]resource.PropertyValue, len(obj))
		etfs, eps := elemSchemas(tfs, ps)
		for k, e := range obj {
			v[k] = extractSchemaInputs(e, etfs, eps)
		}

		// To match previous behavior, we insert the default key for Map types.
		//
		// TODO: We should probably remove the extraneous defaultsKey here.
		v[defaultsKey] = resource.NewArrayProperty([]resource.PropertyValue{})
		return resource.NewObjectProperty(v)
	default:
		return state
	}
}

// extractSchemaInputsObject extracts schema inputs from an object type (not a map).
func extractSchemaInputsObject(
	state resource.PropertyMap, tfs shim.SchemaMap, ps map[string]*SchemaInfo,
) resource.PropertyMap {
	v := make(map[resource.PropertyKey]resource.PropertyValue, len(state))
	for k, e := range state {
		_, etfs, eps := getInfoFromPulumiName(k, tfs, ps)
		typeKnown := tfs != nil && etfs != nil

		// We drop fields that are not present in the schema.
		//
		// We might want to reconsider, since any mismatch between what is
		// returned and the schema indicates a bug somewhere.
		//
		// Since Pulumi is so schema based, it might be better to error on
		// !typeKnown instead of dropping a field.
		if !typeKnown || !(etfs.Optional() || etfs.Required()) {
			glog.V(9).Infof("skipping '%v' (not an input)", k)
			continue
		}

		ev := extractSchemaInputs(e, etfs, eps)

		if !etfs.Required() && isDefaultOrZeroValue(etfs, eps, ev) {
			glog.V(9).Infof("skipping '%v' (not required + default or zero value)", k)
			continue
		}

		v[k] = ev
	}
	v[defaultsKey] = resource.NewArrayProperty([]resource.PropertyValue{})

	return v
}

func ExtractInputsFromOutputs(oldInputs, outs resource.PropertyMap,
	tfs shim.SchemaMap, ps map[string]*SchemaInfo, isRefresh bool) (resource.PropertyMap, error) {

	if isRefresh {
		// If this is a refresh, only extract new values for inputs that are already present.
		inputs, _ := extractInputsObject(oldInputs, outs, tfs, ps)
		return inputs, nil
	}
	// Otherwise, take a schema-directed approach that fills out all input-only properties.
	return extractSchemaInputsObject(outs, tfs, ps), nil
}