Merge pull request #41 from terraform-linters/remove_metadata

tflint: Remove Metadata

Author: wata727

helper/runner.go

@@ -145,8 +145,18 @@ func (r *Runner) EvaluateExpr(expr hcl.Expression, ret interface{}) error {
 	return gocty.FromCtyValue(val, ret)
 }
 
+// EmitIssueOnExpr adds an issue to the runner itself.
+func (r *Runner) EmitIssueOnExpr(rule tflint.Rule, message string, expr hcl.Expression) error {
+	r.Issues = append(r.Issues, &Issue{
+		Rule:    rule,
+		Message: message,
+		Range:   expr.Range(),
+	})
+	return nil
+}
+
 // EmitIssue adds an issue to the runner itself.
-func (r *Runner) EmitIssue(rule tflint.Rule, message string, location hcl.Range, meta tflint.Metadata) error {
+func (r *Runner) EmitIssue(rule tflint.Rule, message string, location hcl.Range) error {
 	r.Issues = append(r.Issues, &Issue{
 		Rule:    rule,
 		Message: message,

helper/runner_test.go

@@ -341,6 +341,38 @@ func (r *dummyRule) Severity() string          { return tflint.ERROR }
 func (r *dummyRule) Link() string              { return "" }
 func (r *dummyRule) Check(tflint.Runner) error { return nil }
 
+func Test_EmitIssueOnExpr(t *testing.T) {
+	src := `
+resource "aws_instance" "foo" {
+  instance_type = "t2.micro"
+}`
+
+	runner := TestRunner(t, map[string]string{"main.tf": src})
+
+	err := runner.WalkResourceAttributes("aws_instance", "instance_type", func(attribute *hcl.Attribute) error {
+		if err := runner.EmitIssueOnExpr(&dummyRule{}, "issue found", attribute.Expr); err != nil {
+			t.Fatal(err)
+		}
+		return nil
+	})
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	expected := Issues{
+		{
+			Rule:    &dummyRule{},
+			Message: "issue found",
+			Range:   hcl.Range{Filename: "main.tf", Start: hcl.Pos{Line: 3, Column: 19}, End: hcl.Pos{Line: 3, Column: 29}},
+		},
+	}
+
+	opt := cmpopts.IgnoreFields(hcl.Pos{}, "Byte")
+	if !cmp.Equal(expected, runner.Issues, opt) {
+		t.Fatalf("Diff: %s", cmp.Diff(expected, runner.Issues, opt))
+	}
+}
+
 func Test_EmitIssue(t *testing.T) {
 	src := `
 resource "aws_instance" "foo" {
@@ -350,7 +382,7 @@ resource "aws_instance" "foo" {
 	runner := TestRunner(t, map[string]string{"main.tf": src})
 
 	err := runner.WalkResourceAttributes("aws_instance", "instance_type", func(attribute *hcl.Attribute) error {
-		if err := runner.EmitIssue(&dummyRule{}, "issue found", attribute.Expr.Range(), tflint.Metadata{}); err != nil {
+		if err := runner.EmitIssue(&dummyRule{}, "issue found", attribute.Expr.Range()); err != nil {
 			t.Fatal(err)
 		}
 		return nil

tflint/client/client.go

@@ -140,20 +140,34 @@ func (c *Client) EvaluateExpr(expr hcl.Expression, ret interface{}) error {
 	return nil
 }
 
-// EmitIssue calls the server-side EmitIssue method with the passed rule, range and metadata.
-func (c *Client) EmitIssue(rule tflint.Rule, message string, location hcl.Range, meta tflint.Metadata) error {
+// EmitIssueOnExpr calls the server-side EmitIssue method with the passed expression.
+func (c *Client) EmitIssueOnExpr(rule tflint.Rule, message string, expr hcl.Expression) error {
 	req := &EmitIssueRequest{
 		Rule:     encodeRule(rule),
 		Message:  message,
-		Location: location,
+		Location: expr.Range(),
 	}
 
-	if meta.Expr != nil {
-		src, err := ioutil.ReadFile(meta.Expr.Range().Filename)
-		if err != nil {
-			return err
-		}
-		req.Expr, req.ExprRange = encodeExpr(src, meta.Expr)
+	src, err := ioutil.ReadFile(expr.Range().Filename)
+	if err != nil {
+		return err
+	}
+	req.Expr, req.ExprRange = encodeExpr(src, expr)
+
+	if err := c.rpcClient.Call("Plugin.EmitIssue", &req, new(interface{})); err != nil {
+		return err
+	}
+	return nil
+}
+
+// EmitIssue calls the server-side EmitIssue method with the passed rule and range.
+// You should use EmitIssueOnExpr if you want to emit an issue for an expression.
+// This API provides a lower level interface.
+func (c *Client) EmitIssue(rule tflint.Rule, message string, location hcl.Range) error {
+	req := &EmitIssueRequest{
+		Rule:     encodeRule(rule),
+		Message:  message,
+		Location: location,
 	}
 
 	if err := c.rpcClient.Call("Plugin.EmitIssue", &req, new(interface{})); err != nil {

tflint/client/client_test.go

@@ -311,6 +311,29 @@ func (*testRule) Severity() string          { return "Error" }
 func (*testRule) Link() string              { return "" }
 func (*testRule) Check(tflint.Runner) error { return nil }
 
+func Test_EmitIssueOnExpr(t *testing.T) {
+	client, server := startMockServer(t)
+	defer server.Listener.Close()
+
+	file, err := ioutil.TempFile("", "tflint-test-evaluateExpr-*.tf")
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer os.Remove(file.Name())
+	if _, err := file.Write([]byte("1")); err != nil {
+		t.Fatal(err)
+	}
+
+	expr, diags := hclsyntax.ParseExpression([]byte("1"), file.Name(), hcl.Pos{Line: 1, Column: 1})
+	if diags.HasErrors() {
+		t.Fatal(diags)
+	}
+
+	if err := client.EmitIssueOnExpr(&testRule{}, file.Name(), expr); err != nil {
+		t.Fatal(err)
+	}
+}
+
 func Test_EmitIssue(t *testing.T) {
 	client, server := startMockServer(t)
 	defer server.Listener.Close()
@@ -329,7 +352,7 @@ func Test_EmitIssue(t *testing.T) {
 		t.Fatal(diags)
 	}
 
-	if err := client.EmitIssue(&testRule{}, file.Name(), hcl.Range{}, tflint.Metadata{Expr: expr}); err != nil {
+	if err := client.EmitIssue(&testRule{}, file.Name(), expr.Range()); err != nil {
 		t.Fatal(err)
 	}
 }

tflint/interface.go

@@ -25,8 +25,13 @@ type Runner interface {
 	// to determine whether to continue processing.
 	EvaluateExpr(expr hcl.Expression, ret interface{}) error
 
+	// EmitIssue sends an issue with an expression to TFLint. You need to pass the message of the issue and the expression.
+	EmitIssueOnExpr(rule Rule, message string, expr hcl.Expression) error
+
 	// EmitIssue sends an issue to TFLint. You need to pass the message of the issue and the range.
-	EmitIssue(rule Rule, message string, location hcl.Range, meta Metadata) error
+	// You should use EmitIssueOnExpr if you want to emit an issue for an expression.
+	// This API provides a lower level interface.
+	EmitIssue(rule Rule, message string, location hcl.Range) error
 
 	// EnsureNoError is a helper for error handling. Depending on the type of error generated by EvaluateExpr,
 	// determine whether to exit, skip, or continue. If it is continued, the passed function will be executed.

tflint/issue.go

@@ -1,7 +1,5 @@
 package tflint
 
-import hcl "github.com/hashicorp/hcl/v2"
-
 // List of issue severity levels. The rules implemented by a plugin can be set to any severity.
 const (
 	// ERROR is possible errors
@@ -11,8 +9,3 @@ const (
 	// NOTICE is not important, it's mentioned
 	NOTICE = "Notice"
 )
-
-// Metadata is an additional data sent to the host process to build the issue.
-type Metadata struct {
-	Expr hcl.Expression
-}