Merge pull request #35 from wata727/add_previous_node_type_detector_for_elasticache

add previous type detector for elasticache

Author: wata727

detector/aws_elasticache_cluster_previous_type.go

@@ -0,0 +1,54 @@
+package detector
+
+import (
+	"fmt"
+
+	"github.com/wata727/tflint/issue"
+)
+
+type AwsElastiCacheClusterPreviousTypeDetector struct {
+	*Detector
+}
+
+func (d *Detector) CreateAwsElastiCacheClusterPreviousTypeDetector() *AwsElastiCacheClusterPreviousTypeDetector {
+	return &AwsElastiCacheClusterPreviousTypeDetector{d}
+}
+
+func (d *AwsElastiCacheClusterPreviousTypeDetector) Detect(issues *[]*issue.Issue) {
+	var previousNodeType = map[string]bool{
+		"cache.m1.small":   true,
+		"cache.m1.medium":  true,
+		"cache.m1.large":   true,
+		"cache.m1.xlarge":  true,
+		"cache.m2.xlarge":  true,
+		"cache.m2.2xlarge": true,
+		"cache.m2.4xlarge": true,
+		"cache.c1.xlarge":  true,
+		"cache.t1.micro":   true,
+	}
+
+	for filename, list := range d.ListMap {
+		for _, item := range list.Filter("resource", "aws_elasticache_cluster").Items {
+			nodeTypeToken, err := hclLiteralToken(item, "node_type")
+			if err != nil {
+				d.Logger.Error(err)
+				continue
+			}
+			nodeType, err := d.evalToString(nodeTypeToken.Text)
+			if err != nil {
+				d.Logger.Error(err)
+				continue
+			}
+
+			if previousNodeType[nodeType] {
+				issue := &issue.Issue{
+					Type:    "WARNING",
+					Message: fmt.Sprintf("\"%s\" is previous generation node type.", nodeType),
+					Line:    nodeTypeToken.Pos.Line,
+					File:    filename,
+				}
+				*issues = append(*issues, issue)
+			}
+		}
+	}
+}

detector/aws_elasticache_cluster_previous_type_test.go

@@ -0,0 +1,56 @@
+package detector
+
+import (
+	"reflect"
+	"testing"
+
+	"github.com/wata727/tflint/config"
+	"github.com/wata727/tflint/issue"
+)
+
+func TestDetectAwsElastiCacheClusterPreviousType(t *testing.T) {
+	cases := []struct {
+		Name   string
+		Src    string
+		Issues []*issue.Issue
+	}{
+		{
+			Name: "cache.t1.micro is previous type",
+			Src: `
+resource "aws_elasticache_cluster" "redis" {
+    node_type = "cache.t1.micro"
+}`,
+			Issues: []*issue.Issue{
+				&issue.Issue{
+					Type:    "WARNING",
+					Message: "\"cache.t1.micro\" is previous generation node type.",
+					Line:    3,
+					File:    "test.tf",
+				},
+			},
+		},
+		{
+			Name: "cache.t2.micro is not previous type",
+			Src: `
+resource "aws_elasticache_cluster" "redis" {
+    node_type = "cache.t2.micro"
+}`,
+			Issues: []*issue.Issue{},
+		},
+	}
+
+	for _, tc := range cases {
+		var issues = []*issue.Issue{}
+		TestDetectByCreatorName(
+			"CreateAwsElastiCacheClusterPreviousTypeDetector",
+			tc.Src,
+			config.Init(),
+			config.Init().NewAwsClient(),
+			&issues,
+		)
+
+		if !reflect.DeepEqual(issues, tc.Issues) {
+			t.Fatalf("Bad: %s\nExpected: %s\n\ntestcase: %s", issues, tc.Issues, tc.Name)
+		}
+	}
+}

detector/detector.go

