Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the cache v1alpha1 API group +k8s:deepcopy-gen=package,register +groupName=osdk.openshift.io
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: "osdk.openshift.io", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} )
Functions ¶
This section is empty.
Types ¶
type ScorecardOutput ¶
type ScorecardOutput struct {
metav1.TypeMeta `json:",inline"`
// +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Log contains the scorecard's log.
Log string `json:"log"`
// Results is an array of ScorecardResult for each suite of the current scorecard run.
Results []ScorecardSuiteResult `json:"results"`
}
ScorecardOutput is the schema for the scorecard API
func NewScorecardOutput ¶ added in v0.13.0
func NewScorecardOutput() *ScorecardOutput
func (*ScorecardOutput) DeepCopy ¶
func (in *ScorecardOutput) DeepCopy() *ScorecardOutput
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScorecardOutput.
func (*ScorecardOutput) DeepCopyInto ¶
func (in *ScorecardOutput) DeepCopyInto(out *ScorecardOutput)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ScorecardOutput) DeepCopyObject ¶
func (in *ScorecardOutput) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (ScorecardOutput) MarshalText ¶ added in v0.12.0
func (s ScorecardOutput) MarshalText() (string, error)
type ScorecardOutputList ¶
type ScorecardOutputList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []ScorecardOutput `json:"items"`
}
ScorecardOutputList contains a list of ScorecardTest
func (*ScorecardOutputList) DeepCopy ¶
func (in *ScorecardOutputList) DeepCopy() *ScorecardOutputList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScorecardOutputList.
func (*ScorecardOutputList) DeepCopyInto ¶
func (in *ScorecardOutputList) DeepCopyInto(out *ScorecardOutputList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ScorecardOutputList) DeepCopyObject ¶
func (in *ScorecardOutputList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ScorecardSuiteResult ¶
type ScorecardSuiteResult struct {
// Name is the name of the test suite
Name string `json:"name"`
// Description is a description of the test suite
Description string `json:"description"`
// Error is the number of tests that ended in the Error state
Error int `json:"error"`
// Pass is the number of tests that ended in the Pass state
Pass int `json:"pass"`
// PartialPass is the number of tests that ended in the PartialPass state
PartialPass int `json:"partialPass"`
// Fail is the number of tests that ended in the Fail state
Fail int `json:"fail"`
// TotalTests is the total number of tests run in this suite
TotalTests int `json:"totalTests"`
// TotalScore is the total score of this suite as a percentage
TotalScore int `json:"totalScorePercent"`
// Tests is an array containing a json-ified version of the TestResults for the suite
Tests []ScorecardTestResult `json:"tests"`
// Log is extra logging information from the scorecard suite/plugin.
// +optional
Log string `json:"log"`
}
ScorecardSuiteResult contains the combined results of a suite of tests.
func (*ScorecardSuiteResult) DeepCopy ¶
func (in *ScorecardSuiteResult) DeepCopy() *ScorecardSuiteResult
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScorecardSuiteResult.
func (*ScorecardSuiteResult) DeepCopyInto ¶
func (in *ScorecardSuiteResult) DeepCopyInto(out *ScorecardSuiteResult)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ScorecardTestResult ¶
type ScorecardTestResult struct {
// State is the final state of the test
State State `json:"state"`
// Name is the name of the test
Name string `json:"name"`
// Description describes what the test does
Description string `json:"description"`
// EarnedPoints is how many points the test received after running
EarnedPoints int `json:"earnedPoints"`
// MaximumPoints is the maximum number of points possible for the test
MaximumPoints int `json:"maximumPoints"`
// Suggestions is a list of suggestions for the user to improve their score (if applicable)
Suggestions []string `json:"suggestions"`
// 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"`
// Labels used for v1alpha2, not included in v1alpha1 JSON output
Labels map[string]string `json:"-"`
// Log used for v1alpha2, not included in v1alpha1 JSON output
Log string `json:"-"`
}
ScorecardTestResult contains the results of an individual scorecard test.
func (*ScorecardTestResult) DeepCopy ¶
func (in *ScorecardTestResult) DeepCopy() *ScorecardTestResult
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScorecardTestResult.
func (*ScorecardTestResult) DeepCopyInto ¶
func (in *ScorecardTestResult) DeepCopyInto(out *ScorecardTestResult)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type State ¶
type State string
State is a type used to indicate the result state of a Test.
const ( // UnsetState is the default state for a TestResult. It must be updated by UpdateState or by the Test. UnsetState State = "unset" // PassState occurs when a Test's ExpectedPoints == MaximumPoints. PassState State = "pass" // PartialPassState occurs when a Test's ExpectedPoints < MaximumPoints and ExpectedPoints > 0. PartialPassState State = "partial_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" )
Source Files