dev: replace golangcitest:config by golangcitest:config_path (#3099)

Author: ldez

test/fix_test.go

@@ -7,7 +7,6 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/require"
-	"gopkg.in/yaml.v3"
 
 	"github.com/golangci/golangci-lint/pkg/exitcodes"
 	"github.com/golangci/golangci-lint/test/testshared"
@@ -56,15 +55,12 @@ func TestFix(t *testing.T) {
 
 			args = append(args, rc.args...)
 
-			cfg, err := yaml.Marshal(rc.config)
-			require.NoError(t, err)
-
 			var runResult *testshared.RunResult
 			if rc.configPath != "" {
 				args = append(args, "-c", rc.configPath)
 				runResult = testshared.NewLintRunner(t).RunCommand("run", args...)
 			} else {
-				runResult = testshared.NewLintRunner(t).RunWithYamlConfig(string(cfg), args...)
+				runResult = testshared.NewLintRunner(t).RunWithYamlConfig("", args...)
 			}
 
 			// nolintlint test uses non existing linters (bob, alice)

test/linters_test.go

@@ -14,7 +14,6 @@ import (
 
 	hcversion "github.com/hashicorp/go-version"
 	"github.com/stretchr/testify/require"
-	"gopkg.in/yaml.v3"
 
 	"github.com/golangci/golangci-lint/pkg/exitcodes"
 	"github.com/golangci/golangci-lint/test/testshared"
@@ -82,7 +81,7 @@ func TestGoimportsLocal(t *testing.T) {
 
 	args = append(args, rc.args...)
 
-	cfg, err := yaml.Marshal(rc.config)
+	cfg, err := os.ReadFile(rc.configPath)
 	require.NoError(t, err)
 
 	testshared.NewLintRunner(t).RunWithYamlConfig(string(cfg), args...).
@@ -175,25 +174,6 @@ func TestFileOutput(t *testing.T) {
 	require.Contains(t, string(b), `"Issues":[`)
 }
 
-func saveConfig(t *testing.T, cfg map[string]interface{}) (cfgPath string, finishFunc func()) {
-	f, err := os.CreateTemp("", "golangci_lint_test")
-	require.NoError(t, err)
-
-	cfgPath = f.Name() + ".yml"
-	err = os.Rename(f.Name(), cfgPath)
-	require.NoError(t, err)
-
-	err = yaml.NewEncoder(f).Encode(cfg)
-	require.NoError(t, err)
-
-	return cfgPath, func() {
-		require.NoError(t, f.Close())
-		if os.Getenv("GL_KEEP_TEMP_FILES") != "1" {
-			require.NoError(t, os.Remove(cfgPath))
-		}
-	}
-}
-
 func testOneSource(t *testing.T, sourcePath string) {
 	args := []string{
 		"run",
@@ -210,25 +190,16 @@ func testOneSource(t *testing.T, sourcePath string) {
 		t.Skipf("Skipped: %s", sourcePath)
 	}
 
-	var cfgPath string
-	if rc.config != nil {
-		p, finish := saveConfig(t, rc.config)
-		defer finish()
-		cfgPath = p
-	} else if rc.configPath != "" {
-		cfgPath = rc.configPath
-	}
-
 	for _, addArg := range []string{"", "-Etypecheck"} {
 		caseArgs := append([]string{}, args...)
 		caseArgs = append(caseArgs, rc.args...)
 		if addArg != "" {
 			caseArgs = append(caseArgs, addArg)
 		}
-		if cfgPath == "" {
+		if rc.configPath == "" {
 			caseArgs = append(caseArgs, "--no-config")
 		} else {
-			caseArgs = append(caseArgs, "-c", cfgPath)
+			caseArgs = append(caseArgs, "-c", rc.configPath)
 		}
 
 		caseArgs = append(caseArgs, sourcePath)
@@ -241,41 +212,17 @@ func testOneSource(t *testing.T, sourcePath string) {
 
 type runContext struct {
 	args           []string
-	config         map[string]interface{}
 	configPath     string
 	expectedLinter string
 }
 
-func buildConfigFromShortRepr(t *testing.T, repr string, config map[string]interface{}) {
-	kv := strings.Split(repr, "=")
-	require.Len(t, kv, 2, "repr: %s", repr)
-
-	keyParts := strings.Split(kv[0], ".")
-	require.True(t, len(keyParts) >= 2, len(keyParts))
-
-	lastObj := config
-	for _, k := range keyParts[:len(keyParts)-1] {
-		var v map[string]interface{}
-		if lastObj[k] == nil {
-			v = map[string]interface{}{}
-		} else {
-			v = lastObj[k].(map[string]interface{})
-		}
-
-		lastObj[k] = v
-		lastObj = v
-	}
-
-	lastObj[keyParts[len(keyParts)-1]] = kv[1]
-}
-
 func skipMultilineComment(scanner *bufio.Scanner) {
 	for line := scanner.Text(); !strings.Contains(line, "*/") && scanner.Scan(); {
 		line = scanner.Text()
 	}
 }
 
-//nolint:gocyclo,funlen
+//nolint:gocyclo
 func extractRunContextFromComments(t *testing.T, sourcePath string) *runContext {
 	f, err := os.Open(sourcePath)
 	require.NoError(t, err)
@@ -324,14 +271,6 @@ func extractRunContextFromComments(t *testing.T, sourcePath string) *runContext
 			rc.args = strings.Split(after, " ")
 			continue
 
-		case "//golangcitest:config":
-			require.NotEmpty(t, after)
-			if rc.config == nil {
-				rc.config = map[string]interface{}{}
-			}
-			buildConfigFromShortRepr(t, after, rc.config)
-			continue
-
 		case "//golangcitest:config_path":
 			require.NotEmpty(t, after)
 			rc.configPath = after
@@ -394,10 +333,7 @@ func TestTparallel(t *testing.T) {
 
 		args = append(args, rc.args...)
 
-		cfg, err := yaml.Marshal(rc.config)
-		require.NoError(t, err)
-
-		testshared.NewLintRunner(t).RunWithYamlConfig(string(cfg), args...).
+		testshared.NewLintRunner(t).RunWithYamlConfig("", args...).
 			ExpectHasIssue(
 				"testdata/tparallel/missing_toplevel_test.go:7:6: TestTopLevel should call t.Parallel on the top level as well as its subtests\n",
 			)
@@ -416,10 +352,7 @@ func TestTparallel(t *testing.T) {
 
 		args = append(args, rc.args...)
 
-		cfg, err := yaml.Marshal(rc.config)
-		require.NoError(t, err)
-
-		testshared.NewLintRunner(t).RunWithYamlConfig(string(cfg), args...).
+		testshared.NewLintRunner(t).RunWithYamlConfig("", args...).
 			ExpectHasIssue(
 				"testdata/tparallel/missing_subtest_test.go:7:6: TestSubtests's subtests should call t.Parallel\n",
 			)
@@ -438,9 +371,6 @@ func TestTparallel(t *testing.T) {
 
 		args = append(args, rc.args...)
 
-		cfg, err := yaml.Marshal(rc.config)
-		require.NoError(t, err)
-
-		testshared.NewLintRunner(t).RunWithYamlConfig(string(cfg), args...).ExpectNoIssues()
+		testshared.NewLintRunner(t).RunWithYamlConfig("", args...).ExpectNoIssues()
 	})
 }

test/testdata/configs/cyclop.yml

@@ -0,0 +1,3 @@
+linters-settings:
+  cyclop:
+    max-complexity: 15

test/testdata/configs/dupl.yml

@@ -0,0 +1,3 @@
+linters-settings:
+  dupl:
+    threshold: 20

test/testdata/configs/errcheck_exclude.yml

@@ -0,0 +1,4 @@
+linters-settings:
+  errcheck:
+    check-blank: true
+    exclude: testdata/errcheck/exclude.txt

test/testdata/configs/errcheck_ignore_default.yml

@@ -0,0 +1,3 @@
+linters-settings:
+  errcheck:
+    check-blank: true

test/testdata/configs/errcheck_type_assertions.yml

@@ -0,0 +1,3 @@
+linters-settings:
+  errcheck:
+    check-type-assertions: true

test/testdata/configs/forbidigo_include_godoc_examples.yml

@@ -0,0 +1,4 @@
+linters-settings:
+  forbidigo:
+   exclude-godoc-examples: false
+

test/testdata/configs/funlen.yml

@@ -0,0 +1,4 @@
+linters-settings:
+  funlen:
+    lines: 20
+    statements: 10

test/testdata/configs/gocognit.yml

@@ -0,0 +1,3 @@
+linters-settings:
+  gocognit:
+    min-complexity: 2

test/testdata/configs/goconst_calls_enabled.yml

@@ -0,0 +1,3 @@
+linters-settings:
+  goconst:
+    ignore-calls: false

test/testdata/configs/goconst_dont_ignore.yml

@@ -0,0 +1,3 @@
+linters-settings:
+  goconst:
+    ignore-tests: false

test/testdata/configs/goconst_ignore.yml

@@ -0,0 +1,3 @@
+linters-settings:
+  goconst:
+    ignore-tests: true

test/testdata/configs/gocyclo.yml

@@ -0,0 +1,3 @@
+linters-settings:
+  gocyclo:
+    min-complexity: 20

test/testdata/configs/godox.yml

@@ -0,0 +1,5 @@
+linters-settings:
+  godox:
+    keywords:
+      - FIXME
+      - TODO

test/testdata/configs/gofmt_no_simplify.yml

@@ -0,0 +1,3 @@
+linters-settings:
+  gofmt:
+    simplify: false

test/testdata/configs/gofumpt-fix.yml

@@ -0,0 +1,3 @@
+linters-settings:
+  gofumpt:
+    extra-rules: true

test/testdata/configs/gofumpt_with_extra.yml

@@ -0,0 +1,3 @@
+linters-settings:
+  gofumpt:
+    extra-rules: true

test/testdata/configs/goimports.yml

@@ -0,0 +1,3 @@
+linters-settings:
+  goimports:
+    local-prefixes: github.com/golangci/golangci-lint

test/testdata/configs/govet.yml

@@ -0,0 +1,3 @@
+linters-settings:
+  govet:
+    check-shadowing: true

test/testdata/configs/govet_fieldalignment.yml

@@ -0,0 +1,3 @@
+linters-settings:
+  govet:
+    enable: fieldalignment

test/testdata/configs/govet_ifaceassert.yml

@@ -0,0 +1,3 @@
+linters-settings:
+  govet:
+    enable: ifaceassert

test/testdata/configs/lll.yml

@@ -0,0 +1,3 @@
+linters-settings:
+  lll:
+    tab-width: 4

test/testdata/configs/makezero_always.yml

@@ -0,0 +1,3 @@
+linters-settings:
+  makezero:
+    always: true

test/testdata/configs/nestif.yml

@@ -0,0 +1,3 @@
+linters-settings:
+  nestif:
+    min-complexity: 1

test/testdata/configs/nolintlint.yml

@@ -0,0 +1,4 @@
+linters-settings:
+  nolintlint:
+    require-explanation: true
+    require-specific: true

test/testdata/configs/nolintlint_unused.yml

@@ -0,0 +1,3 @@
+linters-settings:
+  nolintlint:
+    allow-unused: false

test/testdata/configs/whitespace-fix.yml

@@ -0,0 +1,4 @@
+linters-settings:
+  whitespace:
+    multi-if: true
+    multi-func: true

test/testdata/configs/wsl.yml

@@ -0,0 +1,3 @@
+linters-settings:
+  wsl:
+    allow-cuddle-declarations: false

test/testdata/cyclop.go

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

test/testdata/dupl.go

@@ -1,5 +1,5 @@
 //golangcitest:args -Edupl
-//golangcitest:config linters-settings.dupl.threshold=20
+//golangcitest:config_path testdata/configs/dupl.yml
 package testdata
 
 type DuplLogger struct{}

test/testdata/errcheck_exclude.go

@@ -1,6 +1,5 @@
 //golangcitest:args -Eerrcheck
-//golangcitest:config linters-settings.errcheck.check-blank=true
-//golangcitest:config linters-settings.errcheck.exclude=testdata/errcheck/exclude.txt
+//golangcitest:config_path testdata/configs/errcheck_exclude.yml
 package testdata
 
 import (

test/testdata/errcheck_ignore_default.go

@@ -1,5 +1,5 @@
 //golangcitest:args -Eerrcheck
-//golangcitest:config linters-settings.errcheck.check-blank=true
+//golangcitest:config_path testdata/configs/errcheck_ignore_default.yml
 package testdata
 
 import (

test/testdata/errcheck_type_assertions.go

@@ -1,5 +1,5 @@
 //golangcitest:args -Eerrcheck
-//golangcitest:config linters-settings.errcheck.check-type-assertions=true
+//golangcitest:config_path testdata/configs/errcheck_type_assertions.yml
 package testdata
 
 func ErrorTypeAssertion(filter map[string]interface{}) bool {

test/testdata/fix/in/gofumpt.go

@@ -1,5 +1,5 @@
 //golangcitest:args -Egofumpt
-//golangcitest:config linters-settings.gofumpt.extra-rules=true
+//golangcitest:config_path testdata/configs/gofumpt-fix.yml
 package p
 
 import "fmt"

test/testdata/fix/in/whitespace.go

@@ -1,6 +1,5 @@
 //golangcitest:args -Ewhitespace
-//golangcitest:config linters-settings.whitespace.multi-if=true
-//golangcitest:config linters-settings.whitespace.multi-func=true
+//golangcitest:config_path testdata/configs/whitespace-fix.yml
 package p
 
 import "fmt"

test/testdata/fix/out/gofumpt.go

@@ -1,5 +1,5 @@
 //golangcitest:args -Egofumpt
-//golangcitest:config linters-settings.gofumpt.extra-rules=true
+//golangcitest:config_path testdata/configs/gofumpt-fix.yml
 package p
 
 import "fmt"

test/testdata/fix/out/whitespace.go

@@ -1,6 +1,5 @@
 //golangcitest:args -Ewhitespace
-//golangcitest:config linters-settings.whitespace.multi-if=true
-//golangcitest:config linters-settings.whitespace.multi-func=true
+//golangcitest:config_path testdata/configs/whitespace-fix.yml
 package p
 
 import "fmt"

test/testdata/forbidigo_include_godoc_examples_test.go

@@ -1,5 +1,5 @@
 //golangcitest:args -Eforbidigo
-//golangcitest:config linters-settings.forbidigo.exclude-godoc-examples=false
+//golangcitest:config_path testdata/configs/forbidigo_include_godoc_examples.yml
 package testdata
 
 import "fmt"

test/testdata/funlen.go

@@ -1,6 +1,5 @@
 //golangcitest:args -Efunlen
-//golangcitest:config linters-settings.funlen.lines=20
-//golangcitest:config linters-settings.funlen.statements=10
+//golangcitest:config_path testdata/configs/funlen.yml
 package testdata
 
 func TooManyLines() { // ERROR `Function 'TooManyLines' is too long \(22 > 20\)`

test/testdata/gocognit.go

@@ -1,5 +1,5 @@
 //golangcitest:args -Egocognit
-//golangcitest:config linters-settings.gocognit.min-complexity=2
+//golangcitest:config_path testdata/configs/gocognit.yml
 package testdata
 
 func GoCognit_CC4_GetWords(number int) string { // ERROR "cognitive complexity 4 of func .* is high .*"

test/testdata/goconst_calls_enabled.go

@@ -1,5 +1,5 @@
 //golangcitest:args -Egoconst
-//golangcitest:config linters-settings.goconst.ignore-calls=false
+//golangcitest:config_path testdata/configs/goconst_calls_enabled.yml
 package testdata
 
 import "fmt"