reporter

Documentation

Index

• type CsvReportingConfig
• type JsonReportingConfig
• type MarkdownReportingConfig
• type MarkdownSummaryReporterConfig
• type Reporter
  • func NewConsoleReporter() (Reporter, error)
  • func NewCsvReporter(config CsvReportingConfig) (Reporter, error)
  • func NewDotGraphReporter(directory string) (Reporter, error)
  • func NewJsonReportGenerator(config JsonReportingConfig) (Reporter, error)
  • func NewMarkdownReportGenerator(config MarkdownReportingConfig) (Reporter, error)
  • func NewMarkdownSummaryReporter(config MarkdownSummaryReporterConfig) (Reporter, error)
  • func NewSarifReporter(config SarifReporterConfig) (Reporter, error)
  • func NewSummaryReporter(config SummaryReporterConfig) (Reporter, error)
  • func NewSyncReporter(config SyncReporterConfig) (Reporter, error)
• type SarifReporterConfig
• type SarifToolMetadata
• type SummaryReporterConfig
• type SyncReporterConfig

Types

type CsvReportingConfig

type CsvReportingConfig struct {
	Path string
}

type JsonReportingConfig

type JsonReportingConfig struct {
	Path string
}

type MarkdownReportingConfig

type MarkdownReportingConfig struct {
	Path string
}

type MarkdownSummaryReporterConfig

type MarkdownSummaryReporterConfig struct {
	Path        string
	ReportTitle string
}

type Reporter

type Reporter interface {
	Name() string

	// Feed collected data to reporting module
	AddManifest(manifest *models.PackageManifest)
	AddAnalyzerEvent(event *analyzer.AnalyzerEvent)
	AddPolicyEvent(event *policy.PolicyEvent)

	// Inform reporting module to finalise (e.g. write report to file)
	Finish() error
}

func NewConsoleReporter

func NewConsoleReporter() (Reporter, error)

func NewCsvReporter

func NewCsvReporter(config CsvReportingConfig) (Reporter, error)

func NewDotGraphReporter

func NewDotGraphReporter(directory string) (Reporter, error)

func NewJsonReportGenerator

func NewJsonReportGenerator(config JsonReportingConfig) (Reporter, error)

func NewMarkdownReportGenerator

func NewMarkdownReportGenerator(config MarkdownReportingConfig) (Reporter, error)

func NewMarkdownSummaryReporter

func NewMarkdownSummaryReporter(config MarkdownSummaryReporterConfig) (Reporter, error)

NewMarkdownSummaryReporter creates a new markdown summary reporter. This reporter is suitable for generating markdown reports intended for PR comments.

func NewSarifReporter

func NewSarifReporter(config SarifReporterConfig) (Reporter, error)

func NewSummaryReporter

func NewSummaryReporter(config SummaryReporterConfig) (Reporter, error)

func NewSyncReporter

func NewSyncReporter(config SyncReporterConfig) (Reporter, error)

type SarifReporterConfig

type SarifReporterConfig struct {
	Tool SarifToolMetadata
	Path string
}

type SarifToolMetadata

type SarifToolMetadata struct {
	Name    string
	Version string
}

type SummaryReporterConfig

type SummaryReporterConfig struct {
	MaxAdvice               int
	GroupByDirectDependency bool
}

type SyncReporterConfig

type SyncReporterConfig struct {
	// gRPC connection for ControlTower
	ClientConnection *grpc.ClientConn

	// Enable multi-project syncing
	// In this case, a new project is created per package manifest
	EnableMultiProjectSync bool

	// Required
	ProjectName    string
	ProjectVersion string
	TriggerEvent   string

	// Optional or auto-discovered from environment
	GitRef     string
	GitRefName string
	GitRefType string
	GitSha     string

	// Performance
	WorkerCount int

	// Tool details
	ToolName    string
	ToolVersion string
}