Documentation
¶
Overview ¶
Package v1 contains API Schema definitions for the executor v1 API group +kubebuilder:object:generate=true +groupName=executor.testkube.io
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // Group represents the API Group Group = "executor.testkube.io" // Version represents the Resource version Version = "v1" // ExecutorResource corresponds to the CRD Kind ExecutorResource = "Executor" // WebhookResource corresponds to the CRD Kind WebhookResource = "Webhook" // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: Group, Version: Version} // ExecutorGroupVersionResource is group, version and resource used to register these objects ExecutorGroupVersionResource = schema.GroupVersionResource{Group: Group, Version: Version, Resource: ExecutorResource} // WebhookGroupVersionResource is group, version and resource used to register these objects WebhookGroupVersionResource = schema.GroupVersionResource{Group: Group, Version: Version, Resource: WebhookResource} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type EventType ¶
type EventType string
+kubebuilder:validation:Enum=start-test;end-test-success;end-test-failed;end-test-aborted;end-test-timeout;start-testsuite;end-testsuite-success;end-testsuite-failed;end-testsuite-aborted;end-testsuite-timeout
const ( START_TEST_EventType EventType = "start-test" END_TEST_SUCCESS_EventType EventType = "end-test-success" END_TEST_FAILED_EventType EventType = "end-test-failed" END_TEST_ABORTED_EventType EventType = "end-test-aborted" END_TEST_TIMEOUT_EventType EventType = "end-test-timeout" START_TESTSUITE_EventType EventType = "start-testsuite" END_TESTSUITE_SUCCESS_EventType EventType = "end-testsuite-success" END_TESTSUITE_FAILED_EventType EventType = "end-testsuite-failed" END_TESTSUITE_ABORTED_EventType EventType = "end-testsuite-aborted" END_TESTSUITE_TIMEOUT_EventType EventType = "end-testsuite-timeout" )
List of EventType
type Executor ¶
type Executor struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec ExecutorSpec `json:"spec,omitempty"`
Status ExecutorStatus `json:"status,omitempty"`
}
Executor is the Schema for the executors API
func (*Executor) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Executor.
func (*Executor) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Executor) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ExecutorList ¶
type ExecutorList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Executor `json:"items"`
}
ExecutorList contains a list of Executor
func (*ExecutorList) DeepCopy ¶
func (in *ExecutorList) DeepCopy() *ExecutorList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExecutorList.
func (*ExecutorList) DeepCopyInto ¶
func (in *ExecutorList) DeepCopyInto(out *ExecutorList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ExecutorList) DeepCopyObject ¶
func (in *ExecutorList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ExecutorMeta ¶
type ExecutorMeta struct {
// URI for executor icon
IconURI string `json:"iconURI,omitempty"`
// URI for executor docs
DocsURI string `json:"docsURI,omitempty"`
// executor tooltips
Tooltips map[string]string `json:"tooltips,omitempty"`
}
Executor meta data
func (*ExecutorMeta) DeepCopy ¶
func (in *ExecutorMeta) DeepCopy() *ExecutorMeta
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExecutorMeta.
func (*ExecutorMeta) DeepCopyInto ¶
func (in *ExecutorMeta) DeepCopyInto(out *ExecutorMeta)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ExecutorSpec ¶
type ExecutorSpec struct {
// Types defines what types can be handled by executor e.g. "postman/collection", ":curl/command" etc
Types []string `json:"types,omitempty"`
// ExecutorType one of "rest" for rest openapi based executors or "job" which will be default runners for testkube
// or "container" for container executors
ExecutorType ExecutorType `json:"executor_type,omitempty"`
// URI for rest based executors
URI string `json:"uri,omitempty"`
// Image for kube-job
Image string `json:"image,omitempty"`
// executor binary arguments
Args []string `json:"args,omitempty"`
// executor default binary command
Command []string `json:"command,omitempty"`
// container executor default image pull secrets
ImagePullSecrets []v1.LocalObjectReference `json:"imagePullSecrets,omitempty"`
// Features list of possible features which executor handles
Features []Feature `json:"features,omitempty"`
// ContentTypes list of handled content types
ContentTypes []ScriptContentType `json:"content_types,omitempty"`
// Job template to launch executor
JobTemplate string `json:"job_template,omitempty"`
// name of the template resource
JobTemplateReference string `json:"jobTemplateReference,omitempty"`
// Meta data about executor
Meta *ExecutorMeta `json:"meta,omitempty"`
// Slaves data to run test in distributed environment
Slaves *SlavesMeta `json:"slaves,omitempty"`
// use data dir as working dir for executor
UseDataDirAsWorkingDir bool `json:"useDataDirAsWorkingDir,omitempty"`
}
ExecutorSpec defines the desired state of Executor
func (*ExecutorSpec) DeepCopy ¶
func (in *ExecutorSpec) DeepCopy() *ExecutorSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExecutorSpec.
func (*ExecutorSpec) DeepCopyInto ¶
func (in *ExecutorSpec) DeepCopyInto(out *ExecutorSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ExecutorStatus ¶
type ExecutorStatus struct {
}
ExecutorStatus defines the observed state of Executor
func (*ExecutorStatus) DeepCopy ¶
func (in *ExecutorStatus) DeepCopy() *ExecutorStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExecutorStatus.
func (*ExecutorStatus) DeepCopyInto ¶
func (in *ExecutorStatus) DeepCopyInto(out *ExecutorStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ExecutorType ¶
type ExecutorType string
+kubebuilder:validation:Enum=job;container
const ( ExecutorTypeJob ExecutorType = "job" ExecutorTypeContainer ExecutorType = "container" )
type Runner ¶
type Runner struct {
}
func (*Runner) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Runner.
func (*Runner) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ScriptContentType ¶
type ScriptContentType string
+kubebuilder:validation:Enum=string;file-uri;git-file;git-dir;git
const ( ScriptContentTypeString ScriptContentType = "string" ScriptContentTypeFileURI ScriptContentType = "file-uri" // Deprecated: use git instead ScriptContentTypeGitFile ScriptContentType = "git-file" // Deprecated: use git instead ScriptContentTypeGitDir ScriptContentType = "git-dir" ScriptContentTypeGit ScriptContentType = "git" )
type SlavesMeta ¶
type SlavesMeta struct {
Image string `json:"image"`
}
func (*SlavesMeta) DeepCopy ¶
func (in *SlavesMeta) DeepCopy() *SlavesMeta
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SlavesMeta.
func (*SlavesMeta) DeepCopyInto ¶
func (in *SlavesMeta) DeepCopyInto(out *SlavesMeta)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Webhook ¶
type Webhook struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec WebhookSpec `json:"spec,omitempty"`
Status WebhookStatus `json:"status,omitempty"`
}
Webhook is the Schema for the webhooks API
func (*Webhook) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Webhook.
func (*Webhook) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Webhook) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type WebhookList ¶
type WebhookList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []Webhook `json:"items"`
}
WebhookList contains a list of Webhook
func (*WebhookList) DeepCopy ¶
func (in *WebhookList) DeepCopy() *WebhookList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WebhookList.
func (*WebhookList) DeepCopyInto ¶
func (in *WebhookList) DeepCopyInto(out *WebhookList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*WebhookList) DeepCopyObject ¶
func (in *WebhookList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type WebhookSpec ¶
type WebhookSpec struct {
// Uri is address where webhook should be made (golang template supported)
Uri string `json:"uri,omitempty"`
// Events declare list if events on which webhook should be called
Events []EventType `json:"events,omitempty"`
// Labels to filter for tests and test suites
Selector string `json:"selector,omitempty"`
// will load the generated payload for notification inside the object
PayloadObjectField string `json:"payloadObjectField,omitempty"`
// golang based template for notification payload
PayloadTemplate string `json:"payloadTemplate,omitempty"`
// name of the template resource
PayloadTemplateReference string `json:"payloadTemplateReference,omitempty"`
// webhook headers (golang template supported)
Headers map[string]string `json:"headers,omitempty"`
}
WebhookSpec defines the desired state of Webhook
func (*WebhookSpec) DeepCopy ¶
func (in *WebhookSpec) DeepCopy() *WebhookSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WebhookSpec.
func (*WebhookSpec) DeepCopyInto ¶
func (in *WebhookSpec) DeepCopyInto(out *WebhookSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type WebhookStatus ¶
type WebhookStatus struct {
}
WebhookStatus defines the observed state of Webhook
func (*WebhookStatus) DeepCopy ¶
func (in *WebhookStatus) DeepCopy() *WebhookStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WebhookStatus.
func (*WebhookStatus) DeepCopyInto ¶
func (in *WebhookStatus) DeepCopyInto(out *WebhookStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.