Improve ineffecient module detector method #10

wata727 · 2016-12-11T15:54:46Z

Fix #9

Add cache mechanism for core detector. The following is an example of a deep check detecting that contains single module.

Before

tflint -c .tflint.hcl.config  29.35s user 1.08s system 79% cpu 38.119 total

After

tflint -c .tflint.hcl.config  13.53s user 0.47s system 77% cpu 18.154 total

wata727 · 2016-12-11T16:01:18Z

detector/response_cache.go

+package detector
+
+import (
+	"github.com/aws/aws-sdk-go/service/ec2"


[gometalinter]

[gotype] could not import github.com/aws/aws-sdk-go/service/ec2 (can't find import: github.com/wata727/tflint/vendor/github.com/aws/aws-sdk-go/service/ec2)

wata727 · 2016-12-11T16:01:18Z

detector/response_cache.go

+
+import (
+	"github.com/aws/aws-sdk-go/service/ec2"
+	"github.com/aws/aws-sdk-go/service/iam"


[gometalinter]

[gotype] could not import github.com/aws/aws-sdk-go/service/iam (can't find import: github.com/wata727/tflint/vendor/github.com/aws/aws-sdk-go/service/iam)

wata727 · 2016-12-11T16:01:18Z

detector/test_helper.go

+import (
+	"reflect"
+
+	"github.com/hashicorp/hcl/hcl/ast"


[gometalinter]

[gotype] could not import github.com/hashicorp/hcl/hcl/ast (can't find import: github.com/wata727/tflint/vendor/github.com/hashicorp/hcl/hcl/ast)

wata727 · 2016-12-11T16:01:18Z

detector/test_helper.go

+	"reflect"
+
+	"github.com/hashicorp/hcl/hcl/ast"
+	"github.com/hashicorp/hcl/hcl/parser"


[gometalinter]

[gotype] could not import github.com/hashicorp/hcl/hcl/parser (can't find import: github.com/wata727/tflint/vendor/github.com/hashicorp/hcl/hcl/parser)

wata727 · 2016-12-11T16:01:19Z

detector/response_cache.go

+)
+
+type ResponseCache struct {
+	DescribeImagesOutput       *ec2.DescribeImagesOutput


[gometalinter]

[gotype] undeclared name: ec2

wata727 · 2016-12-11T16:01:19Z

detector/response_cache.go

+
+type ResponseCache struct {
+	DescribeImagesOutput       *ec2.DescribeImagesOutput
+	ListInstanceProfilesOutput *iam.ListInstanceProfilesOutput


[gometalinter]

[gotype] undeclared name: iam

wata727 · 2016-12-11T16:01:19Z

detector/detector.go

-	EvalConfig *evaluator.Evaluator
-	Logger     *logger.Logger
-	Error      bool
+	ListMap       map[string]*ast.ObjectList


[gometalinter]

[gotype] undeclared name: ast

wata727 · 2016-12-11T16:01:19Z

detector/aws_instance_default_standard_volume.go

@@ -14,7 +22,7 @@ func (d *Detector) DetectAwsInstanceDefaultStandardVolume(issues *[]*issue.Issue
 	}
 }

-func (d *Detector) detectForBlockDevices(issues *[]*issue.Issue, item *ast.ObjectItem, filename string, device string) {
+func (d *AwsInstanceDefaultStandardVolumeDetector) detectForBlockDevices(issues *[]*issue.Issue, item *ast.ObjectItem, filename string, device string) {


[gometalinter]

[gotype] undeclared name: ast

wata727 · 2016-12-11T16:01:19Z

detector/aws_instance_invalid_iam_profile.go

-		d.Logger.Error(err)
-		d.Error = true
+	if d.ResponseCache.ListInstanceProfilesOutput == nil {
+		resp, err := d.AwsClient.Iam.ListInstanceProfiles(&iam.ListInstanceProfilesInput{})


[gometalinter]

[gotype] undeclared name: iam

[gotype] cannot use &(iam.ListInstanceProfilesInput literal) (value of type *invalid type) as *github.com/aws/aws-sdk-go/service/iam.ListInstanceProfilesInput value in argument to d.AwsClient.Iam.ListInstanceProfiles

wata727 · 2016-12-11T16:01:19Z

detector/aws_instance_invalid_iam_profile.go

+			d.Logger.Error(err)
+			d.Error = true
+		}
+		d.ResponseCache.ListInstanceProfilesOutput = resp


[gometalinter]

[gotype] cannot use resp (variable of type *github.com/aws/aws-sdk-go/service/iam.ListInstanceProfilesOutput) as *invalid type value in assignment

wata727 · 2016-12-11T16:01:20Z

detector/aws_instance_invalid_iam_profile.go

 	}
-	for _, iamProfile := range resp.InstanceProfiles {
+	for _, iamProfile := range d.ResponseCache.ListInstanceProfilesOutput.InstanceProfiles {


[gometalinter]

[gotype] invalid operation: d.ResponseCache.ListInstanceProfilesOutput (variable of type *invalid type) has no field or method InstanceProfiles

[gotype] cannot range over d.ResponseCache.ListInstanceProfilesOutput.InstanceProfiles (invalid operand)

wata727 · 2016-12-11T16:01:20Z

detector/aws_instance_invalid_ami.go

-		d.Logger.Error(err)
-		d.Error = true
+	if d.ResponseCache.DescribeImagesOutput == nil {
+		resp, err := d.AwsClient.Ec2.DescribeImages(&ec2.DescribeImagesInput{})


[gometalinter]

[gotype] undeclared name: ec2

[gotype] cannot use &(ec2.DescribeImagesInput literal) (value of type *invalid type) as *github.com/aws/aws-sdk-go/service/ec2.DescribeImagesInput value in argument to d.AwsClient.Ec2.DescribeImages

wata727 · 2016-12-11T16:01:20Z

detector/aws_instance_invalid_ami.go

+			d.Logger.Error(err)
+			d.Error = true
+		}
+		d.ResponseCache.DescribeImagesOutput = resp


[gometalinter]

[gotype] cannot use resp (variable of type *github.com/aws/aws-sdk-go/service/ec2.DescribeImagesOutput) as *invalid type value in assignment

wata727 · 2016-12-11T16:01:20Z

detector/aws_instance_invalid_ami.go

 	}
-	for _, image := range resp.Images {
+	for _, image := range d.ResponseCache.DescribeImagesOutput.Images {


[gometalinter]

[gotype] invalid operation: d.ResponseCache.DescribeImagesOutput (variable of type *invalid type) has no field or method Images

[gotype] cannot range over d.ResponseCache.DescribeImagesOutput.Images (invalid operand)

wata727 · 2016-12-11T16:01:20Z

detector/detector.go

-				},
-				Logger: d.Logger,
-				Error:  false,
+			moduleDetector, err := NewDetector(m.ListMap, d.Config)


[gometalinter]

[gotype] cannot use m.ListMap (variable of type map[string]*github.com/hashicorp/hcl/hcl/ast.ObjectList) as map[string]*invalid type value in argument to NewDetector

wata727 · 2016-12-11T16:01:20Z

detector/test_helper.go

+}
+
+func TestDetectByCreatorName(creatorMethod string, src string, c *config.Config, awsClient *config.AwsClient, issues *[]*issue.Issue) {
+	listMap := make(map[string]*ast.ObjectList)


[gometalinter]

[gotype] undeclared name: ast

wata727 · 2016-12-11T16:01:21Z

detector/test_helper.go

+
+func TestDetectByCreatorName(creatorMethod string, src string, c *config.Config, awsClient *config.AwsClient, issues *[]*issue.Issue) {
+	listMap := make(map[string]*ast.ObjectList)
+	root, _ := parser.Parse([]byte(src))


[gometalinter]

[gotype] undeclared name: parser

wata727 · 2016-12-11T16:01:21Z

detector/test_helper.go

+	list, _ := root.Node.(*ast.ObjectList)
+	listMap["test.tf"] = list
+
+	evalConfig, _ := evaluator.NewEvaluator(listMap, c)


[gometalinter]

[gotype] cannot use listMap (variable of type map[string]*invalid type) as map[string]*github.com/hashicorp/hcl/hcl/ast.ObjectList value in argument to evaluator.NewEvaluator

wata727 · 2016-12-11T16:01:21Z

detector/aws_db_instance_default_parameter_group.go

@@ -7,7 +7,15 @@ import (
 	"github.com/wata727/tflint/issue"
 )

-func (d *Detector) DetectAwsDbInstanceDefaultParameterGroup(issues *[]*issue.Issue) {
+type AwsDBInstanceDefaultParameterGroupDetector struct {


[gometalinter]

[golint] exported type AwsDBInstanceDefaultParameterGroupDetector should have comment or be unexported

wata727 · 2016-12-11T16:01:21Z

detector/aws_db_instance_default_parameter_group.go

+	*Detector
+}
+
+func (d *Detector) CreateAwsDBInstanceDefaultParameterGroupDetector() *AwsDBInstanceDefaultParameterGroupDetector {


[gometalinter]

[golint] exported method Detector.CreateAwsDBInstanceDefaultParameterGroupDetector should have comment or be unexported

wata727 · 2016-12-11T16:01:21Z

detector/aws_db_instance_default_parameter_group.go

+	return &AwsDBInstanceDefaultParameterGroupDetector{d}
+}
+
+func (d *AwsDBInstanceDefaultParameterGroupDetector) Detect(issues *[]*issue.Issue) {


[gometalinter]

[golint] exported method AwsDBInstanceDefaultParameterGroupDetector.Detect should have comment or be unexported

wata727 · 2016-12-11T16:01:21Z

detector/aws_elasticache_cluster_default_parameter_group.go

@@ -7,7 +7,15 @@ import (
 	"github.com/wata727/tflint/issue"
 )

-func (d *Detector) DetectAwsElasticacheClusterDefaultParameterGroup(issues *[]*issue.Issue) {
+type AwsElastiCacheClusterDefaultParameterGroupDetector struct {


[gometalinter]

[golint] exported type AwsElastiCacheClusterDefaultParameterGroupDetector should have comment or be unexported

wata727 · 2016-12-11T16:01:21Z

detector/aws_elasticache_cluster_default_parameter_group.go

+	*Detector
+}
+
+func (d *Detector) CreateAwsElastiCacheClusterDefaultParameterGroupDetector() *AwsElastiCacheClusterDefaultParameterGroupDetector {


[gometalinter]

[golint] exported method Detector.CreateAwsElastiCacheClusterDefaultParameterGroupDetector should have comment or be unexported

wata727 · 2016-12-11T16:01:22Z

detector/aws_elasticache_cluster_default_parameter_group.go

+	return &AwsElastiCacheClusterDefaultParameterGroupDetector{d}
+}
+
+func (d *AwsElastiCacheClusterDefaultParameterGroupDetector) Detect(issues *[]*issue.Issue) {


[gometalinter]

[golint] exported method AwsElastiCacheClusterDefaultParameterGroupDetector.Detect should have comment or be unexported

wata727 · 2016-12-11T16:01:22Z

detector/aws_instance_default_standard_volume.go

@@ -5,7 +5,15 @@ import (
 	"github.com/wata727/tflint/issue"
 )

-func (d *Detector) DetectAwsInstanceDefaultStandardVolume(issues *[]*issue.Issue) {
+type AwsInstanceDefaultStandardVolumeDetector struct {


[gometalinter]

[golint] exported type AwsInstanceDefaultStandardVolumeDetector should have comment or be unexported

wata727 · 2016-12-11T16:01:22Z

detector/aws_instance_default_standard_volume.go

+	*Detector
+}
+
+func (d *Detector) CreateAwsInstanceDefaultStandardVolumeDetector() *AwsInstanceDefaultStandardVolumeDetector {


[gometalinter]

[golint] exported method Detector.CreateAwsInstanceDefaultStandardVolumeDetector should have comment or be unexported

wata727 · 2016-12-11T16:01:22Z

detector/aws_instance_default_standard_volume.go

+	return &AwsInstanceDefaultStandardVolumeDetector{d}
+}
+
+func (d *AwsInstanceDefaultStandardVolumeDetector) Detect(issues *[]*issue.Issue) {


[gometalinter]

[golint] exported method AwsInstanceDefaultStandardVolumeDetector.Detect should have comment or be unexported

wata727 · 2016-12-11T16:01:22Z

detector/aws_instance_invalid_ami.go

@@ -7,19 +7,30 @@ import (
 	"github.com/wata727/tflint/issue"
 )

-func (d *Detector) DetectAwsInstanceInvalidAmi(issues *[]*issue.Issue) {
+type AwsInstanceInvalidAMIDetector struct {


[gometalinter]

[golint] exported type AwsInstanceInvalidAMIDetector should have comment or be unexported

wata727 · 2016-12-11T16:01:23Z

detector/aws_instance_invalid_ami.go

+	*Detector
+}
+
+func (d *Detector) CreateAwsInstanceInvalidAMIDetector() *AwsInstanceInvalidAMIDetector {


[gometalinter]

[golint] exported method Detector.CreateAwsInstanceInvalidAMIDetector should have comment or be unexported

wata727 · 2016-12-11T16:01:23Z

detector/aws_instance_invalid_ami.go

+	return &AwsInstanceInvalidAMIDetector{d}
+}
+
+func (d *AwsInstanceInvalidAMIDetector) Detect(issues *[]*issue.Issue) {


[gometalinter]

[golint] exported method AwsInstanceInvalidAMIDetector.Detect should have comment or be unexported

wata727 · 2016-12-11T16:01:23Z

detector/aws_instance_invalid_iam_profile.go

@@ -7,19 +7,30 @@ import (
 	"github.com/wata727/tflint/issue"
 )

-func (d *Detector) DetectAwsInstanceInvalidIamProfile(issues *[]*issue.Issue) {
+type AwsInstanceInvalidIAMProfileDetector struct {


[gometalinter]

[golint] exported type AwsInstanceInvalidIAMProfileDetector should have comment or be unexported

wata727 · 2016-12-11T16:01:23Z

detector/aws_instance_invalid_iam_profile.go

+	*Detector
+}
+
+func (d *Detector) CreateAwsInstanceInvalidIAMProfileDetector() *AwsInstanceInvalidIAMProfileDetector {


[gometalinter]

[golint] exported method Detector.CreateAwsInstanceInvalidIAMProfileDetector should have comment or be unexported

wata727 · 2016-12-11T16:01:23Z

detector/aws_instance_invalid_iam_profile.go

+	return &AwsInstanceInvalidIAMProfileDetector{d}
+}
+
+func (d *AwsInstanceInvalidIAMProfileDetector) Detect(issues *[]*issue.Issue) {


[gometalinter]

[golint] exported method AwsInstanceInvalidIAMProfileDetector.Detect should have comment or be unexported

wata727 · 2016-12-11T16:01:23Z

detector/aws_instance_invalid_type.go

@@ -6,7 +6,15 @@ import (
 	"github.com/wata727/tflint/issue"
 )

-func (d *Detector) DetectAwsInstanceInvalidType(issues *[]*issue.Issue) {
+type AwsInstanceInvalidTypeDetector struct {


[gometalinter]

[golint] exported type AwsInstanceInvalidTypeDetector should have comment or be unexported

wata727 · 2016-12-11T16:01:24Z

detector/aws_instance_invalid_type.go

+	*Detector
+}
+
+func (d *Detector) CreateAwsInstanceInvalidTypeDetector() *AwsInstanceInvalidTypeDetector {


[gometalinter]

[golint] exported method Detector.CreateAwsInstanceInvalidTypeDetector should have comment or be unexported

wata727 · 2016-12-11T16:01:24Z

detector/aws_instance_invalid_type.go

+	return &AwsInstanceInvalidTypeDetector{d}
+}
+
+func (d *AwsInstanceInvalidTypeDetector) Detect(issues *[]*issue.Issue) {


[gometalinter]

[golint] exported method AwsInstanceInvalidTypeDetector.Detect should have comment or be unexported

wata727 · 2016-12-11T16:03:24Z

detector/aws_instance_not_specified_iam_profile.go

@@ -2,7 +2,15 @@ package detector

 import "github.com/wata727/tflint/issue"

-func (d *Detector) DetectAwsInstanceNotSpecifiedIamProfile(issues *[]*issue.Issue) {
+type AwsInstanceNotSpecifiedIAMProfileDetector struct {


[gometalinter]

[golint] exported type AwsInstanceNotSpecifiedIAMProfileDetector should have comment or be unexported

wata727 · 2016-12-11T16:03:24Z

detector/aws_instance_not_specified_iam_profile.go

+	*Detector
+}
+
+func (d *Detector) CreateAwsInstanceNotSpecifiedIAMProfileDetector() *AwsInstanceNotSpecifiedIAMProfileDetector {


[gometalinter]

[golint] exported method Detector.CreateAwsInstanceNotSpecifiedIAMProfileDetector should have comment or be unexported

wata727 · 2016-12-11T16:03:24Z

detector/aws_instance_not_specified_iam_profile.go

+	return &AwsInstanceNotSpecifiedIAMProfileDetector{d}
+}
+
+func (d *AwsInstanceNotSpecifiedIAMProfileDetector) Detect(issues *[]*issue.Issue) {


[gometalinter]

[golint] exported method AwsInstanceNotSpecifiedIAMProfileDetector.Detect should have comment or be unexported

wata727 · 2016-12-11T16:03:24Z

detector/aws_instance_not_specified_iam_profile.go

@@ -17,3 +25,7 @@ func (d *Detector) DetectAwsInstanceNotSpecifiedIamProfile(issues *[]*issue.Issu
 		}
 	}
 }
+
+func (d *AwsInstanceNotSpecifiedIAMProfileDetector) Inherit(original *AwsInstanceNotSpecifiedIAMProfileDetector) *AwsInstanceNotSpecifiedIAMProfileDetector {


[gometalinter]

[golint] exported method AwsInstanceNotSpecifiedIAMProfileDetector.Inherit should have comment or be unexported

wata727 · 2016-12-11T16:03:24Z

detector/aws_instance_previous_type.go

@@ -6,7 +6,15 @@ import (
 	"github.com/wata727/tflint/issue"
 )

-func (d *Detector) DetectAwsInstancePreviousType(issues *[]*issue.Issue) {
+type AwsInstancePreviousTypeDetector struct {


[gometalinter]

[golint] exported type AwsInstancePreviousTypeDetector should have comment or be unexported

wata727 · 2016-12-11T16:03:24Z

detector/aws_instance_previous_type.go

+	*Detector
+}
+
+func (d *Detector) CreateAwsInstancePreviousTypeDetector() *AwsInstancePreviousTypeDetector {


[gometalinter]

[golint] exported method Detector.CreateAwsInstancePreviousTypeDetector should have comment or be unexported

wata727 · 2016-12-11T16:03:25Z

detector/aws_instance_previous_type.go

+	return &AwsInstancePreviousTypeDetector{d}
+}
+
+func (d *AwsInstancePreviousTypeDetector) Detect(issues *[]*issue.Issue) {


[gometalinter]

[golint] exported method AwsInstancePreviousTypeDetector.Detect should have comment or be unexported

wata727 · 2016-12-11T16:03:25Z

detector/response_cache.go

+	"github.com/aws/aws-sdk-go/service/iam"
+)
+
+type ResponseCache struct {


[gometalinter]

[golint] exported type ResponseCache should have comment or be unexported

wata727 · 2016-12-11T16:03:25Z

detector/test_helper.go

+	"github.com/wata727/tflint/issue"
+)
+
+type TestDetector struct {


[gometalinter]

[golint] exported type TestDetector should have comment or be unexported

wata727 · 2016-12-11T16:03:25Z

detector/test_helper.go

+	*Detector
+}
+
+func (d *Detector) CreateTestDetector() *TestDetector {


[gometalinter]

[golint] exported method Detector.CreateTestDetector should have comment or be unexported

wata727 · 2016-12-11T16:03:25Z

detector/test_helper.go

+	return &TestDetector{d}
+}
+
+func (d *TestDetector) Detect(issues *[]*issue.Issue) {


[gometalinter]

[golint] exported method TestDetector.Detect should have comment or be unexported

wata727 · 2016-12-11T16:03:25Z

detector/test_helper.go

+	})
+}
+
+func TestDetectByCreatorName(creatorMethod string, src string, c *config.Config, awsClient *config.AwsClient, issues *[]*issue.Issue) {


[gometalinter]

[golint] exported function TestDetectByCreatorName should have comment or be unexported

wata727 · 2016-12-11T16:07:17Z

Umm... It's noisy. I have to review the settings in SideCI...

wata727 added 4 commits December 11, 2016 18:13

apply FactoryPattern

698648a

use test helper

7dcd78a

fix module detection bug

88f3c57

create ReponseCache

5afa742

wata727 commented Dec 11, 2016

View reviewed changes

wata727 merged commit f625a84 into master Dec 11, 2016

wata727 deleted the improve_ineffecient_module_detector_method branch December 11, 2016 16:07

bendrucker pushed a commit that referenced this pull request Jun 13, 2023

Add note about the project status (#10)

88cbcf6

Improve ineffecient module detector method #10

Improve ineffecient module detector method #10

Conversation

wata727 commented Dec 11, 2016

Before

After

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wata727 commented Dec 11, 2016