pulumi/pkg/codegen/hcl2/model/type_map.go
Pat Gavlin 1d672563da Fix output property names in Python codegen.
Some property names are mapped from their `camelCase` Pulumi name to a
`snake_case` Python name. This mapping is irregular, and only occurs for
resources properties and function calls.

Note that there's still more work to do here: this only fixes names on
the output side; the input side is still broken for nested resource
proprerties and function calls.

The underlying design--annotated types in `hcl2/model`--may need some
additional work in the future, but I _believe_ it's good enough for now.
2020-04-21 10:25:27 -07:00

143 lines
4.2 KiB
Go

// Copyright 2016-2020, 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 model
import (
"fmt"
"github.com/hashicorp/hcl/v2"
"github.com/hashicorp/hcl/v2/hclsyntax"
"github.com/pulumi/pulumi/pkg/v2/codegen/hcl2/syntax"
)
// MapType represents maps from strings to particular element types.
type MapType struct {
// ElementType is the element type of the map.
ElementType Type
s string
}
// The set of map types, indexed by element type.
var mapTypes = map[Type]*MapType{}
// NewMapType creates a new map type with the given element type.
func NewMapType(elementType Type) *MapType {
if t, ok := mapTypes[elementType]; ok {
return t
}
t := &MapType{ElementType: elementType}
mapTypes[elementType] = t
return t
}
// Traverse attempts to traverse the optional type with the given traverser. The result type of traverse(map(T))
// is T; the traversal fails if the traverser is not a string.
func (t *MapType) Traverse(traverser hcl.Traverser) (Traversable, hcl.Diagnostics) {
_, keyType := GetTraverserKey(traverser)
var diagnostics hcl.Diagnostics
if !InputType(StringType).ConversionFrom(keyType).Exists() {
diagnostics = hcl.Diagnostics{unsupportedMapKey(traverser.SourceRange())}
}
return t.ElementType, diagnostics
}
// SyntaxNode returns the syntax node for the type. This is always syntax.None.
func (*MapType) SyntaxNode() hclsyntax.Node {
return syntax.None
}
// AssignableFrom returns true if this type is assignable from the indicated source type. A map(T) is assignable
// from values of type map(U) where T is assignable from U or object(K_0=U_0, ..., K_N=U_N) if T is assignable from the
// unified type of U_0 through U_N.
func (t *MapType) AssignableFrom(src Type) bool {
return assignableFrom(t, src, func() bool {
switch src := src.(type) {
case *MapType:
return t.ElementType.AssignableFrom(src.ElementType)
case *ObjectType:
for _, src := range src.Properties {
if !t.ElementType.AssignableFrom(src) {
return false
}
}
return true
}
return false
})
}
func (t *MapType) ConversionFrom(src Type) ConversionKind {
return t.conversionFrom(src, false)
}
func (t *MapType) conversionFrom(src Type, unifying bool) ConversionKind {
return conversionFrom(t, src, unifying, func() ConversionKind {
switch src := src.(type) {
case *MapType:
return t.ElementType.conversionFrom(src.ElementType, unifying)
case *ObjectType:
conversionKind := SafeConversion
for _, src := range src.Properties {
if ck := t.ElementType.conversionFrom(src, unifying); ck < conversionKind {
conversionKind = ck
}
}
return conversionKind
}
return NoConversion
})
}
func (t *MapType) GetAnnotations() []interface{} {
return nil
}
func (t *MapType) String() string {
if t.s == "" {
t.s = fmt.Sprintf("map(%v)", t.ElementType)
}
return t.s
}
func (t *MapType) unify(other Type) (Type, ConversionKind) {
return unify(t, other, func() (Type, ConversionKind) {
switch other := other.(type) {
case *MapType:
// If the other type is a map type, unify based on the element type.
elementType, conversionKind := t.ElementType.unify(other.ElementType)
return NewMapType(elementType), conversionKind
case *ObjectType:
// If the other type is an object type, prefer the map type, but unify the property types.
elementType, conversionKind := t.ElementType, SafeConversion
for _, other := range other.Properties {
element, ck := elementType.unify(other)
if ck < conversionKind {
conversionKind = ck
}
elementType = element
}
return NewMapType(elementType), conversionKind
default:
// Prefer the map type.
return t, t.conversionFrom(other, true)
}
})
}
func (*MapType) isType() {}