Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 15, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions test/fix_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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)
Expand Down
84 changes: 7 additions & 77 deletions test/linters_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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...).
Expand Down Expand Up @@ -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",
Expand All @@ -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)
Expand All @@ -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)
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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",
)
Expand All @@ -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",
)
Expand All @@ -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()
})
}
3 changes: 3 additions & 0 deletions test/testdata/configs/cyclop.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
linters-settings:
cyclop:
max-complexity: 15
3 changes: 3 additions & 0 deletions test/testdata/configs/dupl.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
linters-settings:
dupl:
threshold: 20
4 changes: 4 additions & 0 deletions test/testdata/configs/errcheck_exclude.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
linters-settings:
errcheck:
check-blank: true
exclude: testdata/errcheck/exclude.txt
3 changes: 3 additions & 0 deletions test/testdata/configs/errcheck_ignore_default.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
linters-settings:
errcheck:
check-blank: true
3 changes: 3 additions & 0 deletions test/testdata/configs/errcheck_type_assertions.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
linters-settings:
errcheck:
check-type-assertions: true
4 changes: 4 additions & 0 deletions test/testdata/configs/forbidigo_include_godoc_examples.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
linters-settings:
forbidigo:
exclude-godoc-examples: false

4 changes: 4 additions & 0 deletions test/testdata/configs/funlen.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
linters-settings:
funlen:
lines: 20
statements: 10
3 changes: 3 additions & 0 deletions test/testdata/configs/gocognit.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
linters-settings:
gocognit:
min-complexity: 2
3 changes: 3 additions & 0 deletions test/testdata/configs/goconst_calls_enabled.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
linters-settings:
goconst:
ignore-calls: false
3 changes: 3 additions & 0 deletions test/testdata/configs/goconst_dont_ignore.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
linters-settings:
goconst:
ignore-tests: false
3 changes: 3 additions & 0 deletions test/testdata/configs/goconst_ignore.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
linters-settings:
goconst:
ignore-tests: true
3 changes: 3 additions & 0 deletions test/testdata/configs/gocyclo.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
linters-settings:
gocyclo:
min-complexity: 20
5 changes: 5 additions & 0 deletions test/testdata/configs/godox.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
linters-settings:
godox:
keywords:
- FIXME
- TODO
3 changes: 3 additions & 0 deletions test/testdata/configs/gofmt_no_simplify.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
linters-settings:
gofmt:
simplify: false
3 changes: 3 additions & 0 deletions test/testdata/configs/gofumpt-fix.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
linters-settings:
gofumpt:
extra-rules: true
3 changes: 3 additions & 0 deletions test/testdata/configs/gofumpt_with_extra.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
linters-settings:
gofumpt:
extra-rules: true
3 changes: 3 additions & 0 deletions test/testdata/configs/goimports.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
linters-settings:
goimports:
local-prefixes: github.com/golangci/golangci-lint
3 changes: 3 additions & 0 deletions test/testdata/configs/govet.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
linters-settings:
govet:
check-shadowing: true
3 changes: 3 additions & 0 deletions test/testdata/configs/govet_fieldalignment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
linters-settings:
govet:
enable: fieldalignment
3 changes: 3 additions & 0 deletions test/testdata/configs/govet_ifaceassert.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
linters-settings:
govet:
enable: ifaceassert
3 changes: 3 additions & 0 deletions test/testdata/configs/lll.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
linters-settings:
lll:
tab-width: 4
3 changes: 3 additions & 0 deletions test/testdata/configs/makezero_always.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
linters-settings:
makezero:
always: true
3 changes: 3 additions & 0 deletions test/testdata/configs/nestif.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
linters-settings:
nestif:
min-complexity: 1
4 changes: 4 additions & 0 deletions test/testdata/configs/nolintlint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
linters-settings:
nolintlint:
require-explanation: true
require-specific: true
3 changes: 3 additions & 0 deletions test/testdata/configs/nolintlint_unused.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
linters-settings:
nolintlint:
allow-unused: false
4 changes: 4 additions & 0 deletions test/testdata/configs/whitespace-fix.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
linters-settings:
whitespace:
multi-if: true
multi-func: true
3 changes: 3 additions & 0 deletions test/testdata/configs/wsl.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
linters-settings:
wsl:
tests: 1
2 changes: 1 addition & 1 deletion test/testdata/cyclop.go
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
2 changes: 1 addition & 1 deletion test/testdata/dupl.go
Original file line number Diff line number Diff line change
@@ -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{}
Expand Down
3 changes: 1 addition & 2 deletions test/testdata/errcheck_exclude.go
Original file line number Diff line number Diff line change
@@ -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 (
Expand Down
2 changes: 1 addition & 1 deletion test/testdata/errcheck_ignore_default.go
Original file line number Diff line number Diff line change
@@ -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 (
Expand Down
2 changes: 1 addition & 1 deletion test/testdata/errcheck_type_assertions.go
Original file line number Diff line number Diff line change
@@ -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 {
Expand Down
2 changes: 1 addition & 1 deletion test/testdata/fix/in/gofumpt.go
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
3 changes: 1 addition & 2 deletions test/testdata/fix/in/whitespace.go
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
2 changes: 1 addition & 1 deletion test/testdata/fix/out/gofumpt.go
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
3 changes: 1 addition & 2 deletions test/testdata/fix/out/whitespace.go
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
2 changes: 1 addition & 1 deletion test/testdata/forbidigo_include_godoc_examples_test.go
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
3 changes: 1 addition & 2 deletions test/testdata/funlen.go
Original file line number Diff line number Diff line change
@@ -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\)`
Expand Down
2 changes: 1 addition & 1 deletion test/testdata/gocognit.go
Original file line number Diff line number Diff line change
@@ -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 .*"
Expand Down
2 changes: 1 addition & 1 deletion test/testdata/goconst_calls_enabled.go
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
Loading