Merge pull request #6 from terraform-linters/migrate_tags_rules

Migrate tags rule from TFLint core

Author: wata727

aws/provider.go

@@ -168,7 +168,7 @@ func (d *ProviderData) Get(key string) (string, bool, error) {
 	}
 
 	var val string
-	err := d.runner.EvaluateExprOnRootCtx(attribute.Expr, &val)
+	err := d.runner.EvaluateExprOnRootCtx(attribute.Expr, &val, nil)
 
 	err = d.runner.EnsureNoError(err, func() error { return nil })
 	if err != nil {

aws/runner.go

@@ -1,7 +1,6 @@
 package aws
 
 import (
-	"fmt"
 	"log"
 
 	"github.com/hashicorp/hcl/v2"
@@ -42,7 +41,7 @@ func NewRunner(runner tflint.Runner, config *Config) (*Runner, error) {
 // If not, the given expression is used as it is
 func (r *Runner) EachStringSliceExprs(expr hcl.Expression, proc func(val string, expr hcl.Expression)) error {
 	var vals []string
-	err := r.EvaluateExpr(expr, &vals)
+	err := r.EvaluateExpr(expr, &vals, nil)
 
 	exprs, diags := hcl.ExprList(expr)
 	if diags.HasErrors() {

docs/rules/aws_resource_missing_tags.md

@@ -0,0 +1,76 @@
+# aws_resource_missing_tags
+
+Require specific tags for all AWS resource types that support them.
+
+## Configuration
+
+```hcl
+rule "aws_resource_missing_tags" {
+  enabled = true
+  tags = ["Foo", "Bar"]
+  exclude = ["aws_autoscaling_group"] # (Optional) Exclude some resource types from tag checks
+}
+```
+
+## Examples
+
+Most resources use the `tags` attribute with simple `key`=`value` pairs:
+
+```hcl
+resource "aws_instance" "instance" {
+  instance_type = "m5.large"
+  tags = {
+    foo = "Bar"
+    bar = "Baz"
+  }
+}
+```
+
+```
+$ tflint
+1 issue(s) found:
+
+Notice: aws_instance.instance is missing the following tags: "Bar", "Foo". (aws_resource_missing_tags)
+
+  on test.tf line 3:
+   3:   tags = {
+   4:     foo = "Bar"
+   5:     bar = "Baz"
+   6:   }
+```
+
+Iterators in `dynamic` blocks cannot be expanded, so the tags in the following example will not be detected.
+
+```hcl
+locals {
+  tags = [
+    {
+      key   = "Name",
+      value = "SomeName",
+    },
+    {
+      key   = "env",
+      value = "SomeEnv",
+    },
+  ]
+}
+resource "aws_autoscaling_group" "this" {
+  dynamic "tag" {
+    for_each = local.tags
+
+    content {
+      key                 = tag.key
+      value               = tag.value
+      propagate_at_launch = true
+    }
+  }
+}
+```
+
+## Why
+
+You want to set a standardized set of tags for your AWS resources.
+
+## How To Fix
+
+For each resource type that supports tags, ensure that each missing tag is present.

go.mod

@@ -13,6 +13,7 @@ require (
 	github.com/onsi/ginkgo v1.14.2 // indirect
 	github.com/onsi/gomega v1.10.3 // indirect
 	github.com/serenize/snaker v0.0.0-20201027110005-a7ad2135616e
-	github.com/terraform-linters/tflint-plugin-sdk v0.6.1-0.20201205142940-d49361e1c42c
+	github.com/terraform-linters/tflint-plugin-sdk v0.6.1-0.20201214165213-827cf110e0a9
 	github.com/terraform-providers/terraform-provider-aws v1.60.1-0.20201118192700-9cc6324740c9
+	github.com/zclconf/go-cty v1.7.0
 )

go.sum

@@ -326,8 +326,8 @@ github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81P
 github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
 github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0=
 github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/terraform-linters/tflint-plugin-sdk v0.6.1-0.20201205142940-d49361e1c42c h1:c19JJeT1VbTXFpqaxi7FBAv4OJAeKVg0mpNs2ySbgi0=
-github.com/terraform-linters/tflint-plugin-sdk v0.6.1-0.20201205142940-d49361e1c42c/go.mod h1:EMiQwq0IiBwylbSgx53sdPBRhOHEXrjXhrD0x5C8SjY=
+github.com/terraform-linters/tflint-plugin-sdk v0.6.1-0.20201214165213-827cf110e0a9 h1:ADqZANXUwQzsBtG4nuaz8qGjXsetvHgk67Fr2OmRJs4=
+github.com/terraform-linters/tflint-plugin-sdk v0.6.1-0.20201214165213-827cf110e0a9/go.mod h1:EMiQwq0IiBwylbSgx53sdPBRhOHEXrjXhrD0x5C8SjY=
 github.com/terraform-providers/terraform-provider-aws v1.60.1-0.20201118192700-9cc6324740c9 h1:0u9SqTq2nbof0t+7xqfI8Ejhmooe3Qqe09fobOCZY6g=
 github.com/terraform-providers/terraform-provider-aws v1.60.1-0.20201118192700-9cc6324740c9/go.mod h1:sToOUnPCXFPwMljH57zM6uOI3q1YVREy4GSlg1Wm8/Y=
 github.com/ulikunitz/xz v0.5.5/go.mod h1:2bypXElzHzzJZwzH67Y6wb67pO62Rzfn7BSiF4ABRW8=

main.go

@@ -4,6 +4,7 @@ import (
 	"github.com/terraform-linters/tflint-plugin-sdk/plugin"
 	"github.com/terraform-linters/tflint-plugin-sdk/tflint"
 	"github.com/terraform-linters/tflint-ruleset-aws/aws"
+	"github.com/terraform-linters/tflint-ruleset-aws/project"
 	"github.com/terraform-linters/tflint-ruleset-aws/rules"
 	"github.com/terraform-linters/tflint-ruleset-aws/rules/api"
 )
@@ -13,7 +14,7 @@ func main() {
 		RuleSet: &aws.RuleSet{
 			BuiltinRuleSet: tflint.BuiltinRuleSet{
 				Name:    "aws",
-				Version: "0.1.0",
+				Version: project.Version,
 				Rules:   rules.Rules,
 			},
 			APIRules: api.Rules,

project/main.go

@@ -0,0 +1,11 @@
+package project
+
+import "fmt"
+
+// Version is ruleset version
+const Version string = "0.1.0"
+
+// ReferenceLink returns the rule reference link
+func ReferenceLink(name string) string {
+	return fmt.Sprintf("https://github.com/terraform-linters/tflint-ruleset-aws/blob/v%s/docs/rules/%s.md", Version, name)
+}

rules/api/aws_db_instance_invalid_db_subnet_group.go

@@ -72,7 +72,7 @@ func (r *AwsDBInstanceInvalidDBSubnetGroupRule) Check(rr tflint.Runner) error {
 		}
 
 		var val string
-		err := runner.EvaluateExpr(attribute.Expr, &val)
+		err := runner.EvaluateExpr(attribute.Expr, &val, nil)
 
 		return runner.EnsureNoError(err, func() error {
 			if !r.data[val] {

rules/api/aws_db_instance_invalid_option_group.go

@@ -72,7 +72,7 @@ func (r *AwsDBInstanceInvalidOptionGroupRule) Check(rr tflint.Runner) error {
 		}
 
 		var val string
-		err := runner.EvaluateExpr(attribute.Expr, &val)
+		err := runner.EvaluateExpr(attribute.Expr, &val, nil)
 
 		return runner.EnsureNoError(err, func() error {
 			if !r.data[val] {

rules/api/aws_db_instance_invalid_parameter_group.go

@@ -72,7 +72,7 @@ func (r *AwsDBInstanceInvalidParameterGroupRule) Check(rr tflint.Runner) error {
 		}
 
 		var val string
-		err := runner.EvaluateExpr(attribute.Expr, &val)
+		err := runner.EvaluateExpr(attribute.Expr, &val, nil)
 
 		return runner.EnsureNoError(err, func() error {
 			if !r.data[val] {