Add new linter gomockcontrollerfinish

.golangci.reference.yml

@@ -2345,6 +2345,7 @@ linters:
     - goimports
     - golint
     - gomnd
+    - gomockcontrollerfinish
     - gomoddirectives
     - gomodguard
     - goprintffuncname
@@ -2465,6 +2466,7 @@ linters:
     - goimports
     - golint
     - gomnd
+    - gomockcontrollerfinish
     - gomoddirectives
     - gomodguard
     - goprintffuncname

go.mod

@@ -54,6 +54,7 @@ require (
 	github.com/gostaticanalysis/nilerr v0.1.1
 	github.com/hashicorp/go-multierror v1.1.1
 	github.com/hashicorp/go-version v1.6.0
+	github.com/hendrywiranto/gomockcontrollerfinish v0.1.0
 	github.com/hexops/gotextdiff v1.0.3
 	github.com/jgautheron/goconst v1.6.0
 	github.com/jingyugao/rowserrcheck v1.1.1

pkg/golinters/gomockcontrollerfinish.go

@@ -0,0 +1,21 @@
+package golinters
+
+import (
+	"github.com/hendrywiranto/gomockcontrollerfinish/pkg/analyzer"
+	"golang.org/x/tools/go/analysis"
+
+	"github.com/golangci/golangci-lint/pkg/golinters/goanalysis"
+)
+
+func NewGomockControllerFinish() *goanalysis.Linter {
+	analyzers := []*analysis.Analyzer{
+		analyzer.New(),
+	}
+
+	return goanalysis.NewLinter(
+		"gomockcontrollerfinish",
+		"Checks whether an unnecessary call to .Finish() on gomock.Controller exists",
+		analyzers,
+		nil,
+	).WithLoadMode(goanalysis.LoadModeTypesInfo)
+}

pkg/lint/lintersdb/manager.go

@@ -829,6 +829,12 @@ func (m Manager) GetAllSupportedLinterConfigs() []*linter.Config {
 			WithLoadForGoAnalysis().
 			WithURL("https://github.com/Antonboom/testifylint"),
 
+		linter.NewConfig(golinters.NewGomockControllerFinish()).
+			WithSince("v1.56.0").
+			WithPresets(linter.PresetTest).
+			WithLoadForGoAnalysis().
+			WithURL("https://github.com/hendrywiranto/gomockcontrollerfinish"),
+
 		linter.NewConfig(golinters.NewTestpackage(testpackageCfg)).
 			WithSince("v1.25.0").
 			WithPresets(linter.PresetStyle, linter.PresetTest).

test/linters_test.go

@@ -33,6 +33,7 @@ func TestSourcesFromTestdataSubDir(t *testing.T) {
 		"ginkgolinter",
 		"zerologlint",
 		"protogetter",
+		"gomockcontrollerfinish",
 	}
 
 	for _, dir := range subDirs {

test/testdata/gomockcontrollerfinish/go.mod

@@ -0,0 +1,5 @@
+module gomockcontrollerfinish
+
+go 1.20
+
+require github.com/golang/mock v1.6.0

test/testdata/gomockcontrollerfinish/gomockcontrollerfinish_original_test.go

@@ -0,0 +1,36 @@
+//golangcitest:args -Egomockcontrollerfinish
+package gomockcontrollerfinish
+
+import (
+	"testing"
+
+	"github.com/golang/mock/gomock"
+)
+
+func TestFinishCall(t *testing.T) {
+	ctrl := gomock.NewController(t)
+	ctrl.Finish() // want "calling Finish on gomock.Controller is no longer needed"
+}
+
+func TestFinishCallDefer(t *testing.T) {
+	ctrl := gomock.NewController(t)
+	defer ctrl.Finish() // want "calling Finish on gomock.Controller is no longer needed"
+}
+
+func TestFinishCallWithoutT(t *testing.T) {
+	ctrl := gomock.NewController(nil)
+	ctrl.Finish() // want "calling Finish on gomock.Controller is no longer needed"
+}
+
+func TestFinsihCallInAnotherFunction(t *testing.T) {
+	ctrl := gomock.NewController(t)
+	callFinish(ctrl)
+}
+
+func callFinish(ctrl *gomock.Controller) {
+	ctrl.Finish() // want "calling Finish on gomock.Controller is no longer needed"
+}
+
+func TestNoFinishCall(t *testing.T) {
+	gomock.NewController(t)
+}

test/testdata/gomockcontrollerfinish/gomockcontrollerfinish_renamed_pkg_test.go

@@ -0,0 +1,36 @@
+//golangcitest:args -Egomockcontrollerfinish
+package gomockcontrollerfinish
+
+import (
+	"testing"
+
+	gomockRenamed "github.com/golang/mock/gomock"
+)
+
+func TestRenamedFinishCall(t *testing.T) {
+	ctrl := gomockRenamed.NewController(t)
+	ctrl.Finish() // want "calling Finish on gomock.Controller is no longer needed"
+}
+
+func TestRenamedFinishCallDefer(t *testing.T) {
+	ctrl := gomockRenamed.NewController(t)
+	defer ctrl.Finish() // want "calling Finish on gomock.Controller is no longer needed"
+}
+
+func TestRenamedFinishCallWithoutT(t *testing.T) {
+	ctrl := gomockRenamed.NewController(nil)
+	ctrl.Finish() // want "calling Finish on gomock.Controller is no longer needed"
+}
+
+func TestRenamedFinsihCallInAnotherFunction(t *testing.T) {
+	ctrl := gomockRenamed.NewController(t)
+	callFinish(ctrl)
+}
+
+func callFinish(ctrl *gomockRenamed.Controller) {
+	ctrl.Finish() // want "calling Finish on gomock.Controller is no longer needed"
+}
+
+func TestNoFinishCall(t *testing.T) {
+	gomockRenamed.NewController(t)
+}