Test
tests.testkube.io / v3
apiVersion: tests.testkube.io/v3
kind: Test
metadata:
name: example
apiVersion
string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind
string
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata
object
spec object
TestSpec defines the desired state of Test
content object
test content object
data
string
test content body
repository object
repository of test content
authType
string
auth type for git requests
enum:
basic, header
branch
string
branch/tag name for checkout
certificateSecret
string
git auth certificate secret for private repositories
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
tokenSecret object
SecretRef is the Testkube internal reference for secret storage in Kubernetes secrets
key
string required
object key
name
string required
object name
type
string
VCS repository type
uri
string
uri of content file or git directory
usernameSecret object
SecretRef is the Testkube internal reference for secret storage in Kubernetes secrets
key
string required
object key
name
string required
object name
workingDir
string
if provided we checkout the whole repository and run test from this directory
type
string
test type
enum:
string, file-uri, git-file, git-dir, git
uri
string
uri of test content
description
string
test description
executionRequest object
test execution request body
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.
format:
int64
args
[]string
additional executor binary arguments
argsMode
string
usage mode for arguments
enum:
append, override, replaceartifactRequest object
artifact request body with test artifacts
dirs
[]string
artifact directories for scraping
masks
[]string
regexp to filter scraped artifacts, single or comma separated
omitFolderPerExecution
boolean
don't use a separate folder for execution artifacts
sharedBetweenPods
boolean
whether to share volume between pods
sidecarScraper
boolean
run scraper as pod sidecar container
storageBucket
string
artifact bucket storage
storageClassName
string
artifact storage class name for container executor
useDefaultStorageClassName
boolean
whether to use default storage class name
volumeMountPath
string
artifact volume mount path for container executor
command
[]string
executor binary command
cronJobTemplate
string
cron job template extensions
cronJobTemplateReference
string
name of the template resource
disableWebhooks
boolean
whether webhooks should be called on execution
Deprecated: field is not used
envConfigMaps []object
config map references
mapToVariables
boolean
whether we shoud map to variables from resource
mount
boolean
whether we shoud mount resource
mountPath
string
where we shoud mount resource
reference object required
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
name
string
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
envSecrets []object
secret references
mapToVariables
boolean
whether we shoud map to variables from resource
mount
boolean
whether we shoud mount resource
mountPath
string
where we shoud mount resource
reference object required
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
name
string
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
envs
object
Environment variables passed to executor. Deprecated: use Basic Variables instead
executePostRunScriptBeforeScraping
boolean
execute post run script before scraping (prebuilt executor only)
executionLabels
object
test execution labels
executionNamespace
string
namespace for test execution (Pro edition only)
httpProxy
string
http proxy for executor containers
httpsProxy
string
https proxy for executor containers
image
string
container executor image
imagePullSecrets []object
container executor image pull secrets
name
string
Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?
isVariablesFileUploaded
boolean
jobTemplate
string
job template extensions
jobTemplateReference
string
name of the template resource
name
string
test execution custom name
namespace
string
test kubernetes namespace (\"testkube\" when not set)
negativeTest
boolean
negative test will fail the execution if it is a success and it will succeed if it is a failure
number
integer
test execution number
format:
int32
postRunScript
string
script to run after test execution
preRunScript
string
script to run before test execution
pvcTemplate
string
pvc template extensions
pvcTemplateReference
string
name of the template resource
scraperTemplate
string
scraper template extensions
scraperTemplateReference
string
name of the template resource
secretEnvs
object
Execution variables passed to executor from secrets. Deprecated: use Secret Variables instead
slavePodRequest object
pod request body
podTemplate
string
pod template extensions
podTemplateReference
string
name of the template resource
resources object
pod resources request specification
limits object
resource request specification
cpu
string
requested cpu units
memory
string
requested memory units
requests object
resource request specification
cpu
string
requested cpu units
memory
string
requested memory units
sourceScripts
boolean
run scripts using source command (container executor only)
sync
boolean
whether to start execution sync or async
testSecretUUID
string
test secret uuid
testSuiteName
string
unique test suite name (CRD Test suite name), if it's run as a part of test suite
testSuiteSecretUUID
string
test suite secret uuid, if it's run as a part of test suite
variables
object
variablesFile
string
variables file content - need to be in format for particular executor (e.g. postman envs file)
name
string
test name
schedule
string
schedule in cron job format for scheduled test execution
source
string
reference to test source resource
type
string
test type
uploads
[]string
files to be used from minio uploads
status object
TestStatus defines the observed state of Test
latestExecution object
latest execution result
endTime
string
test end time
format:
date-time
id
string
execution id
number
integer
execution number
format:
int32
startTime
string
test start time
format:
date-time
status
string
enum:
queued, running, passed, failed, aborted, timeoutNo matches. Try .spec.content for an exact path