From c97ea75521f238d8037015fda90243a06f3cf1a8 Mon Sep 17 00:00:00 2001 From: Will Dixon Date: Sat, 7 Oct 2023 20:30:01 -0400 Subject: [PATCH] Introduce Concept of modes (#69) Signed-off-by: Will Dixon --- settings.go | 24 +++++++++++++-- settings_test.go | 76 +++++++++++++++++++++++++++++++++++++++++++----- 2 files changed, 89 insertions(+), 11 deletions(-) diff --git a/settings.go b/settings.go index 440f329..9314db6 100644 --- a/settings.go +++ b/settings.go @@ -11,12 +11,20 @@ import ( ) type List struct { - Files []string `json:"files" yaml:"files" toml:"files" mapstructure:"files"` - Allow []string `json:"allow" yaml:"allow" toml:"allow" mapstructure:"allow"` - Deny map[string]string `json:"deny" yaml:"deny" toml:"deny" mapstructure:"deny"` + ListMode string `json:"listMode" yaml:"listMode" toml:"listMode" mapstructure:"listMode"` + Files []string `json:"files" yaml:"files" toml:"files" mapstructure:"files"` + Allow []string `json:"allow" yaml:"allow" toml:"allow" mapstructure:"allow"` + Deny map[string]string `json:"deny" yaml:"deny" toml:"deny" mapstructure:"deny"` } +type listMode int + +const ( + listModeStrict listMode = iota +) + type list struct { + listMode listMode name string files []glob.Glob negFiles []glob.Glob @@ -33,6 +41,16 @@ func (l *List) compile() (*list, error) { var errs utils.MultiError var err error + // Determine List Mode + switch strings.ToLower(l.ListMode) { + case "": + li.listMode = listModeStrict + case "strict": + li.listMode = listModeStrict + default: + errs = append(errs, fmt.Errorf("%s is not a known list mode", l.ListMode)) + } + // Compile Files for _, f := range l.Files { var negate bool diff --git a/settings_test.go b/settings_test.go index 62fd6b4..0f6d501 100644 --- a/settings_test.go +++ b/settings_test.go @@ -159,6 +159,48 @@ var ( suggestions: []string{"Don't use Reflect"}, }, }, + { + name: "Strict Mode Default", + list: &List{ + Allow: []string{"os"}, + Deny: map[string]string{ + "reflect": "Don't use Reflect", + }, + }, + exp: &list{ + listMode: listModeStrict, + allow: []string{"os"}, + deny: []string{"reflect"}, + suggestions: []string{"Don't use Reflect"}, + }, + }, + { + name: "Set Strict Mode", + list: &List{ + ListMode: "sTriCT", + Allow: []string{"os"}, + Deny: map[string]string{ + "reflect": "Don't use Reflect", + }, + }, + exp: &list{ + listMode: listModeStrict, + allow: []string{"os"}, + deny: []string{"reflect"}, + suggestions: []string{"Don't use Reflect"}, + }, + }, + { + name: "Unknown List Mode", + list: &List{ + ListMode: "MiddleOut", + Allow: []string{"os"}, + Deny: map[string]string{ + "reflect": "Don't use Reflect", + }, + }, + expErr: errors.New("MiddleOut is not a known list mode"), + }, } settingsCompileScenarios = []*settingsCompileScenario{ { @@ -259,6 +301,7 @@ func init() { // Only doing this so I have a controlled list of expansions for packages utils.PackageExpandable["$gostd"] = &expanderTest{} } + func TestListCompile(t *testing.T) { for _, s := range listCompileScenarios { t.Run(s.name, testListCompile(s)) @@ -521,27 +564,45 @@ var listImportAllowedScenarios = []*listImportAllowedScenario{ }, }, { - name: "Both only allows what is in allow and not in deny", + name: "Both in Strict mode allows what is in allow and not in deny", setup: &list{ - allow: []string{"some/pkg/a"}, - deny: []string{"some/pkg/a/foo"}, - suggestions: []string{"because I said so"}, + listMode: listModeStrict, + allow: []string{"some/pkg/a/foo", "some/pkg/b", "some/pkg/c"}, + deny: []string{"some/pkg/a", "some/pkg/b/foo"}, + suggestions: []string{"because I said so", "really don't use"}, }, tests: []*listImportAllowedScenarioInner{ { name: "in allow but not in deny", - input: "some/pkg/a/bar", + input: "some/pkg/c/alpha", expected: true, }, { - name: "in allow and in deny", + name: "subpackage allowed but root denied", input: "some/pkg/a/foo/bar", expected: false, suggestion: "because I said so", }, + { + name: "subpackage not in allowed but root denied", + input: "some/pkg/a/baz", + expected: false, + suggestion: "because I said so", + }, + { + name: "subpackage denied but root allowed", + input: "some/pkg/b/foo/bar", + expected: false, + suggestion: "really don't use", + }, + { + name: "subpackage not denied but root allowed", + input: "some/pkg/b/baz", + expected: true, + }, { name: "not in allow nor in deny", - input: "some/pkg/b/foo/bar", + input: "some/pkg/d/alpha", expected: false, }, }, @@ -564,7 +625,6 @@ func TestListImportAllowed(t *testing.T) { } }) } - } type linterSettingsWhichListsScenario struct {