From 4b5d31d35d2ee4a4d1eb4312e3cff294a6aa8000 Mon Sep 17 00:00:00 2001
From: Martin Atkins <mart@degeneration.co.uk>
Date: Tue, 4 Dec 2018 12:18:33 -0800
Subject: [PATCH] configs/configupgrade: Rules-based upgrade for "locals" block

Previously we were handling this one as a special case, effectively
duplicating most of the logic from upgradeBlockBody.

By doing some prior analysis of the block we can produce a "rules" that
just passes through all of the attributes as-is, allowing us to reuse
upgradeBlockBody. This is a little weird for the locals block since
everything in it is user-selected names, but this facility will also be
useful in a future commit for dealing with module blocks, which contain
a mixture of user-chosen and reserved argument names.
---
 configs/configupgrade/upgrade_body.go   | 20 ++++++++++
 configs/configupgrade/upgrade_native.go | 51 +++----------------------
 2 files changed, 26 insertions(+), 45 deletions(-)

diff --git a/configs/configupgrade/upgrade_body.go b/configs/configupgrade/upgrade_body.go
index b5195a93d2..ab9827a3af 100644
--- a/configs/configupgrade/upgrade_body.go
+++ b/configs/configupgrade/upgrade_body.go
@@ -353,3 +353,23 @@ func schemaNoInterpBodyRules(filename string, schema *configschema.Block, an *an
 
 	return ret
 }
+
+// justAttributesBodyRules constructs body content rules that just use the
+// standard interpolated attribute mapping for every name already present
+// in the given body object.
+//
+// This is a little weird vs. just processing directly the attributes, but
+// has the advantage that the caller can then apply overrides to the result
+// as necessary to deal with any known names that need special handling.
+//
+// Any attribute rules created by this function do not have a specific wanted
+// value type specified, instead setting it to just cty.DynamicPseudoType.
+func justAttributesBodyRules(filename string, body *hcl1ast.ObjectType, an *analysis) bodyContentRules {
+	rules := make(bodyContentRules, len(body.List.Items))
+	args := body.List.Items
+	for _, arg := range args {
+		name := arg.Keys[0].Token.Value().(string)
+		rules[name] = normalAttributeRule(filename, cty.DynamicPseudoType, an)
+	}
+	return rules
+}
diff --git a/configs/configupgrade/upgrade_native.go b/configs/configupgrade/upgrade_native.go
index cb4ffa8e96..f87afa8ec2 100644
--- a/configs/configupgrade/upgrade_native.go
+++ b/configs/configupgrade/upgrade_native.go
@@ -197,51 +197,12 @@ func (u *Upgrader) upgradeNativeSyntaxFile(filename string, src []byte, an *anal
 			printBlockOpen(&buf, blockType, labels, item.LineComment)
 
 			// The "locals" block contents are free-form declarations, so
-			// we'll need to treat this one as special and not do a rules-based
-			// upgrade as we do for most other block types.
-			args := body.List.Items
-			for i, arg := range args {
-				if len(arg.Keys) != 1 {
-					// Should never happen for valid input, since there are no nested blocks expected here.
-					diags = diags.Append(&hcl2.Diagnostic{
-						Severity: hcl2.DiagWarning,
-						Summary:  "Invalid nested block",
-						Detail:   fmt.Sprintf("Blocks of type %q are not expected here, so this was not automatically upgraded.", arg.Keys[0].Token.Value().(string)),
-						Subject:  hcl1PosRange(filename, arg.Keys[0].Pos()).Ptr(),
-					})
-					// Preserve the item as-is, using the hcl1printer package.
-					buf.WriteString("\n# TF-UPGRADE-TODO: Blocks are not expected here, so this was not automatically upgraded.\n")
-					hcl1printer.Fprint(&buf, arg)
-					buf.WriteString("\n\n")
-					continue
-				}
-
-				comments := adhocComments.TakeBefore(arg)
-				for _, group := range comments {
-					printComments(&buf, group)
-					buf.WriteByte('\n') // Extra separator after each group
-				}
-
-				printComments(&buf, arg.LeadComment)
-
-				name := arg.Keys[0].Token.Value().(string)
-				expr := arg.Val
-				exprSrc, exprDiags := upgradeExpr(expr, filename, true, an)
-				diags = diags.Append(exprDiags)
-				printAttribute(&buf, name, exprSrc, arg.LineComment)
-
-				// If we have another item and it's more than one line away
-				// from the current one then we'll print an extra blank line
-				// to retain that separation.
-				if (i + 1) < len(args) {
-					next := args[i+1]
-					thisPos := hcl1NodeEndPos(arg)
-					nextPos := next.Pos()
-					if nextPos.Line-thisPos.Line > 1 {
-						buf.WriteByte('\n')
-					}
-				}
-			}
+			// we'll just use the default attribute mapping rule for everything
+			// inside it.
+			rules := justAttributesBodyRules(filename, body, an)
+			log.Printf("[TRACE] configupgrade: Upgrading locals block at %s", declRange)
+			bodyDiags := upgradeBlockBody(filename, "locals", &buf, body.List.Items, body.Rbrace, rules, adhocComments)
+			diags = diags.Append(bodyDiags)
 			buf.WriteString("}\n\n")
 
 		default: