Skip to content

Commit 6a1e223

Browse files
ldezldez
committed
tests: use directives instead of comments
1 parent 0abb298 commit 6a1e223

File tree

162 files changed

+280
-272
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

162 files changed

+280
-272
lines changed

Diff for: ‎pkg/golinters/gofmt_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ index 2c9f78d..c0d5791 100644
310310
--- a/gofmt.go
311311
+++ b/gofmt.go
312312
@@ -1,9 +1,9 @@
313-
//args: -Egofmt
313+
//golangcitest:args -Egofmt
314314
package p
315315
316316
- func gofmt(a, b int) int {

Diff for: ‎test/linters_test.go

+32-24
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ type runContext struct {
248248

249249
func buildConfigFromShortRepr(t *testing.T, repr string, config map[string]interface{}) {
250250
kv := strings.Split(repr, "=")
251-
require.Len(t, kv, 2)
251+
require.Len(t, kv, 2, "repr: %s", repr)
252252

253253
keyParts := strings.Split(kv[0], ".")
254254
require.True(t, len(keyParts) >= 2, len(keyParts))
@@ -308,47 +308,55 @@ func extractRunContextFromComments(t *testing.T, sourcePath string) *runContext
308308
continue
309309
}
310310

311-
line = strings.TrimLeft(strings.TrimPrefix(line, "//"), " ")
312-
if strings.HasPrefix(line, "args: ") {
311+
if !strings.HasPrefix(line, "//golangcitest:") {
312+
require.Failf(t, "invalid prefix of comment line %s", line)
313+
}
314+
315+
// TODO(ldez) replace that by strings.Cut when we will drop go1.17
316+
var before string
317+
var after string
318+
if i := strings.Index(line, " "); i >= 0 {
319+
before = line[:i]
320+
after = strings.TrimSpace(line[i+len(" "):])
321+
} else {
322+
require.Failf(t, "invalid prefix of comment line %s", line)
323+
}
324+
325+
switch before {
326+
case "//golangcitest:args":
313327
require.Nil(t, rc.args)
314-
args := strings.TrimPrefix(line, "args: ")
315-
require.NotEmpty(t, args)
316-
rc.args = strings.Split(args, " ")
328+
require.NotEmpty(t, after)
329+
rc.args = strings.Split(after, " ")
317330
continue
318-
}
319331

320-
if strings.HasPrefix(line, "config: ") {
321-
repr := strings.TrimPrefix(line, "config: ")
322-
require.NotEmpty(t, repr)
332+
case "//golangcitest:config":
333+
require.NotEmpty(t, after)
323334
if rc.config == nil {
324335
rc.config = map[string]interface{}{}
325336
}
326-
buildConfigFromShortRepr(t, repr, rc.config)
337+
buildConfigFromShortRepr(t, after, rc.config)
327338
continue
328-
}
329339

330-
if strings.HasPrefix(line, "config_path: ") {
331-
configPath := strings.TrimPrefix(line, "config_path: ")
332-
require.NotEmpty(t, configPath)
333-
rc.configPath = configPath
340+
case "//golangcitest:config_path":
341+
require.NotEmpty(t, after)
342+
rc.configPath = after
334343
continue
335-
}
336344

337-
if strings.HasPrefix(line, "expected_linter: ") {
338-
expectedLinter := strings.TrimPrefix(line, "expected_linter: ")
339-
require.NotEmpty(t, expectedLinter)
340-
rc.expectedLinter = expectedLinter
345+
case "//golangcitest:expected_linter":
346+
require.NotEmpty(t, after)
347+
rc.expectedLinter = after
341348
continue
342-
}
343349

344-
require.Fail(t, "invalid prefix of comment line %s", line)
350+
default:
351+
require.Failf(t, "invalid prefix of comment line %s", line)
352+
}
345353
}
346354

347355
// guess the expected linter if none is specified
348356
if rc.expectedLinter == "" {
349357
for _, arg := range rc.args {
350358
if strings.HasPrefix(arg, "-E") && !strings.Contains(arg, ",") {
351-
require.Empty(t, rc.expectedLinter, "could not infer expected linter for errors because multiple linters are enabled. Please use the `expected_linter: ` directive in your test to indicate the linter-under-test.") //nolint:lll
359+
require.Empty(t, rc.expectedLinter, "could not infer expected linter for errors because multiple linters are enabled. Please use the `//golangcitest:expected_linter ` directive in your test to indicate the linter-under-test.") //nolint:lll
352360
rc.expectedLinter = arg[2:]
353361
}
354362
}

Diff for: ‎test/testdata/asciicheck.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//args: -Easciicheck
1+
//golangcitest:args -Easciicheck
22
package testdata
33

44
import (

Diff for: ‎test/testdata/bidichk.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//args: -Ebidichk
1+
//golangcitest:args -Ebidichk
22
package testdata
33

44
import "fmt"

Diff for: ‎test/testdata/bodyclose.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//args: -Ebodyclose
1+
//golangcitest:args -Ebodyclose
22
package testdata
33

44
import (

Diff for: ‎test/testdata/containedctx.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// args: -Econtainedctx
1+
//golangcitest:args -Econtainedctx
22
package testdata
33

44
import "context"

Diff for: ‎test/testdata/contextcheck.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//args: -Econtextcheck
1+
//golangcitest:args -Econtextcheck
22
package testdata
33

44
import "context"

Diff for: ‎test/testdata/cyclop.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
//args: -Ecyclop
2-
//config: linters-settings.cyclop.max-complexity=15
1+
//golangcitest:args -Ecyclop
2+
//golangcitest:config linters-settings.cyclop.max-complexity=15
33
package testdata
44

55
func cyclopComplexFunc(s string) { // ERROR "calculated cyclomatic complexity for function cyclopComplexFunc is 22, max is 15"

Diff for: ‎test/testdata/deadcode.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//args: -Edeadcode
1+
//golangcitest:args -Edeadcode
22
package testdata
33

44
var y int

Diff for: ‎test/testdata/decorder.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
// args: -Edecorder
2-
// config_path: testdata/configs/decorder.yml
1+
//golangcitest:args -Edecorder
2+
//golangcitest:config_path testdata/configs/decorder.yml
33
package testdata
44

55
import "math"

Diff for: ‎test/testdata/decorder_default.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// args: -Edecorder
1+
//golangcitest:args -Edecorder
22
package testdata
33

44
import "math"

Diff for: ‎test/testdata/default_exclude.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
//args: -Estylecheck,golint --internal-cmd-test
2-
//config_path: testdata/configs/default_exclude.yml
1+
//golangcitest:args -Estylecheck,golint --internal-cmd-test
2+
//golangcitest:config_path testdata/configs/default_exclude.yml
33

44
/*Package testdata ...*/
55
package testdata

Diff for: ‎test/testdata/depguard.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
//args: -Edepguard
2-
//config_path: testdata/configs/depguard.yml
1+
//golangcitest:args -Edepguard
2+
//golangcitest:config_path testdata/configs/depguard.yml
33
package testdata
44

55
import (

Diff for: ‎test/testdata/depguard_additional_guards.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
//args: -Edepguard
2-
//config_path: testdata/configs/depguard_additional_guards.yml
1+
//golangcitest:args -Edepguard
2+
//golangcitest:config_path testdata/configs/depguard_additional_guards.yml
33
package testdata
44

55
import (

Diff for: ‎test/testdata/depguard_ignore_file_rules.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
//args: -Edepguard
2-
//config_path: testdata/configs/depguard_ignore_file_rules.yml
1+
//golangcitest:args -Edepguard
2+
//golangcitest:config_path testdata/configs/depguard_ignore_file_rules.yml
33
package testdata
44

55
// NOTE - No lint errors becuase this file is ignored

Diff for: ‎test/testdata/dogsled.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//args: -Edogsled
1+
//golangcitest:args -Edogsled
22
package testdata
33

44
func Dogsled() {

Diff for: ‎test/testdata/dupl.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
//args: -Edupl
2-
//config: linters-settings.dupl.threshold=20
1+
//golangcitest:args -Edupl
2+
//golangcitest:config linters-settings.dupl.threshold=20
33
package testdata
44

55
type DuplLogger struct{}

Diff for: ‎test/testdata/durationcheck.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//args: -Edurationcheck
1+
//golangcitest:args -Edurationcheck
22
package testdata
33

44
import (

Diff for: ‎test/testdata/errcheck.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//args: -Eerrcheck
1+
//golangcitest:args -Eerrcheck
22
package testdata
33

44
import (

Diff for: ‎test/testdata/errcheck_exclude.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
//args: -Eerrcheck
2-
//config: linters-settings.errcheck.check-blank=true
3-
//config: linters-settings.errcheck.exclude=testdata/errcheck/exclude.txt
1+
//golangcitest:args -Eerrcheck
2+
//golangcitest:config linters-settings.errcheck.check-blank=true
3+
//golangcitest:config linters-settings.errcheck.exclude=testdata/errcheck/exclude.txt
44
package testdata
55

66
import (

Diff for: ‎test/testdata/errcheck_exclude_functions.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
//args: -Eerrcheck
2-
//config_path: testdata/errcheck/exclude_functions.yml
1+
//golangcitest:args -Eerrcheck
2+
//golangcitest:config_path testdata/errcheck/exclude_functions.yml
33
package testdata
44

55
import (

Diff for: ‎test/testdata/errcheck_ignore.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
//args: -Eerrcheck
2-
//config_path: testdata/errcheck/ignore_config.yml
1+
//golangcitest:args -Eerrcheck
2+
//golangcitest:config_path testdata/errcheck/ignore_config.yml
33
package testdata
44

55
import (

Diff for: ‎test/testdata/errcheck_ignore_default.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
//args: -Eerrcheck
2-
//config: linters-settings.errcheck.check-blank=true
1+
//golangcitest:args -Eerrcheck
2+
//golangcitest:config linters-settings.errcheck.check-blank=true
33
package testdata
44

55
import (

Diff for: ‎test/testdata/errcheck_type_assertions.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
//args: -Eerrcheck
2-
//config: linters-settings.errcheck.check-type-assertions=true
1+
//golangcitest:args -Eerrcheck
2+
//golangcitest:config linters-settings.errcheck.check-type-assertions=true
33
package testdata
44

55
func ErrorTypeAssertion(filter map[string]interface{}) bool {

Diff for: ‎test/testdata/errchkjson.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
// args: -Eerrchkjson
2-
// config_path: testdata/configs/errchkjson.yml
1+
//golangcitest:args -Eerrchkjson
2+
//golangcitest:config_path testdata/configs/errchkjson.yml
33
package testdata
44

55
import (

Diff for: ‎test/testdata/errchkjson_check_error_free_encoding.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
// args: -Eerrchkjson
2-
// config_path: testdata/configs/errchkjson_check_error_free_encoding.yml
1+
//golangcitest:args -Eerrchkjson
2+
//golangcitest:config_path testdata/configs/errchkjson_check_error_free_encoding.yml
33
package testdata
44

55
import (

Diff for: ‎test/testdata/errchkjson_no_exported.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
// args: -Eerrchkjson
2-
// config_path: testdata/configs/errchkjson_no_exported.yml
1+
//golangcitest:args -Eerrchkjson
2+
//golangcitest:config_path testdata/configs/errchkjson_no_exported.yml
33
package testdata
44

55
import (

Diff for: ‎test/testdata/errname.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//args: -Eerrname
1+
//golangcitest:args -Eerrname
22
package testdata
33

44
import (

Diff for: ‎test/testdata/errorlint.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//args: -Eerrorlint
1+
//golangcitest:args -Eerrorlint
22
package testdata
33

44
import (

Diff for: ‎test/testdata/errorlint_asserts.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
//args: -Eerrorlint
2-
//config_path: testdata/configs/errorlint_asserts.yml
1+
//golangcitest:args -Eerrorlint
2+
//golangcitest:config_path testdata/configs/errorlint_asserts.yml
33
package testdata
44

55
import (

Diff for: ‎test/testdata/errorlint_comparison.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
//args: -Eerrorlint
2-
//config_path: testdata/configs/errorlint_comparison.yml
1+
//golangcitest:args -Eerrorlint
2+
//golangcitest:config_path testdata/configs/errorlint_comparison.yml
33
package testdata
44

55
import (

Diff for: ‎test/testdata/errorlint_errorf.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
//args: -Eerrorlint
2-
//config_path: testdata/configs/errorlint_errorf.yml
1+
//golangcitest:args -Eerrorlint
2+
//golangcitest:config_path testdata/configs/errorlint_errorf.yml
33
package testdata
44

55
import (

Diff for: ‎test/testdata/execinquery.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// args: -Eexecinquery
1+
//golangcitest:args -Eexecinquery
22
package testdata
33

44
import (

Diff for: ‎test/testdata/exhaustive.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//args: -Eexhaustive
1+
//golangcitest:args -Eexhaustive
22
package testdata
33

44
type Direction int

Diff for: ‎test/testdata/exhaustive_default.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
//args: -Eexhaustive
2-
//config_path: testdata/configs/exhaustive_default.yml
1+
//golangcitest:args -Eexhaustive
2+
//golangcitest:config_path testdata/configs/exhaustive_default.yml
33
package testdata
44

55
type Direction int

Diff for: ‎test/testdata/exhaustive_generated.go

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: ‎test/testdata/exhaustive_ignore_enum_members.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
//args: -Eexhaustive
2-
//config_path: testdata/configs/exhaustive_ignore_enum_members.yml
1+
//golangcitest:args -Eexhaustive
2+
//golangcitest:config_path testdata/configs/exhaustive_ignore_enum_members.yml
33
package testdata
44

55
type Direction int

Diff for: ‎test/testdata/exhaustivestruct.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// args: -Eexhaustivestruct --internal-cmd-test
1+
//golangcitest:args -Eexhaustivestruct --internal-cmd-test
22
package testdata
33

44
import "time"

Diff for: ‎test/testdata/exhaustivestruct_custom.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
// args: -Eexhaustivestruct --internal-cmd-test
2-
// config_path: testdata/configs/exhaustivestruct.yml
1+
//golangcitest:args -Eexhaustivestruct --internal-cmd-test
2+
//golangcitest:config_path testdata/configs/exhaustivestruct.yml
33
package testdata
44

55
import "time"

Diff for: ‎test/testdata/exhaustruct.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// args: -Eexhaustruct
1+
//golangcitest:args -Eexhaustruct
22
package testdata
33

44
import "time"

Diff for: ‎test/testdata/exhaustruct_custom.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
// args: -Eexhaustruct
2-
// config_path: testdata/configs/exhaustruct.yml
1+
//golangcitest:args -Eexhaustruct
2+
//golangcitest:config_path testdata/configs/exhaustruct.yml
33
package testdata
44

55
import "time"

Diff for: ‎test/testdata/exportloopref.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//args: -Eexportloopref
1+
//golangcitest:args -Eexportloopref
22
package testdata
33

44
import "fmt"

Diff for: ‎test/testdata/fix/in/gci.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
//args: -Egci
2-
//config_path: testdata/configs/gci.yml
1+
//golangcitest:args -Egci
2+
//golangcitest:config_path testdata/configs/gci.yml
33
package gci
44

55
import (

Diff for: ‎test/testdata/fix/in/gocritic.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
// args: -Egocritic
2-
// config_path: testdata/configs/gocritic-fix.yml
1+
//golangcitest:args -Egocritic
2+
//golangcitest:config_path testdata/configs/gocritic-fix.yml
33
package p
44

55
import (

0 commit comments

Comments
 (0)