scorecard

type AnnotationsContainExamplesTest struct {
	TestInfo
	OLMTestConfig
}

type BasicTestConfig struct {
	Client   client.Client
	CR       *unstructured.Unstructured
	ProxyPod *v1.Pod
}

type CRDsHaveResourcesTest struct {
	TestInfo
	OLMTestConfig
}

type CRDsHaveValidationTest struct {
	TestInfo
	OLMTestConfig
}

type CheckSpecTest struct {
	TestInfo
	BasicTestConfig
}

type CheckStatusTest struct {
	TestInfo
	BasicTestConfig
}

type OLMTestConfig struct {
	Client   client.Client
	CR       *unstructured.Unstructured
	CSV      *olmapiv1alpha1.ClusterServiceVersion
	CRDsDir  string
	ProxyPod *v1.Pod
}

type SpecDescriptorsTest struct {
	TestInfo
	OLMTestConfig
}

type StatusDescriptorsTest struct {
	TestInfo
	OLMTestConfig
}

type Test interface {
	GetName() string
	GetDescription() string
	IsCumulative() bool
	Run(context.Context) *TestResult
}

type TestInfo struct {
	Name        string
	Description string
	// If a test is set to cumulative, the scores of multiple runs of the same test on separate CRs are added together for the total score.
	// If cumulative is false, if any test failed, the total score is 0/1. Otherwise 1/1.
	Cumulative bool
}

type TestResult struct {
	Test          Test
	EarnedPoints  int
	MaximumPoints int
	Suggestions   []string
	Errors        []error
}

type TestSuite struct {
	TestInfo
	Tests       []Test
	TestResults []*TestResult
	Weights     map[string]float64
}

type WritingIntoCRsHasEffectTest struct {
	TestInfo
	BasicTestConfig
}