Documentation
¶
Overview ¶
Package v1alpha3 contains API Schema definitions for the cache v1alpha3 API group
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: "scorecard.operatorframework.io", Version: "v1alpha3"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} )
Functions ¶
This section is empty.
Types ¶
type State ¶
type State string
State is a type used to indicate the result state of a Test.
const ( // PassState occurs when a Test's ExpectedPoints == MaximumPoints. PassState State = "pass" // FailState occurs when a Test's ExpectedPoints == 0. FailState State = "fail" // ErrorState occurs when a Test encounters a fatal error and the reported points should not be considered. ErrorState State = "error" )
type Test ¶
type Test struct {
metav1.TypeMeta `json:",inline"`
Spec TestSpec `json:"spec,omitempty"`
Status TestStatus `json:"status,omitempty"`
}
Test is the schema for the scorecard API
func (*Test) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Test.
func (*Test) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Test) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (Test) MarshalText ¶
type TestResult ¶
type TestResult struct {
// Name is the name of the test
Name string `json:"name"`
// Log holds a log produced from the test (if applicable)
Log string `json:"log,omitempty"`
// State is the final state of the test
State State `json:"state"`
// Errors is a list of the errors that occurred during the test (this can include both fatal and non-fatal errors)
Errors []string `json:"errors,omitempty"`
// Suggestions is a list of suggestions for the user to improve their score (if applicable)
Suggestions []string `json:"suggestions,omitempty"`
}
TestResult contains the results of an individual scorecard test
func (*TestResult) DeepCopy ¶
func (in *TestResult) DeepCopy() *TestResult
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestResult.
func (*TestResult) DeepCopyInto ¶
func (in *TestResult) DeepCopyInto(out *TestResult)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TestSpec ¶
type TestSpec struct {
// Image is the name of the testimage
Image string `json:"image"`
// EntryPoint is list of commands and arguments passed to the test image
EntryPoint []string `json:"entrypoint,omitempty"`
// Labels that further describe the test and enable selection
Labels map[string]string `json:"labels,omitempty"`
}
TestSpec contains the spec details of an individual scorecard test
func (*TestSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestSpec.
func (*TestSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TestStatus ¶
type TestStatus struct {
Results []TestResult `json:"results"`
}
TestStatus contains collection of testResults.
func (*TestStatus) DeepCopy ¶
func (in *TestStatus) DeepCopy() *TestStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestStatus.
func (*TestStatus) DeepCopyInto ¶
func (in *TestStatus) DeepCopyInto(out *TestStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
Source Files