@@ -50,6 +50,7 @@ var detectors = map[string]string{
 	"aws_elasticache_cluster_invalid_subnet_group":    "CreateAwsElastiCacheClusterInvalidSubnetGroupDetector",
 	"aws_elasticache_cluster_invalid_security_group":  "CreateAwsElastiCacheClusterInvalidSecurityGroupDetector",
 	"aws_elasticache_cluster_invalid_type":            "CreateAwsElastiCacheClusterInvalidTypeDetector",
+	"aws_elasticache_cluster_previous_type":           "CreateAwsElastiCacheClusterPreviousTypeDetector",
 }
 
 func NewDetector(listMap map[string]*ast.ObjectList, c *config.Config) (*Detector, error) {

docs/README.md

@@ -22,6 +22,7 @@ Issues are classified into the following three types.
     - [aws_db_instance_default_parameter_group](aws_db_instance_default_parameter_group.md)
 - AWS ElastiCache Cluster
     - [aws_elasticache_cluster_invalid_type](aws_elasticache_cluster_invalid_type.md)
+    - [aws_elasticache_cluster_previous_type](aws_elasticache_cluster_previous_type.md)
     - [aws_elasticache_cluster_default_parameter_group](aws_elasticache_cluster_default_parameter_group.md)
 
 ### Invalid Issues

docs/aws_db_instance_invalid_type.md

@@ -30,4 +30,4 @@ Result: 1 issues  (1 errors , 0 warnings , 0 notices)
 If an invalid instance type is specified, an error will occur at `terraform apply`.
 
 ## How to fix
-Check the [instance type list](https://aws.amazon.com/jp/rds/details/) and select a valid instance type again.
+Check the [instance type list](https://aws.amazon.com/rds/details/) and select a valid instance type again.

docs/aws_db_instance_previous_type.md

@@ -30,4 +30,4 @@ Result: 1 issues  (0 errors , 1 warnings , 0 notices)
 There are two types of instance types, the current generation and the previous generation. The current generation is superior to the previous generation in terms of performance and fee. AWS also officially states that unless there is a special reason, you should use the instance type of the current generation.
 
 ## How to fix
-Follow the [upgrade paths](https://aws.amazon.com/jp/rds/previous-generation/) and confirm that the instance type of the current generation can be used, then select again.
+Follow the [upgrade paths](https://aws.amazon.com/rds/previous-generation/) and confirm that the instance type of the current generation can be used, then select again.

docs/aws_elasticache_cluster_invalid_type.md

@@ -31,4 +31,4 @@ Result: 1 issues  (1 errors , 0 warnings , 0 notices)
 If an invalid node type is specified, an error will occur at `terraform apply`.
 
 ## How to fix
-Check the [node type list](https://aws.amazon.com/jp/elasticache/details/) and select a valid node type again.
+Check the [node type list](https://aws.amazon.com/elasticache/details/) and select a valid node type again.

docs/aws_elasticache_cluster_previous_type.md

@@ -0,0 +1,34 @@
+# AWS ElastiCache Cluster Instance Previous Type
+Report this issue if you have specified the previous node type. This issue type is WARNING.
+
+## Example
+```
+resource "aws_elasticache_cluster" "redis" {
+  cluster_id           = "app"
+  engine               = "redis"
+  engine_version       = "3.2.4"
+  maintenance_window   = "sun:00:00-sun:06:00"
+  node_type            = "cache.t1.micro" // previous type!
+  num_cache_nodes      = 1
+  port                 = 6379
+  parameter_group_name = "default.redis3.2"
+  subnet_group_name    = "app-subnet-group"
+  security_group_ids   = ["${aws_security_group.redis.id}"]
+}
+```
+
+The following is the execution result of TFLint:
+
+```
+$ tflint
+template.tf
+        WARNING:6 "cache.t1.micro" is previous generation node type.
+
+Result: 1 issues  (0 errors , 1 warnings , 0 notices)
+```
+
+## Why
+There are two types of node types, the current generation and the previous generation. The current generation is superior to the previous generation in terms of performance and fee. AWS also officially states that unless there is a special reason, you should use the node type of the current generation.
+
+## How to fix
+Follow the [upgrade paths](https://aws.amazon.com/elasticache/previous-generation/) and confirm that the node type of the current generation can be used, then select again.