add tenv linter

Author: sivchari

.golangci.example.yml

@@ -590,6 +590,10 @@ linters-settings:
       name: true
       begin: true
 
+  tenv:
+    # The following configurations enable checks prior to Go 1.17.
+    f: false
+
   unparam:
     # Inspect exported functions, default is false. Set to true if no external program/library imports your code.
     # XXX: if you enable this setting, unparam will report a lot of false-positives in text editors:

go.mod

@@ -67,6 +67,7 @@ require (
 	github.com/shazow/go-diff v0.0.0-20160112020656-b6b7b6733b8c
 	github.com/shirou/gopsutil/v3 v3.21.7
 	github.com/sirupsen/logrus v1.8.1
+	github.com/sivchari/tenv v1.0.2
 	github.com/sonatard/noctx v0.0.1
 	github.com/sourcegraph/go-diff v0.6.1
 	github.com/spf13/cobra v1.2.1

go.sum

@@ -129,6 +129,7 @@ type LintersSettings struct {
 	Tagliatelle      TagliatelleSettings
 	Testpackage      TestpackageSettings
 	Thelper          ThelperSettings
+	Tenv             TenvSettings
 	Unparam          UnparamSettings
 	Unused           StaticCheckSettings
 	Varcheck         VarCheckSettings
@@ -447,6 +448,10 @@ type ThelperSettings struct {
 	} `mapstructure:"tb"`
 }
 
+type TenvSettings struct {
+	Force bool `mapstructure:"f"`
+}
+
 type UnparamSettings struct {
 	CheckExported bool `mapstructure:"check-exported"`
 	Algo          string

pkg/config/linters_settings.go

@@ -0,0 +1,33 @@
+package golinters
+
+import (
+	"github.com/sivchari/tenv"
+	"golang.org/x/tools/go/analysis"
+
+	"github.com/golangci/golangci-lint/pkg/config"
+	"github.com/golangci/golangci-lint/pkg/golinters/goanalysis"
+)
+
+func NewTenv(settings *config.TenvSettings) *goanalysis.Linter {
+	a := tenv.Analyzer
+
+	analyzers := []*analysis.Analyzer{
+		a,
+	}
+
+	var cfg map[string]map[string]interface{}
+	if settings != nil {
+		cfg = map[string]map[string]interface{}{
+			a.Name: {
+				tenv.F: settings.Force,
+			},
+		}
+	}
+
+	return goanalysis.NewLinter(
+		a.Name,
+		"tenv is analyzer that detects using os.Setenv instead of t.Setenv since Go1.17",
+		analyzers,
+		cfg,
+	).WithLoadMode(goanalysis.LoadModeSyntax)
+}

pkg/golinters/tenv.go

@@ -105,6 +105,7 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 	var exhaustiveStructCfg *config.ExhaustiveStructSettings
 	var errorlintCfg *config.ErrorLintSettings
 	var thelperCfg *config.ThelperSettings
+	var tenvCfg *config.TenvSettings
 	var predeclaredCfg *config.PredeclaredSettings
 	var ifshortCfg *config.IfshortSettings
 	var reviveCfg *config.ReviveSettings
@@ -126,6 +127,7 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 		exhaustiveStructCfg = &m.cfg.LintersSettings.ExhaustiveStruct
 		errorlintCfg = &m.cfg.LintersSettings.ErrorLint
 		thelperCfg = &m.cfg.LintersSettings.Thelper
+		tenvCfg = &m.cfg.LintersSettings.Tenv
 		predeclaredCfg = &m.cfg.LintersSettings.Predeclared
 		ifshortCfg = &m.cfg.LintersSettings.Ifshort
 		reviveCfg = &m.cfg.LintersSettings.Revive
@@ -506,6 +508,11 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 			WithLoadForGoAnalysis().
 			WithURL("https://github.com/Antonboom/errname").
 			WithSince("v1.42.0"),
+		linter.NewConfig(golinters.NewTenv(tenvCfg)).
+			WithSince("v1.43.0").
+			WithPresets(linter.PresetPerformance, linter.PresetStyle).
+			WithLoadForGoAnalysis().
+			WithURL("https://github.com/sivchari/tenv"),
 
 		// nolintlint must be last because it looks at the results of all the previous linters for unused nolint directives
 		linter.NewConfig(golinters.NewNoLintLint()).

pkg/lint/lintersdb/manager.go

@@ -0,0 +1,3 @@
+linters-settings:
+  tenv:
+    f: true

test/testdata/configs/tenv.yml

@@ -0,0 +1,25 @@
+// args: -Etenv
+package testdata
+
+import (
+	"os"
+)
+
+var (
+	e = os.Setenv("a", "b") // OK
+)
+
+func setup() {
+	os.Setenv("a", "b")        // OK
+	err := os.Setenv("a", "b") // OK
+	if err != nil {
+		_ = err
+	}
+}
+
+func TestF() {
+	os.Setenv("a", "b")                         // OK
+	if err := os.Setenv("a", "b"); err != nil { // OK
+		_ = err
+	}
+}

test/testdata/tenv_force_test.go

@@ -0,0 +1,26 @@
+// args: -Etenv
+// config_path: testdata/configs/tenv.yml
+package testdata
+
+import (
+	"os"
+)
+
+var (
+	e = os.Setenv("a", "b") // ERROR "variable e is not using t.Setenv"
+)
+
+func setup() {
+	os.Setenv("a", "b")        // ERROR "func setup is not using t.Setenv"
+	err := os.Setenv("a", "b") // ERROR "func setup is not using t.Setenv"
+	if err != nil {
+		_ = err
+	}
+}
+
+func TestF() {
+	os.Setenv("a", "b")                         // ERROR "func TestF is not using t.Setenv"
+	if err := os.Setenv("a", "b"); err != nil { // ERROR "func TestF is not using t.Setenv"
+		_ = err
+	}
+}