Testkube API Reference

Features described in this document are being deprecated as
part of the transition to Test Workflows - Read More.

Packages

• executor.testkube.io/v1

executor.testkube.io/v1

Package v1 contains API Schema definitions for the executor v1 API group

Resource Types

• Executor
• ExecutorList
• Webhook
• WebhookList
• WebhookTemplate
• WebhookTemplateList

EventType

Underlying type: string

Validation:

• Enum: [start-test end-test-success end-test-failed end-test-aborted end-test-timeout become-test-up become-test-down become-test-failed become-test-aborted become-test-timeout start-testsuite end-testsuite-success end-testsuite-failed end-testsuite-aborted end-testsuite-timeout become-testsuite-up become-testsuite-down become-testsuite-failed become-testsuite-aborted become-testsuite-timeout start-testworkflow queue-testworkflow end-testworkflow-success end-testworkflow-failed end-testworkflow-aborted become-testworkflow-up become-testworkflow-down become-testworkflow-failed become-testworkflow-aborted]

Appears in:

• WebhookSpec
• WebhookTemplateSpec

Field	Description
start-test
end-test-success
end-test-failed
end-test-aborted
end-test-timeout
become-test-up
become-test-down
become-test-failed
become-test-aborted
become-test-timeout
start-testsuite
end-testsuite-success
end-testsuite-failed
end-testsuite-aborted
end-testsuite-timeout
become-testsuite-up
become-testsuite-down
become-testsuite-failed
become-testsuite-aborted
become-testsuite-timeout
start-testworkflow
queue-testworkflow
end-testworkflow-success
end-testworkflow-failed
end-testworkflow-aborted
become-testworkflow-up
become-testworkflow-down
become-testworkflow-failed
become-testworkflow-aborted

Executor

Executor is the Schema for the executors API

Appears in:

• ExecutorList

Field	Description	Default	Validation
apiVersion string	executor.testkube.io/v1
kind string	Executor
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec ExecutorSpec

ExecutorList

ExecutorList contains a list of Executor

Field	Description	Default	Validation
apiVersion string	executor.testkube.io/v1
kind string	ExecutorList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items Executor array

ExecutorMeta

Executor meta data

Appears in:

• ExecutorSpec

Field	Description	Default	Validation
iconURI string	URI for executor icon
docsURI string	URI for executor docs
tooltips object (keys:string, values:string)	executor tooltips

ExecutorSpec

ExecutorSpec defines the desired state of Executor

Appears in:

• Executor

Field	Description	Default	Validation
types string array	Types defines what types can be handled by executor e.g. "postman/collection", ":curl/command" etc
executor_type ExecutorType	ExecutorType one of "rest" for rest openapi based executors or "job" which will be default runners for testkube or "container" for container executors		Enum: [job container]
uri string	URI for rest based executors
image string	Image for kube-job
args string array	executor binary arguments
command string array	executor default binary command
imagePullSecrets LocalObjectReference array	container executor default image pull secrets
features Feature array	Features list of possible features which executor handles		Enum: [artifacts junit-report]
content_types ScriptContentType array	ContentTypes list of handled content types		Enum: [string file-uri git-file git-dir git]
job_template string	Job template to launch executor
jobTemplateReference string	name of the template resource
meta ExecutorMeta	Meta data about executor
slaves SlavesMeta	Slaves data to run test in distributed environment
useDataDirAsWorkingDir boolean	use data dir as working dir for executor

ExecutorType

Underlying type: string

Validation:

• Enum: [job container]

Appears in:

• ExecutorSpec

Field	Description
job
container

Feature

Underlying type: string

Validation:

• Enum: [artifacts junit-report]

Appears in:

• ExecutorSpec

Field	Description
artifacts
junit-report

ScriptContentType

Underlying type: string

Validation:

• Enum: [string file-uri git-file git-dir git]

Appears in:

• ExecutorSpec

Field	Description
string
file-uri
git-file	Deprecated: use git instead
git-dir	Deprecated: use git instead
git

SecretRef

Testkube internal reference for secret storage in Kubernetes secrets

Appears in:

• WebhookConfigValue

Field	Description	Default	Validation
namespace string	object kubernetes namespace
name string	object name
key string	object key

SlavesMeta

Appears in:

• ExecutorSpec

Field	Description	Default	Validation
image string

Webhook

Webhook is the Schema for the webhooks API

