scorecard

Documentation

Index

• Constants
• Variables
• func ConfigDocLink() string
• type Config
  • func (s Config) GetPlugins(configs []PluginConfig) ([]Plugin, error)
  • func (s Config) RunTests() error
• type Plugin
• type PluginConfig
  • func (config PluginConfig) ValidateConfig(idx int) error

Constants

const (
	JSONOutputFormat = "json"
	TextOutputFormat = "text"
)

const DefaultConfigFile = ".osdk-scorecard"

Variables

var (
	Log = logrus.New()
)

Functions

func ConfigDocLink

func ConfigDocLink() string

Types

type Config

type Config struct {
	List          bool
	OutputFormat  string
	Version       string
	Selector      labels.Selector
	Bundle        string
	Kubeconfig    string
	Plugins       []Plugin
	PluginConfigs []PluginConfig
	LogReadWriter io.ReadWriter
}

func (Config) GetPlugins

func (s Config) GetPlugins(configs []PluginConfig) ([]Plugin, error)

func (Config) RunTests

func (s Config) RunTests() error

type Plugin

type Plugin interface {
	List() scapiv1alpha1.ScorecardOutput
	Run() scapiv1alpha1.ScorecardOutput
}

type PluginConfig

type PluginConfig struct {
	Basic *scplugins.BasicAndOLMPluginConfig `mapstructure:"basic,omitempty"`
	Olm   *scplugins.BasicAndOLMPluginConfig `mapstructure:"olm,omitempty"`
}

func (PluginConfig) ValidateConfig

func (config PluginConfig) ValidateConfig(idx int) error

ValidateConfig takes a config for a plugin and returns a nil error if valid or an error explaining why the config is invalid