schelpers

Documentation

Index

• Constants
• Variables
• func ValidateVersion(version string) error
• type Test
• type TestInfo
  • func (i TestInfo) GetDescription() string
  • func (i TestInfo) GetLabels() map[string]string
  • func (i TestInfo) GetName() string
• type TestResult

Constants

const DefaultScorecardVersion = v1alpha2

const LatestScorecardVersion = v1alpha2

Variables

var ScorecardVersions = []string{v1alpha2}

Functions

func ValidateVersion

func ValidateVersion(version string) error

Types

type Test

type Test interface {
	GetName() string
	GetDescription() string
	GetLabels() map[string]string
	Run(context.Context) *TestResult
}

Test provides methods for running scorecard tests

type TestInfo

type TestInfo struct {
	Name        string
	Description string
	Labels      map[string]string
}

TestInfo contains information about the scorecard test

func (TestInfo) GetDescription

func (i TestInfo) GetDescription() string

GetDescription returns the test description

func (TestInfo) GetLabels

func (i TestInfo) GetLabels() map[string]string

GetLabels returns the labels for this test

func (TestInfo) GetName

func (i TestInfo) GetName() string

GetName return the test name

type TestResult

type TestResult struct {
	State       scapiv1alpha2.State
	Test        Test
	Suggestions []string
	Errors      []error
	Log         string
	CRName      string
}

TestResult contains a test's points, suggestions, and errors