Allow ruleset to accept Only option

terraform-linters · Sep 14, 2022 · 7a18971 · 7a18971
1 parent 6997918
commit 7a18971
Show file tree

Hide file tree

Showing 8 changed files with 451 additions and 280 deletions.
diff --git a/plugin/fromproto/fromproto.go b/plugin/fromproto/fromproto.go
@@ -180,7 +180,11 @@ func Config(config *proto.ApplyGlobalConfig_Config) *tflint.Config {
 	for name, rule := range config.Rules {
 		rules[name] = &tflint.RuleConfig{Name: rule.Name, Enabled: rule.Enabled}
 	}
-	return &tflint.Config{Rules: rules, DisabledByDefault: config.DisabledByDefault}
+	return &tflint.Config{
+		Rules:             rules,
+		DisabledByDefault: config.DisabledByDefault,
+		Only:              config.Only,
+	}
 }
 
 // GetModuleContentOption converts proto.GetModuleContent_Option to tflint.GetModuleContentOption

diff --git a/plugin/host2plugin/host2plugin_test.go b/plugin/host2plugin/host2plugin_test.go
@@ -299,6 +299,7 @@ func TestApplyGlobalConfig(t *testing.T) {
 					"test2": {Name: "test2", Enabled: false},
 				},
 				DisabledByDefault: true,
