golangci-lint/test/output_test.go

98 lines
2.9 KiB
Go

package test
import (
"fmt"
"os"
"path/filepath"
"testing"
"github.com/stretchr/testify/require"
"github.com/golangci/golangci-lint/pkg/exitcodes"
"github.com/golangci/golangci-lint/test/testshared"
)
//nolint:misspell // misspelling is intentional
const expectedJSONOutput = `{"Issues":[{"FromLinter":"misspell","Text":"` + "`" + `occured` + "`" + ` is a misspelling of ` + "`" + `occurred` + "`" + `","Severity":"","SourceLines":["\t// comment with incorrect spelling: occured // want \"` + "`" + `occured` + "`" + ` is a misspelling of ` + "`" + `occurred` + "`" + `\""],"Replacement":{"NeedOnlyDelete":false,"NewLines":null,"Inline":{"StartCol":37,"Length":7,"NewString":"occurred"}},"Pos":{"Filename":"testdata/misspell.go","Offset":0,"Line":6,"Column":38},"ExpectNoLint":false,"ExpectedNoLintLinter":""}]`
func TestOutput_lineNumber(t *testing.T) {
sourcePath := filepath.Join(testdataDir, "misspell.go")
testshared.NewRunnerBuilder(t).
WithArgs(
"--disable-all",
"--print-issued-lines=false",
"--print-linter-name=false",
"--out-format=line-number",
).
WithDirectives(sourcePath).
WithTargetPath(sourcePath).
Runner().
Install().
Run().
//nolint:misspell // misspelling is intentional
ExpectHasIssue("testdata/misspell.go:6:38: `occured` is a misspelling of `occurred`")
}
func TestOutput_Stderr(t *testing.T) {
sourcePath := filepath.Join(testdataDir, "misspell.go")
testshared.NewRunnerBuilder(t).
WithArgs(
"--disable-all",
"--print-issued-lines=false",
"--print-linter-name=false",
"--out-format=json:stderr",
).
WithDirectives(sourcePath).
WithTargetPath(sourcePath).
Runner().
Install().
Run().
ExpectHasIssue(testshared.NormalizeFilePathInJSON(expectedJSONOutput))
}
func TestOutput_File(t *testing.T) {
resultPath := filepath.Join(t.TempDir(), "golangci_lint_test_result")
sourcePath := filepath.Join(testdataDir, "misspell.go")
testshared.NewRunnerBuilder(t).
WithArgs(
"--disable-all",
"--print-issued-lines=false",
"--print-linter-name=false",
fmt.Sprintf("--out-format=json:%s", resultPath),
).
WithDirectives(sourcePath).
WithTargetPath(sourcePath).
Runner().
Install().
Run().
ExpectExitCode(exitcodes.IssuesFound)
b, err := os.ReadFile(resultPath)
require.NoError(t, err)
require.Contains(t, string(b), testshared.NormalizeFilePathInJSON(expectedJSONOutput))
}
func TestOutput_Multiple(t *testing.T) {
sourcePath := filepath.Join(testdataDir, "misspell.go")
testshared.NewRunnerBuilder(t).
WithArgs(
"--disable-all",
"--print-issued-lines=false",
"--print-linter-name=false",
"--out-format=line-number,json:stdout",
).
WithDirectives(sourcePath).
WithTargetPath(sourcePath).
Runner().
Install().
Run().
//nolint:misspell // misspelling is intentional
ExpectHasIssue("testdata/misspell.go:6:38: `occured` is a misspelling of `occurred`").
ExpectOutputContains(testshared.NormalizeFilePathInJSON(expectedJSONOutput))
}