assessments

Documentation

Index

• Variables
• func ParseFailThresholds(thresholds []string) (map[string]int, error)
• func RegisterPRIntegration(integ func(ctx context.Context, config *jnode.Node) PRIntegration)
• type Assessment
  • func (a *Assessment) EvaluateFailures(thresholds map[string]int)
  • func (a *Assessment) UpdatePR(client *api.Client) error
• type Assessments
  • func FindCIEnvAssessments(client *api.Client) (Assessments, error)
  • func (a Assessments) UpdatePR(client *api.Client) error
• type Finding
  • func (f *Finding) GetTitle() string
  • func (f *Finding) SetAttribute(name, value string) *Finding
• type Findings
  • func (findings Findings) ComputePartialFingerprints(dir string)
• type PRIntegration
• type PRIntegrations

Variables

var SeverityNames = util.NewStringSetWithValues([]string{
	"info", "low", "medium", "high", "critical",
})

Functions

func ParseFailThresholds

func ParseFailThresholds(thresholds []string) (map[string]int, error)

func RegisterPRIntegration

func RegisterPRIntegration(integ func(ctx context.Context, config *jnode.Node) PRIntegration)

Types

type Assessment

type Assessment struct {
	ID       string   `json:"assessmentId"`
	URL      string   `json:"appUrl"`
	Title    string   `json:"title"`
	Module   string   `json:"module"`
	Category string   `json:"category"`
	Markdown string   `json:"markdown,omitempty"`
	Findings Findings `json:"findings"`

	Failed         bool   `json:"failed"`
	FailedCount    int    `json:"failedCount"`
	FailedSeverity string `json:"failedSeverity"`
}

func (*Assessment) EvaluateFailures

func (a *Assessment) EvaluateFailures(thresholds map[string]int)

func (*Assessment) UpdatePR

func (a *Assessment) UpdatePR(client *api.Client) error

NB - not used

type Assessments

type Assessments []*Assessment

func FindCIEnvAssessments

func FindCIEnvAssessments(client *api.Client) (Assessments, error)

func (Assessments) UpdatePR

func (a Assessments) UpdatePR(client *api.Client) error

type Finding

type Finding struct {
	SID           string `json:"sid,omitempty"`
	Severity      string `json:"severity,omitempty"`
	Title         string `json:"title,omitempty"`
	Description   string `json:"description,omitempty"`
	Markdown      string `json:"markdown,omitempty"`
	FilePath      string `json:"filePath,omitempty"`
	Resource      string `json:"resource,omitempty"`
	Line          int    `json:"line,omitempty"`
	Pass          bool   `json:"pass,omitempty"`
	GeneratedFile bool   `json:"generated_filed,omitempty"`

	// These fields are filled in by the CLI and sent to the api-server
	RepoPath           string            `json:"repoPath,omitempty"`
	PartialFingerprint string            `json:"partialFingerprint,omitempty"`
	Tool               map[string]string `json:"tool,omitempty"`
}

func (*Finding) GetTitle

func (f *Finding) GetTitle() string

func (*Finding) SetAttribute

func (f *Finding) SetAttribute(name, value string) *Finding

type Findings

type Findings []*Finding

func (Findings) ComputePartialFingerprints

func (findings Findings) ComputePartialFingerprints(dir string)

type PRIntegration

type PRIntegration interface {
	Update(ctx context.Context, assessments Assessments)
}

type PRIntegrations

type PRIntegrations []func(context.Context, *jnode.Node) PRIntegration