如何用Go的hclWrite生成带变量引用的Terraform Map字段

问题场景 #

要生成Terraform的kubernetes_secret资源配置，其中data字段下的config.hcl需要引用Terraform变量data.template_file.vault_config.rendered，但用hclwrite直接生成时，这个引用会被自动加上引号，变成字符串字面量，不符合Terraform的语法要求。

优雅实现方法 #

不用底层的tokens操作，而是利用hclwrite的表达式构造能力来生成合法的变量引用，代码如下：

package main

import (
	"fmt"
	"os"

	"github.com/hashicorp/hcl/v2/hclwrite"
	"github.com/zclconf/go-cty/cty"
)

func generateVaultConfigSecret() error {
	// 初始化空HCL文件
	f := hclwrite.NewEmptyFile()
	rootBody := f.Body()

	// 创建kubernetes_secret资源块
	secretBlock := rootBody.AppendNewBlock("resource", []string{"kubernetes_secret", "vault_config"})
	secretBody := secretBlock.Body()

	// 添加metadata配置
	metadataBlock := secretBody.AppendNewBlock("metadata", nil)
	metadataBody := metadataBlock.Body()
	metadataBody.SetAttributeValue("name", cty.StringVal("vault-config"))
	metadataBody.SetAttributeValue("namespace", cty.StringVal("default"))

	// 核心：构造变量引用表达式，而非字符串值
	dataBody := secretBody.AppendNewBlock("data", nil).Body()
	// 构建Terraform变量的遍历路径
	refExpr := hclwrite.NewExpressionAbsTraversal(
		hclwrite.Traversal{
			hclwrite.TraverseRoot{Name: "data"},
			hclwrite.TraverseAttr{Name: "template_file"},
			hclwrite.TraverseAttr{Name: "vault_config"},
			hclwrite.TraverseAttr{Name: "rendered"},
		},
	)
	// 直接传入表达式token序列，避免自动加引号
	dataBody.SetAttributeRaw("config.hcl", refExpr.BuildTokens(nil))

	// 输出到文件
	return os.WriteFile("secret.tf", f.Bytes(), 0644)
}

func main() {
	if err := generateVaultConfigSecret(); err != nil {
		fmt.Printf("生成配置失败: %v\n", err)
		os.Exit(1)
	}
	fmt.Println("Terraform配置生成成功")
}

代码说明 #

• hclwrite.NewExpressionAbsTraversal专门用于构造绝对路径的遍历表达式，完美匹配Terraform中data.template_file.vault_config.rendered的引用语法。
• SetAttributeRaw方法允许直接传入HCL token序列，避开SetAttributeValue自动处理字符串常量的逻辑，确保生成的是变量引用而非带引号的字符串。

最终生成的Terraform代码如下，完全符合需求：

resource "kubernetes_secret" "vault_config" {
  metadata {
    name      = "vault-config"
    namespace = "default"
  }
  data {
    config.hcl = data.template_file.vault_config.rendered
  }
}

这种方式比直接操作底层tokens更直观，属于hclwrite的标准用法，代码可读性和维护性更强。

内容的提问来源于stack exchange，提问作者Sachith Kasthuriarachchi