dev: use directives instead of comments for tests (#2978)

Author: ldez

pkg/config/linters_settings.go

@@ -629,12 +629,12 @@ type WSLSettings struct {
 // CustomLinterSettings encapsulates the meta-data of a private linter.
 // For example, a private linter may be added to the golangci config file as shown below.
 //
-// linters-settings:
-//  custom:
-//    example:
-//      path: /example.so
-//      description: The description of the linter
-//      original-url: github.com/golangci/example-linter
+//	linters-settings:
+//	 custom:
+//	   example:
+//	     path: /example.so
+//	     description: The description of the linter
+//	     original-url: github.com/golangci/example-linter
 type CustomLinterSettings struct {
 	// Path to a plugin *.so file that implements the private linter.
 	Path string

pkg/golinters/gofmt_test.go

@@ -310,7 +310,7 @@ index 2c9f78d..c0d5791 100644
 --- a/gofmt.go
 +++ b/gofmt.go
 @@ -1,9 +1,9 @@
- //args: -Egofmt
+ //golangcitest:args -Egofmt
  package p
 
 - func gofmt(a, b int) int {

pkg/golinters/revive.go

@@ -34,6 +34,7 @@ type jsonObject struct {
 }
 
 // NewRevive returns a new Revive linter.
+//
 //nolint:dupl
 func NewRevive(settings *config.ReviveSettings) *goanalysis.Linter {
 	var mu sync.Mutex

pkg/golinters/scopelint.go

@@ -84,6 +84,7 @@ type Node struct {
 // Visit method is invoked for each node encountered by Walk.
 // If the result visitor w is not nil, Walk visits each of the children
 // of node with the visitor w, followed by a call of w.Visit(nil).
+//
 //nolint:gocyclo,gocritic
 func (f *Node) Visit(node ast.Node) ast.Visitor {
 	switch typedNode := node.(type) {
@@ -173,6 +174,7 @@ func (f *Node) Visit(node ast.Node) ast.Visitor {
 
 // The variadic arguments may start with link and category types,
 // and must end with a format string and any arguments.
+//
 //nolint:interfacer
 func (f *Node) errorf(n ast.Node, format string, args ...interface{}) {
 	pos := f.fset.Position(n.Pos())

test/errchk.go

@@ -24,6 +24,7 @@ var errorLineRx = regexp.MustCompile(`^\S+?: (.*)\((\S+?)\)$`)
 //
 // Sources files are supplied as fullshort slice.
 // It consists of pairs: full path to source file and its base name.
+//
 //nolint:gocyclo,funlen
 func errorCheck(outStr string, wantAuto bool, defaultWantedLinter string, fullshort ...string) (err error) {
 	var errs []error
@@ -179,6 +180,7 @@ var (
 )
 
 // wantedErrors parses expected errors from comments in a file.
+//
 //nolint:nakedret
 func wantedErrors(file, short, defaultLinter string) (errs []wantedError) {
 	cache := make(map[string]*regexp.Regexp)

test/linters_test.go

@@ -248,7 +248,7 @@ type runContext struct {
 
 func buildConfigFromShortRepr(t *testing.T, repr string, config map[string]interface{}) {
 	kv := strings.Split(repr, "=")
-	require.Len(t, kv, 2)
+	require.Len(t, kv, 2, "repr: %s", repr)
 
 	keyParts := strings.Split(kv[0], ".")
 	require.True(t, len(keyParts) >= 2, len(keyParts))
@@ -308,47 +308,55 @@ func extractRunContextFromComments(t *testing.T, sourcePath string) *runContext
 			continue
 		}
 
-		line = strings.TrimLeft(strings.TrimPrefix(line, "//"), " ")
-		if strings.HasPrefix(line, "args: ") {
+		if !strings.HasPrefix(line, "//golangcitest:") {
+			require.Failf(t, "invalid prefix of comment line %s", line)
+		}
+
+		// TODO(ldez) replace that by strings.Cut when we will drop go1.17
+		var before string
+		var after string
+		if i := strings.Index(line, " "); i >= 0 {
+			before = line[:i]
+			after = strings.TrimSpace(line[i+len(" "):])
+		} else {
+			require.Failf(t, "invalid prefix of comment line %s", line)
+		}
+
+		switch before {
+		case "//golangcitest:args":
 			require.Nil(t, rc.args)
-			args := strings.TrimPrefix(line, "args: ")
-			require.NotEmpty(t, args)
-			rc.args = strings.Split(args, " ")
+			require.NotEmpty(t, after)
+			rc.args = strings.Split(after, " ")
 			continue
-		}
 
-		if strings.HasPrefix(line, "config: ") {
-			repr := strings.TrimPrefix(line, "config: ")
-			require.NotEmpty(t, repr)
+		case "//golangcitest:config":
+			require.NotEmpty(t, after)
 			if rc.config == nil {
 				rc.config = map[string]interface{}{}
 			}
-			buildConfigFromShortRepr(t, repr, rc.config)
+			buildConfigFromShortRepr(t, after, rc.config)
 			continue
-		}
 
-		if strings.HasPrefix(line, "config_path: ") {
-			configPath := strings.TrimPrefix(line, "config_path: ")
-			require.NotEmpty(t, configPath)
-			rc.configPath = configPath
+		case "//golangcitest:config_path":
+			require.NotEmpty(t, after)
+			rc.configPath = after
 			continue
-		}
 
-		if strings.HasPrefix(line, "expected_linter: ") {
-			expectedLinter := strings.TrimPrefix(line, "expected_linter: ")
-			require.NotEmpty(t, expectedLinter)
-			rc.expectedLinter = expectedLinter
+		case "//golangcitest:expected_linter":
+			require.NotEmpty(t, after)
+			rc.expectedLinter = after
 			continue
-		}
 
-		require.Fail(t, "invalid prefix of comment line %s", line)
+		default:
+			require.Failf(t, "invalid prefix of comment line %s", line)
+		}
 	}
 
 	// guess the expected linter if none is specified
 	if rc.expectedLinter == "" {
 		for _, arg := range rc.args {
 			if strings.HasPrefix(arg, "-E") && !strings.Contains(arg, ",") {
-				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
+				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
 				rc.expectedLinter = arg[2:]
 			}
 		}

test/testdata/asciicheck.go

@@ -1,4 +1,4 @@
-//args: -Easciicheck
+//golangcitest:args -Easciicheck
 package testdata
 
 import (

test/testdata/bidichk.go

@@ -1,4 +1,4 @@
-//args: -Ebidichk
+//golangcitest:args -Ebidichk
 package testdata
 
 import "fmt"

test/testdata/bodyclose.go

@@ -1,4 +1,4 @@
-//args: -Ebodyclose
+//golangcitest:args -Ebodyclose
 package testdata
 
 import (

test/testdata/containedctx.go

@@ -1,4 +1,4 @@
-// args: -Econtainedctx
+//golangcitest:args -Econtainedctx
 package testdata
 
 import "context"

test/testdata/contextcheck.go

@@ -1,4 +1,4 @@
-//args: -Econtextcheck
+//golangcitest:args -Econtextcheck
 package testdata
 
 import "context"

test/testdata/cyclop.go

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

test/testdata/deadcode.go

@@ -1,4 +1,4 @@
-//args: -Edeadcode
+//golangcitest:args -Edeadcode
 package testdata
 
 var y int

test/testdata/decorder.go

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

test/testdata/decorder_default.go

@@ -1,4 +1,4 @@
-// args: -Edecorder
+//golangcitest:args -Edecorder
 package testdata
 
 import "math"

test/testdata/default_exclude.go

@@ -1,5 +1,5 @@
-//args: -Estylecheck,golint --internal-cmd-test
-//config_path: testdata/configs/default_exclude.yml
+//golangcitest:args -Estylecheck,golint --internal-cmd-test
+//golangcitest:config_path testdata/configs/default_exclude.yml
 
 /*Package testdata ...*/
 package testdata

test/testdata/depguard.go

@@ -1,5 +1,5 @@
-//args: -Edepguard
-//config_path: testdata/configs/depguard.yml
+//golangcitest:args -Edepguard
+//golangcitest:config_path testdata/configs/depguard.yml
 package testdata
 
 import (

test/testdata/depguard_additional_guards.go

@@ -1,5 +1,5 @@
-//args: -Edepguard
-//config_path: testdata/configs/depguard_additional_guards.yml
+//golangcitest:args -Edepguard
+//golangcitest:config_path testdata/configs/depguard_additional_guards.yml
 package testdata
 
 import (

test/testdata/depguard_ignore_file_rules.go

@@ -1,5 +1,5 @@
-//args: -Edepguard
-//config_path: testdata/configs/depguard_ignore_file_rules.yml
+//golangcitest:args -Edepguard
+//golangcitest:config_path testdata/configs/depguard_ignore_file_rules.yml
 package testdata
 
 // NOTE - No lint errors becuase this file is ignored

test/testdata/dogsled.go

@@ -1,4 +1,4 @@
-//args: -Edogsled
+//golangcitest:args -Edogsled
 package testdata
 
 func Dogsled() {

test/testdata/dupl.go

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

test/testdata/durationcheck.go

@@ -1,4 +1,4 @@
-//args: -Edurationcheck
+//golangcitest:args -Edurationcheck
 package testdata
 
 import (

test/testdata/errcheck.go

@@ -1,4 +1,4 @@
-//args: -Eerrcheck
+//golangcitest:args -Eerrcheck
 package testdata
 
 import (

test/testdata/errcheck_exclude.go

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

test/testdata/errcheck_exclude_functions.go

@@ -1,5 +1,5 @@
-//args: -Eerrcheck
-//config_path: testdata/errcheck/exclude_functions.yml
+//golangcitest:args -Eerrcheck
+//golangcitest:config_path testdata/errcheck/exclude_functions.yml
 package testdata
 
 import (

test/testdata/errcheck_ignore.go

@@ -1,5 +1,5 @@
-//args: -Eerrcheck
-//config_path: testdata/errcheck/ignore_config.yml
+//golangcitest:args -Eerrcheck
+//golangcitest:config_path testdata/errcheck/ignore_config.yml
 package testdata
 
 import (

test/testdata/errcheck_ignore_default.go

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

test/testdata/errcheck_type_assertions.go

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

test/testdata/errchkjson.go

@@ -1,5 +1,5 @@
-// args: -Eerrchkjson
-// config_path: testdata/configs/errchkjson.yml
+//golangcitest:args -Eerrchkjson
+//golangcitest:config_path testdata/configs/errchkjson.yml
 package testdata
 
 import (

test/testdata/errchkjson_check_error_free_encoding.go

@@ -1,5 +1,5 @@
-// args: -Eerrchkjson
-// config_path: testdata/configs/errchkjson_check_error_free_encoding.yml
+//golangcitest:args -Eerrchkjson
+//golangcitest:config_path testdata/configs/errchkjson_check_error_free_encoding.yml
 package testdata
 
 import (

test/testdata/errchkjson_no_exported.go

@@ -1,5 +1,5 @@
-// args: -Eerrchkjson
-// config_path: testdata/configs/errchkjson_no_exported.yml
+//golangcitest:args -Eerrchkjson
+//golangcitest:config_path testdata/configs/errchkjson_no_exported.yml
 package testdata
 
 import (

test/testdata/errname.go

@@ -1,4 +1,4 @@
-//args: -Eerrname
+//golangcitest:args -Eerrname
 package testdata
 
 import (

test/testdata/errorlint.go

@@ -1,4 +1,4 @@
-//args: -Eerrorlint
+//golangcitest:args -Eerrorlint
 package testdata
 
 import (

test/testdata/errorlint_asserts.go

@@ -1,5 +1,5 @@
-//args: -Eerrorlint
-//config_path: testdata/configs/errorlint_asserts.yml
+//golangcitest:args -Eerrorlint
+//golangcitest:config_path testdata/configs/errorlint_asserts.yml
 package testdata
 
 import (

test/testdata/errorlint_comparison.go

@@ -1,5 +1,5 @@
-//args: -Eerrorlint
-//config_path: testdata/configs/errorlint_comparison.yml
+//golangcitest:args -Eerrorlint
+//golangcitest:config_path testdata/configs/errorlint_comparison.yml
 package testdata
 
 import (

test/testdata/errorlint_errorf.go

@@ -1,5 +1,5 @@
-//args: -Eerrorlint
-//config_path: testdata/configs/errorlint_errorf.yml
+//golangcitest:args -Eerrorlint
+//golangcitest:config_path testdata/configs/errorlint_errorf.yml
 package testdata
 
 import (

test/testdata/execinquery.go

@@ -1,4 +1,4 @@
-// args: -Eexecinquery
+//golangcitest:args -Eexecinquery
 package testdata
 
 import (

test/testdata/exhaustive.go

@@ -1,4 +1,4 @@
-//args: -Eexhaustive
+//golangcitest:args -Eexhaustive
 package testdata
 
 type Direction int

test/testdata/exhaustive_default.go

@@ -1,5 +1,5 @@
-//args: -Eexhaustive
-//config_path: testdata/configs/exhaustive_default.yml
+//golangcitest:args -Eexhaustive
+//golangcitest:config_path testdata/configs/exhaustive_default.yml
 package testdata
 
 type Direction int