warning
Features described in this document are being deprecated as part of the transition to Test Workflows - Read More.
API Reference
Packages
tests.testkube.io/v3
Package v3 contains API Schema definitions for the tests v3 API group
Resource Types
ArgsModeType
Underlying type: ArgsModeType
Appears in:
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 |
DownloadArtifactOptions
options to download artifacts from previous steps
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
allPreviousSteps boolean | |||
previousStepNumbers integer array | previous step numbers starting from 1 | ||
previousTestNames string array | previous test names |
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 |
ExecutionCore
test execution core
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
id string | execution id | ||
number integer | execution number | ||
startTime Time | test start time | ||
endTime Time | test end time |
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 | ||
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 | ||
jobTemplateReference string | name of the template resource | ||
cronJobTemplate string | cron job template extensions | ||
cronJobTemplateReference string | name of the template resource | ||
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 | ||
scraperTemplateReference string | name of the template resource | ||
pvcTemplate string | pvc template extensions | ||
pvcTemplateReference string | name of the template resource | ||
envConfigMaps EnvReference array | config map references | ||
envSecrets EnvReference array | secret references | ||
slavePodRequest PodRequest | |||
executionNamespace string | namespace for test execution (Pro edition only) | ||
disableWebhooks boolean | whether webhooks should be called on execution Deprecated: field is not used |
GitAuthType
Underlying type: string
GitAuthType defines git auth type
Validation:
- Enum: [basic header]
Appears in:
| Field | Description |
|---|---|
basic | GitAuthTypeBasic for git basic auth requests |
header | GitAuthTypeHeader for git header auth requests |
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
pod resources request specification
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
requests ResourceRequest | |||
limits ResourceRequest |
Repository
Repository represents VCS repo, currently we're handling Git only
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
type string | VCS repository type | ||
uri string | uri of content file or git directory | ||
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 | ||
usernameSecret SecretRef | |||
tokenSecret SecretRef | |||
certificateSecret string | git auth certificate secret for private repositories | ||
workingDir string | if provided we checkout the whole repository and run test from this directory | ||
authType GitAuthType | auth type for git requests | Enum: [basic header] |
ResourceRequest
resource request specification
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
cpu string | requested cpu units | ||
memory string | requested memory units |
RunningContextType
Underlying type: string
Appears in:
| Field | Description |
|---|---|
user-cli | |
user-ui | |
testsuite | |
testtrigger | |
scheduler | |
| `` |
SecretRef
SecretRef is the Testkube internal reference for secret storage in Kubernetes secrets
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | object name | ||
key string | object key |
Test
Test is the Schema for the tests API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | tests.testkube.io/v3 | ||
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 |
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 |
TestList
TestList contains a list of Test
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | tests.testkube.io/v3 | ||
kind string | TestList | ||
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
items Test array |
TestSpec
TestSpec defines the desired state of Test
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
type string | test type | ||
name string | test name | ||
description string | test description | ||
content TestContent | test content object | ||
source string | reference to test source resource | ||
schedule string | schedule in cron job format for scheduled test execution | ||
executionRequest ExecutionRequest | |||
uploads string array | files to be used from minio uploads |
TestSuite
TestSuite is the Schema for the testsuites API
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | tests.testkube.io/v3 | ||
kind string | TestSuite | ||
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. | ||
spec TestSuiteSpec |
TestSuiteBatchStep
TestSuiteBatchStep is set of steps run in parallel
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
stopOnFailure boolean | |||
downloadArtifacts DownloadArtifactOptions | |||
execute TestSuiteStepSpec array |
TestSuiteExecutionCore
TestSuiteExecutionCore defines the observed state of TestSuiteExecution
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
id string | execution id | ||
startTime Time | test suite execution start time | ||
endTime Time | test suite execution end time |
TestSuiteExecutionRequest
test suite execution request body
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
name string | test execution custom name | ||
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 | timeout for test suite execution | ||
jobTemplate string | job template extensions | ||
jobTemplateReference string | name of the template resource | ||
cronJobTemplate string | cron job template extensions | ||
cronJobTemplateReference string | name of the template resource | ||
scraperTemplate string | scraper template extensions | ||
scraperTemplateReference string | name of the template resource | ||
pvcTemplate string | pvc template extensions | ||
pvcTemplateReference string | name of the template resource | ||
disableWebhooks boolean | whether webhooks should be called on execution Deprecated: field is not used |
TestSuiteList
TestSuiteList contains a list of TestSuite
| Field | Description | Default | Validation |
|---|---|---|---|
apiVersion string | tests.testkube.io/v3 | ||
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 TestSuiteBatchStep array | Before batch steps is list of batch tests which will be sequentially orchestrated for parallel tests in each batch | ||
steps TestSuiteBatchStep array | Batch steps is list of batch tests which will be sequentially orchestrated for parallel tests in each batch | ||
after TestSuiteBatchStep array | After batch steps is list of batch tests which will be sequentially orchestrated for parallel tests in each batch | ||
repeats integer | |||
description string | |||
schedule string | schedule in cron job format for scheduled test execution | ||
executionRequest TestSuiteExecutionRequest |
TestSuiteStepExecutionRequest
TestSuiteStepExecutionRequest contains parameters to be used by the executions. These fields will be passed to the execution when a Test Suite is queued for execution. TestSuiteStepExecutionRequest parameters have the highest priority. They override the values coming from Test Suites, Tests, and Test Executions.
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
executionLabels object (keys:string, values:string) | test execution labels | ||
variables object (keys:string, values:Variable) | |||
args string array | additional executor binary arguments | ||
argsMode ArgsModeType | usage mode for arguments | ||
command string array | executor binary command | ||
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 | ||
jobTemplate string | job template extensions | ||
jobTemplateReference string | job template extensions reference | ||
cronJobTemplate string | cron job template extensions | ||
cronJobTemplateReference string | cron job template extensions reference | ||
scraperTemplate string | scraper template extensions | ||
scraperTemplateReference string | scraper template extensions reference | ||
pvcTemplate string | pvc template extensions | ||
pvcTemplateReference string | pvc template extensions reference | ||
runningContext RunningContext | |||
disableWebhooks boolean | whether webhooks should be called on execution Deprecated: field is not used |
TestSuiteStepSpec
TestSuiteStepSpec for particular type will have config for possible step types
Appears in:
| Field | Description | Default | Validation |
|---|---|---|---|
test string | object name | ||
delay Duration | delay duration in time units | Format: duration Type: string | |
executionRequest TestSuiteStepExecutionRequest |
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 |