Prepare for #164: rename GAS to gosec

1. Rename in a backward compatible way
2. Remove gosec default exclude list because gosec is already disabled
by default.
3. Warn about unmatched linter names in //nolint directives
4. Process linter names in //nolint directives in upper case
5. Disable gosec for golangci-lint in .golangci.yml

Author: jirfag

.golangci.yml

@@ -25,4 +25,5 @@ linters:
   enable-all: true
   disable:
     - maligned
-    - prealloc
+    - prealloc
+    - gosec

Makefile

@@ -14,6 +14,9 @@ assets:
 readme:
 	go run ./scripts/gen_readme/main.go
 
+gen:
+	go generate ./...
+
 check_generated:
 	make readme && git diff --exit-code # check no changes
 

README.tmpl.md

@@ -166,12 +166,12 @@ We compare golangci-lint and gometalinter in default mode, but explicitly enable
 $ golangci-lint run --no-config --issues-exit-code=0 --deadline=30m \
 	--disable-all --enable=deadcode  --enable=gocyclo --enable=golint --enable=varcheck \
 	--enable=structcheck --enable=maligned --enable=errcheck --enable=dupl --enable=ineffassign \
-	--enable=interfacer --enable=unconvert --enable=goconst --enable=gas --enable=megacheck
+	--enable=interfacer --enable=unconvert --enable=goconst --enable=gosec --enable=megacheck
 $ gometalinter --deadline=30m --vendor --cyclo-over=30 --dupl-threshold=150 \
 	--exclude=<defaul golangci-lint excludes> --skip=testdata --skip=builtin \
 	--disable-all --enable=deadcode  --enable=gocyclo --enable=golint --enable=varcheck \
 	--enable=structcheck --enable=maligned --enable=errcheck --enable=dupl --enable=ineffassign \
