Skip to content

Commit b1e4403

Browse files
tim-thacker-nullifytim-thacker-nullify
authored
replace ignore_patterns with ignore_paths (#33)
1 parent 12dd256 commit b1e4403

File tree

5 files changed

+27
-27
lines changed

5 files changed

+27
-27
lines changed

‎pkg/models/config.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ package models
33
type Configuration struct {
44
SeverityThreshold string `yaml:"severity_threshold"`
55
IgnoreDirs []string `yaml:"ignore_dirs"`
6-
IgnorePatterns []string `yaml:"ignore_patterns"`
6+
IgnorePaths []string `yaml:"ignore_paths"`
77
EmailNotifications []string `yaml:"email_notifications"`
88
SecretsWhitelist []string `yaml:"secrets_whitelist"`
99
}

‎pkg/parser/defaults.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ func NewDefaultConfig() *models.Configuration {
88
return &models.Configuration{
99
SeverityThreshold: DefaultSeverityThreshold,
1010
IgnoreDirs: []string{},
11-
IgnorePatterns: []string{},
11+
IgnorePaths: []string{},
1212
}
1313
}

‎pkg/parser/parse_test.go‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ func TestParseConfiguration(t *testing.T) {
2626
expected: &models.Configuration{
2727
SeverityThreshold: models.SeverityMedium,
2828
IgnoreDirs: nil,
29-
IgnorePatterns: nil,
29+
IgnorePaths: nil,
3030
SecretsWhitelist: nil,
3131
},
3232
},
@@ -36,7 +36,7 @@ func TestParseConfiguration(t *testing.T) {
3636
expected: &models.Configuration{
3737
SeverityThreshold: models.SeverityHigh,
3838
IgnoreDirs: []string{"data"},
39-
IgnorePatterns: []string{"*d"},
39+
IgnorePaths: []string{"*d"},
4040
SecretsWhitelist: []string{"secretPassword", "superSecretPassword"},
4141
},
4242
},
@@ -46,7 +46,7 @@ func TestParseConfiguration(t *testing.T) {
4646
expected: &models.Configuration{
4747
SeverityThreshold: models.SeverityMedium,
4848
IgnoreDirs: nil,
49-
IgnorePatterns: nil,
49+
IgnorePaths: nil,
5050
SecretsWhitelist: nil,
5151
},
5252
},
@@ -56,7 +56,7 @@ func TestParseConfiguration(t *testing.T) {
5656
expected: &models.Configuration{
5757
SeverityThreshold: models.SeverityLow,
5858
IgnoreDirs: nil,
59-
IgnorePatterns: nil,
59+
IgnorePaths: nil,
6060
SecretsWhitelist: nil,
6161
},
6262
},
@@ -66,7 +66,7 @@ func TestParseConfiguration(t *testing.T) {
6666
expected: &models.Configuration{
6767
SeverityThreshold: models.SeverityMedium,
6868
IgnoreDirs: nil,
69-
IgnorePatterns: nil,
69+
IgnorePaths: nil,
7070
SecretsWhitelist: []string{"password"},
7171
},
7272
},
@@ -77,26 +77,26 @@ func TestParseConfiguration(t *testing.T) {
7777
SeverityThreshold: models.SeverityMedium,
7878
IgnoreDirs: nil,
7979
SecretsWhitelist: nil,
80-
IgnorePatterns: nil,
80+
IgnorePaths: nil,
8181
},
8282
},
8383
{
8484
name: "user provided empty ignore patterns",
85-
data: `ignore_patterns: `,
85+
data: `ignore_paths: `,
8686
expected: &models.Configuration{
8787
SeverityThreshold: models.SeverityMedium,
8888
IgnoreDirs: nil,
89-
IgnorePatterns: nil,
89+
IgnorePaths: nil,
9090
SecretsWhitelist: nil,
9191
},
9292
},
9393
{
9494
name: "user provided glob in ignore patterns",
95-
data: `ignore_patterns: ["*d"]`,
95+
data: `ignore_paths: ["*d"]`,
9696
expected: &models.Configuration{
9797
SeverityThreshold: models.SeverityMedium,
9898
IgnoreDirs: nil,
99-
IgnorePatterns: []string{"*d"},
99+
IgnorePaths: []string{"*d"},
100100
SecretsWhitelist: nil,
101101
},
102102
},

