如何将HCL文件（或状态文件）转换为tfvars文件？

我们使用Terraformer获取基础设施的状态文件和HCL文件，随后将其用于Terraform模块中管理基础设施并防止配置漂移。由于tfvars文件会作为变量传入模块，因此需要输出tfvars来实现全流程自动化，流程如下：

infrastructure -> terraformer -> (HCL, statefile) -> tfvars -> terraform module -> infrastructure

由于Terraformer不支持直接输出tfvars，我尝试编写Go模块将HCL文件（或状态文件）转换为.tfvars文件。此前查到相关技术问答，其中提到使用cty模块作为底层解析器，于是基于此实现了HCL解析逻辑：

// ...
parser := hclparse.NewParser()
// filePath 指向JSON格式的HCL文件
hclFile, diags := parser.ParseJSONFile(filePath)
attrs, diags := hclFile.Body.JustAttributes()
if diags.HasErrors() {
    log.Fatal(diags.Error())
}
vals := make(map[string]cty.Value, len(attrs))

for name, attr := range attrs {
    vals[name], diags = attr.Expr.Value(nil)
    if diags.HasErrors() {
        log.Fatal(diags.Error())
    }
}

目前已成功将HCL解析为cty类型，但cty原生不支持序列化为tfvars格式，因此自行编写了序列化器代码：

func serializeValue(value cty.Value) string {
    switch {
    case value.Type().IsPrimitiveType():
        switch value.Type() {
        case cty.String:
            return fmt.Sprintf("\"%s\"", value.AsString())
        case cty.Number:
            return value.AsBigFloat().Text('f', -1)
        case cty.Bool:
            return fmt.Sprintf("%t", value.True())
        }
    case value.Type().IsListType() || value.Type().IsTupleType():
        return serializeList(value)
    case value.Type().IsMapType() || value.Type().IsObjectType():
        return serializeMapOrObject(value)
    default:
        panic("Unhandled type")
    }
    return ""
}

func serializeMapOrObject(value cty.Value) string {
    var elements []string
    for key, val := range value.AsValueMap() {
        elements = append(elements, fmt.Sprintf("\"%s\" = %s\n", key, serializeValue(val)))
    }
    return fmt.Sprintf("{%s}", strings.Join(elements, "\n"))
}

func serializeList(value cty.Value) string {
    var elements []string
    for _, elem := range value.AsValueSlice() {
        elements = append(elements, serializeValue(elem))
    }
    return fmt.Sprintf("[%s]", strings.Join(elements, ", "))
}

方案可行性与优化建议 #

这个方案完全可行，cty作为Terraform的核心类型系统，是处理HCL和Terraform类型的标准工具，基于它实现序列化是合理的技术路径。可以通过以下几点完善实现：

• 处理字符串转义：当前直接给字符串加双引号的方式会忽略特殊字符（如"、\n）的转义，导致生成的tfvars语法错误。建议改用strconv.Quote(value.AsString())来自动处理转义逻辑。
• 支持空值（Null）：cty中的Null值需要对应tfvars里的null关键字，需在serializeValue中增加分支判断：

  case value.IsNull():
      return "null"
  

• 优化格式化可读性：嵌套的Map/Object可以增加缩进，让生成的tfvars更易读。比如给serializeMapOrObject增加缩进参数：

  func serializeMapOrObject(value cty.Value, indent int) string {
      var elements []string
      indentStr := strings.Repeat("  ", indent)
      nextIndent := indent + 1
      for key, val := range value.AsValueMap() {
          elements = append(elements, fmt.Sprintf("%s\"%s\" = %s", indentStr, key, serializeValueWithIndent(val, nextIndent)))
      }
      return fmt.Sprintf("{\n%s\n%s}", strings.Join(elements, "\n"), indentStr)
  }
  

• 状态文件转换逻辑：如果要从Terraform状态文件（JSON格式）转换，需先解析状态文件结构，提取资源的attributes字段，将其转为cty.Value后再使用序列化逻辑。例如：

  // 解析状态文件JSON
  stateBytes, _ := os.ReadFile("terraform.tfstate")
  var state map[string]interface{}
  json.Unmarshal(stateBytes, &state)
  // 提取资源属性
  resources := state["resources"].([]interface{})
  for _, res := range resources {
      resMap := res.(map[string]interface{})
      attrs := resMap["primary"].(map[string]interface{})["attributes"].(map[string]interface{})
      // 将attrs转为cty.Value，可使用cty.UnknownAsNull处理未知值
      ctyVal := cty.UnknownAsNull(cty.FromValue(attrs))
      // 序列化
      tfvarsContent := serializeValueWithIndent(ctyVal, 0)
      // 写入文件
      os.WriteFile("output.tfvars", []byte(tfvarsContent), 0644)
  }
  

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