Skip to content

fix: rule severity is required #4469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions pkg/config/severity.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,9 @@ type SeverityRule struct {
}

func (s *SeverityRule) Validate() error {
if s.Severity == "" {
return errors.New("severity should be set")
}

return s.BaseRule.Validate(severityRuleMinConditionsCount)
}
123 changes: 120 additions & 3 deletions pkg/config/severity_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,108 @@ import (
)

func TestSeverity_Validate(t *testing.T) {
testCases := []struct {
desc string
severity *Severity
}{
{
desc: "default with rules",
severity: &Severity{
Default: "high",
Rules: []SeverityRule{
{
Severity: "low",
BaseRule: BaseRule{
Path: "test",
},
},
},
},
},
{
desc: "default without rules",
severity: &Severity{
Default: "high",
},
},
{
desc: "same severity between default and rule",
severity: &Severity{
Default: "high",
Rules: []SeverityRule{
{
Severity: "high",
BaseRule: BaseRule{
Path: "test",
},
},
},
},
},
}

for _, test := range testCases {
test := test
t.Run(test.desc, func(t *testing.T) {
t.Parallel()

err := test.severity.Validate()
require.NoError(t, err)
})
}
}

func TestSeverity_Validate_error(t *testing.T) {
testCases := []struct {
desc string
severity *Severity
expected string
}{
{
desc: "missing default severity",
severity: &Severity{
Default: "",
Rules: []SeverityRule{
{
Severity: "low",
BaseRule: BaseRule{
Path: "test",
},
},
},
},
expected: "can't set severity rule option: no default severity defined",
},
{
desc: "missing rule severity",
severity: &Severity{
Default: "high",
Rules: []SeverityRule{
{
BaseRule: BaseRule{
Path: "test",
},
},
},
},
expected: "error in severity rule #0: severity should be set",
},
}

for _, test := range testCases {
test := test
t.Run(test.desc, func(t *testing.T) {
t.Parallel()

err := test.severity.Validate()
require.EqualError(t, err, test.expected)
})
}
}

func TestSeverityRule_Validate(t *testing.T) {
rule := &SeverityRule{
Severity: "low",
BaseRule: BaseRule{
Path: "test",
},
Expand All @@ -17,20 +118,32 @@ func TestSeverity_Validate(t *testing.T) {
require.NoError(t, err)
}

func TestSeverity_Validate_error(t *testing.T) {
func TestSeverityRule_Validate_error(t *testing.T) {
testCases := []struct {
desc string
rule *SeverityRule
expected string
}{
{
desc: "empty rule",
rule: &SeverityRule{},
desc: "missing severity",
rule: &SeverityRule{
BaseRule: BaseRule{
Path: "test",
},
},
expected: "severity should be set",
},
{
desc: "empty rule",
rule: &SeverityRule{
Severity: "low",
},
expected: "at least 1 of (text, source, path[-except], linters) should be set",
},
{
desc: "invalid path rule",
rule: &SeverityRule{
Severity: "low",
BaseRule: BaseRule{
Path: "**test",
},
Expand All @@ -40,6 +153,7 @@ func TestSeverity_Validate_error(t *testing.T) {
{
desc: "invalid path-except rule",
rule: &SeverityRule{
Severity: "low",
BaseRule: BaseRule{
PathExcept: "**test",
},
Expand All @@ -49,6 +163,7 @@ func TestSeverity_Validate_error(t *testing.T) {
{
desc: "invalid text rule",
rule: &SeverityRule{
Severity: "low",
BaseRule: BaseRule{
Text: "**test",
},
Expand All @@ -58,6 +173,7 @@ func TestSeverity_Validate_error(t *testing.T) {
{
desc: "invalid source rule",
rule: &SeverityRule{
Severity: "low",
BaseRule: BaseRule{
Source: "**test",
},
Expand All @@ -67,6 +183,7 @@ func TestSeverity_Validate_error(t *testing.T) {
{
desc: "path and path-expect",
rule: &SeverityRule{
Severity: "low",
BaseRule: BaseRule{
Path: "test",
PathExcept: "test",
Expand Down