generator: use terraform-json types for provider schemas (#589)

Author: HadrienPatte

go.mod

@@ -28,6 +28,7 @@ require (
 )
 
 require (
+	github.com/hashicorp/terraform-json v0.20.0
 	github.com/stretchr/testify v1.8.4
 	golang.org/x/exp v0.0.0-20230425010034-47ecfdc1ba53
 	golang.org/x/net v0.19.0

go.sum

@@ -44,6 +44,8 @@ github.com/hashicorp/go-version v1.6.0 h1:feTTfFNnjP967rlCxM/I9g701jU+RN74YKx2mO
 github.com/hashicorp/go-version v1.6.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA=
 github.com/hashicorp/hcl/v2 v2.19.1 h1://i05Jqznmb2EXqa39Nsvyan2o5XyMowW5fnCKW5RPI=
 github.com/hashicorp/hcl/v2 v2.19.1/go.mod h1:ThLC89FV4p9MPW804KVbe/cEXoQ8NZEh+JtMeeGErHE=
+github.com/hashicorp/terraform-json v0.20.0 h1:cJcvn4gIOTi0SD7pIy+xiofV1zFA3hza+6K+fo52IX8=
+github.com/hashicorp/terraform-json v0.20.0/go.mod h1:qdeBs11ovMzo5puhrRibdD6d2Dq6TyE/28JiU4tIQxk=
 github.com/hashicorp/yamux v0.0.0-20181012175058-2f1d1f20f75d h1:kJCB4vdITiW1eC1vq2e6IsrXKrZit1bv/TDYFGMp4BQ=
 github.com/hashicorp/yamux v0.0.0-20181012175058-2f1d1f20f75d/go.mod h1:+NfK9FKeTrX5uv1uIXGdwYDTeHna2qgaIlx54MXqjAM=
 github.com/jhump/protoreflect v1.6.0 h1:h5jfMVslIg6l29nsMs0D8Wj17RDVdNYti0vDN/PZZoE=

rules/api/generator/main.go

@@ -1,4 +1,4 @@
-// +build generators
+//go:build generators
 
 package main
 
@@ -99,18 +99,10 @@ func dataType(resource, attribute string) string {
 		panic(fmt.Sprintf("`%s.%s` not found in the Terraform schema", resource, attribute))
 	}
 
-	switch ty := attrSchema.Type.(type) {
-	case string:
-		if ty != "string" {
-			panic(fmt.Errorf("Unexpected data type: %#v", attrSchema.Type))
-		}
+	if ty := attrSchema.AttributeType.FriendlyName(); ty == "string" {
 		return "string"
-	case []interface{}:
-		if len(ty) != 2 || !(ty[0] == "set" && ty[1] == "string") {
-			panic(fmt.Errorf("Unexpected data type: %#v", attrSchema.Type))
-		}
+	} else if attrSchema.AttributeType.IsSetType() || attrSchema.AttributeType.IsListType() {
 		return "list"
-	default:
-		panic(fmt.Errorf("Unexpected data type: %#v", attrSchema.Type))
 	}
+	panic(fmt.Errorf("Unexpected data type: %#v", attrSchema.AttributeType))
 }

rules/generator-utils/schema.go

@@ -3,43 +3,19 @@ package utils
 import (
 	"encoding/json"
 	"io/ioutil"
-)
-
-type Schema struct {
-	ProviderSchemas ProviderSchemas `json:"provider_schemas"`
-}
-
-type ProviderSchemas struct {
-	AWS ProviderSchema `json:"registry.terraform.io/hashicorp/aws"`
-}
-
-type ProviderSchema struct {
-	ResourceSchemas map[string]ResourceSchema `json:"resource_schemas"`
-}
 
-type ResourceSchema struct {
-	Block BlockSchema `json:"block"`
-}
-
-type BlockSchema struct {
-	Attributes map[string]AttributeSchema `json:"attributes"`
-	BlockTypes map[string]ResourceSchema  `json:"block_types"`
-}
-
-type AttributeSchema struct {
-	Type      interface{} `json:"type"`
-	Sensitive bool        `json:"sensitive"`
-}
+	tfjson "github.com/hashicorp/terraform-json"
+)
 
-func LoadProviderSchema(path string) ProviderSchema {
+func LoadProviderSchema(path string) *tfjson.ProviderSchema {
 	src, err := ioutil.ReadFile(path)
 	if err != nil {
 		panic(err)
 	}
 
-	var schema Schema
+	var schema tfjson.ProviderSchemas
 	if err := json.Unmarshal(src, &schema); err != nil {
 		panic(err)
 	}
-	return schema.ProviderSchemas.AWS
+	return schema.Schemas["registry.terraform.io/hashicorp/aws"]
 }

rules/models/generator/doc.go

@@ -1,4 +1,4 @@
-// +build generators
+//go:build generators
 
 package main
 

rules/models/generator/main.go

@@ -1,4 +1,4 @@
-// +build generators
+//go:build generators
 
 package main
 
@@ -12,6 +12,7 @@ import (
 	hcl "github.com/hashicorp/hcl/v2"
 	"github.com/hashicorp/hcl/v2/gohcl"
 	"github.com/hashicorp/hcl/v2/hclparse"
+	tfjson "github.com/hashicorp/terraform-json"
 	utils "github.com/terraform-linters/tflint-ruleset-aws/rules/generator-utils"
 )
 
@@ -99,26 +100,23 @@ func main() {
 	generateDocFile(generatedRules)
 }
 
-func fetchSchema(resource, attribute string, model map[string]interface{}, provider utils.ProviderSchema) utils.AttributeSchema {
+func fetchSchema(resource, attribute string, model map[string]interface{}, provider *tfjson.ProviderSchema) *tfjson.SchemaAttribute {
 	resourceSchema, ok := provider.ResourceSchemas[resource]
 	if !ok {
 		panic(fmt.Sprintf("resource `%s` not found in the Terraform schema", resource))
 	}
 	attrSchema, ok := resourceSchema.Block.Attributes[attribute]
 	if !ok {
-		if _, ok := resourceSchema.Block.BlockTypes[attribute]; !ok {
+		if _, ok := resourceSchema.Block.NestedBlocks[attribute]; !ok {
 			panic(fmt.Sprintf("`%s.%s` not found in the Terraform schema", resource, attribute))
 		}
 	}
 
 	switch model["type"].(string) {
 	case "string":
-		ty, ok := attrSchema.Type.(string)
-		if !ok {
-			panic(fmt.Sprintf("`%s.%s` is expected as string, but not (%s)", resource, attribute, attrSchema.Type))
-		}
+		ty := attrSchema.AttributeType.FriendlyName()
 		if ty != "string" && ty != "number" {
-			panic(fmt.Sprintf("`%s.%s` is expected as string, but not (%s)", resource, attribute, attrSchema.Type))
+			panic(fmt.Sprintf("`%s.%s` is expected as string, but not (%s)", resource, attribute, ty))
 		}
 	default:
 		// noop

rules/models/generator/provider.go

@@ -1,4 +1,4 @@
-// +build generators
+//go:build generators
 
 package main
 

rules/models/generator/rule.go

@@ -1,4 +1,4 @@
-// +build generators
+//go:build generators
 
 package main
 
@@ -7,6 +7,7 @@ import (
 	"regexp"
 	"strings"
 
+	tfjson "github.com/hashicorp/terraform-json"
 	utils "github.com/terraform-linters/tflint-ruleset-aws/rules/generator-utils"
 )
 
@@ -24,7 +25,7 @@ type ruleMeta struct {
 	TestNG        string
 }
 
-func generateRuleFile(resource, attribute string, model map[string]interface{}, schema utils.AttributeSchema) {
+func generateRuleFile(resource, attribute string, model map[string]interface{}, schema *tfjson.SchemaAttribute) {
 	ruleName := makeRuleName(resource, attribute)
 
 	meta := &ruleMeta{

rules/tags/generator/main.go

@@ -1,4 +1,4 @@
-// +build generators
+//go:build generators
 
 package main