gatecheck

Documentation

Index

• Variables
• type Artifact
• type Config
  • func NewConfig(projectName string) *Config
• type Report
  • func NewReport(projectName string) *Report
  • func (r Report) String() string
  • func (r Report) Validate() error
  • func (r Report) WithConfig(c *Config) *Report
  • func (r Report) WithSettings(s Settings) *Report
• type Settings

Variables

var ErrorValidation = errors.New("report failed validation")

Types

type Artifact

type Artifact interface {
	Validate() error
	fmt.Stringer
}

type Config

type Config struct {
	ProjectName string         `yaml:"projectName" json:"projectName"`
	Grype       grype.Config   `yaml:"grype,omitempty" json:"grype,omitempty"`
	Semgrep     semgrep.Config `yaml:"semgrep,omitempty" json:"semgrep,omitempty"`
}

func NewConfig

func NewConfig(projectName string) *Config

type Report

type Report struct {
	ProjectName string `json:"projectName"`
	PipelineId  string `json:"pipelineId"`
	PipelineUrl string `json:"pipelineUrl"`
	Timestamp   string `json:"timestamp"`
	Artifacts   struct {
		Grype   grype.Artifact   `json:"grype,omitempty"`
		Semgrep semgrep.Artifact `json:"semgrep,omitempty"`
	} `json:"artifacts"`
}

func NewReport

func NewReport(projectName string) *Report

func (Report) String

func (r Report) String() string

func (Report) Validate

func (r Report) Validate() error

Validate calls the validate function for each artifact

func (Report) WithConfig

func (r Report) WithConfig(c *Config) *Report

func (Report) WithSettings

func (r Report) WithSettings(s Settings) *Report

type Settings

type Settings struct {
	ProjectName string
	PipelineId  string
	PipelineUrl string
}