finding

Documentation

Index

• type AnonymousFinding
• type FileType
• type Finding
  • func FromBytes(content []byte, probeID string) (*Finding, error)
  • func New(loc embed.FS, probeID string) (*Finding, error)
  • func NewNegative(efs embed.FS, probeID, text string, loc *Location) (*Finding, error)
  • func NewNotAvailable(efs embed.FS, probeID, text string, loc *Location) (*Finding, error)
  • func NewPositive(efs embed.FS, probeID, text string, loc *Location) (*Finding, error)
  • func NewWith(efs embed.FS, probeID, text string, loc *Location, o Outcome) (*Finding, error)
  • func (f *Finding) Anonymize() *AnonymousFinding
  • func (f *Finding) WithLocation(loc *Location) *Finding
  • func (f *Finding) WithMessage(text string) *Finding
  • func (f *Finding) WithOutcome(o Outcome) *Finding
  • func (f *Finding) WithPatch(patch *string) *Finding
  • func (f *Finding) WithRemediationMetadata(values map[string]string) *Finding
• type Location
• type Outcome
  • func (o *Outcome) UnmarshalYAML(n *yaml.Node) error

Types

type AnonymousFinding

type AnonymousFinding struct {
	Finding
	// Remove the probe ID from
	// the structure until the probes are GA.
	Probe string `json:"probe,omitempty"`
}

AnonymousFinding is a finding without a corerpsonding probe ID.

type FileType

type FileType int

FileType is the type of a file.

const (
	// FileTypeNone must be `0`.
	FileTypeNone FileType = iota
	// FileTypeSource is for source code files.
	FileTypeSource
	// FileTypeBinary is for binary files.
	FileTypeBinary
	// FileTypeText is for text files.
	FileTypeText
	// FileTypeURL for URLs.
	FileTypeURL
)

type Finding

type Finding struct {
	Probe       string             `json:"probe"`
	Outcome     Outcome            `json:"outcome"`
	Message     string             `json:"message"`
	Location    *Location          `json:"location,omitempty"`
	Remediation *probe.Remediation `json:"remediation,omitempty"`
}

Finding represents a finding. nolint: govet

func FromBytes

func FromBytes(content []byte, probeID string) (*Finding, error)

FromBytes creates a finding for a probe given its config file's content.

func New

func New(loc embed.FS, probeID string) (*Finding, error)

New creates a new finding.

func NewNegative

func NewNegative(efs embed.FS, probeID, text string, loc *Location,
) (*Finding, error)

NewWith create a negative finding with the desried location.

func NewNotAvailable

func NewNotAvailable(efs embed.FS, probeID, text string, loc *Location,
) (*Finding, error)

NewNotAvailable create a finding with a NotAvailable outcome and the desried location.

func NewPositive

func NewPositive(efs embed.FS, probeID, text string, loc *Location,
) (*Finding, error)

NewPositive create a positive finding with the desried location.

func NewWith

func NewWith(efs embed.FS, probeID, text string, loc *Location,
	o Outcome,
) (*Finding, error)

NewWith create a finding with the desried location and outcome.

func (*Finding) Anonymize

func (f *Finding) Anonymize() *AnonymousFinding

Anonymize removes the probe ID and outcome from the finding. It is a temporary solution to integrate the code in the details without exposing too much information.

func (*Finding) WithLocation

func (f *Finding) WithLocation(loc *Location) *Finding

WithLocation adds a location to an existing finding. No copy is made.

func (*Finding) WithMessage

func (f *Finding) WithMessage(text string) *Finding

WithMessage adds a message to an existing finding. No copy is made.

func (*Finding) WithOutcome

func (f *Finding) WithOutcome(o Outcome) *Finding

WithOutcome adds an outcome to an existing finding. No copy is made. WARNING: this function should be called at most once for a finding.

func (*Finding) WithPatch

func (f *Finding) WithPatch(patch *string) *Finding

WithPatch adds a patch to an existing finding. No copy is made.

func (*Finding) WithRemediationMetadata

func (f *Finding) WithRemediationMetadata(values map[string]string) *Finding

WithRemediationMetadata adds remediation metadata to an existing finding. No copy is made.

type Location

type Location struct {
	Type      FileType `json:"type"`
	Path      string   `json:"path"`
	LineStart *uint    `json:"lineStart,omitempty"`
	LineEnd   *uint    `json:"lineEnd,omitempty"`
	Snippet   *string  `json:"snippet,omitempty"`
}

Location represents the location of a finding. nolint: govet

type Outcome

type Outcome int

Outcome is the result of a finding.

const (
	// NOTE: The additional '_' are intended for future use.
	// This allows adding outcomes without breaking the values
	// of existing outcomes.
	// OutcomeNegative indicates a negative outcome.
	OutcomeNegative Outcome = iota

	// OutcomeNotAvailable indicates an unavailable outcome,
	// typically because an API call did not return an answer.
	OutcomeNotAvailable

	// OutcomeError indicates an errors while running.
	// The results could not be determined.
	OutcomeError

	// OutcomePositive indicates a positive outcome.
	OutcomePositive

	// OutcomeNotSupported indicates a non-supported outcome.
	OutcomeNotSupported
)

TODO(#2928): re-visit the finding definitions.

func (*Outcome) UnmarshalYAML

func (o *Outcome) UnmarshalYAML(n *yaml.Node) error

UnmarshalYAML is a custom unmarshalling function to transform the string into an enum.