reporter

Documentation

Index

• Constants
• Variables
• type Report
• type Reporter
• type ReporterResourceClient
• type ResourceReports
  • func (e ResourceReports) Accept(res ...resources.InputResource) ResourceReports
  • func (e ResourceReports) AddError(res resources.InputResource, err error)
  • func (e ResourceReports) AddErrors(res resources.InputResource, errs ...error)
  • func (e ResourceReports) AddMessage(res resources.InputResource, message string)
  • func (e ResourceReports) AddMessages(res resources.InputResource, messages ...string)
  • func (e ResourceReports) AddWarning(res resources.InputResource, warning string)
  • func (e ResourceReports) AddWarnings(res resources.InputResource, warning ...string)
  • func (e ResourceReports) FilterByKind(kind string) ResourceReports
  • func (e ResourceReports) Find(kind string, ref *core.ResourceRef) (resources.InputResource, Report)
  • func (e ResourceReports) Merge(resErrs ResourceReports)
  • func (e ResourceReports) Validate() error
  • func (e ResourceReports) ValidateStrict() error
• type StatusReporter
  • func NewReporter(reporterRef string, statusClient resources.StatusClient, ...) StatusReporter

Constants

const (
	// 1024 chars = 1kb
	MaxStatusBytes = 1024
	MaxStatusKeys  = 100
)

Variables

var (
	// only public for unit tests!
	DisableTruncateStatus = false
)

Types

type Report

type Report struct {
	Warnings []string
	Errors   error

	// Additional information about the current state of the resource.
	Messages []string
}

type Reporter

type Reporter interface {
	WriteReports(ctx context.Context, errs ResourceReports, subresourceStatuses map[string]*core.Status) error
}

type ReporterResourceClient

type ReporterResourceClient interface {
	Kind() string
	ApplyStatus(statusClient resources.StatusClient, inputResource resources.InputResource, opts clients.ApplyStatusOpts) (resources.Resource, error)
}

Minimal set of client operations required for reporters.

type ResourceReports

type ResourceReports map[resources.InputResource]Report

func (ResourceReports) Accept

func (e ResourceReports) Accept(res ...resources.InputResource) ResourceReports

func (ResourceReports) AddError

func (e ResourceReports) AddError(res resources.InputResource, err error)

func (ResourceReports) AddErrors

func (e ResourceReports) AddErrors(res resources.InputResource, errs ...error)

func (ResourceReports) AddMessage

func (e ResourceReports) AddMessage(res resources.InputResource, message string)

func (ResourceReports) AddMessages

func (e ResourceReports) AddMessages(res resources.InputResource, messages ...string)

func (ResourceReports) AddWarning

func (e ResourceReports) AddWarning(res resources.InputResource, warning string)

func (ResourceReports) AddWarnings

func (e ResourceReports) AddWarnings(res resources.InputResource, warning ...string)

func (ResourceReports) FilterByKind

func (e ResourceReports) FilterByKind(kind string) ResourceReports

func (ResourceReports) Find

func (e ResourceReports) Find(kind string, ref *core.ResourceRef) (resources.InputResource, Report)

func (ResourceReports) Merge

func (e ResourceReports) Merge(resErrs ResourceReports)

Merge merges the given resourceReports into this resourceReports. Any resources which appear in both resourceReports will have their warnings and errors merged. Errors appearing in both reports, as determined by the error strings, will not be duplicated in the resulting merged report.

func (ResourceReports) Validate

func (e ResourceReports) Validate() error

Validate ignores warnings

func (ResourceReports) ValidateStrict

func (e ResourceReports) ValidateStrict() error

ValidateStrict does not ignore warnings. If warnings are present, they will be included in the error. If an error is not present but warnings are, an "invalid resource" error will be returned along with each warning.

type StatusReporter

type StatusReporter interface {
	Reporter
	StatusFromReport(report Report, subresourceStatuses map[string]*core.Status) *core.Status
}

func NewReporter

func NewReporter(reporterRef string, statusClient resources.StatusClient, reporterClients ...ReporterResourceClient) StatusReporter