terraform_naming_convention: Add support for checks and scoped data sources (#131)

* Add support for scoped data sources

* Add support for check blocks

Author: wata727

docs/rules/terraform_naming_convention.md

@@ -8,6 +8,7 @@ Enforces naming conventions for the following blocks:
 * Local values
 * Modules
 * Data sources
+* Checks
 
 ## Configuration
 
@@ -23,6 +24,7 @@ module | | Block settings to override naming convention for modules
 output | | Block settings to override naming convention for output values
 resource | | Block settings to override naming convention for resources
 variable | | Block settings to override naming convention for input variables
+check | | Block settings to override naming convention for checks
 
 
 #### `format`

rules/terraform_naming_convention.go

@@ -29,6 +29,7 @@ type terraformNamingConventionRuleConfig struct {
 	Output   *BlockFormatConfig `hclext:"output,block"`
 	Resource *BlockFormatConfig `hclext:"resource,block"`
 	Variable *BlockFormatConfig `hclext:"variable,block"`
+	Check    *BlockFormatConfig `hclext:"check,block"`
 }
 
 // CustomFormatConfig defines a custom format that can be used instead of the predefined formats
@@ -128,6 +129,19 @@ func (r *TerraformNamingConventionRule) Check(rr tflint.Runner) error {
 				LabelNames: []string{"name"},
 				Body:       &hclext.BodySchema{},
 			},
+			{
+				Type:       "check",
+				LabelNames: []string{"name"},
+				Body: &hclext.BodySchema{
+					Blocks: []hclext.BlockSchema{
+						{
+							Type:       "data",
+							LabelNames: []string{"type", "name"},
+							Body:       &hclext.BodySchema{},
+						},
+					},
+				},
+			},
 		},
 	}, &tflint.GetModuleContentOption{ExpandMode: tflint.ExpandModeNone})
 	if err != nil {
@@ -146,6 +160,14 @@ func (r *TerraformNamingConventionRule) Check(rr tflint.Runner) error {
 			return err
 		}
 	}
+	checkBlockName := "check"
+	for _, checkBlock := range blocks[checkBlockName] {
+		for _, block := range checkBlock.Body.Blocks {
+			if err := nameValidator.checkBlock(runner, r, dataBlockName, block.Labels[1], &block.DefRange); err != nil {
+				return err
+			}
+		}
+	}
 
 	// modules
 	moduleBlockName := "module"
@@ -195,6 +217,17 @@ func (r *TerraformNamingConventionRule) Check(rr tflint.Runner) error {
 		}
 	}
 
+	// checks
+	nameValidator, err = config.Check.getNameValidator(defaultNameValidator, &config, checkBlockName)
+	if err != nil {
+		return err
+	}
+	for _, block := range blocks[checkBlockName] {
+		if err := nameValidator.checkBlock(runner, r, checkBlockName, block.Labels[0], &block.DefRange); err != nil {
+			return err
+		}
+	}
+
 	// locals
 	localBlockName := "local value"
 	nameValidator, err = config.Locals.getNameValidator(defaultNameValidator, &config, localBlockName)

rules/terraform_naming_convention_test.go

@@ -295,6 +295,36 @@ data "aws_eip" "foo_bar" {
 			Name: fmt.Sprintf("data: %s - Valid single word", testType),
 			Content: `
 data "aws_eip" "foo" {
+}`,
+			Config:   config,
+			Expected: helper.Issues{},
+		},
+		{
+			Name: fmt.Sprintf("data: %s - Invalid snake_case in a check block", testType),
+			Content: `
+check "ignored" {
+  data "aws_eip" "dash-name" {
+  }
+}`,
+			Config: config,
+			Expected: helper.Issues{
+				{
+					Rule:    rule,
+					Message: fmt.Sprintf("data name `dash-name` must match the following %s", formatName),
+					Range: hcl.Range{
+						Filename: "tests.tf",
+						Start:    hcl.Pos{Line: 3, Column: 3},
+						End:      hcl.Pos{Line: 3, Column: 29},
+					},
+				},
+			},
+		},
+		{
+			Name: fmt.Sprintf("data: %s - Valid snake_case in a check block", testType),
+			Content: `
+check "ignored" {
+  data "aws_eip" "foo_bar" {
+  }
 }`,
 			Config:   config,
 			Expected: helper.Issues{},
@@ -2926,3 +2956,59 @@ variable "camelCase" {
 		})
 	}
 }
+
+func Test_TerraformNamingConventionRule_Check(t *testing.T) {
+	rule := NewTerraformNamingConventionRule()
+
+	config := `
+rule "terraform_naming_convention" {
+  enabled = true
+
+  check {
+    format = "snake_case"
+  }
+}`
+
+	tests := []struct {
+		name    string
+		content string
+		want    helper.Issues
+	}{
+		{
+			name: "Invalid snake_case",
+			content: `
+check "dash-name" {
+}`,
+			want: helper.Issues{
+				{
+					Rule:    rule,
+					Message: "check name `dash-name` must match the following format: snake_case",
+					Range: hcl.Range{
+						Filename: "tests.tf",
+						Start:    hcl.Pos{Line: 2, Column: 1},
+						End:      hcl.Pos{Line: 2, Column: 18},
+					},
+				},
+			},
+		},
+		{
+			name: "Valid snake_case",
+			content: `
+check "foo_bar" {
+}`,
+			want: helper.Issues{},
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			runner := testRunner(t, map[string]string{"tests.tf": test.content, ".tflint.hcl": config})
+
+			if err := rule.Check(runner); err != nil {
+				t.Fatalf("Unexpected error occurred: %s", err)
+			}
+
+			helper.AssertIssues(t, test.want, runner.Runner.(*helper.Runner).Issues)
+		})
+	}
+}