Introduce autofix API

terraform-linters · May 2, 2023 · d07f142 · d07f142
1 parent b8f431f
commit d07f142
Show file tree

Hide file tree

Showing 10 changed files with 423 additions and 330 deletions.
diff --git a/helper/runner.go b/helper/runner.go
@@ -318,6 +318,11 @@ func (r *Runner) EmitIssue(rule tflint.Rule, message string, location hcl.Range)
 	return nil
 }
 
+func (r *Runner) EmitIssueWithFix(rule tflint.Rule, message string, location hcl.Range, fixFunc func(f *tflint.Fixer) error) error {
+	// TODO: Implement
+	return nil
+}
+
 // EnsureNoError is a method that simply runs a function if there is no error.
 //
 // Deprecated: Use EvaluateExpr with a function callback. e.g. EvaluateExpr(expr, func (val T) error {}, ...)

diff --git a/plugin/host2plugin/host2plugin_test.go b/plugin/host2plugin/host2plugin_test.go
@@ -575,7 +575,7 @@ func (s *mockServer) EvaluateExpr(expr hcl.Expression, opts tflint.EvaluateExprO
 	return cty.Value{}, nil
 }
 
-func (s *mockServer) EmitIssue(rule tflint.Rule, message string, location hcl.Range) error {
+func (s *mockServer) EmitIssue(rule tflint.Rule, message string, location hcl.Range, fixed map[string][]byte) error {
 	return nil
 }
 

diff --git a/plugin/host2plugin/server.go b/plugin/host2plugin/server.go
@@ -116,7 +116,13 @@ func (s *GRPCServer) Check(ctx context.Context, req *proto.Check_Request) (*prot
 	}
 	defer conn.Close()
 
-	runner, err := s.impl.NewRunner(&plugin2host.GRPCClient{Client: proto.NewRunnerClient(conn)})
+	client := proto.NewRunnerClient(conn)
+	resp, err := client.GetFiles(ctx, &proto.GetFiles_Request{})
+	if err != nil {
+		return nil, toproto.Error(codes.FailedPrecondition, err)
+	}
+
+	runner, err := s.impl.NewRunner(&plugin2host.GRPCClient{Client: client, Fixer: tflint.NewFixer(resp.Files)})
 	if err != nil {
 		return nil, toproto.Error(codes.FailedPrecondition, err)
 	}

diff --git a/plugin/plugin2host/client.go b/plugin/plugin2host/client.go
@@ -28,6 +28,7 @@ import (
 // GRPCClient is a plugin-side implementation. Plugin can send requests through the client to host's gRPC server.
 type GRPCClient struct {
 	Client proto.RunnerClient
+	Fixer  *tflint.Fixer
 }
 
 var _ tflint.Runner = &GRPCClient{}
@@ -423,6 +424,20 @@ func (c *GRPCClient) EmitIssue(rule tflint.Rule, message string, location hcl.Ra
 	return nil
 }
 
+func (c *GRPCClient) EmitIssueWithFix(rule tflint.Rule, message string, location hcl.Range, fixFunc func(f *tflint.Fixer) error) error {
+	if err := fixFunc(c.Fixer); err != nil {
+		return err
+	}
+
+	_, err := c.Client.EmitIssue(context.Background(), &proto.EmitIssue_Request{Rule: toproto.Rule(rule), Message: message, Range: toproto.Range(location), Fixed: c.Fixer.Changes()})
+	if err != nil {
+		return fromproto.Error(err)
+	}
+	// TODO: ApplyChanges() should be called if the issue is not ignored.
+	c.Fixer.ApplyChanges()
+	return nil
+}
+
 // 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.
 //

diff --git a/plugin/plugin2host/plugin2host_test.go b/plugin/plugin2host/plugin2host_test.go
@@ -43,7 +43,7 @@ type mockServerImpl struct {
 	getFiles             func() map[string][]byte
 	getRuleConfigContent func(string, *hclext.BodySchema) (*hclext.BodyContent, map[string][]byte, error)
 	evaluateExpr         func(hcl.Expression, tflint.EvaluateExprOption) (cty.Value, error)
-	emitIssue            func(tflint.Rule, string, hcl.Range) error
+	emitIssue            func(tflint.Rule, string, hcl.Range, map[string][]byte) error
 }
 
 func newMockServer(impl mockServerImpl) *mockServer {
@@ -99,9 +99,9 @@ func (s *mockServer) EvaluateExpr(expr hcl.Expression, opts tflint.EvaluateExprO
 	return cty.Value{}, nil
 }
 
-func (s *mockServer) EmitIssue(rule tflint.Rule, message string, location hcl.Range) error {
+func (s *mockServer) EmitIssue(rule tflint.Rule, message string, location hcl.Range, fixed map[string][]byte) error {
 	if s.impl.emitIssue != nil {
-		return s.impl.emitIssue(rule, message, location)
+		return s.impl.emitIssue(rule, message, location, fixed)
 	}
 	return nil
 }
@@ -2359,15 +2359,15 @@ func TestEmitIssue(t *testing.T) {
 	tests := []struct {
 		Name       string
 		Args       func() (tflint.Rule, string, hcl.Range)
-		ServerImpl func(tflint.Rule, string, hcl.Range) error
+		ServerImpl func(tflint.Rule, string, hcl.Range, map[string][]byte) error
 		ErrCheck   func(error) bool
 	}{
 		{
 			Name: "emit issue",
 			Args: func() (tflint.Rule, string, hcl.Range) {
 				return &Rule{}, "this is test", hcl.Range{Filename: "test.tf", Start: hcl.Pos{Line: 2, Column: 2}, End: hcl.Pos{Line: 2, Column: 10}}
 			},
-			ServerImpl: func(rule tflint.Rule, message string, location hcl.Range) error {
+			ServerImpl: func(rule tflint.Rule, message string, location hcl.Range, fixed map[string][]byte) error {
 				if rule.Name() != "test_rule" {
 					return fmt.Errorf("rule.Name() should be test_rule, but %s", rule.Name())
 				}
@@ -2400,7 +2400,7 @@ func TestEmitIssue(t *testing.T) {
 			Args: func() (tflint.Rule, string, hcl.Range) {
 				return &Rule{}, "this is test", hcl.Range{Filename: "test.tf", Start: hcl.Pos{Line: 2, Column: 2}, End: hcl.Pos{Line: 2, Column: 10}}
 			},
-			ServerImpl: func(tflint.Rule, string, hcl.Range) error {
+			ServerImpl: func(tflint.Rule, string, hcl.Range, map[string][]byte) error {
 				return errors.New("unexpected error")
 			},
 			ErrCheck: func(err error) bool {

diff --git a/plugin/plugin2host/server.go b/plugin/plugin2host/server.go
@@ -35,7 +35,7 @@ type Server interface {
 	GetFiles(tflint.ModuleCtxType) map[string][]byte
 	GetRuleConfigContent(string, *hclext.BodySchema) (*hclext.BodyContent, map[string][]byte, error)
 	EvaluateExpr(hcl.Expression, tflint.EvaluateExprOption) (cty.Value, error)
-	EmitIssue(rule tflint.Rule, message string, location hcl.Range) error
+	EmitIssue(rule tflint.Rule, message string, location hcl.Range, fixed map[string][]byte) error
 }
 
 // GetOriginalwd gets the original working directory.
@@ -172,7 +172,7 @@ func (s *GRPCServer) EmitIssue(ctx context.Context, req *proto.EmitIssue_Request
 		return nil, status.Error(codes.InvalidArgument, "range should not be null")
 	}
 
-	err := s.Impl.EmitIssue(fromproto.Rule(req.Rule), req.Message, fromproto.Range(req.Range))
+	err := s.Impl.EmitIssue(fromproto.Rule(req.Rule), req.Message, fromproto.Range(req.Range), req.Fixed)
 	if err != nil {
 		return nil, toproto.Error(codes.FailedPrecondition, err)
 	}