+				Only:              []string{"test_rule1", "test_rule2"},
 			},
 			ServerImpl: func(config *tflint.Config) error {
 				want := &tflint.Config{
@@ -307,6 +308,7 @@ func TestApplyGlobalConfig(t *testing.T) {
 						"test2": {Name: "test2", Enabled: false},
 					},
 					DisabledByDefault: true,
+					Only:              []string{"test_rule1", "test_rule2"},
 				}
 
 				if diff := cmp.Diff(config, want); diff != "" {

diff --git a/plugin/proto/tflint.pb.go b/plugin/proto/tflint.pb.go
diff --git a/plugin/proto/tflint.proto b/plugin/proto/tflint.proto
@@ -45,6 +45,7 @@ message ApplyGlobalConfig {
     message Config {
         map<string, RuleConfig> rules = 1;
         bool disabled_by_default = 2;
+        repeated string only = 3;
     }
     message RuleConfig {
         string name = 1;

diff --git a/plugin/toproto/toproto.go b/plugin/toproto/toproto.go
@@ -138,7 +138,11 @@ func Config(config *tflint.Config) *proto.ApplyGlobalConfig_Config {
 	for name, rule := range config.Rules {
 		rules[name] = &proto.ApplyGlobalConfig_RuleConfig{Name: rule.Name, Enabled: rule.Enabled}
 	}
-	return &proto.ApplyGlobalConfig_Config{Rules: rules, DisabledByDefault: config.DisabledByDefault}
+	return &proto.ApplyGlobalConfig_Config{
+		Rules:             rules,
+		DisabledByDefault: config.DisabledByDefault,
+		Only:              config.Only,
+	}
 }
 
 // GetModuleContentOption converts tflint.GetModuleContentOption to proto.GetModuleContent_Option

diff --git a/tflint/config.go b/tflint/config.go
@@ -4,6 +4,7 @@ package tflint
 type Config struct {
 	Rules             map[string]*RuleConfig
 	DisabledByDefault bool
+	Only              []string
 }
 
 // RuleConfig is a TFLint's rule configuration.

diff --git a/tflint/ruleset.go b/tflint/ruleset.go
@@ -44,14 +44,22 @@ func (r *BuiltinRuleSet) RuleNames() []string {
 // Override the ApplyConfig if you want to apply the plugin's own configuration.
 func (r *BuiltinRuleSet) ApplyGlobalConfig(config *Config) error {
 	r.EnabledRules = []Rule{}
+	only := map[string]bool{}
 
-	if config.DisabledByDefault {
+	if len(config.Only) > 0 {
 		log.Printf("[DEBUG] Only mode is enabled. Ignoring default plugin rules")
+		for _, rule := range config.Only {
+			only[rule] = true
+		}
+	} else if config.DisabledByDefault {
+		log.Printf("[DEBUG] Default plugin rules are disabled by default")
 	}
 
 	for _, rule := range r.Rules {
 		enabled := rule.Enabled()
-		if cfg := config.Rules[rule.Name()]; cfg != nil {
+		if len(only) > 0 {
+			enabled = only[rule.Name()]
+		} else if cfg := config.Rules[rule.Name()]; cfg != nil {
 			enabled = cfg.Enabled
 		} else if config.DisabledByDefault {
 			enabled = false

diff --git a/tflint/ruleset_test.go b/tflint/ruleset_test.go
@@ -0,0 +1,142 @@
+package tflint
+
+import (
+	"testing"
+
+	"github.com/google/go-cmp/cmp"
+)
+
+type testRule struct {
+	DefaultRule
+	name string
+}
+
+func (r *testRule) Name() string       { return r.name }
+func (r *testRule) Enabled() bool      { return true }
+func (r *testRule) Severity() Severity { return ERROR }
+func (r *testRule) Check(Runner) error { return nil }
+
+type testRule1 struct {
+	testRule
+}
+
+type testRule2 struct {
+	testRule
+}
+
+type testRule3 struct {
+	testRule
+}
+
+func TestApplyGlobalConfig(t *testing.T) {
+	tests := []struct {
+		name   string
+		config *Config
+		want   []string
+	}{
+		{
+			name:   "default",
+			config: &Config{},
+			want:   []string{"test_rule1", "test_rule2", "test_rule3"},
+		},
+		{
+			name:   "disabled by default",
+			config: &Config{DisabledByDefault: true},
+			want:   []string{},
+		},
+		{
+			name: "rule config",
+			config: &Config{
+				Rules: map[string]*RuleConfig{
+					"test_rule1": {
+						Name:    "test_rule1",
+						Enabled: false,
+					},
+				},
+			},
+			want: []string{"test_rule2", "test_rule3"},
+		},
+		{
+			name:   "only",
+			config: &Config{Only: []string{"test_rule1"}},
+			want:   []string{"test_rule1"},
+		},
+		{
+			name: "disabled by default + rule config",
+			config: &Config{
+				Rules: map[string]*RuleConfig{
+					"test_rule2": {
+						Name:    "test_rule2",
+						Enabled: true,
+					},
+				},
+				DisabledByDefault: true,
+			},
+			want: []string{"test_rule2"},
+		},
+		{
+			name: "only + rule config",
+			config: &Config{
+				Rules: map[string]*RuleConfig{
+					"test_rule1": {
+						Name:    "test_rule1",
+						Enabled: false,
+					},
+				},
+				Only: []string{"test_rule1", "test_rule2"},
+			},
+			want: []string{"test_rule1", "test_rule2"},
+		},
+		{
+			name: "disabled by default + only",
+			config: &Config{
+				DisabledByDefault: true,
+				Only:              []string{"test_rule1", "test_rule2"},
+			},
+			want: []string{"test_rule1", "test_rule2"},
+		},
+		{
+			name: "disabled by default + only + rule config",
+			config: &Config{
+				Rules: map[string]*RuleConfig{
+					"test_rule2": {
+						Name:    "test_rule2",
+						Enabled: true,
+					},
+					"test_rule3": {
+						Name:    "test_rule3",
+						Enabled: false,
+					},
+				},
+				DisabledByDefault: true,
+				Only:              []string{"test_rule1", "test_rule3"},
+			},
+			want: []string{"test_rule1", "test_rule3"},
+		},
+	}
+
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			ruleset := &BuiltinRuleSet{
+				Rules: []Rule{
+					&testRule1{testRule: testRule{name: "test_rule1"}},
+					&testRule2{testRule: testRule{name: "test_rule2"}},
+					&testRule3{testRule: testRule{name: "test_rule3"}},
+				},
+			}
+
+			if err := ruleset.ApplyGlobalConfig(test.config); err != nil {
+				t.Fatal(err)
+			}
+
+			got := make([]string, len(ruleset.EnabledRules))
+			for i, r := range ruleset.EnabledRules {
+				got[i] = r.Name()
+			}
+
+			if diff := cmp.Diff(got, test.want); diff != "" {
+				t.Errorf(diff)
+			}
+		})
+	}
+}