dev: group linter implementation and integration tests (#4603)

Author: ldez

.gitignore

@@ -3,6 +3,7 @@
 /*.pdf
 /*.pprof
 /*.txt
+/test.lock
 /.idea/
 /.vscode/
 /dist/

.golangci.yml

@@ -163,27 +163,27 @@ issues:
       text: "SA1019: c.cfg.Run.ShowStats is deprecated: use Output.ShowStats instead."
 
     # Deprecated linter options.
-    - path: pkg/golinters/errcheck.go
+    - path: pkg/golinters/errcheck/errcheck.go
       linters: [staticcheck]
       text: "SA1019: errCfg.Exclude is deprecated: use ExcludeFunctions instead"
-    - path: pkg/golinters/govet.go
+    - path: pkg/golinters/govet/govet.go
       linters: [staticcheck]
       text: "SA1019: cfg.CheckShadowing is deprecated: the linter should be enabled inside Enable."
-    - path: pkg/golinters/godot.go
+    - path: pkg/golinters/godot/godot.go
       linters: [staticcheck]
       text: "SA1019: settings.CheckAll is deprecated: use Scope instead"
-    - path: pkg/golinters/gci.go
+    - path: pkg/golinters/gci/gci.go
       linters: [staticcheck]
       text: "SA1019: settings.LocalPrefixes is deprecated: use Sections instead."
-    - path: pkg/golinters/mnd.go
+    - path: pkg/golinters/mnd/mnd.go
       linters: [staticcheck]
       text: "SA1019: settings.Settings is deprecated: use root level settings instead."
-    - path: pkg/golinters/mnd.go
+    - path: pkg/golinters/mnd/mnd.go
       linters: [staticcheck]
       text: "SA1019: config.GoMndSettings is deprecated: use MndSettings."
 
     # Related to `run.go`, it cannot be removed.
-    - path: pkg/golinters/gofumpt.go
+    - path: pkg/golinters/gofumpt/gofumpt.go
       linters: [staticcheck]
       text: "SA1019: settings.LangVersion is deprecated: use the global `run.go` instead."
     - path: pkg/golinters/internal/staticcheck_common.go
@@ -194,7 +194,7 @@ issues:
       text: "SA1019: (.+).(GoVersion|LangVersion) is deprecated: use the global `run.go` instead."
 
     # Based on existing code, the modifications should be limited to make maintenance easier.
-    - path: pkg/golinters/unused.go
+    - path: pkg/golinters/unused/unused.go
       linters: [gocritic]
       text: "rangeValCopy: each iteration copies 160 bytes \\(consider pointers or indexing\\)"
 

Makefile

@@ -33,23 +33,21 @@ test: build
 	GL_TEST_RUN=1 go test -v -parallel 2 ./...
 .PHONY: test
 
-# ex: T=gofmt.go make test_fix
-# the value of `T` is the name of a file from `test/testdata/fix`
-test_fix: build
-	GL_TEST_RUN=1 go test -v ./test -count 1 -run TestFix/$T
-.PHONY: test_fix
-
 test_race: build_race
 	GL_TEST_RUN=1 ./$(BINARY) run -v --timeout=5m
 .PHONY: test_race
 
-test_linters:
+# ex: T=output.go make test_integration
+# the value of `T` is the name of a file from `test/testdata`
+test_integration:
 	GL_TEST_RUN=1 go test -v ./test -count 1 -run TestSourcesFromTestdata/$T
-.PHONY: test_linters
+.PHONY: test_integration
 
-test_linters_sub:
-	GL_TEST_RUN=1 go test -v ./test -count 1 -run TestSourcesFromTestdataSubDir/$T
-.PHONY: test_linters_sub
+# ex: T=multiple-issues-fix.go make test_integration_fix
+# the value of `T` is the name of a file from `test/testdata/fix`
+test_integration_fix: build
+	GL_TEST_RUN=1 go test -v ./test -count 1 -run TestFix/$T
+.PHONY: test_integration_fix
 
 # Maintenance
 

docs/src/docs/contributing/new-linters.mdx

@@ -15,19 +15,16 @@ We don't accept non `go/analysis` linters.
 After that:
 
 1. Implement functional tests for the linter:
-    - Add one file into directory [`test/testdata`](https://github.com/golangci/golangci-lint/tree/master/test/testdata).
-    - Run the test to ensure that test fails:
-      ```bash
-      T=yourlintername.go make test_linters
-      ```
+    - Add one file into directory `pkg/golinters/{yourlintername}/testdata/`.
+    - Run the test to ensure that test fails.
     - Run:
       ```bash
-      go run ./cmd/golangci-lint/ run --no-config --disable-all --enable=yourlintername ./test/testdata/yourlintername.go
+      go run ./cmd/golangci-lint/ run --no-config --disable-all --enable={yourlintername} ./pkg/golinters/{yourlintername}/testdata/{yourlintername}.go
       ```
-2. Add a new file `pkg/golinters/{yourlintername}.go`.
+2. Add a new file `pkg/golinters/{yourlintername}/{yourlintername}.go`.
    Look at other linters in this directory.
    Implement linter integration and check that test passes.
-3. Add the new struct for the linter (which you've implemented in `pkg/golinters/{yourlintername}.go`) to the
+3. Add the new struct for the linter (which you've implemented in `pkg/golinters/{yourlintername}/{yourlintername}.go`) to the
    list of all supported linters in [`pkg/lint/lintersdb/builder_linter.go`](https://github.com/golangci/golangci-lint/blob/master/pkg/lint/lintersdb/builder_linter.go)
    to the method `LinterBuilder.Build`.
     - Add `WithSince("next_version")`, where `next_version` must be replaced by the next minor version. (ex: v1.2.0 if the current version is v1.1.0)

pkg/golinters/asasalint.go pkg/golinters/asasalint/asasalint.go

@@ -1,4 +1,4 @@
-package golinters
+package asasalint
 
 import (
 	"github.com/alingse/asasalint"
@@ -9,7 +9,7 @@ import (
 	"github.com/golangci/golangci-lint/pkg/golinters/internal"
 )
 
-func NewAsasalint(setting *config.AsasalintSettings) *goanalysis.Linter {
+func New(setting *config.AsasalintSettings) *goanalysis.Linter {
 	cfg := asasalint.LinterSetting{}
 	if setting != nil {
 		cfg.Exclude = setting.Exclude

pkg/golinters/asasalint/asasalint_integration_test.go

@@ -0,0 +1,11 @@
+package asasalint
+
+import (
+	"testing"
+
+	"github.com/golangci/golangci-lint/test/testshared/integration"
+)
+
+func TestFromTestdata(t *testing.T) {
+	integration.RunTestdata(t)
+}

test/testdata/asasalint.go pkg/golinters/asasalint/testdata/asasalint.go

@@ -1,4 +1,4 @@
-package golinters
+package asciicheck
 
 import (
 	"github.com/tdakkota/asciicheck"
@@ -7,7 +7,7 @@ import (
 	"github.com/golangci/golangci-lint/pkg/goanalysis"
 )
 
-func NewAsciicheck() *goanalysis.Linter {
+func New() *goanalysis.Linter {
 	a := asciicheck.NewAnalyzer()
 
 	return goanalysis.NewLinter(

pkg/golinters/asciicheck.go pkg/golinters/asciicheck/asciicheck.go

@@ -0,0 +1,11 @@
+package asciicheck
+
+import (
+	"testing"
+
+	"github.com/golangci/golangci-lint/test/testshared/integration"
+)
+
+func TestFromTestdata(t *testing.T) {
+	integration.RunTestdata(t)
+}

pkg/golinters/asciicheck/asciicheck_integration_test.go

@@ -1,4 +1,4 @@
-package golinters
+package bidichk
 
 import (
 	"strings"
@@ -10,7 +10,7 @@ import (
 	"github.com/golangci/golangci-lint/pkg/goanalysis"
 )
 
-func NewBiDiChk(cfg *config.BiDiChkSettings) *goanalysis.Linter {
+func New(cfg *config.BiDiChkSettings) *goanalysis.Linter {
 	a := bidichk.NewAnalyzer()
 
 	cfgMap := map[string]map[string]any{}

test/testdata/asciicheck.go pkg/golinters/asciicheck/testdata/asciicheck.go

@@ -0,0 +1,11 @@
+package bidichk
+
+import (
+	"testing"
+
+	"github.com/golangci/golangci-lint/test/testshared/integration"
+)
+
+func TestFromTestdata(t *testing.T) {
+	integration.RunTestdata(t)
+}

pkg/golinters/bidichk.go pkg/golinters/bidichk/bidichk.go

@@ -1,4 +1,4 @@
-package golinters
+package bodyclose
 
 import (
 	"github.com/timakin/bodyclose/passes/bodyclose"
@@ -7,7 +7,7 @@ import (
 	"github.com/golangci/golangci-lint/pkg/goanalysis"
 )
 
-func NewBodyclose() *goanalysis.Linter {
+func New() *goanalysis.Linter {
 	a := bodyclose.Analyzer
 
 	return goanalysis.NewLinter(

pkg/golinters/bidichk/bidichk_integration_test.go

@@ -0,0 +1,11 @@
+package bodyclose
+
+import (
+	"testing"
+
+	"github.com/golangci/golangci-lint/test/testshared/integration"
+)
+
+func TestFromTestdata(t *testing.T) {
+	integration.RunTestdata(t)
+}

test/testdata/bidichk.go pkg/golinters/bidichk/testdata/bidichk.go

@@ -1,4 +1,4 @@
-package golinters
+package containedctx
 
 import (
 	"github.com/sivchari/containedctx"
@@ -7,7 +7,7 @@ import (
 	"github.com/golangci/golangci-lint/pkg/goanalysis"
 )
 
-func NewContainedCtx() *goanalysis.Linter {
+func New() *goanalysis.Linter {
 	a := containedctx.Analyzer
 
 	return goanalysis.NewLinter(

pkg/golinters/bodyclose.go pkg/golinters/bodyclose/bodyclose.go

@@ -0,0 +1,11 @@
+package containedctx
+
+import (
+	"testing"
+
+	"github.com/golangci/golangci-lint/test/testshared/integration"
+)
+
+func TestFromTestdata(t *testing.T) {
+	integration.RunTestdata(t)
+}

pkg/golinters/bodyclose/bodyclose_integration_test.go

@@ -1,4 +1,4 @@
-package golinters
+package contextcheck
 
 import (
 	"github.com/kkHAIKE/contextcheck"
@@ -8,7 +8,7 @@ import (
 	"github.com/golangci/golangci-lint/pkg/lint/linter"
 )
 
-func NewContextCheck() *goanalysis.Linter {
+func New() *goanalysis.Linter {
 	analyzer := contextcheck.NewAnalyzer(contextcheck.Configuration{})
 
 	return goanalysis.NewLinter(

test/testdata/bodyclose.go pkg/golinters/bodyclose/testdata/bodyclose.go

@@ -0,0 +1,11 @@
+package contextcheck
+
+import (
+	"testing"
+
+	"github.com/golangci/golangci-lint/test/testshared/integration"
+)
+
+func TestFromTestdata(t *testing.T) {
+	integration.RunTestdata(t)
+}

pkg/golinters/containedctx.go pkg/golinters/containedctx/containedctx.go

@@ -1,4 +1,4 @@
-package golinters
+package copyloopvar
 
 import (
 	"github.com/karamaru-alpha/copyloopvar"
@@ -8,7 +8,7 @@ import (
 	"github.com/golangci/golangci-lint/pkg/goanalysis"
 )
 
-func NewCopyLoopVar(settings *config.CopyLoopVarSettings) *goanalysis.Linter {
+func New(settings *config.CopyLoopVarSettings) *goanalysis.Linter {
 	a := copyloopvar.NewAnalyzer()
 
 	var cfg map[string]map[string]any

pkg/golinters/containedctx/containedctx_integration_test.go

@@ -0,0 +1,11 @@
+package copyloopvar
+
+import (
+	"testing"
+
+	"github.com/golangci/golangci-lint/test/testshared/integration"
+)
+
+func TestFromTestdata(t *testing.T) {
+	integration.RunTestdata(t)
+}

test/testdata/containedctx.go pkg/golinters/containedctx/testdata/containedctx.go

@@ -1,7 +1,7 @@
 //go:build go1.22
 
 //golangcitest:args -Ecopyloopvar
-//golangcitest:config_path testdata/configs/copyloopvar.yml
+//golangcitest:config_path testdata/copyloopvar.yml
 package testdata
 
 import "fmt"

pkg/golinters/contextcheck.go pkg/golinters/contextcheck/contextcheck.go

@@ -1,4 +1,4 @@
-package golinters
+package cyclop
 
 import (
 	"github.com/bkielbasa/cyclop/pkg/analyzer"
@@ -8,7 +8,7 @@ import (
 	"github.com/golangci/golangci-lint/pkg/goanalysis"
 )
 
-func NewCyclop(settings *config.Cyclop) *goanalysis.Linter {
+func New(settings *config.Cyclop) *goanalysis.Linter {
 	a := analyzer.NewAnalyzer()
 
 	var cfg map[string]map[string]any

pkg/golinters/contextcheck/contextcheck_integration_test.go

@@ -0,0 +1,11 @@
+package cyclop
+
+import (
+	"testing"
+
+	"github.com/golangci/golangci-lint/test/testshared/integration"
+)
+
+func TestFromTestdata(t *testing.T) {
+	integration.RunTestdata(t)
+}

test/testdata/contextcheck.go pkg/golinters/contextcheck/testdata/contextcheck.go

@@ -1,5 +1,5 @@
 //golangcitest:args -Ecyclop
-//golangcitest:config_path testdata/configs/cyclop.yml
+//golangcitest:config_path testdata/cyclop.yml
 package testdata
 
 func cyclopComplexFunc(s string) { // want "calculated cyclomatic complexity for function cyclopComplexFunc is 22, max is 15"

pkg/golinters/copyloopvar.go pkg/golinters/copyloopvar/copyloopvar.go

@@ -1,4 +1,4 @@
-package golinters
+package decorder
 
 import (
 	"strings"
@@ -10,7 +10,7 @@ import (
 	"github.com/golangci/golangci-lint/pkg/goanalysis"
 )
 
-func NewDecorder(settings *config.DecorderSettings) *goanalysis.Linter {
+func New(settings *config.DecorderSettings) *goanalysis.Linter {
 	a := decorder.Analyzer
 
 	// disable all rules/checks by default

pkg/golinters/copyloopvar/copyloopvar_integration_test.go

@@ -0,0 +1,11 @@
+package decorder
+
+import (
+	"testing"
+
+	"github.com/golangci/golangci-lint/test/testshared/integration"
+)
+
+func TestFromTestdata(t *testing.T) {
+	integration.RunTestdata(t)
+}

test/testdata/copyloopvar.go pkg/golinters/copyloopvar/testdata/copyloopvar.go

@@ -1,5 +1,5 @@
 //golangcitest:args -Edecorder
-//golangcitest:config_path testdata/configs/decorder_custom.yml
+//golangcitest:config_path testdata/decorder_custom.yml
 package testdata
 
 import "math"

test/testdata/configs/copyloopvar.yml pkg/golinters/copyloopvar/testdata/copyloopvar.yml

@@ -1,4 +1,4 @@
-package golinters
+package depguard
 
 import (
 	"github.com/OpenPeeDeeP/depguard/v2"
@@ -9,7 +9,7 @@ import (
 	"github.com/golangci/golangci-lint/pkg/lint/linter"
 )
 
-func NewDepguard(settings *config.DepGuardSettings) *goanalysis.Linter {
+func New(settings *config.DepGuardSettings) *goanalysis.Linter {
 	conf := depguard.LinterSettings{}
 
 	if settings != nil {