-	--enable=interfacer --enable=unconvert --enable=goconst --enable=gas --enable=megacheck
+	--enable=interfacer --enable=unconvert --enable=goconst --enable=gosec --enable=megacheck
 	./...
 ```
 

pkg/commands/help.go

@@ -33,8 +33,12 @@ func (e *Executor) initHelp() {
 
 func printLinterConfigs(lcs []linter.Config) {
 	for _, lc := range lcs {
-		fmt.Fprintf(logutils.StdOut, "%s: %s [fast: %t]\n", color.YellowString(lc.Linter.Name()),
-			lc.Linter.Desc(), !lc.DoesFullImport)
+		altNamesStr := ""
+		if len(lc.AlternativeNames) != 0 {
+			altNamesStr = fmt.Sprintf(" (%s)", strings.Join(lc.AlternativeNames, ", "))
+		}
+		fmt.Fprintf(logutils.StdOut, "%s%s: %s [fast: %t]\n", color.YellowString(lc.Name()),
+			altNamesStr, lc.Linter.Desc(), !lc.DoesFullImport)
 	}
 }
 
@@ -58,7 +62,7 @@ func (e Executor) executeLintersHelp(cmd *cobra.Command, args []string) {
 		linters := e.DBManager.GetAllLinterConfigsForPreset(p)
 		linterNames := []string{}
 		for _, lc := range linters {
-			linterNames = append(linterNames, lc.Linter.Name())
+			linterNames = append(linterNames, lc.Name())
 		}
 		fmt.Fprintf(logutils.StdOut, "%s: %s\n", color.YellowString(p), strings.Join(linterNames, ", "))
 	}

pkg/commands/linters.go

@@ -20,8 +20,8 @@ func (e *Executor) initLinters() {
 }
 
 func IsLinterInConfigsList(name string, linters []linter.Config) bool {
-	for _, linter := range linters {
-		if linter.Linter.Name() == name {
+	for _, lc := range linters {
+		if lc.Name() == name {
 			return true
 		}
 	}
@@ -40,7 +40,7 @@ func (e *Executor) executeLinters(cmd *cobra.Command, args []string) {
 
 	var disabledLCs []linter.Config
 	for _, lc := range e.DBManager.GetAllSupportedLinterConfigs() {
-		if !IsLinterInConfigsList(lc.Linter.Name(), enabledLCs) {
+		if !IsLinterInConfigsList(lc.Name(), enabledLCs) {
 			disabledLCs = append(disabledLCs, lc)
 		}
 	}

pkg/commands/run.go

@@ -238,23 +238,23 @@ func fixSlicesFlags(fs *pflag.FlagSet) {
 func (e *Executor) runAnalysis(ctx context.Context, args []string) (<-chan result.Issue, error) {
 	e.cfg.Run.Args = args
 
-	linters, err := e.EnabledLintersSet.Get()
+	enabledLinters, err := e.EnabledLintersSet.Get()
 	if err != nil {
 		return nil, err
 	}
 
 	for _, lc := range e.DBManager.GetAllSupportedLinterConfigs() {
 		isEnabled := false
-		for _, linter := range linters {
-			if linter.Linter.Name() == lc.Linter.Name() {
+		for _, enabledLC := range enabledLinters {
+			if enabledLC.Name() == lc.Name() {
 				isEnabled = true
 				break
 			}
 		}
-		e.reportData.AddLinter(lc.Linter.Name(), isEnabled, lc.EnabledByDefault)
+		e.reportData.AddLinter(lc.Name(), isEnabled, lc.EnabledByDefault)
 	}
 
-	lintCtx, err := lint.LoadContext(linters, e.cfg, e.log.Child("load"))
+	lintCtx, err := lint.LoadContext(enabledLinters, e.cfg, e.log.Child("load"))
 	if err != nil {
 		return nil, errors.Wrap(err, "context loading failed")
 	}
@@ -264,7 +264,7 @@ func (e *Executor) runAnalysis(ctx context.Context, args []string) (<-chan resul
 		return nil, err
 	}
 
-	return runner.Run(ctx, linters, lintCtx), nil
+	return runner.Run(ctx, enabledLinters, lintCtx), nil
 }
 
 func (e *Executor) setOutputToDevNull() (savedStdout, savedStderr *os.File) {

pkg/config/config.go

@@ -44,31 +44,6 @@ var DefaultExcludePatterns = []ExcludePattern{
 		Linter:  "golint",
 		Why:     "False positive when tests are defined in package 'test'",
 	},
-	{
-		Pattern: "Use of unsafe calls should be audited",
-		Linter:  "gas",
-		Why:     "Too many false-positives on 'unsafe' usage",
-	},
-	{
-		Pattern: "Subprocess launch(ed with variable|ing should be audited)",
-		Linter:  "gas",
-		Why:     "Too many false-positives for parametrized shell calls",
-	},
-	{
-		Pattern: "G104",
-		Linter:  "gas",
-		Why:     "Duplicated errcheck checks",
-	},
-	{
-		Pattern: "(Expect directory permissions to be 0750 or less|Expect file permissions to be 0600 or less)",
-		Linter:  "gas",
-		Why:     "Too many issues in popular repos",
-	},
-	{
-		Pattern: "Potential file inclusion via variable",
-		Linter:  "gas",
-		Why:     "False positive is triggered by 'src, err := ioutil.ReadFile(filename)'",
-	},
 	{
 		Pattern: "(possible misuse of unsafe.Pointer|should have signature)",
 		Linter:  "govet",

pkg/golinters/gas.go

@@ -14,17 +14,17 @@ import (
 	"github.com/golangci/golangci-lint/pkg/result"
 )
 
-type Gas struct{}
+type Gosec struct{}
 
-func (Gas) Name() string {
-	return "gas"
+func (Gosec) Name() string {
+	return "gosec"
 }
 
-func (Gas) Desc() string {
+func (Gosec) Desc() string {
 	return "Inspects source code for security problems"
 }
 
-func (lint Gas) Run(ctx context.Context, lintCtx *linter.Context) ([]result.Issue, error) {
+func (lint Gosec) Run(ctx context.Context, lintCtx *linter.Context) ([]result.Issue, error) {
 	gasConfig := gas.NewConfig()
 	enabledRules := rules.Generate()
 	logger := log.New(ioutil.Discard, "", 0)
@@ -45,7 +45,7 @@ func (lint Gas) Run(ctx context.Context, lintCtx *linter.Context) ([]result.Issu
 		if err != nil {
 			r = &result.Range{}
 			if n, rerr := fmt.Sscanf(i.Line, "%d-%d", &r.From, &r.To); rerr != nil || n != 2 {
-				lintCtx.Log.Warnf("Can't convert gas line number %q of %v to int: %s", i.Line, i, err)
+				lintCtx.Log.Warnf("Can't convert gosec line number %q of %v to int: %s", i.Line, i, err)
 				continue
 			}
 			line = r.From

pkg/golinters/utils.go

@@ -56,7 +56,7 @@ var replacePatterns = []replacePattern{
 	{`^(\S+) arg list ends with redundant newline$`, "`${1}` arg list ends with redundant newline"},
 	{`^(\S+) composite literal uses unkeyed fields$`, "`${1}` composite literal uses unkeyed fields"},
 
-	// gas
+	// gosec
 	{`^Blacklisted import (\S+): weak cryptographic primitive$`,
 		"Blacklisted import `${1}`: weak cryptographic primitive"},
 	{`^TLS InsecureSkipVerify set true.$`, "TLS `InsecureSkipVerify` set true."},

pkg/lint/linter/config.go

@@ -16,6 +16,7 @@ type Config struct {
 	NeedsSSARepr     bool
 	InPresets        []string
 	Speed            int // more value means faster execution of linter
+	AlternativeNames []string
 
 	OriginalURL string // URL of original (not forked) repo, needed for autogenerated README
 }
@@ -46,6 +47,11 @@ func (lc Config) WithURL(url string) Config {
 	return lc
 }
 
+func (lc Config) WithAlternativeNames(names ...string) Config {
+	lc.AlternativeNames = names
+	return lc
+}
+
 func (lc Config) NeedsProgramLoading() bool {
 	return lc.DoesFullImport
 }
@@ -58,6 +64,14 @@ func (lc Config) GetSpeed() int {
 	return lc.Speed
 }
 
+func (lc Config) AllNames() []string {
+	return append([]string{lc.Name()}, lc.AlternativeNames...)
+}
+
+func (lc Config) Name() string {
+	return lc.Linter.Name()
+}
+
 func NewConfig(linter Linter) *Config {
 	return &Config{
 		Linter: linter,

pkg/lint/lintersdb/enabled_set.go

@@ -43,7 +43,7 @@ func (es EnabledSet) build(lcfg *config.Linters, enabledByDefaultLinters []linte
 	for _, p := range lcfg.Presets {
 		for _, lc := range es.m.GetAllLinterConfigsForPreset(p) {
 			lc := lc
-			resultLintersSet[lc.Linter.Name()] = &lc
+			resultLintersSet[lc.Name()] = &lc
 		}
 	}
 
@@ -52,14 +52,16 @@ func (es EnabledSet) build(lcfg *config.Linters, enabledByDefaultLinters []linte
 	// It should be before --enable and --disable to be able to enable or disable specific linter.
 	if lcfg.Fast {
 		for name := range resultLintersSet {
-			if es.m.getLinterConfig(name).DoesFullImport {
+			if es.m.GetLinterConfig(name).DoesFullImport {
 				delete(resultLintersSet, name)
 			}
 		}
 	}
 
 	for _, name := range lcfg.Enable {
-		resultLintersSet[name] = es.m.getLinterConfig(name)
+		lc := es.m.GetLinterConfig(name)
+		// it's important to use lc.Name() nor name because name can be alias
+		resultLintersSet[lc.Name()] = lc
 	}
 
 	for _, name := range lcfg.Disable {
@@ -68,7 +70,10 @@ func (es EnabledSet) build(lcfg *config.Linters, enabledByDefaultLinters []linte
 				delete(resultLintersSet, ln)
 			}
 		}
-		delete(resultLintersSet, name)
+
+		lc := es.m.GetLinterConfig(name)
+		// it's important to use lc.Name() nor name because name can be alias
+		delete(resultLintersSet, lc.Name())
 	}
 
 	es.optimizeLintersSet(resultLintersSet)
@@ -111,7 +116,7 @@ func (es EnabledSet) optimizeLintersSet(linters map[string]*linter.Config) {
 		delete(linters, n)
 	}
 
-	lc := *es.m.getLinterConfig("megacheck")
+	lc := *es.m.GetLinterConfig("megacheck")
 	lc.Linter = mega
 	linters[mega.Name()] = &lc
 }
@@ -135,7 +140,7 @@ func (es EnabledSet) Get() ([]linter.Config, error) {
 func (es EnabledSet) verbosePrintLintersStatus(lcs []linter.Config) {
 	var linterNames []string
 	for _, lc := range lcs {
-		linterNames = append(linterNames, lc.Linter.Name())
+		linterNames = append(linterNames, lc.Name())
 	}
 	sort.StringSlice(linterNames).Sort()
 	es.log.Infof("Active %d linters: %s", len(linterNames), linterNames)

pkg/lint/lintersdb/enabled_set_test.go

@@ -42,6 +42,41 @@ func TestGetEnabledLintersSet(t *testing.T) {
 			def:  []string{"gofmt", "govet"},
 			exp:  []string{"gofmt", "govet"},
 		},
+		{
+			name: "enable gosec by gas alias",
+			cfg: config.Linters{
+				Enable: []string{"gas"},
+			},
+			exp: []string{"gosec"},
+		},
+		{
+			name: "enable gosec by primary name",
+			cfg: config.Linters{
+				Enable: []string{"gosec"},
+			},
+			exp: []string{"gosec"},
+		},
+		{
+			name: "enable gosec by both names",
+			cfg: config.Linters{
+				Enable: []string{"gosec", "gas"},
+			},
+			exp: []string{"gosec"},
+		},
+		{
+			name: "disable gosec by gas alias",
+			cfg: config.Linters{
+				Disable: []string{"gas"},
+			},
+			def: []string{"gosec"},
+		},
+		{
+			name: "disable gosec by primary name",
+			cfg: config.Linters{
+				Disable: []string{"gosec"},
+			},
+			def: []string{"gosec"},
+		},
 	}
 
 	m := NewManager()
@@ -50,12 +85,12 @@ func TestGetEnabledLintersSet(t *testing.T) {
 		t.Run(c.name, func(t *testing.T) {
 			defaultLinters := []linter.Config{}
 			for _, ln := range c.def {
-				defaultLinters = append(defaultLinters, *m.getLinterConfig(ln))
+				defaultLinters = append(defaultLinters, *m.GetLinterConfig(ln))
 			}
 			els := es.build(&c.cfg, defaultLinters)
 			var enabledLinters []string
 			for ln, lc := range els {
-				assert.Equal(t, ln, lc.Linter.Name())
+				assert.Equal(t, ln, lc.Name())
 				enabledLinters = append(enabledLinters, ln)
 			}
 

pkg/lint/lintersdb/manager.go

@@ -15,7 +15,9 @@ func NewManager() *Manager {
 	m := &Manager{}
 	nameToLC := make(map[string]linter.Config)
 	for _, lc := range m.GetAllSupportedLinterConfigs() {
-		nameToLC[lc.Linter.Name()] = lc
+		for _, name := range lc.AllNames() {
+			nameToLC[name] = lc
+		}
 	}
 
 	m.nameToLC = nameToLC
@@ -35,7 +37,7 @@ func (m Manager) allPresetsSet() map[string]bool {
 	return ret
 }
 
-func (m Manager) getLinterConfig(name string) *linter.Config {
+func (m Manager) GetLinterConfig(name string) *linter.Config {
 	lc, ok := m.nameToLC[name]
 	if !ok {
 		return nil
@@ -87,11 +89,12 @@ func (Manager) GetAllSupportedLinterConfigs() []linter.Config {
 			WithSpeed(5).
 			WithURL("https://github.com/dominikh/go-tools/tree/master/cmd/gosimple"),
 
-		linter.NewConfig(golinters.Gas{}).
+		linter.NewConfig(golinters.Gosec{}).
 			WithFullImport().
 			WithPresets(linter.PresetBugs).
 			WithSpeed(8).
-			WithURL("https://github.com/GoASTScanner/gas"),
+			WithURL("https://github.com/securego/gosec").
+			WithAlternativeNames("gas"),
 		linter.NewConfig(golinters.Structcheck{}).
 			WithFullImport().
 			WithPresets(linter.PresetUnused).
@@ -202,7 +205,7 @@ func (Manager) GetAllSupportedLinterConfigs() []linter.Config {
 		golinters.TypeCheck{}.Name(): isLocalRun,
 	}
 	return enableLinterConfigs(lcs, func(lc *linter.Config) bool {
-		return enabled[lc.Linter.Name()]
+		return enabled[lc.Name()]
 	})
 }
 
@@ -221,7 +224,7 @@ func linterConfigsToMap(lcs []linter.Config) map[string]*linter.Config {
 	ret := map[string]*linter.Config{}
 	for _, lc := range lcs {
 		lc := lc // local copy
-		ret[lc.Linter.Name()] = &lc
+		ret[lc.Name()] = &lc
 	}
 
 	return ret