reporters

Documentation

Index

• type JSONReporter
  • func (r JSONReporter) Report(w io.Writer, fs []report.Failure) error
• type JUnitFailure
• type JUnitReporter
  • func (r JUnitReporter) Report(w io.Writer, fs []report.Failure) error
• type JUnitTestCase
• type JUnitTestSuite
• type JUnitTestSuites
• type PlainReporter
  • func (r PlainReporter) Report(w io.Writer, fs []report.Failure) error
• type SarifReporter
  • func (r SarifReporter) Report(w io.Writer, fs []report.Failure) error
• type UnixReporter
  • func (r UnixReporter) Report(w io.Writer, fs []report.Failure) error

Types

type JSONReporter

type JSONReporter struct{}

JSONReporter prints failures as a single JSON struct, allowing for simple machine-readable output.

The format is:

 {
		"lints":
			[
				{"filename": FILENAME, "line": LINE, "column": COL, "message": MESSAGE, "rule": RULE}
			],
 }

func (JSONReporter) Report

func (r JSONReporter) Report(w io.Writer, fs []report.Failure) error

Report writes failures to w.

type JUnitFailure

type JUnitFailure struct {
	Message  string `xml:"message,attr"`
	Type     string `xml:"type,attr"`
	Contents string `xml:",cdata"`
}

JUnitFailure contains data related to a failed test.

type JUnitReporter

type JUnitReporter struct{}

JUnitReporter prints failures in JUnit XML format.

func (JUnitReporter) Report

func (r JUnitReporter) Report(w io.Writer, fs []report.Failure) error

Report writes failures to w.

type JUnitTestCase

type JUnitTestCase struct {
	XMLName   xml.Name      `xml:"testcase"`
	ClassName string        `xml:"classname,attr"`
	Name      string        `xml:"name,attr"`
	Time      string        `xml:"time,attr"`
	Failure   *JUnitFailure `xml:"failure,omitempty"`
}

JUnitTestCase is a single test case with its result.

type JUnitTestSuite

type JUnitTestSuite struct {
	XMLName   xml.Name `xml:"testsuite"`
	Package   string   `xml:"package"`
	Tests     int      `xml:"tests,attr"`
	Failures  int      `xml:"failures,attr"`
	Time      string   `xml:"time,attr"`
	TestCases []JUnitTestCase
}

JUnitTestSuite is a single JUnit test suite which may contain many testcases.

type JUnitTestSuites

type JUnitTestSuites struct {
	XMLName xml.Name `xml:"testsuites"`
	Suites  []JUnitTestSuite
}

JUnitTestSuites is a collection of JUnit test suites.

type PlainReporter

type PlainReporter struct{}

PlainReporter prints failures as it is.

func (PlainReporter) Report

func (r PlainReporter) Report(w io.Writer, fs []report.Failure) error

Report writes failures to w.

type SarifReporter

type SarifReporter struct{}

SarifReporter creates reports formatted as a JSON Document. The document format is used according to the SARIF Standard. Refer to http://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html for details to the format.

func (SarifReporter) Report

func (r SarifReporter) Report(w io.Writer, fs []report.Failure) error

Report writes failures to w formatted as a SARIF document.

type UnixReporter

type UnixReporter struct{}

UnixReporter prints failures as it respects Unix output conventions those are frequently employed by preprocessors and compilers.

The format is "FILENAME:LINE:COL: MESSAGE".

func (UnixReporter) Report

func (r UnixReporter) Report(w io.Writer, fs []report.Failure) error

Report writes failures to w.