2c01ea7ff2
* Add variable for ruleguard config directory * Add variable for ruleguard config directory * Add variable for ruleguard config directory * Add variable for ruleguard config directory * Add unit tests * Add unit tests for ruleguard * Add unit tests for ruleguard * Add unit tests for ruleguard * Add unit tests for ruleguard, fix package name
326 lines
9.0 KiB
Go
326 lines
9.0 KiB
Go
package test
|
|
|
|
import (
|
|
"bufio"
|
|
"os"
|
|
"os/exec"
|
|
"path/filepath"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
"gopkg.in/yaml.v3"
|
|
|
|
"github.com/golangci/golangci-lint/pkg/exitcodes"
|
|
"github.com/golangci/golangci-lint/test/testshared"
|
|
)
|
|
|
|
func runGoErrchk(c *exec.Cmd, defaultExpectedLinter string, files []string, t *testing.T) {
|
|
output, err := c.CombinedOutput()
|
|
// The returned error will be nil if the test file does not have any issues
|
|
// and thus the linter exits with exit code 0. So perform the additional
|
|
// assertions only if the error is non-nil.
|
|
if err != nil {
|
|
var exitErr *exec.ExitError
|
|
require.ErrorAs(t, err, &exitErr)
|
|
require.Equal(t, exitcodes.IssuesFound, exitErr.ExitCode(), "Unexpected exit code: %s", string(output))
|
|
}
|
|
|
|
fullshort := make([]string, 0, len(files)*2)
|
|
for _, f := range files {
|
|
fullshort = append(fullshort, f, filepath.Base(f))
|
|
}
|
|
|
|
err = errorCheck(string(output), false, defaultExpectedLinter, fullshort...)
|
|
require.NoError(t, err)
|
|
}
|
|
|
|
func testSourcesFromDir(t *testing.T, dir string) {
|
|
t.Log(filepath.Join(dir, "*.go"))
|
|
|
|
findSources := func(pathPatterns ...string) []string {
|
|
sources, err := filepath.Glob(filepath.Join(pathPatterns...))
|
|
require.NoError(t, err)
|
|
require.NotEmpty(t, sources)
|
|
return sources
|
|
}
|
|
sources := findSources(dir, "*.go")
|
|
|
|
testshared.NewLintRunner(t).Install()
|
|
|
|
for _, s := range sources {
|
|
s := s
|
|
t.Run(filepath.Base(s), func(subTest *testing.T) {
|
|
subTest.Parallel()
|
|
testOneSource(subTest, s)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestSourcesFromTestdataWithIssuesDir(t *testing.T) {
|
|
testSourcesFromDir(t, testdataDir)
|
|
}
|
|
|
|
func TestTypecheck(t *testing.T) {
|
|
testSourcesFromDir(t, filepath.Join(testdataDir, "notcompiles"))
|
|
}
|
|
|
|
func TestGoimportsLocal(t *testing.T) {
|
|
sourcePath := filepath.Join(testdataDir, "goimports", "goimports.go")
|
|
args := []string{
|
|
"--disable-all", "--print-issued-lines=false", "--print-linter-name=false", "--out-format=line-number",
|
|
sourcePath,
|
|
}
|
|
rc := extractRunContextFromComments(t, sourcePath)
|
|
args = append(args, rc.args...)
|
|
|
|
cfg, err := yaml.Marshal(rc.config)
|
|
require.NoError(t, err)
|
|
|
|
testshared.NewLintRunner(t).RunWithYamlConfig(string(cfg), args...).
|
|
ExpectHasIssue("testdata/goimports/goimports.go:8: File is not `goimports`-ed")
|
|
}
|
|
|
|
func TestGciLocal(t *testing.T) {
|
|
sourcePath := filepath.Join(testdataDir, "gci", "gci.go")
|
|
args := []string{
|
|
"--disable-all", "--print-issued-lines=false", "--print-linter-name=false", "--out-format=line-number",
|
|
sourcePath,
|
|
}
|
|
rc := extractRunContextFromComments(t, sourcePath)
|
|
args = append(args, rc.args...)
|
|
|
|
cfg, err := yaml.Marshal(rc.config)
|
|
require.NoError(t, err)
|
|
|
|
testshared.NewLintRunner(t).RunWithYamlConfig(string(cfg), args...).
|
|
ExpectHasIssue("testdata/gci/gci.go:7: File is not `gci`-ed")
|
|
}
|
|
|
|
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",
|
|
"--allow-parallel-runners",
|
|
"--disable-all",
|
|
"--print-issued-lines=false",
|
|
"--out-format=line-number",
|
|
"--max-same-issues=100",
|
|
}
|
|
|
|
rc := extractRunContextFromComments(t, 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 == "" {
|
|
caseArgs = append(caseArgs, "--no-config")
|
|
} else {
|
|
caseArgs = append(caseArgs, "-c", cfgPath)
|
|
}
|
|
|
|
caseArgs = append(caseArgs, sourcePath)
|
|
|
|
cmd := exec.Command(binName, caseArgs...)
|
|
t.Log(caseArgs)
|
|
runGoErrchk(cmd, rc.expectedLinter, []string{sourcePath}, t)
|
|
}
|
|
}
|
|
|
|
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)
|
|
|
|
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()
|
|
}
|
|
}
|
|
|
|
func extractRunContextFromComments(t *testing.T, sourcePath string) *runContext {
|
|
f, err := os.Open(sourcePath)
|
|
require.NoError(t, err)
|
|
defer f.Close()
|
|
|
|
rc := &runContext{}
|
|
|
|
scanner := bufio.NewScanner(f)
|
|
for scanner.Scan() {
|
|
line := scanner.Text()
|
|
if strings.HasPrefix(line, "/*") {
|
|
skipMultilineComment(scanner)
|
|
continue
|
|
}
|
|
if strings.TrimSpace(line) == "" {
|
|
continue
|
|
}
|
|
if !strings.HasPrefix(line, "//") {
|
|
break
|
|
}
|
|
|
|
line = strings.TrimLeft(strings.TrimPrefix(line, "//"), " ")
|
|
if strings.HasPrefix(line, "args: ") {
|
|
require.Nil(t, rc.args)
|
|
args := strings.TrimPrefix(line, "args: ")
|
|
require.NotEmpty(t, args)
|
|
rc.args = strings.Split(args, " ")
|
|
continue
|
|
}
|
|
|
|
if strings.HasPrefix(line, "config: ") {
|
|
repr := strings.TrimPrefix(line, "config: ")
|
|
require.NotEmpty(t, repr)
|
|
if rc.config == nil {
|
|
rc.config = map[string]interface{}{}
|
|
}
|
|
buildConfigFromShortRepr(t, repr, rc.config)
|
|
continue
|
|
}
|
|
|
|
if strings.HasPrefix(line, "config_path: ") {
|
|
configPath := strings.TrimPrefix(line, "config_path: ")
|
|
require.NotEmpty(t, configPath)
|
|
rc.configPath = configPath
|
|
continue
|
|
}
|
|
|
|
if strings.HasPrefix(line, "expected_linter: ") {
|
|
expectedLinter := strings.TrimPrefix(line, "expected_linter: ")
|
|
require.NotEmpty(t, expectedLinter)
|
|
rc.expectedLinter = expectedLinter
|
|
continue
|
|
}
|
|
|
|
require.Fail(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, ",") {
|
|
if rc.expectedLinter != "" {
|
|
require.Fail(t, "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
|
|
break
|
|
}
|
|
rc.expectedLinter = arg[2:]
|
|
}
|
|
}
|
|
}
|
|
|
|
return rc
|
|
}
|
|
|
|
func TestExtractRunContextFromComments(t *testing.T) {
|
|
rc := extractRunContextFromComments(t, filepath.Join(testdataDir, "goimports", "goimports.go"))
|
|
require.Equal(t, []string{"-Egoimports"}, rc.args)
|
|
}
|
|
|
|
func TestTparallel(t *testing.T) {
|
|
t.Run("should fail on missing top-level Parallel()", func(t *testing.T) {
|
|
sourcePath := filepath.Join(testdataDir, "tparallel", "missing_toplevel_test.go")
|
|
args := []string{
|
|
"--disable-all", "--print-issued-lines=false", "--print-linter-name=false", "--out-format=line-number", "--enable", "tparallel",
|
|
sourcePath,
|
|
}
|
|
rc := extractRunContextFromComments(t, sourcePath)
|
|
args = append(args, rc.args...)
|
|
|
|
cfg, err := yaml.Marshal(rc.config)
|
|
require.NoError(t, err)
|
|
|
|
testshared.NewLintRunner(t).RunWithYamlConfig(string(cfg), 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",
|
|
)
|
|
})
|
|
|
|
t.Run("should fail on missing subtest Parallel()", func(t *testing.T) {
|
|
sourcePath := filepath.Join(testdataDir, "tparallel", "missing_subtest_test.go")
|
|
args := []string{
|
|
"--disable-all", "--print-issued-lines=false", "--print-linter-name=false", "--out-format=line-number", "--enable", "tparallel",
|
|
sourcePath,
|
|
}
|
|
rc := extractRunContextFromComments(t, sourcePath)
|
|
args = append(args, rc.args...)
|
|
|
|
cfg, err := yaml.Marshal(rc.config)
|
|
require.NoError(t, err)
|
|
|
|
testshared.NewLintRunner(t).RunWithYamlConfig(string(cfg), args...).
|
|
ExpectHasIssue(
|
|
"testdata/tparallel/missing_subtest_test.go:7:6: TestSubtests's subtests should call t.Parallel\n",
|
|
)
|
|
})
|
|
|
|
t.Run("should pass on parallel test with no subtests", func(t *testing.T) {
|
|
sourcePath := filepath.Join(testdataDir, "tparallel", "happy_path_test.go")
|
|
args := []string{
|
|
"--disable-all", "--print-issued-lines=false", "--print-linter-name=false", "--out-format=line-number", "--enable", "tparallel",
|
|
sourcePath,
|
|
}
|
|
rc := extractRunContextFromComments(t, sourcePath)
|
|
args = append(args, rc.args...)
|
|
|
|
cfg, err := yaml.Marshal(rc.config)
|
|
require.NoError(t, err)
|
|
|
|
testshared.NewLintRunner(t).RunWithYamlConfig(string(cfg), args...).ExpectNoIssues()
|
|
})
|
|
}
|