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/v2

tests.testkube.io/v2

Package v2 contains API Schema definitions for the testkube v2 API group

Resource Types

• Script
• ScriptList
• Test
• TestList
• TestSuite
• TestSuiteList

Repository

Repository represents VCS repo, currently we're handling Git only

Appears in:

• TestContent

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
username string	git auth username for private repositories
token string	git auth token for private repositories

RunningContextType

Underlying type: string

Appears in:

• RunningContext

Field	Description
user-cli
user-ui
testsuite
testtrigger
scheduler
``

Script

Script is the Schema for the scripts API

Appears in:

• ScriptList

Field	Description	Default	Validation
apiVersion string	tests.testkube.io/v2
kind string	Script
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec ScriptSpec

ScriptContent

Appears in:

• ScriptSpec

Field	Description	Default	Validation
type string	script type
repository Repository	repository of script content
data string	script content body
uri string	uri of script content

ScriptList

ScriptList contains a list of Script

Field	Description	Default	Validation
apiVersion string	tests.testkube.io/v2
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:

• Script

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 ScriptContent	script content object
tags string array	script tags

Test

Test is the Schema for the tests API

Appears in:

• TestList

Field	Description	Default	Validation
apiVersion string	tests.testkube.io/v2
kind string	Test
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec TestSpec

TestContent

TestContent defines test content

Appears in:

• TestSpec

Field	Description	Default	Validation
type string	test type
repository Repository	repository of test content
data string	test content body
uri string	uri of test content

TestList

TestList contains a list of Test

Field	Description	Default	Validation
apiVersion string	tests.testkube.io/v2
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:

• Test

Field	Description	Default	Validation
type string	test type
name string	test execution custom name
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
content TestContent	test content object
schedule string	schedule in cron job format for scheduled test execution
executorArgs string array	additional executor binary arguments

TestSuite

TestSuite is the Schema for the testsuites API

Appears in:

• TestSuiteList

Field	Description	Default	Validation
apiVersion string	tests.testkube.io/v2
kind string	TestSuite
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec TestSuiteSpec

TestSuiteExecutionCore

test suite execution core

Appears in:

• TestSuiteStatus

Field	Description	Default	Validation
id string	execution id
startTime Time	test suite execution start time
endTime Time	test suite execution end time

TestSuiteExecutionRequest

TestSuiteExecutionRequest defines the execution request body

Appears in:

• TestSuiteSpec

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
cronJobTemplate string	cron job template extensions

TestSuiteList

TestSuiteList contains a list of TestSuite

Field	Description	Default	Validation
apiVersion string	tests.testkube.io/v2
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:

• TestSuite

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
executionRequest TestSuiteExecutionRequest

TestSuiteStepDelay

TestSuiteStepDelay contains step delay parameters

Appears in:

• TestSuiteStepSpec

Field	Description	Default	Validation
duration integer	Duration in ms

TestSuiteStepExecute

TestSuiteStepExecute defines step to be executed

Appears in:

• TestSuiteStepSpec

Field	Description	Default	Validation
namespace string
name string
stopOnFailure boolean

TestSuiteStepSpec

TestSuiteStepSpec for particular type will have config for possible step types

Appears in:

• TestSuiteSpec

Field	Description	Default	Validation
type TestSuiteStepType			Enum: [execute delay]
execute TestSuiteStepExecute
delay TestSuiteStepDelay

TestSuiteStepType

Underlying type: string

TestSuiteStepType defines different type of test suite steps

Validation:

• Enum: [execute delay]

Appears in:

• TestSuiteStepSpec

Field	Description
execute
delay

Variable

Underlying type: Variable

Appears in:

• TestSuiteExecutionRequest

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