v1alpha3

package
Version: v0.10.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 22, 2021 License: Apache-2.0 Imports: 6 Imported by: 9

Documentation

Overview

Package v1alpha3 contains resources types for version v1alpha3 of the scorecard.operatorframework.com API group.

Index

Constants

View Source
const ConfigurationKind = "Configuration"

ConfigurationKind is the default scorecard componentconfig kind.

Variables

View Source
var (
	// GroupVersion is the group and version of this package. Used for parsing purposes only.
	GroupVersion = schema.GroupVersion{Group: "scorecard.operatorframework.io", Version: "v1alpha3"}
)

Functions

This section is empty.

Types

type Configuration

type Configuration struct {
	metav1.TypeMeta `json:",inline" yaml:",inline"`

	// Do not use metav1.ObjectMeta because this "object" should not be treated as an actual object.
	Metadata struct {
		// Name is a required field for kustomize-able manifests, and is not used on-cluster (nor is the config itself).
		Name string `json:"name,omitempty" yaml:"name,omitempty"`
	} `json:"metadata,omitempty" yaml:"metadata,omitempty"`

	// Stages is a set of test stages to run. Once a stage is finished, the next stage in the slice will be run.
	Stages []StageConfiguration `json:"stages" yaml:"stages"`

	// Storage is the optional storage configuration
	Storage Storage `json:"storage,omitempty" yaml:"storage,omitempty"`
}

Configuration represents the set of test configurations which scorecard would run.

func (*Configuration) DeepCopy

func (in *Configuration) DeepCopy() *Configuration

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Configuration.

func (*Configuration) DeepCopyInto

func (in *Configuration) DeepCopyInto(out *Configuration)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type MountPath added in v0.10.2

type MountPath struct {
	// Path is the fully qualified path that a directory should be mounted in the test pod
	Path string `json:"path,omitempty" yaml:"path,omitempty"`
}

MountPath configures the path to mount directories in the test pod

func (*MountPath) DeepCopy added in v0.10.2

func (in *MountPath) DeepCopy() *MountPath

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MountPath.

func (*MountPath) DeepCopyInto added in v0.10.2

func (in *MountPath) DeepCopyInto(out *MountPath)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StageConfiguration

type StageConfiguration struct {
	// Parallel, if true, will run each test in tests in parallel.
	// The default is to wait until a test finishes to run the next.
	Parallel bool `json:"parallel,omitempty" yaml:"parallel,omitempty"`
	// Tests are a list of tests to run.
	Tests []TestConfiguration `json:"tests" yaml:"tests"`
}

StageConfiguration configures a set of tests to be run.

func (*StageConfiguration) DeepCopy

func (in *StageConfiguration) DeepCopy() *StageConfiguration

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StageConfiguration.

func (*StageConfiguration) DeepCopyInto

func (in *StageConfiguration) DeepCopyInto(out *StageConfiguration)

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 (
	// 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 Storage added in v0.10.2

type Storage struct {
	// Spec contains the storage configuration options
	Spec StorageSpec `json:"spec" yaml:"spec"`
}

Storage configures custom storage options

func (*Storage) DeepCopy added in v0.10.2

func (in *Storage) DeepCopy() *Storage

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Storage.

func (*Storage) DeepCopyInto added in v0.10.2

func (in *Storage) DeepCopyInto(out *Storage)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StorageSpec added in v0.10.2

type StorageSpec struct {
	// MountPath configures the path to mount directories in the test pod
	MountPath MountPath `json:"mountPath,omitempty" yaml:"mountPath,omitempty"`
}

StorageSpec contains storage configuration options

func (*StorageSpec) DeepCopy added in v0.10.2

func (in *StorageSpec) DeepCopy() *StorageSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StorageSpec.

func (*StorageSpec) DeepCopyInto added in v0.10.2

func (in *StorageSpec) DeepCopyInto(out *StorageSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Test

type Test struct {
	metav1.TypeMeta `json:",inline"`
	Spec            TestConfiguration `json:"spec,omitempty"`
	Status          TestStatus        `json:"status,omitempty"`
}

Test specifies a single test run.

func NewTest

func NewTest() Test

func (*Test) DeepCopy

func (in *Test) DeepCopy() *Test

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Test.

func (*Test) DeepCopyInto

func (in *Test) DeepCopyInto(out *Test)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Test) DeepCopyObject

func (in *Test) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (Test) MarshalText

func (s Test) MarshalText() string

type TestConfiguration

type TestConfiguration struct {
	// Image is the name of the test image.
	Image string `json:"image" yaml:"image"`
	// UniqueID is is an optional unique test identifier of the test image.
	UniqueID string `json:"uniqueID,omitempty" yaml:"uniqueID,omitempty"`
	// Entrypoint is a list of commands and arguments passed to the test image.
	Entrypoint []string `json:"entrypoint,omitempty" yaml:"entrypoint,omitempty"`
	// Labels further describe the test and enable selection.
	Labels map[string]string `json:"labels,omitempty" yaml:"labels,omitempty"`
	// Storage is the optional storage configuration for the test image.
	Storage Storage `json:"storage,omitempty" yaml:"storage,omitempty"`
}

TestConfiguration configures a specific scorecard test, identified by entrypoint.

func (*TestConfiguration) DeepCopy

func (in *TestConfiguration) DeepCopy() *TestConfiguration

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestConfiguration.

func (*TestConfiguration) DeepCopyInto

func (in *TestConfiguration) DeepCopyInto(out *TestConfiguration)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TestList

type TestList struct {
	metav1.TypeMeta `json:",inline"`
	Items           []Test `json:"items"`
}

TestList is a list of tests.

func NewTestList

func NewTestList() TestList

func (*TestList) DeepCopy

func (in *TestList) DeepCopy() *TestList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestList.

func (*TestList) DeepCopyInto

func (in *TestList) DeepCopyInto(out *TestList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TestResult

type TestResult struct {
	// Name is the name of the test
	Name string `json:"name,omitempty"`
	// 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 TestStatus

type TestStatus struct {
	Results []TestResult `json:"results,omitempty"`
}

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL