Features described in this document are being deprecated as part of the transition to Test Workflows - Read More.
API Reference
Packages
tests.testkube.io/v1
Package v1 contains API Schema definitions for the testkube v1 API group
Resource Types
- Script
- ScriptList
- Template
- TemplateList
- Test
- TestExecution
- TestExecutionList
- TestList
- TestSource
- TestSourceList
- TestSuite
- TestSuiteExecution
- TestSuiteExecutionList
- TestSuiteList
- TestTrigger
- TestTriggerList
ArgsModeType
Underlying type: string
ArgsModeType defines args mode type
Validation:
- Enum: [append override replace]
Appears in:
Field | Description |
---|---|
append | ArgsModeTypeAppend for append args mode |
override | ArgsModeTypeOverride for override args mode |
replace | ArgsModeTypeReplace for replace args mode |
ArtifactRequest
artifact request body with test artifacts
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
storageClassName string | artifact storage class name for container executor | ||
volumeMountPath string | artifact volume mount path for container executor | ||
dirs string array | artifact directories for scraping | ||
masks string array | regexp to filter scraped artifacts, single or comma separated | ||
storageBucket string | artifact bucket storage | ||
omitFolderPerExecution boolean | don't use a separate folder for execution artifacts | ||
sharedBetweenPods boolean | whether to share volume between pods | ||
useDefaultStorageClassName boolean | whether to use default storage class name | ||
sidecarScraper boolean | run scraper as pod sidecar container |
EnvReference
Reference to env resource
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
reference LocalObjectReference | |||
mount boolean | whether we shoud mount resource | ||
mountPath string | where we shoud mount resource | ||
mapToVariables boolean | whether we shoud map to variables from resource |
Execution
test execution
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
id string | execution id | ||
testName string | unique test name (CRD Test name) | ||
testSuiteName string | unique test suite name (CRD Test suite name), if it's run as a part of test suite | ||
testNamespace string | test namespace | ||
testType string | test type e.g. postman/collection | ||
name string | execution name | ||
number integer | execution number | ||
envs object (keys:string, values:string) | Environment variables passed to executor. Deprecated: use Basic Variables instead | ||
command string array | executor image command | ||
args string array | additional arguments/flags passed to executor binary | ||
args_mode ArgsModeType | usage mode for arguments | Enum: [append override replace] | |
variables object (keys:string, values:Variable) | |||
isVariablesFileUploaded boolean | in case the variables file is too big, it will be uploaded to storage | ||
variablesFile string | variables file content - need to be in format for particular executor (e.g. postman envs file) | ||
testSecretUUID string | test secret uuid | ||
testSuiteSecretUUID string | test suite secret uuid, if it's run as a part of test suite | ||
content TestContent | |||
startTime Time | test start time | ||
endTime Time | test end time | ||
duration string | test duration | ||
durationMs integer | test duration in milliseconds | ||
executionResult ExecutionResult | |||
labels object (keys:string, values:string) | test and execution labels | ||
uploads string array | list of file paths that need to be copied into the test from uploads | ||
bucketName string | minio bucket name to get uploads from | ||
artifactRequest ArtifactRequest | |||
preRunScript string | script to run before test execution | ||
postRunScript string | script to run after test execution | ||
executePostRunScriptBeforeScraping boolean | execute post run script before scraping (prebuilt executor only) | ||
sourceScripts boolean | run scripts using source command (container executor only) | ||
runningContext RunningContext | |||
containerShell string | shell used in container executor | ||
testExecutionName string | test execution name started the test execution | ||
slavePodRequest PodRequest | |||
executionNamespace string | namespace for test execution (Pro edition only) | ||
disableWebhooks boolean | whether webhooks should be disabled for this execution |
ExecutionRequest
test execution request body
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
name string | test execution custom name | ||
testSuiteName string | unique test suite name (CRD Test suite name), if it's run as a part of test suite | ||
number integer | test execution number | ||
executionLabels object (keys:string, values:string) | test execution labels | ||
namespace string | test kubernetes namespace ("testkube" when not set) | ||
variablesFile string | variables file content - need to be in format for particular executor (e.g. postman envs file) | ||
isVariablesFileUploaded boolean | |||
variables object (keys:string, values:Variable) | |||
testSecretUUID string | test secret uuid | ||
testSuiteSecretUUID string | test suite secret uuid, if it's run as a part of test suite | ||
args string array | additional executor binary arguments | ||
argsMode ArgsModeType | usage mode for arguments | Enum: [append override replace] | |
command string array | executor binary command | ||
image string | container executor image | ||
imagePullSecrets LocalObjectReference array | container executor image pull secrets | ||
envs object (keys:string, values:string) | Environment variables passed to executor. Deprecated: use Basic Variables instead | ||
secretEnvs object (keys:string, values:string) | Execution variables passed to executor from secrets. Deprecated: use Secret Variables instead | ||
sync boolean | whether to start execution sync or async | ||
httpProxy string | http proxy for executor containers | ||
httpsProxy string | https proxy for executor containers | ||
negativeTest boolean | negative test will fail the execution if it is a success and it will succeed if it is a failure | ||
activeDeadlineSeconds integer | Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. | ||
artifactRequest ArtifactRequest | |||
jobTemplate string | job template extensions | ||
cronJobTemplate string | cron job template extensions | ||
preRunScript string | script to run before test execution | ||
postRunScript string | script to run after test execution | ||
executePostRunScriptBeforeScraping boolean | execute post run script before scraping (prebuilt executor only) | ||
sourceScripts boolean | run scripts using source command (container executor only) | ||
scraperTemplate string | scraper template extensions | ||
envConfigMaps EnvReference array | config map references | ||
envSecrets EnvReference array | secret references | ||
runningContext RunningContext | |||
slavePodRequest PodRequest | |||
executionNamespace string | namespace for test execution (Pro edition only) | ||
disableWebhooks boolean | whether webhooks should be called on execution |
ExecutionResult
execution result returned from executor
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
errorMessage string | error message when status is error, separate to output as output can be partial in case of error | ||
steps ExecutionStepResult array | execution steps (for collection of requests) | ||
reports ExecutionResultReports |
ExecutionResultReports
Underlying type: struct{Junit string "json:"junit,omitempty""}
Appears in:
ExecutionStepResult
execution result data
Appears in:
ObjectRef
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
namespace string | object kubernetes namespace | ||
name string | object name |
PodRequest
pod request body
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
resources PodResourcesRequest | |||
podTemplate string | pod template extensions | ||
podTemplateReference string | name of the template resource |
PodResourcesRequest
Underlying type: struct{Requests *ResourceRequest "json:"requests,omitempty""; Limits *ResourceRequest "json:"limits,omitempty""}
pod resources request specification
Appears in:
Repository
Repository represents VCS repo, currently we're handling Git only
Appears in:
RepositoryParameters
repository parameters for tests in git repositories
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
branch string | branch/tag name for checkout | ||
commit string | commit id (sha) for checkout | ||
path string | if needed we can checkout particular path (dir or file) in case of BIG/mono repositories | ||
workingDir string | if provided we checkout the whole repository and run test from this directory |
RunningContext
running context for test or test suite execution
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
type RunningContextType | One of possible context types | Enum: [user-cli user-ui testsuite testtrigger scheduler testexecution testsuiteexecution] | |
context string | Context value depending from its type |
RunningContextType
Underlying type: string
RunningContextType defines running context type
Validation:
- Enum: [user-cli user-ui testsuite testtrigger scheduler testexecution testsuiteexecution]
Appears in:
Field | Description |
---|---|
user-cli | |
user-ui | |
testsuite | |
testtrigger | |
scheduler | |
testexecution | |
testsuiteexecution | |
`` |
Script
Script is the Schema for the scripts API
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
apiVersion string | tests.testkube.io/v1 | ||
kind string | Script | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . | ||
spec ScriptSpec |
ScriptList
ScriptList contains a list of Script
Field | Description | Default | Validation |
---|---|---|---|
apiVersion string | tests.testkube.io/v1 | ||
kind string | ScriptList | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata . | ||
items Script array |
ScriptSpec
ScriptSpec defines the desired state of Script
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
type string | script type | ||
name string | script execution custom name | ||
params object (keys:string, values:string) | execution params passed to executor | ||
content string | script content as string (content depends from executor) | ||
input-type string | script content type can be: - direct content - created from file, - git repo directory checkout in case when test is some kind of project or have more than one file, | ||
repository Repository | repository details if exists | ||
tags string array |
SuiteExecution
SuiteExecutions data
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
id string | execution id | ||
name string | execution name | ||
testSuite ObjectRef | |||
envs object (keys:string, values:string) | Environment variables passed to executor. Deprecated: use Basic Variables instead | ||
variables object (keys:string, values:Variable) | |||
secretUUID string | secret uuid | ||
startTime Time | test start time | ||
endTime Time | test end time | ||
duration string | test duration | ||
durationMs integer | test duration in ms | ||
stepResults TestSuiteStepExecutionResultV2 array | steps execution results | ||
executeStepResults TestSuiteBatchStepExecutionResult array | batch steps execution results | ||
labels object (keys:string, values:string) | test suite labels | ||
runningContext RunningContext | |||
testSuiteExecutionName string | test suite execution name started the test suite execution | ||
disableWebhooks boolean | whether webhooks should be disabled for this execution |
Template
Template is the Schema for the Templates API
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
apiVersion string | tests.testkube.io/v1 | ||
kind string | Template | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . | ||
spec TemplateSpec |
TemplateList
TemplateList contains a list of Template
Field | Description | Default | Validation |
---|---|---|---|
apiVersion string | tests.testkube.io/v1 | ||
kind string | TemplateList | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata . | ||
items Template array |
TemplateSpec
TemplateSpec defines the desired state of Template
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
type TemplateType | Enum: [job container cronjob scraper pvc webhook pod] | ||
body string | template body to use |
TemplateType
Underlying type: string
TemplateType defines template type by purpose
Validation:
- Enum: [job container cronjob scraper pvc webhook pod]
Appears in:
Field | Description |
---|---|
job | |
container | |
cronjob | |
scraper | |
pvc | |
webhook | |
pod |
Test
Test is the Schema for the tests API
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
apiVersion string | tests.testkube.io/v1 | ||
kind string | Test | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . | ||
spec TestSpec |
TestContent
TestContent defines test content
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
type TestContentType | test type | Enum: [string file-uri git-file git-dir git] | |
repository Repository | repository of test content | ||
data string | test content body | ||
uri string | uri of test content |
TestContentRequest
test content request body
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
repository RepositoryParameters |
TestContentType
Underlying type: string
Validation:
- Enum: [string file-uri git-file git-dir git]
Appears in:
Field | Description |
---|---|
string | |
file-uri | |
git-file | Deprecated: use git instead |
git-dir | Deprecated: use git instead |
git |
TestExecution
TestExecution is the Schema for the testexecutions API
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
apiVersion string | tests.testkube.io/v1 | ||
kind string | TestExecution | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . | ||
spec TestExecutionSpec |
TestExecutionList
TestExecutionList contains a list of TestExecution
Field | Description | Default | Validation |
---|---|---|---|
apiVersion string | tests.testkube.io/v1 | ||
kind string | TestExecutionList | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata . | ||
items TestExecution array |
TestExecutionSpec
TestExecutionSpec defines the desired state of TestExecution
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
test ObjectRef | |||
executionRequest ExecutionRequest |
TestList
TestList contains a list of Test
Field | Description | Default | Validation |
---|---|---|---|
apiVersion string | tests.testkube.io/v1 | ||
kind string | TestList | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata . | ||
items Test array |
TestSource
TestSource is the Schema for the testsources API
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
apiVersion string | tests.testkube.io/v1 | ||
kind string | TestSource | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . | ||
spec TestSourceSpec |
TestSourceList
TestSourceList contains a list of TestSource
Field | Description | Default | Validation |
---|---|---|---|
apiVersion string | tests.testkube.io/v1 | ||
kind string | TestSourceList | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata . | ||
items TestSource array |
TestSourceSpec
TestSourceSpec defines the desired state of TestSource
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
type TestSourceType | Enum: [string file-uri git-file git-dir git] | ||
repository Repository | repository of test content | ||
data string | test content body | ||
uri string | uri of test content |
TestSourceType
Underlying type: string
Validation:
- Enum: [string file-uri git-file git-dir git]
Appears in:
Field | Description |
---|---|
string | |
file-uri | |
git-file | Deprecated: use git instead |
git-dir | Deprecated: use git instead |
git |
TestSpec
TestSpec defines the desired state of Test
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
before TestStepSpec array | Before steps is list of scripts which will be sequentially orchestrated | ||
steps TestStepSpec array | Steps is list of scripts which will be sequentially orchestrated | ||
after TestStepSpec array | After steps is list of scripts which will be sequentially orchestrated | ||
repeats integer | |||
description string | |||
tags string array |
TestStepDelay
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
duration integer | Duration in ms |
TestStepExecute
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
namespace string | |||
name string | |||
stopOnFailure boolean |
TestStepSpec
TestStepSpec will of particular type will have config for possible step types
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
type string | |||
execute TestStepExecute | |||
delay TestStepDelay |
TestSuite
TestSuite is the Schema for the testsuites API
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
apiVersion string | tests.testkube.io/v1 | ||
kind string | TestSuite | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . | ||
spec TestSuiteSpec |
TestSuiteBatchStep
set of steps run in parallel
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
stopOnFailure boolean | |||
execute TestSuiteStep array |
TestSuiteBatchStepExecutionResult
execution result returned from executor
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
step TestSuiteBatchStep | |||
execute TestSuiteStepExecutionResult array | |||
startTime Time | step start time | ||
endTime Time | step end time | ||
duration string | step duration |
TestSuiteExecution
TestSuiteExecution is the Schema for the testsuiteexecutions API
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
apiVersion string | tests.testkube.io/v1 | ||
kind string | TestSuiteExecution | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . | ||
spec TestSuiteExecutionSpec |
TestSuiteExecutionList
TestSuiteExecutionList contains a list of TestSuiteExecution
Field | Description | Default | Validation |
---|---|---|---|
apiVersion string | tests.testkube.io/v1 | ||
kind string | TestSuiteExecutionList | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata . | ||
items TestSuiteExecution array |
TestSuiteExecutionRequest
test suite execution request body
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
name string | test execution custom name | ||
number integer | test suite execution number | ||
namespace string | test kubernetes namespace ("testkube" when not set) | ||
variables object (keys:string, values:Variable) | |||
secretUUID string | secret uuid | ||
labels object (keys:string, values:string) | test suite labels | ||
executionLabels object (keys:string, values:string) | execution labels | ||
sync boolean | whether to start execution sync or async | ||
httpProxy string | http proxy for executor containers | ||
httpsProxy string | https proxy for executor containers | ||
timeout integer | duration in seconds the test suite may be active, until its stopped | ||
contentRequest TestContentRequest | |||
runningContext RunningContext | |||
cronJobTemplate string | cron job template extensions | ||
concurrencyLevel integer | number of tests run in parallel | ||
testSuiteExecutionName string | test suite execution name started the test suite execution | ||
disableWebhooks boolean | whether webhooks should be disabled for this execution |
TestSuiteExecutionSpec
TestSuiteExecutionSpec defines the desired state of TestSuiteExecution
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
testSuite ObjectRef | |||
executionRequest TestSuiteExecutionRequest |
TestSuiteList
TestSuiteList contains a list of TestSuite
Field | Description | Default | Validation |
---|---|---|---|
apiVersion string | tests.testkube.io/v1 | ||
kind string | TestSuiteList | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata . | ||
items TestSuite array |
TestSuiteSpec
TestSuiteSpec defines the desired state of TestSuite
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
before TestSuiteStepSpec array | Before steps is list of tests which will be sequentially orchestrated | ||
steps TestSuiteStepSpec array | Steps is list of tests which will be sequentially orchestrated | ||
after TestSuiteStepSpec array | After steps is list of tests which will be sequentially orchestrated | ||
repeats integer | |||
description string | |||
schedule string | schedule in cron job format for scheduled test execution | ||
params object (keys:string, values:string) | DEPRECATED execution params passed to executor | ||
variables object (keys:string, values:Variable) | Variables are new params with secrets attached |
TestSuiteStep
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
test string | object name | ||
delay string | delay duration in time units |
TestSuiteStepDelay
TestSuiteStepDelay contains step delay parameters
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
duration integer | Duration in ms |
TestSuiteStepDelayV2
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
duration integer | delay duration in milliseconds |
TestSuiteStepExecute
TestSuiteStepExecute defines step to be executed
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
namespace string | |||
name string | |||
stopOnFailure boolean |
TestSuiteStepExecuteTestV2
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
namespace string | object kubernetes namespace | ||
name string | object name |
TestSuiteStepExecutionResult
execution result returned from executor
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
step TestSuiteStep | |||
test ObjectRef | |||
execution Execution |
TestSuiteStepExecutionResultV2
execution result returned from executor
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
step TestSuiteStepV2 | |||
test ObjectRef | |||
execution Execution |
TestSuiteStepSpec
TestSuiteStepSpec will of particular type will have config for possible step types
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
type string | |||
execute TestSuiteStepExecute | |||
delay TestSuiteStepDelay |
TestSuiteStepV2
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
stopTestOnFailure boolean | |||
execute TestSuiteStepExecuteTestV2 | |||
delay TestSuiteStepDelayV2 |
TestTrigger
TestTrigger is the Schema for the testtriggers API
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
apiVersion string | tests.testkube.io/v1 | ||
kind string | TestTrigger | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata . | ||
spec TestTriggerSpec |
TestTriggerAction
Underlying type: string
TestTriggerAction defines action for test triggers
Validation:
- Enum: [run]
Appears in:
Field | Description |
---|---|
run |
TestTriggerConcurrencyPolicy
Underlying type: string
TestTriggerConcurrencyPolicy defines concurrency policy for test triggers
Validation:
- Enum: [allow forbid replace]
Appears in:
Field | Description |
---|---|
allow | |
forbid | |
replace |
TestTriggerCondition
TestTriggerCondition is used for definition of the condition for test triggers
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
type string | test trigger condition | ||
reason string | test trigger condition reason | ||
ttl integer | duration in seconds in the past from current time when the condition is still valid |
TestTriggerConditionSpec
TestTriggerConditionSpec defines the condition specification for TestTrigger
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
conditions TestTriggerCondition array | list of test trigger conditions | ||
timeout integer | duration in seconds the test trigger waits for conditions, until its stopped | ||
delay integer | duration in seconds the test trigger waits between condition check |
TestTriggerEvent
Underlying type: string
TestTriggerEvent defines event for test triggers
Validation:
- Enum: [created modified deleted deployment-scale-update deployment-image-update deployment-env-update deployment-containers-modified event-start-test event-end-test-success event-end-test-failed event-end-test-aborted event-end-test-timeout event-start-testsuite event-end-testsuite-success event-end-testsuite-failed event-end-testsuite-aborted event-end-testsuite-timeout event-queue-testworkflow event-start-testworkflow event-end-testworkflow-success event-end-testworkflow-failed event-end-testworkflow-aborted event-created event-updated event-deleted]
Appears in:
Field | Description |
---|---|
created | |
modified | |
deleted | |
deployment-scale-update | |
deployment-image-update | |
deployment-env-update | |
deployment-containers-modified | |
event-start-test | |
event-end-test-success | |
event-end-test-failed | |
event-end-test-aborted | |
event-end-test-timeout | |
event-start-testsuite | |
event-end-testsuite-success | |
event-end-testsuite-failed | |
event-end-testsuite-aborted | |
event-end-testsuite-timeout | |
event-queue-testworkflow | |
event-start-testworkflow | |
event-end-testworkflow-success | |
event-end-testworkflow-failed | |
event-end-testworkflow-aborted | |
event-created | |
event-updated | |
event-deleted |
TestTriggerExecution
Underlying type: string
TestTriggerExecution defines execution for test triggers
Validation:
- Enum: [test testsuite testworkflow]
Appears in:
Field | Description |
---|---|
test | |
testsuite | |
testworkflow |
TestTriggerList
TestTriggerList contains a list of TestTrigger
Field | Description | Default | Validation |
---|---|---|---|
apiVersion string | tests.testkube.io/v1 | ||
kind string | TestTriggerList | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata . | ||
items TestTrigger array |
TestTriggerProbe
TestTriggerProbe is used for definition of the probe for test triggers
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
scheme string | test trigger condition probe scheme to connect to host, default is http | ||
host string | test trigger condition probe host, default is pod ip or service name | ||
path string | test trigger condition probe path to check, default is / | ||
port integer | test trigger condition probe port to connect | ||
headers object (keys:string, values:string) | test trigger condition probe headers to submit |
TestTriggerProbeSpec
TestTriggerProbeSpec defines the probe specification for TestTrigger
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
probes TestTriggerProbe array | list of test trigger probes | ||
timeout integer | duration in seconds the test trigger waits for probes, until its stopped | ||
delay integer | duration in seconds the test trigger waits between probes |
TestTriggerResource
Underlying type: string
TestTriggerResource defines resource for test triggers
Validation:
- Enum: [pod deployment statefulset daemonset service ingress event configmap]
Appears in:
Field | Description |
---|---|
pod | |
deployment | |
statefulset | |
daemonset | |
service | |
ingress | |
event | |
configmap |
TestTriggerSelector
TestTriggerSelector is used for selecting Kubernetes Objects
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
name string | Name selector is used to identify a Kubernetes Object based on the metadata name | ||
nameRegex string | kubernetes resource name regex | ||
namespace string | Namespace of the Kubernetes object | ||
labelSelector LabelSelector | LabelSelector is used to identify a group of Kubernetes Objects based on their metadata labels |
TestTriggerSpec
TestTriggerSpec defines the desired state of TestTrigger
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
resource TestTriggerResource | For which Resource do we monitor Event which triggers an Action on certain conditions | Enum: [pod deployment statefulset daemonset service ingress event configmap] | |
resourceSelector TestTriggerSelector | ResourceSelector identifies which Kubernetes Objects should be watched | ||
event TestTriggerEvent | On which Event for a Resource should an Action be triggered | Enum: [created modified deleted deployment-scale-update deployment-image-update deployment-env-update deployment-containers-modified event-start-test event-end-test-success event-end-test-failed event-end-test-aborted event-end-test-timeout event-start-testsuite event-end-testsuite-success event-end-testsuite-failed event-end-testsuite-aborted event-end-testsuite-timeout event-queue-testworkflow event-start-testworkflow event-end-testworkflow-success event-end-testworkflow-failed event-end-testworkflow-aborted event-created event-updated event-deleted] | |
conditionSpec TestTriggerConditionSpec | What resource conditions should be matched | ||
probeSpec TestTriggerProbeSpec | What resource probes should be matched | ||
action TestTriggerAction | Action represents what needs to be executed for selected Execution | Enum: [run] | |
execution TestTriggerExecution | Execution identifies for which test execution should an Action be executed | Enum: [test testsuite testworkflow] | |
testSelector TestTriggerSelector | TestSelector identifies on which Testkube Kubernetes Objects an Action should be taken | ||
concurrencyPolicy TestTriggerConcurrencyPolicy | ConcurrencyPolicy defines concurrency policy for selected Execution | Enum: [allow forbid replace] | |
delay Duration | Delay is a duration string which specifies how long should the test be delayed after a trigger is matched | Format: duration Type: string | |
disabled boolean | whether test trigger is disabled |
Variable
Underlying type: Variable
Appears in:
Field | Description | Default | Validation |
---|---|---|---|
type string | variable type | ||
name string | variable name | ||
value string | variable string value | ||
valueFrom EnvVarSource | or load it from var source |