‎pkg/validator/glob.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ import (
66
)
77

88
func ValidateGlob(config *models.Configuration) bool {
9-
if config.IgnorePatterns == nil {
9+
if config.IgnorePaths == nil {
1010
return true
1111
}
1212

13-
for _, pattern := range config.IgnorePatterns {
13+
for _, pattern := range config.IgnorePaths {
1414
_, err := glob.Compile(pattern)
1515
if err != nil {
1616
return false

‎pkg/validator/glob_test.go‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,75 +21,75 @@ func TestValidGlobs(t *testing.T) {
2121
expected: true,
2222
},
2323
{
24-
config: &models.Configuration{IgnorePatterns: []string{}},
24+
config: &models.Configuration{IgnorePaths: []string{}},
2525
expected: true,
2626
},
2727
{
28-
config: &models.Configuration{IgnorePatterns: []string{"*[abc]"}},
28+
config: &models.Configuration{IgnorePaths: []string{"*[abc]"}},
2929
expected: true,
3030
},
3131
{
32-
config: &models.Configuration{IgnorePatterns: []string{"*[abc]", "*d"}},
32+
config: &models.Configuration{IgnorePaths: []string{"*[abc]", "*d"}},
3333
expected: true,
3434
},
3535
{
36-
config: &models.Configuration{IgnorePatterns: []string{"*[abc"}},
36+
config: &models.Configuration{IgnorePaths: []string{"*[abc"}},
3737
expected: false,
3838
},
3939
{
40-
config: &models.Configuration{IgnorePatterns: []string{"*d", "*[abc"}},
40+
config: &models.Configuration{IgnorePaths: []string{"*d", "*[abc"}},
4141
expected: false,
4242
},
4343
{
44-
config: &models.Configuration{IgnorePatterns: []string{"*[abc", "*d"}},
44+
config: &models.Configuration{IgnorePaths: []string{"*[abc", "*d"}},
4545
expected: false,
4646
},
4747
} {
4848
t.Run(scenario.name, func(t *testing.T) {
4949
isValid := ValidateGlob(scenario.config)
50-
assert.Equalf(t, isValid, scenario.expected, fmt.Sprintf("failed test, globs: %s, len: %d\n", scenario.config.IgnorePatterns, len(scenario.config.IgnorePatterns)))
50+
assert.Equalf(t, isValid, scenario.expected, fmt.Sprintf("failed test, globs: %s, len: %d\n", scenario.config.IgnorePaths, len(scenario.config.IgnorePaths)))
5151
})
5252
}
5353
}
5454

5555
const validGlob string = `
5656
severity_threshold: medium
5757
ignore_dirs: ["data"]
58-
ignore_patterns: ["*[abc]"]
58+
ignore_paths: ["*[abc]"]
5959
email_notifications: ["[email protected]"]
6060
`
6161
const emptyGlob string = `
6262
severity_threshold: medium
6363
ignore_dirs: ["data"]
64-
ignore_patterns: ["*[abc]", "*d"]
64+
ignore_paths: ["*[abc]", "*d"]
6565
email_notifications: ["[email protected]"]
6666
`
6767

6868
const twoValidGlob string = `
6969
severity_threshold: medium
7070
ignore_dirs: ["data"]
71-
ignore_patterns:
71+
ignore_paths:
7272
email_notifications: ["[email protected]"]
7373
`
7474

7575
const invalidGlob string = `
7676
severity_threshold: medium
7777
ignore_dirs: ["data"]
78-
ignore_patterns: ["*[abc"]
78+
ignore_paths: ["*[abc"]
7979
email_notifications: ["[email protected]"]
8080
`
8181

8282
const endInvalidGlob string = `
8383
severity_threshold: medium
8484
ignore_dirs: ["data"]
85-
ignore_patterns: ["*d", "*[abc"]
85+
ignore_paths: ["*d", "*[abc"]
8686
email_notifications: ["[email protected]"]
8787
`
8888

8989
const startInvalidGlob string = `
9090
severity_threshold: medium
9191
ignore_dirs: ["data"]
92-
ignore_patterns: ["*[abc", "*d"]
92+
ignore_paths: ["*[abc", "*d"]
9393
email_notifications: ["[email protected]"]
9494
`
9595

0 commit comments

Comments
 (0)