Documentation
¶
Overview ¶
Package v1 contains API Schema definitions for the tests v1 API group +kubebuilder:object:generate=true +groupName=tests.testkube.io
Index ¶
- Variables
- type RunningContext
- type RunningContextType
- type TestSuite
- type TestSuiteExecutionCore
- type TestSuiteExecutionRequest
- type TestSuiteExecutionStatus
- type TestSuiteList
- type TestSuiteSpec
- type TestSuiteStatus
- type TestSuiteStepDelay
- type TestSuiteStepExecute
- type TestSuiteStepSpec
- type TestSuiteStepType
- type Variable
Constants ¶
This section is empty.
Variables ¶
var ( // Group represents the API Group Group = "tests.testkube.io" // Version represents the Resource version Version = "v2" // Resource corresponds to the CRD Kind Resource = "TestSuite" // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: Group, Version: Version} // GroupVersionResource is group, version and resource used to register these objects GroupVersionResource = schema.GroupVersionResource{Group: Group, Version: Version, Resource: Resource} // 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 RunningContext ¶
type RunningContext struct {
// One of possible context types
Type_ RunningContextType `json:"type"`
// Context value depending from its type
Context string `json:"context,omitempty"`
}
RunningContext for test or test suite execution
func (*RunningContext) DeepCopy ¶
func (in *RunningContext) DeepCopy() *RunningContext
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RunningContext.
func (*RunningContext) DeepCopyInto ¶
func (in *RunningContext) DeepCopyInto(out *RunningContext)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type RunningContextType ¶
type RunningContextType string
const ( RunningContextTypeUserCLI RunningContextType = "user-cli" RunningContextTypeUserUI RunningContextType = "user-ui" RunningContextTypeTestSuite RunningContextType = "testsuite" RunningContextTypeTestTrigger RunningContextType = "testtrigger" RunningContextTypeScheduler RunningContextType = "scheduler" RunningContextTypeEmpty RunningContextType = "" )
type TestSuite ¶
type TestSuite struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec TestSuiteSpec `json:"spec,omitempty"`
Status TestSuiteStatus `json:"status,omitempty"`
}
TestSuite is the Schema for the testsuites API
func (*TestSuite) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestSuite.
func (*TestSuite) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TestSuite) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TestSuiteExecutionCore ¶
type TestSuiteExecutionCore struct {
// execution id
Id string `json:"id,omitempty"`
// test suite execution start time
StartTime metav1.Time `json:"startTime,omitempty"`
// test suite execution end time
EndTime metav1.Time `json:"endTime,omitempty"`
Status *TestSuiteExecutionStatus `json:"status,omitempty"`
}
test suite execution core
func (*TestSuiteExecutionCore) DeepCopy ¶
func (in *TestSuiteExecutionCore) DeepCopy() *TestSuiteExecutionCore
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestSuiteExecutionCore.
func (*TestSuiteExecutionCore) DeepCopyInto ¶
func (in *TestSuiteExecutionCore) DeepCopyInto(out *TestSuiteExecutionCore)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TestSuiteExecutionRequest ¶
type TestSuiteExecutionRequest struct {
// test execution custom name
Name string `json:"name,omitempty"`
// test kubernetes namespace (\"testkube\" when not set)
Namespace string `json:"namespace,omitempty"`
Variables map[string]Variable `json:"variables,omitempty"`
// secret uuid
SecretUUID string `json:"secretUUID,omitempty"`
// test suite labels
Labels map[string]string `json:"labels,omitempty"`
// execution labels
ExecutionLabels map[string]string `json:"executionLabels,omitempty"`
// whether to start execution sync or async
Sync bool `json:"sync,omitempty"`
// http proxy for executor containers
HttpProxy string `json:"httpProxy,omitempty"`
// https proxy for executor containers
HttpsProxy string `json:"httpsProxy,omitempty"`
// timeout for test suite execution
Timeout int32 `json:"timeout,omitempty"`
RunningContext *RunningContext `json:"-"`
// cron job template extensions
CronJobTemplate string `json:"cronJobTemplate,omitempty"`
}
TestSuiteExecutionRequest defines the execution request body
func (*TestSuiteExecutionRequest) DeepCopy ¶
func (in *TestSuiteExecutionRequest) DeepCopy() *TestSuiteExecutionRequest
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestSuiteExecutionRequest.
func (*TestSuiteExecutionRequest) DeepCopyInto ¶
func (in *TestSuiteExecutionRequest) DeepCopyInto(out *TestSuiteExecutionRequest)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TestSuiteExecutionStatus ¶
type TestSuiteExecutionStatus string
+kubebuilder:validation:Enum=queued;running;passed;failed;aborting;aborted;timeout
const ( QUEUED_TestSuiteExecutionStatus TestSuiteExecutionStatus = "queued" RUNNING_TestSuiteExecutionStatus TestSuiteExecutionStatus = "running" PASSED_TestSuiteExecutionStatus TestSuiteExecutionStatus = "passed" FAILED_TestSuiteExecutionStatus TestSuiteExecutionStatus = "failed" ABORTING_TestSuiteExecutionStatus TestSuiteExecutionStatus = "aborting" ABORTED_TestSuiteExecutionStatus TestSuiteExecutionStatus = "aborted" TIMEOUT_TestSuiteExecutionStatus TestSuiteExecutionStatus = "timeout" )
List of TestSuiteExecutionStatus
type TestSuiteList ¶
type TestSuiteList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []TestSuite `json:"items"`
}
TestSuiteList contains a list of TestSuite
func (*TestSuiteList) DeepCopy ¶
func (in *TestSuiteList) DeepCopy() *TestSuiteList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestSuiteList.
func (*TestSuiteList) DeepCopyInto ¶
func (in *TestSuiteList) DeepCopyInto(out *TestSuiteList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TestSuiteList) DeepCopyObject ¶
func (in *TestSuiteList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TestSuiteSpec ¶
type TestSuiteSpec struct {
// Before steps is list of tests which will be sequentially orchestrated
Before []TestSuiteStepSpec `json:"before,omitempty"`
// Steps is list of tests which will be sequentially orchestrated
Steps []TestSuiteStepSpec `json:"steps,omitempty"`
// After steps is list of tests which will be sequentially orchestrated
After []TestSuiteStepSpec `json:"after,omitempty"`
Repeats int `json:"repeats,omitempty"`
Description string `json:"description,omitempty"`
// schedule in cron job format for scheduled test execution
Schedule string `json:"schedule,omitempty"`
ExecutionRequest *TestSuiteExecutionRequest `json:"executionRequest,omitempty"`
}
TestSuiteSpec defines the desired state of TestSuite
func (*TestSuiteSpec) DeepCopy ¶
func (in *TestSuiteSpec) DeepCopy() *TestSuiteSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestSuiteSpec.
func (*TestSuiteSpec) DeepCopyInto ¶
func (in *TestSuiteSpec) DeepCopyInto(out *TestSuiteSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TestSuiteStatus ¶
type TestSuiteStatus struct {
// latest execution result
LatestExecution *TestSuiteExecutionCore `json:"latestExecution,omitempty"`
}
TestSuiteStatus defines the observed state of TestSuite
func (*TestSuiteStatus) DeepCopy ¶
func (in *TestSuiteStatus) DeepCopy() *TestSuiteStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestSuiteStatus.
func (*TestSuiteStatus) DeepCopyInto ¶
func (in *TestSuiteStatus) DeepCopyInto(out *TestSuiteStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TestSuiteStepDelay ¶
type TestSuiteStepDelay struct {
// Duration in ms
Duration int32 `json:"duration,omitempty"`
}
TestSuiteStepDelay contains step delay parameters
func (*TestSuiteStepDelay) DeepCopy ¶
func (in *TestSuiteStepDelay) DeepCopy() *TestSuiteStepDelay
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestSuiteStepDelay.
func (*TestSuiteStepDelay) DeepCopyInto ¶
func (in *TestSuiteStepDelay) DeepCopyInto(out *TestSuiteStepDelay)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TestSuiteStepExecute ¶
type TestSuiteStepExecute struct {
Namespace string `json:"namespace,omitempty"`
Name string `json:"name,omitempty"`
StopOnFailure bool `json:"stopOnFailure,omitempty"`
}
TestSuiteStepExecute defines step to be executed
func (*TestSuiteStepExecute) DeepCopy ¶
func (in *TestSuiteStepExecute) DeepCopy() *TestSuiteStepExecute
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestSuiteStepExecute.
func (*TestSuiteStepExecute) DeepCopyInto ¶
func (in *TestSuiteStepExecute) DeepCopyInto(out *TestSuiteStepExecute)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TestSuiteStepSpec ¶
type TestSuiteStepSpec struct {
Type TestSuiteStepType `json:"type,omitempty"`
Execute *TestSuiteStepExecute `json:"execute,omitempty"`
Delay *TestSuiteStepDelay `json:"delay,omitempty"`
}
TestSuiteStepSpec for particular type will have config for possible step types
func (*TestSuiteStepSpec) DeepCopy ¶
func (in *TestSuiteStepSpec) DeepCopy() *TestSuiteStepSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TestSuiteStepSpec.
func (*TestSuiteStepSpec) DeepCopyInto ¶
func (in *TestSuiteStepSpec) DeepCopyInto(out *TestSuiteStepSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TestSuiteStepType ¶
type TestSuiteStepType string
TestSuiteStepType defines different type of test suite steps +kubebuilder:validation:Enum=execute;delay
const ( TestSuiteStepTypeExecute TestSuiteStepType = "execute" TestSuiteStepTypeDelay TestSuiteStepType = "delay" )