Appears in:

• WebhookList

Field	Description	Default	Validation
apiVersion string	executor.testkube.io/v1
kind string	Webhook
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec WebhookSpec

WebhookConfigValue

webhook configuration value

Appears in:

• WebhookSpec
• WebhookTemplateSpec

Field	Description	Default	Validation
value string	public value to use in webhook template
secret SecretRef	private value stored in secret to use in webhook template

WebhookList

WebhookList contains a list of Webhook

Field	Description	Default	Validation
apiVersion string	executor.testkube.io/v1
kind string	WebhookList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items Webhook array

WebhookParameterSchema

webhook parameter schema

Appears in:

• WebhookSpec
• WebhookTemplateSpec

Field	Description	Default	Validation
name string	unique parameter name
description string	description for the parameter
required boolean	whether parameter is required
example string	example value for the parameter
default string	default parameter value
pattern string	regular expression to match

WebhookSpec

WebhookSpec defines the desired state of Webhook

Appears in:

• Webhook

Field	Description	Default	Validation
uri string	Uri is address where webhook should be made (golang template supported)
events EventType array	Events declare list if events on which webhook should be called		Enum: [start-test end-test-success end-test-failed end-test-aborted end-test-timeout become-test-up become-test-down become-test-failed become-test-aborted become-test-timeout start-testsuite end-testsuite-success end-testsuite-failed end-testsuite-aborted end-testsuite-timeout become-testsuite-up become-testsuite-down become-testsuite-failed become-testsuite-aborted become-testsuite-timeout start-testworkflow queue-testworkflow end-testworkflow-success end-testworkflow-failed end-testworkflow-aborted become-testworkflow-up become-testworkflow-down become-testworkflow-failed become-testworkflow-aborted]
selector string	Labels to filter for tests and test suites
payloadObjectField string	will load the generated payload for notification inside the object
payloadTemplate string	golang based template for notification payload
payloadTemplateReference string	name of the template resource
headers object (keys:string, values:string)	webhook headers (golang template supported)
disabled boolean	Disabled will disable the webhook
onStateChange boolean	OnStateChange will trigger the webhook only when the result of the current execution differs from the previous result of the same test/test suite/workflow Deprecated: field is not used
config object (keys:string, values:WebhookConfigValue)	webhook configuration
parameters WebhookParameterSchema array	webhook parameters
webhookTemplateRef WebhookTemplateRef	webhook template reference

WebhookTemplate

WebhookTemplate is the Schema for the webhook templates API

Appears in:

• WebhookTemplateList

Field	Description	Default	Validation
apiVersion string	executor.testkube.io/v1
kind string	WebhookTemplate
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec WebhookTemplateSpec

WebhookTemplateList

WebhookTemplateList contains a list of Webhook Template

Field	Description	Default	Validation
apiVersion string	executor.testkube.io/v1
kind string	WebhookTemplateList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items WebhookTemplate array

WebhookTemplateRef

webhook template reference

Appears in:

• WebhookSpec

Field	Description	Default	Validation
name string	webhook template name to include

WebhookTemplateSpec

WebhookTemplateSpec defines the desired state of Webhook Template

Appears in:

• WebhookTemplate

Field	Description	Default	Validation
uri string	Uri is address where webhook should be made (golang template supported)
events EventType array	Events declare list if events on which webhook should be called		Enum: [start-test end-test-success end-test-failed end-test-aborted end-test-timeout become-test-up become-test-down become-test-failed become-test-aborted become-test-timeout start-testsuite end-testsuite-success end-testsuite-failed end-testsuite-aborted end-testsuite-timeout become-testsuite-up become-testsuite-down become-testsuite-failed become-testsuite-aborted become-testsuite-timeout start-testworkflow queue-testworkflow end-testworkflow-success end-testworkflow-failed end-testworkflow-aborted become-testworkflow-up become-testworkflow-down become-testworkflow-failed become-testworkflow-aborted]
selector string	Labels to filter for tests and test suites
payloadObjectField string	will load the generated payload for notification inside the object
payloadTemplate string	golang based template for notification payload
payloadTemplateReference string	name of the template resource
headers object (keys:string, values:string)	webhook headers (golang template supported)
disabled boolean	Disabled will disable the webhook
config object (keys:string, values:WebhookConfigValue)	webhook configuration
parameters WebhookParameterSchema array	webhook parameters