feat: add team city output format

fixes #3597

Author: ferhatelmas

pkg/commands/run.go

@@ -494,6 +494,8 @@ func (e *Executor) createPrinter(format string, w io.Writer) (printers.Printer,
 		p = printers.NewJunitXML(w)
 	case config.OutFormatGithubActions:
 		p = printers.NewGithub(w)
+	case config.OutFormatTeamCity:
+		p = printers.NewTeamCity(&e.reportData, w, nil)
 	default:
 		return nil, fmt.Errorf("unknown output format %s", format)
 	}

pkg/config/output.go

@@ -10,6 +10,7 @@ const (
 	OutFormatHTML              = "html"
 	OutFormatJunitXML          = "junit-xml"
 	OutFormatGithubActions     = "github-actions"
+	OutFormatTeamCity          = "team-city"
 )
 
 var OutFormats = []string{
@@ -22,6 +23,7 @@ var OutFormats = []string{
 	OutFormatHTML,
 	OutFormatJunitXML,
 	OutFormatGithubActions,
+	OutFormatTeamCity,
 }
 
 type Output struct {

pkg/printers/teamcity.go

@@ -0,0 +1,151 @@
+package printers
+
+import (
+	"bytes"
+	"context"
+	"fmt"
+	"io"
+	"sort"
+	"strings"
+	"time"
+
+	"github.com/golangci/golangci-lint/pkg/report"
+	"github.com/golangci/golangci-lint/pkg/result"
+)
+
+const (
+	timestampFormat = "2006-01-02T15:04:05.000"
+	testStarted     = "##teamcity[testStarted timestamp='%s' name='%s']\n"
+	testStdErr      = "##teamcity[testStdErr timestamp='%s' name='%s' out='%s']\n"
+	testFailed      = "##teamcity[testFailed timestamp='%s' name='%s']\n"
+	testIgnored     = "##teamcity[testIgnored timestamp='%s' name='%s']\n"
+	testFinished    = "##teamcity[testFinished timestamp='%s' name='%s']\n"
+)
+
+type teamcityLinter struct {
+	data   *report.LinterData
+	issues []string
+}
+
+func (l *teamcityLinter) getName() string {
+	return fmt.Sprintf("linter: %s", l.data.Name)
+}
+
+func (l *teamcityLinter) failed() bool {
+	return len(l.issues) > 0
+}
+
+type teamcity struct {
+	linters map[string]*teamcityLinter
+	w       io.Writer
+	err     error
+	now     now
+}
+
+type now func() string
+
+// NewTeamCity output format outputs issues according to TeamCity service message format
+func NewTeamCity(rd *report.Data, w io.Writer, nower now) Printer {
+	t := &teamcity{
+		linters: map[string]*teamcityLinter{},
+		w:       w,
+		now:     nower,
+	}
+	if t.now == nil {
+		t.now = func() string {
+			return time.Now().Format(timestampFormat)
+		}
+	}
+	for i, l := range rd.Linters {
+		t.linters[l.Name] = &teamcityLinter{
+			data: &rd.Linters[i],
+		}
+	}
+	return t
+}
+
+func (p *teamcity) getSortedLinterNames() []string {
+	names := make([]string, 0, len(p.linters))
+	for name := range p.linters {
+		names = append(names, name)
+	}
+	sort.Strings(names)
+	return names
+}
+
+// escape transforms strings for TeamCity service messages
+// https://www.jetbrains.com/help/teamcity/service-messages.html#Escaped+values
+func (p *teamcity) escape(s string) string {
+	var buf bytes.Buffer
+	for {
+		nextSpecial := strings.IndexAny(s, "'\n\r|[]")
+		switch nextSpecial {
+		case -1:
+			if buf.Len() == 0 {
+				return s
+			}
+			return buf.String() + s
+		case 0:
+		default:
+			buf.WriteString(s[:nextSpecial])
+		}
+		switch s[nextSpecial] {
+		case '\'':
+			buf.WriteString("|'")
+		case '\n':
+			buf.WriteString("|n")
+		case '\r':
+			buf.WriteString("|r")
+		case '|':
+			buf.WriteString("||")
+		case '[':
+			buf.WriteString("|[")
+		case ']':
+			buf.WriteString("|]")
+		}
+		s = s[nextSpecial+1:]
+	}
+}
+
+func (p *teamcity) print(format string, args ...any) {
+	if p.err != nil {
+		return
+	}
+	args = append([]any{p.now()}, args...)
+	_, p.err = fmt.Fprintf(p.w, format, args...)
+}
+
+func (p *teamcity) Print(_ context.Context, issues []result.Issue) error {
+	for i := range issues {
+		issue := &issues[i]
+
+		var col string
+		if issue.Pos.Column != 0 {
+			col = fmt.Sprintf(":%d", issue.Pos.Column)
+		}
+
+		formatted := fmt.Sprintf("%s:%v%s - %s", issue.FilePath(), issue.Line(), col, issue.Text)
+		p.linters[issue.FromLinter].issues = append(p.linters[issue.FromLinter].issues, formatted)
+	}
+
+	for _, linterName := range p.getSortedLinterNames() {
+		linter := p.linters[linterName]
+
+		name := p.escape(linter.getName())
+		p.print(testStarted, name)
+		if !linter.data.Enabled && !linter.data.EnabledByDefault {
+			p.print(testIgnored, name)
+			continue
+		}
+
+		if linter.failed() {
+			for _, issue := range linter.issues {
+				p.print(testStdErr, name, p.escape(issue))
+			}
+			p.print(testFailed, name)
+		} else {
+			p.print(testFinished, name)
+		}
+	}
+	return p.err
+}

pkg/printers/teamcity_test.go

@@ -0,0 +1,82 @@
+//nolint:dupl
+package printers
+
+import (
+	"bytes"
+	"context"
+	"go/token"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	"github.com/golangci/golangci-lint/pkg/report"
+	"github.com/golangci/golangci-lint/pkg/result"
+)
+
+func TestTeamCity_Print(t *testing.T) {
+	issues := []result.Issue{
+		{
+			FromLinter: "linter-a",
+			Severity:   "error",
+			Text:       "some issue",
+			Pos: token.Position{
+				Filename: "path/to/filea.go",
+				Offset:   2,
+				Line:     10,
+				Column:   4,
+			},
+		},
+		{
+			FromLinter: "linter-a",
+			Severity:   "error",
+			Text:       "some issue 2",
+			Pos: token.Position{
+				Filename: "path/to/filea.go",
+				Offset:   2,
+				Line:     10,
+			},
+		},
+		{
+			FromLinter: "linter-b",
+			Severity:   "error",
+			Text:       "another issue",
+			SourceLines: []string{
+				"func foo() {",
+				"\tfmt.Println(\"bar\")",
+				"}",
+			},
+			Pos: token.Position{
+				Filename: "path/to/fileb.go",
+				Offset:   5,
+				Line:     300,
+				Column:   9,
+			},
+		},
+	}
+
+	buf := new(bytes.Buffer)
+	rd := &report.Data{
+		Linters: []report.LinterData{
+			{Name: "linter-a", Enabled: true},
+			{Name: "linter-b", Enabled: false},
+		},
+	}
+	nower := func() string {
+		return "2023-02-17T15:42:23.630"
+	}
+	printer := NewTeamCity(rd, buf, nower)
+
+	err := printer.Print(context.Background(), issues)
+	require.NoError(t, err)
+
+	expected := `##teamcity[testStarted timestamp='2023-02-17T15:42:23.630' name='linter: linter-a']
+##teamcity[testStdErr timestamp='2023-02-17T15:42:23.630' name='linter: linter-a' out='path/to/filea.go:10:4 - some issue']
+##teamcity[testStdErr timestamp='2023-02-17T15:42:23.630' name='linter: linter-a' out='path/to/filea.go:10 - some issue 2']
+##teamcity[testFailed timestamp='2023-02-17T15:42:23.630' name='linter: linter-a']
+##teamcity[testStarted timestamp='2023-02-17T15:42:23.630' name='linter: linter-b']
+##teamcity[testIgnored timestamp='2023-02-17T15:42:23.630' name='linter: linter-b']
+`
+
+	assert.Equal(t, expected, buf.String())
+}