Merge pull request #14713 from johngmyers/tf-refactor

Refactor writing of Terraform data sources

upup/pkg/fi/cloudup/terraform/element.go

@@ -0,0 +1,129 @@
+/*
+Copyright 2022 The Kubernetes Authors.
+
+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 terraform
+
+import (
+	"bytes"
+	"fmt"
+	"reflect"
+	"sort"
+	"strings"
+	"unicode"
+
+	"k8s.io/kops/upup/pkg/fi/cloudup/terraformWriter"
+)
+
+// element is some sort of value that can be written in HCL
+type element interface {
+	IsSingleValue() bool
+	Write(buffer *bytes.Buffer, indent int, key string)
+}
+
+type object struct {
+	field map[string]element
+}
+
+var _ element = &object{}
+
+func (o *object) IsSingleValue() bool {
+	return false
+}
+
+func (o *object) Write(buffer *bytes.Buffer, indent int, key string) {
+	writeIndent(buffer, indent)
+	buffer.WriteString(key)
+	buffer.WriteString(" {\n")
+	keys := make([]string, 0, len(o.field))
+	for key := range o.field {
+		keys = append(keys, key)
+	}
+	sort.Strings(keys)
+
+	maxKeyLen := 0
+	for i, key := range keys {
+		if o.field[key].IsSingleValue() {
+			if maxKeyLen == 0 {
+				for j := i; j < len(keys) && o.field[keys[j]].IsSingleValue(); j++ {
+					if len(keys[j]) > maxKeyLen {
+						maxKeyLen = len(keys[j])
+					}
+				}
+				maxKeyLen++
+			}
+			writeIndent(buffer, indent+2)
+			buffer.WriteString(key)
+			writeIndent(buffer, maxKeyLen-len(key))
+		} else {
+			maxKeyLen = 0
+		}
+		o.field[key].Write(buffer, indent+2, key)
+		buffer.WriteString("\n")
+	}
+	writeIndent(buffer, indent)
+	buffer.WriteString("}")
+}
+
+func ToElement(item interface{}) (element, error) {
+	v := reflect.ValueOf(item)
+	if v.Kind() == reflect.Pointer {
+		if v.IsNil() {
+			return nil, nil
+		}
+		v = v.Elem()
+	}
+	if v.Kind() == reflect.String {
+		return terraformWriter.LiteralFromStringValue(v.String()), nil
+	}
+	if v.Kind() == reflect.Struct {
+		o := &object{
+			field: map[string]element{},
+		}
+		for _, field := range reflect.VisibleFields(v.Type()) {
+			element, err := ToElement(v.FieldByIndex(field.Index).Interface())
+			if err != nil {
+				return nil, fmt.Errorf("converting field %q to element: %w", field.Name, err)
+			}
+			if element != nil {
+				o.field[fieldKey(field)] = element
+			}
+		}
+		return o, nil
+	}
+	panic(fmt.Sprintf("unhandled kind %s", v.Kind()))
+}
+
+func fieldKey(field reflect.StructField) string {
+	key := field.Tag.Get("cty")
+	if key != "" {
+		return key
+	}
+
+	var b strings.Builder
+	prev_lower := false
+	for _, r := range field.Name {
+		if unicode.IsUpper(r) {
+			if prev_lower {
+				b.WriteRune('_')
+				prev_lower = false
+			}
+		} else {
+			prev_lower = true
+		}
+		b.WriteRune(unicode.ToLower(r))
+	}
+	return b.String()
+}

upup/pkg/fi/cloudup/terraform/target_hcl2.go

@@ -104,6 +104,8 @@ func (t *TerraformTarget) finishHCL2() error {
 		}
 	}
 
+	buf := bytes.NewBuffer(hclwrite.Format(f.Bytes()))
+
 	dataSourcesByType, err := t.GetDataSourcesByType()
 	if err != nil {
 		return err
@@ -122,30 +124,15 @@ func (t *TerraformTarget) finishHCL2() error {
 		}
 		sort.Strings(dataSourceNames)
 		for _, dataSourceName := range dataSourceNames {
-			item := dataSources[dataSourceName]
-
-			dataBlock := rootBody.AppendNewBlock("data", []string{dataSourceType, dataSourceName})
-			dataBody := dataBlock.Body()
-			dataType, err := gocty.ImpliedType(item)
+			element, err := ToElement(dataSources[dataSourceName])
 			if err != nil {
-				return err
-			}
-			dataVal, err := gocty.ToCtyValue(item, dataType)
-			if err != nil {
-				return err
-			}
-			if dataVal.IsNull() {
-				continue
-			}
-			dataVal.ForEachElement(func(key cty.Value, value cty.Value) bool {
-				writeValue(dataBody, key.AsString(), value)
-				return false
-			})
-			rootBody.AppendNewline()
-		}
+				return fmt.Errorf("data %q %q: %w", dataSourceType, dataSourceName, err)
 			}
 
-	buf := bytes.NewBuffer(hclwrite.Format(f.Bytes()))
+			element.Write(buf, 0, fmt.Sprintf("data %q %q", dataSourceType, dataSourceName))
+			buf.WriteString("\n\n")
+		}
+	}
 
 	buf.WriteString("terraform {\n")
 	buf.WriteString("  required_version = \">= 0.15.0\"\n")

upup/pkg/fi/cloudup/terraformWriter/literal.go

@@ -17,6 +17,7 @@ limitations under the License.
 package terraformWriter
 
 import (
+	"bytes"
 	"encoding/json"
 	"fmt"
 	"sort"
@@ -37,6 +38,15 @@ func (l *Literal) MarshalJSON() ([]byte, error) {
 	return json.Marshal(&l.String)
 }
 
+func (l *Literal) IsSingleValue() bool {
+	return true
+}
+
+func (l *Literal) Write(buffer *bytes.Buffer, indent int, key string) {
+	buffer.WriteString("= ")
+	buffer.WriteString(l.String)
+}
+
 // LiteralFunctionExpression constructs a Literal representing the result of
 // calling the supplied functionName with the supplied args.
 func LiteralFunctionExpression(functionName string, args ...*Literal) *Literal {