feat: add rowserr linter

stevenh · stevenh · commit de1a0709c364 · 2022-11-06T22:37:27.000Z
Add rowserr a linter which checks for missing sql Rows.Err() calls
that supports generics.
diff --git a/.golangci.reference.yml b/.golangci.reference.yml
@@ -1632,6 +1632,14 @@ linters-settings:
         severity: warning
         disabled: false
 
+  rowserr:
+    # packages sets additional packages to check.
+    # The following know sql packages are always checked:
+    # - database/sql
+    # - github.com/jmoiron/sqlx
+    # Default: []
+    packages: []
+
   rowserrcheck:
     # database/sql is always checked
     # Default: []
@@ -2035,6 +2043,7 @@ linters:
     - promlinter
     - reassign
     - revive
+    - rowserr
     - rowserrcheck
     - scopelint
     - sqlclosecheck
@@ -2142,6 +2151,7 @@ linters:
     - promlinter
     - reassign
     - revive
+    - rowserr
     - rowserrcheck
     - scopelint
     - sqlclosecheck
diff --git a/go.mod b/go.mod
@@ -186,3 +186,5 @@ require (
 	gopkg.in/yaml.v2 v2.4.0 // indirect
 	mvdan.cc/lint v0.0.0-20170908181259-adc824a0674b // indirect
 )
+
+require github.com/stevenh/go-rowserr v0.2.0
diff --git a/go.sum b/go.sum
diff --git a/pkg/config/linters_settings.go b/pkg/config/linters_settings.go
@@ -190,6 +190,7 @@ type LintersSettings struct {
 	Promlinter       PromlinterSettings
 	Reassign         ReassignSettings
 	Revive           ReviveSettings
+	RowsErr          RowsErrSettings
 	RowsErrCheck     RowsErrCheckSettings
 	Staticcheck      StaticCheckSettings
 	Structcheck      StructCheckSettings
@@ -599,6 +600,9 @@ type ReviveSettings struct {
 		Severity string
 	}
 }
+type RowsErrSettings struct {
+	Packages []string
+}
 
 type RowsErrCheckSettings struct {
 	Packages []string
diff --git a/pkg/golinters/rowserr.go b/pkg/golinters/rowserr.go
@@ -0,0 +1,19 @@
+package golinters
+
+import (
+	"github.com/stevenh/go-rowserr/pkg/rowserr"
+	"golang.org/x/tools/go/analysis"
+
+	"github.com/golangci/golangci-lint/pkg/config"
+	"github.com/golangci/golangci-lint/pkg/golinters/goanalysis"
+)
+
+func NewRowsErr(settings *config.RowsErrSettings) *goanalysis.Linter {
+	a := rowserr.NewAnalyzer(settings.Packages...)
+	return goanalysis.NewLinter(
+		a.Name,
+		a.Doc,
+		[]*analysis.Analyzer{a},
+		nil,
+	).WithLoadMode(goanalysis.LoadModeTypesInfo)
+}
diff --git a/pkg/lint/lintersdb/manager.go b/pkg/lint/lintersdb/manager.go
@@ -158,6 +158,7 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 		promlinterCfg       *config.PromlinterSettings
 		reassignCfg         *config.ReassignSettings
 		reviveCfg           *config.ReviveSettings
+		rowserrCfg          *config.RowsErrSettings
 		rowserrcheckCfg     *config.RowsErrCheckSettings
 		staticcheckCfg      *config.StaticCheckSettings
 		structcheckCfg      *config.StructCheckSettings
@@ -234,6 +235,7 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 		promlinterCfg = &m.cfg.LintersSettings.Promlinter
 		reassignCfg = &m.cfg.LintersSettings.Reassign
 		reviveCfg = &m.cfg.LintersSettings.Revive
+		rowserrCfg = &m.cfg.LintersSettings.RowsErr
 		rowserrcheckCfg = &m.cfg.LintersSettings.RowsErrCheck
 		staticcheckCfg = &m.cfg.LintersSettings.Staticcheck
 		structcheckCfg = &m.cfg.LintersSettings.Structcheck
@@ -707,6 +709,12 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 			ConsiderSlow().
 			WithURL("https://github.com/mgechev/revive"),
 
+		linter.NewConfig(golinters.NewRowsErr(rowserrCfg)).
+			WithSince("v1.51.0").
+			WithLoadForGoAnalysis().
+			WithPresets(linter.PresetBugs, linter.PresetSQL).
+			WithURL("https://github.com/stevenh/go-rowserr"),
+
 		linter.NewConfig(golinters.NewRowsErrCheck(rowserrcheckCfg)).
 			WithSince("v1.23.0").
 			WithLoadForGoAnalysis().
diff --git a/test/testdata/rowserr/rowserr.go b/test/testdata/rowserr/rowserr.go
@@ -0,0 +1,17 @@
+//golangcitest:args -Erowserr
+package testdata
+
+import (
+	"database/sql"
+)
+
+func RowsErrNotChecked(db *sql.DB) {
+	rows, err := db.Query("select id from tb") // want "rows.Err\\(\\) must be checked"
+	if err != nil {
+		// Handle error.
+	}
+
+	for rows.Next() {
+		// Handle row.
+	}
+}

Original file line number	Diff line number	Diff line change
`@@ -186,3 +186,5 @@ require (`
`186`	`186`	`gopkg.in/yaml.v2 v2.4.0 // indirect`
`187`	`187`	`mvdan.cc/lint v0.0.0-20170908181259-adc824a0674b // indirect`
`188`	`188`	`)`
	`189`	`+`
	`190`	`+require github.com/stevenh/go-rowserr v0.2.0`