fix TeamCity printer

Changes:
- print SEVERITY;
- populate inspectionType from linter's Name and Desc;
- test escaping;
- extend .golangci.reference.yml with TeamCity;
- minor documentation fixes.

Author: alexandear

.golangci.reference.yml

@@ -2339,6 +2339,7 @@ severity:
   # - Code climate: https://docs.codeclimate.com/docs/issues#issue-severity
   # - Checkstyle: https://checkstyle.sourceforge.io/property_types.html#SeverityLevel
   # - GitHub: https://help.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-error-message
+  # - TeamCity: https://www.jetbrains.com/help/teamcity/service-messages.html#Inspection+Instance
   #
   # Default value is an empty string.
   default-severity: error

pkg/commands/run.go

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

pkg/printers/teamcity.go

@@ -7,6 +7,7 @@ import (
 	"strings"
 	"unicode/utf8"
 
+	"github.com/golangci/golangci-lint/pkg/lint/linter"
 	"github.com/golangci/golangci-lint/pkg/result"
 )
 
@@ -16,16 +17,23 @@ const (
 	largeLimit = 4000
 )
 
+// Configer used for accessing linter.Config by its name for printing instanceType values.
+type Configer interface {
+	GetLinterConfigs(name string) []*linter.Config
+}
+
 // TeamCity printer for TeamCity format.
 type TeamCity struct {
 	w       io.Writer
+	conf    Configer
 	escaper *strings.Replacer
 }
 
