Add support for multiple outputs (#2386)

lafriks · web-flow · commit d20938962545 · 2022-01-04T21:36:27.000+01:00
diff --git a/.golangci.example.yml b/.golangci.example.yml
@@ -62,6 +62,10 @@ run:
 output:
   # colored-line-number|line-number|json|tab|checkstyle|code-climate|junit-xml|github-actions
   # default is "colored-line-number"
+  # multiple can be specified by separating them by comma, output can be provided
+  # for each of them by separating format name and path by colon symbol.
+  # Output path can be either `stdout`, `stderr` or path to the file to write to.
+  # Example "checkstyle:report.json,colored-line-number"
   format: colored-line-number
 
   # print lines of code with issue, default is true
diff --git a/pkg/commands/run.go b/pkg/commands/run.go
@@ -26,6 +26,8 @@ import (
 	"github.com/golangci/golangci-lint/pkg/result/processors"
 )
 
+const defaultFileMode = 0644
+
 func getDefaultIssueExcludeHelp() string {
 	parts := []string{"Use or not use default excludes:"}
 	for _, ep := range config.DefaultExcludePatterns {
@@ -400,44 +402,89 @@ func (e *Executor) runAndPrint(ctx context.Context, args []string) error {
 		return err // XXX: don't loose type
 	}
 
-	p, err := e.createPrinter()
-	if err != nil {
-		return err
+	formats := strings.Split(e.cfg.Output.Format, ",")
+	for _, format := range formats {
+		out := strings.SplitN(format, ":", 2)
+		if len(out) < 2 {
+			out = append(out, "")
+		}
+
+		err := e.printReports(ctx, issues, out[1], out[0])
+		if err != nil {
+			return err
+		}
 	}
 
 	e.setExitCodeIfIssuesFound(issues)
 
+	e.fileCache.PrintStats(e.log)
+
+	return nil
+}
+
+func (e *Executor) printReports(ctx context.Context, issues []result.Issue, path, format string) error {
+	w, shouldClose, err := e.createWriter(path)
+	if err != nil {
+		return fmt.Errorf("can't create output for %s: %w", path, err)
+	}
+
+	p, err := e.createPrinter(format, w)
+	if err != nil {
+		if file, ok := w.(io.Closer); shouldClose && ok {
+			_ = file.Close()
+		}
+		return err
+	}
+
 	if err = p.Print(ctx, issues); err != nil {
+		if file, ok := w.(io.Closer); shouldClose && ok {
+			_ = file.Close()
+		}
 		return fmt.Errorf("can't print %d issues: %s", len(issues), err)
 	}
 
-	e.fileCache.PrintStats(e.log)
+	if file, ok := w.(io.Closer); shouldClose && ok {
+		_ = file.Close()
+	}
 
 	return nil
 }
 
-func (e *Executor) createPrinter() (printers.Printer, error) {
+func (e *Executor) createWriter(path string) (io.Writer, bool, error) {
+	if path == "" || path == "stdout" {
+		return logutils.StdOut, false, nil
+	}
+	if path == "stderr" {
+		return logutils.StdErr, false, nil
+	}
+	f, err := os.OpenFile(path, os.O_CREATE|os.O_TRUNC|os.O_WRONLY, defaultFileMode)
+	if err != nil {
+		return nil, false, err
+	}
+	return f, true, nil
+}
+
+func (e *Executor) createPrinter(format string, w io.Writer) (printers.Printer, error) {
 	var p printers.Printer
-	format := e.cfg.Output.Format
 	switch format {
 	case config.OutFormatJSON:
-		p = printers.NewJSON(&e.reportData)
+		p = printers.NewJSON(&e.reportData, w)
 	case config.OutFormatColoredLineNumber, config.OutFormatLineNumber:
 		p = printers.NewText(e.cfg.Output.PrintIssuedLine,
 			format == config.OutFormatColoredLineNumber, e.cfg.Output.PrintLinterName,
-			e.log.Child("text_printer"))
+			e.log.Child("text_printer"), w)
 	case config.OutFormatTab:
-		p = printers.NewTab(e.cfg.Output.PrintLinterName, e.log.Child("tab_printer"))
+		p = printers.NewTab(e.cfg.Output.PrintLinterName, e.log.Child("tab_printer"), w)
 	case config.OutFormatCheckstyle:
-		p = printers.NewCheckstyle()
+		p = printers.NewCheckstyle(w)
 	case config.OutFormatCodeClimate:
-		p = printers.NewCodeClimate()
+		p = printers.NewCodeClimate(w)
 	case config.OutFormatHTML:
-		p = printers.NewHTML()
+		p = printers.NewHTML(w)
 	case config.OutFormatJunitXML:
-		p = printers.NewJunitXML()
+		p = printers.NewJunitXML(w)
 	case config.OutFormatGithubActions:
-		p = printers.NewGithub()
+		p = printers.NewGithub(w)
 	default:
 		return nil, fmt.Errorf("unknown output format %s", format)
 	}
diff --git a/pkg/printers/checkstyle.go b/pkg/printers/checkstyle.go
@@ -4,10 +4,10 @@ import (
 	"context"
 	"encoding/xml"
 	"fmt"
+	"io"
 
 	"github.com/go-xmlfmt/xmlfmt"
 
-	"github.com/golangci/golangci-lint/pkg/logutils"
 	"github.com/golangci/golangci-lint/pkg/result"
 )
 
@@ -32,13 +32,15 @@ type checkstyleError struct {
 
 const defaultCheckstyleSeverity = "error"
 
-type Checkstyle struct{}
+type Checkstyle struct {
+	w io.Writer
+}
 
-func NewCheckstyle() *Checkstyle {
-	return &Checkstyle{}
+func NewCheckstyle(w io.Writer) *Checkstyle {
+	return &Checkstyle{w: w}
 }
 
-func (Checkstyle) Print(ctx context.Context, issues []result.Issue) error {
+func (p Checkstyle) Print(ctx context.Context, issues []result.Issue) error {
 	out := checkstyleOutput{
 		Version: "5.0",
 	}
@@ -82,6 +84,10 @@ func (Checkstyle) Print(ctx context.Context, issues []result.Issue) error {
 		return err
 	}
 
-	fmt.Fprintf(logutils.StdOut, "%s%s\n", xml.Header, xmlfmt.FormatXML(string(data), "", "  "))
+	_, err = fmt.Fprintf(p.w, "%s%s\n", xml.Header, xmlfmt.FormatXML(string(data), "", "  "))
+	if err != nil {
+		return err
+	}
+
 	return nil
 }
diff --git a/pkg/printers/codeclimate.go b/pkg/printers/codeclimate.go
@@ -4,8 +4,8 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"io"
 
-	"github.com/golangci/golangci-lint/pkg/logutils"
 	"github.com/golangci/golangci-lint/pkg/result"
 )
 
@@ -24,10 +24,11 @@ type CodeClimateIssue struct {
 }
 
 type CodeClimate struct {
+	w io.Writer
 }
 
-func NewCodeClimate() *CodeClimate {
-	return &CodeClimate{}
+func NewCodeClimate(w io.Writer) *CodeClimate {
+	return &CodeClimate{w: w}
 }
 
 func (p CodeClimate) Print(ctx context.Context, issues []result.Issue) error {
@@ -52,6 +53,9 @@ func (p CodeClimate) Print(ctx context.Context, issues []result.Issue) error {
 		return err
 	}
 
-	fmt.Fprint(logutils.StdOut, string(outputJSON))
+	_, err = fmt.Fprint(p.w, string(outputJSON))
+	if err != nil {
+		return err
+	}
 	return nil
 }
diff --git a/pkg/printers/github.go b/pkg/printers/github.go
@@ -3,20 +3,21 @@ package printers
 import (
 	"context"
 	"fmt"
+	"io"
 
-	"github.com/golangci/golangci-lint/pkg/logutils"
 	"github.com/golangci/golangci-lint/pkg/result"
 )
 
 type github struct {
+	w io.Writer
 }
 
 const defaultGithubSeverity = "error"
 
 // NewGithub output format outputs issues according to GitHub actions format:
 // https://help.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-error-message
-func NewGithub() Printer {
-	return &github{}
+func NewGithub(w io.Writer) Printer {
+	return &github{w: w}
 }
 
 // print each line as: ::error file=app.js,line=10,col=15::Something went wrong
@@ -35,9 +36,9 @@ func formatIssueAsGithub(issue *result.Issue) string {
 	return ret
 }
 
-func (g *github) Print(_ context.Context, issues []result.Issue) error {
+func (p *github) Print(_ context.Context, issues []result.Issue) error {
 	for ind := range issues {
-		_, err := fmt.Fprintln(logutils.StdOut, formatIssueAsGithub(&issues[ind]))
+		_, err := fmt.Fprintln(p.w, formatIssueAsGithub(&issues[ind]))
 		if err != nil {
 			return err
 		}
diff --git a/pkg/printers/html.go b/pkg/printers/html.go
@@ -4,9 +4,9 @@ import (
 	"context"
 	"fmt"
 	"html/template"
+	"io"
 	"strings"
 
-	"github.com/golangci/golangci-lint/pkg/logutils"
 	"github.com/golangci/golangci-lint/pkg/result"
 )
 
@@ -123,13 +123,15 @@ type htmlIssue struct {
 	Code   string
 }
 
-type HTML struct{}
+type HTML struct {
+	w io.Writer
+}
 
-func NewHTML() *HTML {
-	return &HTML{}
+func NewHTML(w io.Writer) *HTML {
+	return &HTML{w: w}
 }
 
-func (h HTML) Print(_ context.Context, issues []result.Issue) error {
+func (p HTML) Print(_ context.Context, issues []result.Issue) error {
 	var htmlIssues []htmlIssue
 
 	for i := range issues {
@@ -151,5 +153,5 @@ func (h HTML) Print(_ context.Context, issues []result.Issue) error {
 		return err
 	}
 
-	return t.Execute(logutils.StdOut, struct{ Issues []htmlIssue }{Issues: htmlIssues})
+	return t.Execute(p.w, struct{ Issues []htmlIssue }{Issues: htmlIssues})
 }
diff --git a/pkg/printers/json.go b/pkg/printers/json.go
@@ -3,20 +3,21 @@ package printers
 import (
 	"context"
 	"encoding/json"
-	"fmt"
+	"io"
 
-	"github.com/golangci/golangci-lint/pkg/logutils"
 	"github.com/golangci/golangci-lint/pkg/report"
 	"github.com/golangci/golangci-lint/pkg/result"
 )
 
 type JSON struct {
 	rd *report.Data
+	w  io.Writer
 }
 
-func NewJSON(rd *report.Data) *JSON {
+func NewJSON(rd *report.Data, w io.Writer) *JSON {
 	return &JSON{
 		rd: rd,
+		w:  w,
 	}
 }
 
@@ -34,11 +35,5 @@ func (p JSON) Print(ctx context.Context, issues []result.Issue) error {
 		res.Issues = []result.Issue{}
 	}
 
-	outputJSON, err := json.Marshal(res)
-	if err != nil {
-		return err
-	}
-
-	fmt.Fprint(logutils.StdOut, string(outputJSON))
-	return nil
+	return json.NewEncoder(p.w).Encode(res)
 }
diff --git a/pkg/printers/junitxml.go b/pkg/printers/junitxml.go
@@ -3,9 +3,9 @@ package printers
 import (
 	"context"
 	"encoding/xml"
+	"io"
 	"strings"
 
-	"github.com/golangci/golangci-lint/pkg/logutils"
 	"github.com/golangci/golangci-lint/pkg/result"
 )
 
@@ -35,13 +35,14 @@ type failureXML struct {
 }
 
 type JunitXML struct {
+	w io.Writer
 }
 
-func NewJunitXML() *JunitXML {
-	return &JunitXML{}
+func NewJunitXML(w io.Writer) *JunitXML {
+	return &JunitXML{w: w}
 }
 
-func (JunitXML) Print(ctx context.Context, issues []result.Issue) error {
+func (p JunitXML) Print(ctx context.Context, issues []result.Issue) error {
 	suites := make(map[string]testSuiteXML) // use a map to group by file
 
 	for ind := range issues {
@@ -70,7 +71,7 @@ func (JunitXML) Print(ctx context.Context, issues []result.Issue) error {
 		res.TestSuites = append(res.TestSuites, val)
 	}
 
-	enc := xml.NewEncoder(logutils.StdOut)
+	enc := xml.NewEncoder(p.w)
 	enc.Indent("", "  ")
 	if err := enc.Encode(res); err != nil {
 		return err
diff --git a/pkg/printers/tab.go b/pkg/printers/tab.go
@@ -15,12 +15,14 @@ import (
 type Tab struct {
 	printLinterName bool
 	log             logutils.Log
+	w               io.Writer
 }
 
-func NewTab(printLinterName bool, log logutils.Log) *Tab {
+func NewTab(printLinterName bool, log logutils.Log, w io.Writer) *Tab {
 	return &Tab{
 		printLinterName: printLinterName,
 		log:             log,
+		w:               w,
 	}
 }
 
@@ -30,7 +32,7 @@ func (p Tab) SprintfColored(ca color.Attribute, format string, args ...interface
 }
 
 func (p *Tab) Print(ctx context.Context, issues []result.Issue) error {
-	w := tabwriter.NewWriter(logutils.StdOut, 0, 0, 2, ' ', 0)
+	w := tabwriter.NewWriter(p.w, 0, 0, 2, ' ', 0)
 
 	for i := range issues {
 		p.printIssue(&issues[i], w)
diff --git a/pkg/printers/text.go b/pkg/printers/text.go
diff --git a/test/linters_test.go b/test/linters_test.go
diff --git a/test/testshared/testshared.go b/test/testshared/testshared.go

Original file line number	Diff line number	Diff line change
`@@ -4,8 +4,8 @@ import (`
`4`	`4`	`"context"`
`5`	`5`	`"encoding/json"`
`6`	`6`	`"fmt"`
	`7`	`+ "io"`
`7`	`8`
`8`		`- "github.com/golangci/golangci-lint/pkg/logutils"`
`9`	`9`	`"github.com/golangci/golangci-lint/pkg/result"`
`10`	`10`	`)`
`11`	`11`
`@@ -24,10 +24,11 @@ type CodeClimateIssue struct {`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`type CodeClimate struct {`
	`27`	`+ w io.Writer`
`27`	`28`	`}`
`28`	`29`
`29`		`-func NewCodeClimate() *CodeClimate {`
`30`		`- return &CodeClimate{}`
	`30`	`+func NewCodeClimate(w io.Writer) *CodeClimate {`
	`31`	`+ return &CodeClimate{w: w}`
`31`	`32`	`}`
`32`	`33`
`33`	`34`	`func (p CodeClimate) Print(ctx context.Context, issues []result.Issue) error {`
`@@ -52,6 +53,9 @@ func (p CodeClimate) Print(ctx context.Context, issues []result.Issue) error {`
`52`	`53`	`return err`
`53`	`54`	`}`
`54`	`55`
`55`		`- fmt.Fprint(logutils.StdOut, string(outputJSON))`
	`56`	`+ _, err = fmt.Fprint(p.w, string(outputJSON))`
	`57`	`+ if err != nil {`
	`58`	`+ return err`
	`59`	`+ }`
`56`	`60`	`return nil`
`57`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,9 +4,9 @@ import (`
`4`	`4`	`"context"`
`5`	`5`	`"fmt"`
`6`	`6`	`"html/template"`
	`7`	`+ "io"`
`7`	`8`	`"strings"`
`8`	`9`
`9`		`- "github.com/golangci/golangci-lint/pkg/logutils"`
`10`	`10`	`"github.com/golangci/golangci-lint/pkg/result"`
`11`	`11`	`)`
`12`	`12`
`@@ -123,13 +123,15 @@ type htmlIssue struct {`
`123`	`123`	`Code string`
`124`	`124`	`}`
`125`	`125`
`126`		`-type HTML struct{}`
	`126`	`+type HTML struct {`
	`127`	`+ w io.Writer`
	`128`	`+}`
`127`	`129`
`128`		`-func NewHTML() *HTML {`
`129`		`- return &HTML{}`
	`130`	`+func NewHTML(w io.Writer) *HTML {`
	`131`	`+ return &HTML{w: w}`
`130`	`132`	`}`
`131`	`133`
`132`		`-func (h HTML) Print(_ context.Context, issues []result.Issue) error {`
	`134`	`+func (p HTML) Print(_ context.Context, issues []result.Issue) error {`
`133`	`135`	`var htmlIssues []htmlIssue`
`134`	`136`
`135`	`137`	`for i := range issues {`
`@@ -151,5 +153,5 @@ func (h HTML) Print(_ context.Context, issues []result.Issue) error {`
`151`	`153`	`return err`
`152`	`154`	`}`
`153`	`155`
`154`		`- return t.Execute(logutils.StdOut, struct{ Issues []htmlIssue }{Issues: htmlIssues})`
	`156`	`+ return t.Execute(p.w, struct{ Issues []htmlIssue }{Issues: htmlIssues})`
`155`	`157`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,20 +3,21 @@ package printers`
`3`	`3`	`import (`
`4`	`4`	`"context"`
`5`	`5`	`"encoding/json"`
`6`		`- "fmt"`
	`6`	`+ "io"`
`7`	`7`
`8`		`- "github.com/golangci/golangci-lint/pkg/logutils"`
`9`	`8`	`"github.com/golangci/golangci-lint/pkg/report"`
`10`	`9`	`"github.com/golangci/golangci-lint/pkg/result"`
`11`	`10`	`)`
`12`	`11`
`13`	`12`	`type JSON struct {`
`14`	`13`	`rd *report.Data`
	`14`	`+ w io.Writer`
`15`	`15`	`}`
`16`	`16`
`17`		`-func NewJSON(rd report.Data) JSON {`
	`17`	`+func NewJSON(rd report.Data, w io.Writer) JSON {`
`18`	`18`	`return &JSON{`
`19`	`19`	`rd: rd,`
	`20`	`+ w: w,`
`20`	`21`	`}`
`21`	`22`	`}`
`22`	`23`
`@@ -34,11 +35,5 @@ func (p JSON) Print(ctx context.Context, issues []result.Issue) error {`
`34`	`35`	`res.Issues = []result.Issue{}`
`35`	`36`	`}`
`36`	`37`
`37`		`- outputJSON, err := json.Marshal(res)`
`38`		`- if err != nil {`
`39`		`- return err`
`40`		`- }`
`41`		`-`
`42`		`- fmt.Fprint(logutils.StdOut, string(outputJSON))`
`43`		`- return nil`
	`38`	`+ return json.NewEncoder(p.w).Encode(res)`
`44`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,9 +3,9 @@ package printers`
`3`	`3`	`import (`
`4`	`4`	`"context"`
`5`	`5`	`"encoding/xml"`
	`6`	`+ "io"`
`6`	`7`	`"strings"`
`7`	`8`
`8`		`- "github.com/golangci/golangci-lint/pkg/logutils"`
`9`	`9`	`"github.com/golangci/golangci-lint/pkg/result"`
`10`	`10`	`)`
`11`	`11`
`@@ -35,13 +35,14 @@ type failureXML struct {`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`type JunitXML struct {`
	`38`	`+ w io.Writer`
`38`	`39`	`}`
`39`	`40`
`40`		`-func NewJunitXML() *JunitXML {`
`41`		`- return &JunitXML{}`
	`41`	`+func NewJunitXML(w io.Writer) *JunitXML {`
	`42`	`+ return &JunitXML{w: w}`
`42`	`43`	`}`
`43`	`44`
`44`		`-func (JunitXML) Print(ctx context.Context, issues []result.Issue) error {`
	`45`	`+func (p JunitXML) Print(ctx context.Context, issues []result.Issue) error {`
`45`	`46`	`suites := make(map[string]testSuiteXML) // use a map to group by file`
`46`	`47`
`47`	`48`	`for ind := range issues {`
`@@ -70,7 +71,7 @@ func (JunitXML) Print(ctx context.Context, issues []result.Issue) error {`
`70`	`71`	`res.TestSuites = append(res.TestSuites, val)`
`71`	`72`	`}`
`72`	`73`
`73`		`- enc := xml.NewEncoder(logutils.StdOut)`
	`74`	`+ enc := xml.NewEncoder(p.w)`
`74`	`75`	`enc.Indent("", " ")`
`75`	`76`	`if err := enc.Encode(res); err != nil {`
`76`	`77`	`return err`
Original file line number	Diff line number	Diff line change
`@@ -15,12 +15,14 @@ import (`
`15`	`15`	`type Tab struct {`
`16`	`16`	`printLinterName bool`
`17`	`17`	`log logutils.Log`
	`18`	`+ w io.Writer`
`18`	`19`	`}`
`19`	`20`
`20`		`-func NewTab(printLinterName bool, log logutils.Log) *Tab {`
	`21`	`+func NewTab(printLinterName bool, log logutils.Log, w io.Writer) *Tab {`
`21`	`22`	`return &Tab{`
`22`	`23`	`printLinterName: printLinterName,`
`23`	`24`	`log: log,`
	`25`	`+ w: w,`
`24`	`26`	`}`
`25`	`27`	`}`
`26`	`28`
`@@ -30,7 +32,7 @@ func (p Tab) SprintfColored(ca color.Attribute, format string, args ...interface`
`30`	`32`	`}`
`31`	`33`
`32`	`34`	`func (p *Tab) Print(ctx context.Context, issues []result.Issue) error {`
`33`		`- w := tabwriter.NewWriter(logutils.StdOut, 0, 0, 2, ' ', 0)`
	`35`	`+ w := tabwriter.NewWriter(p.w, 0, 0, 2, ' ', 0)`
`34`	`36`
`35`	`37`	`for i := range issues {`
`36`	`38`	`p.printIssue(&issues[i], w)`