alpha

Documentation

Index

• func ConfigDocLink() string
• func RunTests(o Options) error
• type Config
  • func LoadConfig(configFilePath string) (Config, error)
• type Options
• type ScorecardTest

Functions

func ConfigDocLink

func ConfigDocLink() string

func RunTests

func RunTests(o Options) error

RunTests executes the scorecard tests as configured

Types

type Config

type Config struct {
	Tests []ScorecardTest `yaml:"tests"`
}

Config represents the set of test configurations which scorecard would run based on user input

func LoadConfig

func LoadConfig(configFilePath string) (Config, error)

LoadConfig will find and return the scorecard config, the config file can be passed in via command line flag or from a bundle location or bundle image

type Options

type Options struct {
	Config       Config
	Selector     labels.Selector
	List         bool
	OutputFormat string
	Client       kubernetes.Interface
}

type ScorecardTest

type ScorecardTest struct {
	Name        string            `yaml:"name"`                 // The container test name
	Image       string            `yaml:"image"`                // The container image name
	Entrypoint  string            `yaml:"entrypoint,omitempty"` // An optional entrypoint passed to the test image
	Labels      map[string]string `yaml:"labels"`               // User defined labels used to filter tests
	Description string            `yaml:"description"`          // User readable test description
}