-// NewTeamCity output format outputs issues according to TeamCity service message format
-func NewTeamCity(w io.Writer) *TeamCity {
+// NewTeamCity output format outputs issues according to TeamCity service message format.
+func NewTeamCity(w io.Writer, conf Configer) *TeamCity {
 	return &TeamCity{
-		w: w,
+		w:    w,
+		conf: conf,
 		// https://www.jetbrains.com/help/teamcity/service-messages.html#Escaped+Values
 		escaper: strings.NewReplacer(
 			"'", "|'",
@@ -46,27 +54,30 @@ func (p *TeamCity) Print(_ context.Context, issues []result.Issue) error {
 
 		_, ok := uniqLinters[issue.FromLinter]
 		if !ok {
-			inspectionType := InspectionType{
-				id:          issue.FromLinter,
-				name:        issue.FromLinter,
-				description: issue.FromLinter,
-				category:    "Golangci-lint reports",
-			}
-
-			_, err := inspectionType.Print(p.w, p.escaper)
-			if err != nil {
-				return err
+			linterConfigs := p.conf.GetLinterConfigs(issue.FromLinter)
+			for _, config := range linterConfigs {
+				inspectionType := inspectionType{
+					id:          config.Linter.Name(),
+					name:        config.Linter.Name(),
+					description: config.Linter.Desc(),
+					category:    "Golangci-lint reports",
+				}
+
+				_, err := inspectionType.Print(p.w, p.escaper)
+				if err != nil {
+					return err
+				}
 			}
 
 			uniqLinters[issue.FromLinter] = struct{}{}
 		}
 
-		instance := InspectionInstance{
-			typeID:              issue.FromLinter,
-			message:             issue.Text,
-			file:                issue.FilePath(),
-			line:                issue.Line(),
-			additionalAttribute: strings.TrimSpace(issue.Severity),
+		instance := inspectionInstance{
+			typeID:   issue.FromLinter,
+			message:  issue.Text,
+			file:     issue.FilePath(),
+			line:     issue.Line(),
+			severity: issue.Severity,
 		}
 
 		_, err := instance.Print(p.w, p.escaper)
@@ -78,46 +89,36 @@ func (p *TeamCity) Print(_ context.Context, issues []result.Issue) error {
 	return nil
 }
 
-// InspectionType Each specific warning or an error in code (inspection instance) has an inspection type.
+// inspectionType is the unique description of the conducted inspection. Each specific warning or
+// an error in code (inspection instance) has an inspection type.
 // https://www.jetbrains.com/help/teamcity/service-messages.html#Inspection+Type
-type InspectionType struct {
+type inspectionType struct {
 	id          string // (mandatory) limited by 255 characters.
 	name        string // (mandatory) limited by 255 characters.
 	description string // (mandatory) limited by 255 characters.
 	category    string // (mandatory) limited by 4000 characters.
 }
 
-func (i InspectionType) Print(w io.Writer, escaper *strings.Replacer) (int, error) {
+func (i inspectionType) Print(w io.Writer, escaper *strings.Replacer) (int, error) {
 	return fmt.Fprintf(w, "##teamcity[inspectionType id='%s' name='%s' description='%s' category='%s']\n",
 		limit(i.id, smallLimit), limit(i.name, smallLimit), limit(escaper.Replace(i.description), largeLimit), limit(i.category, smallLimit))
 }
 
-// InspectionInstance Reports a specific defect, warning, error message.
+// inspectionInstance reports a specific defect, warning, error message.
 // Includes location, description, and various optional and custom attributes.
 // https://www.jetbrains.com/help/teamcity/service-messages.html#Inspection+Instance
-type InspectionInstance struct {
-	typeID              string // (mandatory) limited by 255 characters.
-	message             string // (optional)  limited by 4000 characters.
-	file                string // (mandatory) file path limited by 4000 characters.
-	line                int    // (optional) line of the file, integer.
-	additionalAttribute string // (optional) can be any attribute.
+type inspectionInstance struct {
+	typeID   string // (mandatory) limited by 255 characters.
+	message  string // (optional)  limited by 4000 characters.
+	file     string // (mandatory) file path limited by 4000 characters.
+	line     int    // (optional)  line of the file.
+	severity string // (optional)  severity attribute: INFO, ERROR, WARNING, WEAK WARNING.
 }
 
-func (i InspectionInstance) Print(w io.Writer, replacer *strings.Replacer) (int, error) {
-	_, err := fmt.Fprintf(w, "##teamcity[inspection typeId='%s' message='%s' file='%s' line='%d'",
-		limit(i.typeID, smallLimit), limit(replacer.Replace(i.message), largeLimit), limit(i.file, largeLimit), i.line)
-	if err != nil {
-		return 0, err
-	}
-
-	if i.additionalAttribute != "" {
-		_, err = fmt.Fprintf(w, " additional attribute='%s'", i.additionalAttribute)
-		if err != nil {
-			return 0, err
-		}
-	}
-
-	return fmt.Fprintln(w, "]")
+func (i inspectionInstance) Print(w io.Writer, replacer *strings.Replacer) (int, error) {
+	return fmt.Fprintf(w, "##teamcity[inspection typeId='%s' message='%s' file='%s' line='%d' SEVERITY='%s']\n",
+		limit(i.typeID, smallLimit), limit(replacer.Replace(i.message), largeLimit), limit(i.file, largeLimit), i.line,
+		strings.ToUpper(i.severity))
 }
 
 func limit(s string, max int) string {

pkg/printers/teamcity_test.go

@@ -9,15 +9,16 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
+	"github.com/golangci/golangci-lint/pkg/lint/linter"
 	"github.com/golangci/golangci-lint/pkg/result"
 )
 
 func TestTeamCity_Print(t *testing.T) {
 	issues := []result.Issue{
 		{
 			FromLinter: "linter-a",
-			Severity:   "error",
-			Text:       "some issue",
+			Severity:   "warning",
+			Text:       "warning issue",
 			Pos: token.Position{
 				Filename: "path/to/filea.go",
 				Offset:   2,
@@ -28,7 +29,7 @@ func TestTeamCity_Print(t *testing.T) {
 		{
 			FromLinter: "linter-a",
 			Severity:   "error",
-			Text:       "some issue 2",
+			Text:       "error issue",
 			Pos: token.Position{
 				Filename: "path/to/filea.go",
 				Offset:   2,
@@ -37,8 +38,8 @@ func TestTeamCity_Print(t *testing.T) {
 		},
 		{
 			FromLinter: "linter-b",
-			Severity:   "error",
-			Text:       "another issue",
+			Severity:   "info",
+			Text:       "info issue",
 			SourceLines: []string{
 				"func foo() {",
 				"\tfmt.Println(\"bar\")",
@@ -54,22 +55,35 @@ func TestTeamCity_Print(t *testing.T) {
 	}
 
 	buf := new(bytes.Buffer)
-	printer := NewTeamCity(buf)
+	printer := NewTeamCity(buf, configerMock(
+		map[string][]*linter.Config{
+			"linter-a": {
+				{
+					Linter: &linterMock{name: "linter-a", desc: "description for linter-a"},
+				},
+			},
+			"linter-b": {
+				{
+					Linter: &linterMock{name: "linter-b", desc: "description for linter-b with escape '\n\r|[] characters"},
+				},
+			},
+		},
+	))
 
 	err := printer.Print(context.Background(), issues)
 	require.NoError(t, err)
 
-	expected := `##teamcity[inspectionType id='linter-a' name='linter-a' description='linter-a' category='Golangci-lint reports']
-##teamcity[inspection typeId='linter-a' message='some issue' file='path/to/filea.go' line='10' additional attribute='error']
-##teamcity[inspection typeId='linter-a' message='some issue 2' file='path/to/filea.go' line='10' additional attribute='error']
-##teamcity[inspectionType id='linter-b' name='linter-b' description='linter-b' category='Golangci-lint reports']
-##teamcity[inspection typeId='linter-b' message='another issue' file='path/to/fileb.go' line='300' additional attribute='error']
+	expected := `##teamcity[inspectionType id='linter-a' name='linter-a' description='description for linter-a' category='Golangci-lint reports']
+##teamcity[inspection typeId='linter-a' message='warning issue' file='path/to/filea.go' line='10' SEVERITY='WARNING']
+##teamcity[inspection typeId='linter-a' message='error issue' file='path/to/filea.go' line='10' SEVERITY='ERROR']
+##teamcity[inspectionType id='linter-b' name='linter-b' description='description for linter-b with escape |'|n|r|||[|] characters' category='Golangci-lint reports']
+##teamcity[inspection typeId='linter-b' message='info issue' file='path/to/fileb.go' line='300' SEVERITY='INFO']
 `
 
 	assert.Equal(t, expected, buf.String())
 }
 
-func TestLimit(t *testing.T) {
+func TestTeamCity_limit(t *testing.T) {
 	tests := []struct {
 		input    string
 		max      int
@@ -106,3 +120,19 @@ func TestLimit(t *testing.T) {
 		require.Equal(t, tc.expected, limit(tc.input, tc.max))
 	}
 }
+
+type configerMock map[string][]*linter.Config
+
+func (c configerMock) GetLinterConfigs(name string) []*linter.Config {
+	return c[name]
+}
+
+type linterMock struct {
+	linter.Noop
+	name string
+	desc string
+}
+
+func (l linterMock) Name() string { return l.name }
+
+func (l linterMock) Desc() string { return l.desc }