Merge pull request #60 from terraform-linters/add_runner_config

tflint: Add `Runner.Config()`

Author: wata727

helper/runner.go

@@ -1,10 +1,13 @@
 package helper
 
 import (
+	"fmt"
+
 	"github.com/hashicorp/go-version"
 	"github.com/hashicorp/hcl/v2"
 	"github.com/hashicorp/hcl/v2/gohcl"
 	"github.com/terraform-linters/tflint-plugin-sdk/terraform"
+	"github.com/terraform-linters/tflint-plugin-sdk/terraform/configs"
 	"github.com/terraform-linters/tflint-plugin-sdk/tflint"
 	"github.com/zclconf/go-cty/cty/gocty"
 )
@@ -203,6 +206,74 @@ func (r *Runner) Backend() (*terraform.Backend, error) {
 	return nil, nil
 }
 
+// Config returns the Terraform configuration
+func (r *Runner) Config() (*configs.Config, error) {
+	config := &configs.Config{
+		Module: &configs.Module{},
+	}
+
+	for _, file := range r.Files {
+		content, diags := file.Body.Content(configFileSchema)
+		if diags.HasErrors() {
+			return nil, diags
+		}
+
+		for _, block := range content.Blocks {
+			switch block.Type {
+			case "terraform":
+				content, diags := block.Body.Content(terraformBlockSchema)
+				if diags.HasErrors() {
+					return nil, diags
+				}
+
+				for _, block := range content.Blocks {
+					switch block.Type {
+					case "backend":
+						config.Module.Backend = &terraform.Backend{
+							Type:      block.Labels[0],
+							TypeRange: block.LabelRanges[0],
+							Config:    block.Body,
+							DeclRange: block.DefRange,
+						}
+					case "required_providers":
+						// TODO
+					case "provider_meta":
+						// TODO
+					default:
+						continue
+					}
+				}
+			case "provider":
+				// TODO
+			case "variable":
+				// TODO
+			case "locals":
+				// TODO
+			case "output":
+				// TODO
+			case "module":
+				call, diags := simpleDecodeModuleCallBlock(block)
+				if diags.HasErrors() {
+					return nil, diags
+				}
+				config.Module.ModuleCalls[call.Name] = call
+			case "resource":
+				resource, diags := simpleDecodeResouceBlock(block)
+				if diags.HasErrors() {
+					return nil, diags
+				}
+				config.Module.ManagedResources[fmt.Sprintf("%s.%s", resource.Type, resource.Name)] = resource
+			case "data":
+				// TODO
+			default:
+				continue
+			}
+		}
+	}
+
+	return nil, nil
+}
+
 // EvaluateExpr returns a value of the passed expression.
 // Note that there is no evaluation, no type conversion, etc.
 func (r *Runner) EvaluateExpr(expr hcl.Expression, ret interface{}) error {
@@ -505,3 +576,65 @@ func decodeProviderConfigRef(expr hcl.Expression) (*terraform.ProviderConfigRef,
 
 	return ref, nil
 }
+
+// configFileSchema is the schema for the top-level of a config file.
+// @see https://github.com/hashicorp/terraform/blob/v0.13.2/configs/parser_config.go#L197-L239
+var configFileSchema = &hcl.BodySchema{
+	Blocks: []hcl.BlockHeaderSchema{
+		{
+			Type: "terraform",
+		},
+		{
+			Type: "required_providers",
+		},
+		{
+			Type:       "provider",
+			LabelNames: []string{"name"},
+		},
+		{
+			Type:       "variable",
+			LabelNames: []string{"name"},
+		},
+		{
+			Type: "locals",
+		},
+		{
+			Type:       "output",
+			LabelNames: []string{"name"},
+		},
+		{
+			Type:       "module",
+			LabelNames: []string{"name"},
+		},
+		{
+			Type:       "resource",
+			LabelNames: []string{"type", "name"},
+		},
+		{
+			Type:       "data",
+			LabelNames: []string{"type", "name"},
+		},
+	},
+}
+
+// terraformBlockSchema is the schema for a top-level "terraform" block in a configuration file.
+// @see https://github.com/hashicorp/terraform/blob/v0.13.2/configs/parser_config.go#L241-L261
+var terraformBlockSchema = &hcl.BodySchema{
+	Attributes: []hcl.AttributeSchema{
+		{Name: "required_version"},
+		{Name: "experiments"},
+	},
+	Blocks: []hcl.BlockHeaderSchema{
+		{
+			Type:       "backend",
+			LabelNames: []string{"type"},
+		},
+		{
+			Type: "required_providers",
+		},
+		{
+			Type:       "provider_meta",
+			LabelNames: []string{"provider"},
+		},
+	},
+}

terraform/addrs/module.go

@@ -0,0 +1,5 @@
+package addrs
+
+// Module is an alternative representation of addrs.Module.
+// https://github.com/hashicorp/terraform/blob/v0.13.1/addrs/module.go#L17
+type Module []string

terraform/configs/config.go

@@ -0,0 +1,21 @@
+package configs
+
+import (
+	"github.com/hashicorp/go-version"
+	"github.com/hashicorp/hcl/v2"
+	"github.com/terraform-linters/tflint-plugin-sdk/terraform/addrs"
+)
+
+// Config is an alternative representation of configs.Config.
+// https://github.com/hashicorp/terraform/blob/v0.13.1/configs/config.go#L22-L78
+type Config struct {
+	// Root            *Config
+	// Parent          *Config
+	Path addrs.Module
+	// Children        map[string]*Config
+	Module          *Module
+	CallRange       hcl.Range
+	SourceAddr      string
+	SourceAddrRange hcl.Range
+	Version         *version.Version
+}

terraform/configs/module.go

@@ -0,0 +1,31 @@
+package configs
+
+import (
+	"github.com/terraform-linters/tflint-plugin-sdk/terraform"
+	"github.com/terraform-linters/tflint-plugin-sdk/terraform/experiments"
+)
+
+// Module is an alternative representation of configs.Module.
+// https://github.com/hashicorp/terraform/blob/v0.13.1/configs/module.go#L14-L45
+type Module struct {
+	SourceDir string
+
+	CoreVersionConstraints []terraform.VersionConstraint
+
+	ActiveExperiments experiments.Set
+
+	Backend              *terraform.Backend
+	ProviderConfigs      map[string]*Provider
+	ProviderRequirements *RequiredProviders
+	ProviderLocalNames   map[terraform.Provider]string
+	ProviderMetas        map[terraform.Provider]*ProviderMeta
+
+	Variables map[string]*Variable
+	Locals    map[string]*Local
+	Outputs   map[string]*Output
+
+	ModuleCalls map[string]*terraform.ModuleCall
+
+	ManagedResources map[string]*terraform.Resource
+	DataResources    map[string]*terraform.Resource
+}

terraform/configs/named_values.go

@@ -0,0 +1,77 @@
+package configs
+
+import (
+	"github.com/hashicorp/hcl/v2"
+	"github.com/zclconf/go-cty/cty"
+)
+
+// Variable is an alternative representation of configs.Variable.
+// https://github.com/hashicorp/terraform/blob/v0.13.1/configs/named_values.go#L21-L32
+type Variable struct {
+	Name        string
+	Description string
+	Default     cty.Value
+	Type        cty.Type
+	ParsingMode VariableParsingMode
+	Validations []*VariableValidation
+
+	DescriptionSet bool
+
+	DeclRange hcl.Range
+}
+
+// VariableParsingMode is an alternative representation of configs.VariableParsingMode.
+// https://github.com/hashicorp/terraform/blob/v0.13.1/configs/named_values.go#L226-L234
+type VariableParsingMode rune
+
+// VariableParseLiteral is a variable parsing mode that just takes the given
+// string directly as a cty.String value.
+const VariableParseLiteral VariableParsingMode = 'L'
+
+// VariableParseHCL is a variable parsing mode that attempts to parse the given
+// string as an HCL expression and returns the result.
+const VariableParseHCL VariableParsingMode = 'H'
+
+// VariableValidation is an alternative representation of configs.VariableValidation.
+// https://github.com/hashicorp/terraform/blob/v0.13.1/configs/named_values.go#L273-L289
+type VariableValidation struct {
+	// Condition is an expression that refers to the variable being tested
+	// and contains no other references. The expression must return true
+	// to indicate that the value is valid or false to indicate that it is
+	// invalid. If the expression produces an error, that's considered a bug
+	// in the module defining the validation rule, not an error in the caller.
+	Condition hcl.Expression
+
+	// ErrorMessage is one or more full sentences, which would need to be in
+	// English for consistency with the rest of the error message output but
+	// can in practice be in any language as long as it ends with a period.
+	// The message should describe what is required for the condition to return
+	// true in a way that would make sense to a caller of the module.
+	ErrorMessage string
+
+	DeclRange hcl.Range
+}
+
+// Local is an alternative representation of configs.Local.
+// https://github.com/hashicorp/terraform/blob/v0.13.1/configs/named_values.go#L485-L490
+type Local struct {
+	Name string
+	Expr hcl.Expression
+
+	DeclRange hcl.Range
+}
+
+// Output is an alternative representation of configs.Output.
+// https://github.com/hashicorp/terraform/blob/v0.13.1/configs/named_values.go#L422-L433
+type Output struct {
+	Name        string
+	Description string
+	Expr        hcl.Expression
+	// DependsOn   []hcl.Traversal
+	Sensitive bool
+
+	DescriptionSet bool
+	SensitiveSet   bool
+
+	DeclRange hcl.Range
+}

terraform/configs/provider.go

@@ -0,0 +1,48 @@
+package configs
+
+import (
+	"github.com/hashicorp/hcl/v2"
+	"github.com/terraform-linters/tflint-plugin-sdk/terraform"
+)
+
+// Provider is an alternative representation of configs.Provider.
+// https://github.com/hashicorp/terraform/blob/v0.13.1/configs/provider.go#L17-L28
+type Provider struct {
+	Name       string
+	NameRange  hcl.Range
+	Alias      string
+	AliasRange *hcl.Range // nil if no alias set
+
+	Version terraform.VersionConstraint
+
+	Config hcl.Body
+
+	DeclRange hcl.Range
+}
+
+// ProviderMeta is an alternative representation of configs.ProviderMeta.
+// https://github.com/hashicorp/terraform/blob/v0.13.1/configs/provider_meta.go#L7-L13
+type ProviderMeta struct {
+	Provider string
+	Config   hcl.Body
+
+	ProviderRange hcl.Range
+	DeclRange     hcl.Range
+}
+
+// RequiredProvider is an alternative representation of configs.RequiredProvider.
+// https://github.com/hashicorp/terraform/blob/v0.13.1/configs/provider_requirements.go#L14-L20
+type RequiredProvider struct {
+	Name        string
+	Source      string
+	Type        terraform.Provider
+	Requirement terraform.VersionConstraint
+	DeclRange   hcl.Range
+}
+
+// RequiredProviders is an alternative representation of configs.RequiredProviders.
+// https://github.com/hashicorp/terraform/blob/v0.13.1/configs/provider_requirements.go#L22-L25
+type RequiredProviders struct {
+	RequiredProviders map[string]*RequiredProvider
+	DeclRange         hcl.Range
+}

terraform/experiments/experiment.go

@@ -0,0 +1,9 @@
+package experiments
+
+// Experiment is an alternative representation of experiments.Experiment.
+// https://github.com/hashicorp/terraform/blob/v0.13.1/experiments/experiment.go#L5
+type Experiment string
+
+// Set is an alternative representation of experiments.Set.
+// https://github.com/hashicorp/terraform/blob/v0.13.1/experiments/set.go#L5
+type Set map[Experiment]struct{}

tflint/client/client.go

@@ -9,6 +9,7 @@ import (
 
 	hcl "github.com/hashicorp/hcl/v2"
 	"github.com/terraform-linters/tflint-plugin-sdk/terraform"
+	"github.com/terraform-linters/tflint-plugin-sdk/terraform/configs"
 	"github.com/terraform-linters/tflint-plugin-sdk/tflint"
 	"github.com/zclconf/go-cty/cty/gocty"
 )
@@ -150,6 +151,26 @@ func (c *Client) Backend() (*terraform.Backend, error) {
 	return backend, nil
 }
 
+// Config calls the server-side Config method and returns the Terraform configuration.
+func (c *Client) Config() (*configs.Config, error) {
+	log.Print("[DEBUG] Accessing to Config")
+
+	var response ConfigResponse
+	if err := c.rpcClient.Call("Plugin.Config", ConfigRequest{}, &response); err != nil {
+		return nil, err
+	}
+	if response.Err != nil {
+		return nil, response.Err
+	}
+
+	config, diags := decodeConfig(response.Config)
+	if diags.HasErrors() {
+		return nil, diags
+	}
+
+	return config, nil
+}
+
 // EvaluateExpr calls the server-side EvalExpr method and reflects the response
 // in the passed argument.
 func (c *Client) EvaluateExpr(expr hcl.Expression, ret interface{}) error {