Test Engine · Cicada

The TestEngine is a Kubernetes resource for creating the Cicada engine and managing file transfer before and after running Cicada


apiVersion:  cicada.io/v1
kind: TestEngine
metadata:
  name: your-test-name
spec:
  dependencies:
    - name: string
      labels: Map[string, string]
      statuses: List[string]
  ioConfig:
    S3_ENDPOINT: string
    S3_REGION: string
    S3_ACCESS_KEY_ID: string
    S3_SECRET_ACCESS_KEY: string
  engineConfig: Map[string, string]
  tests:
    pvc: string
    mountPath: string
    remotePath: string
    localPath: string
  reports:
    pvc: string
    mountPath: string
    remotePath: string
    localPath: string

dependencies

dependencies.name

Name of pod to check statuses of (optional)

dependencies.labels

Labels to find pods with if name is not specified

dependencies.statuses

List of allowed statuses for found pods to be in for check to succeed. Defaults to "Running" and "Succeeded" if not specified

See Pod Phase

ioConfig

ioConfig.S3_ENDPOINT

S3 endpoint of server to connect to

ioConfig.S3_REGION

Region S3 server is located

ioConfig.S3_ACCESS_KEY_ID

Access key to use when connecting to S3 server

ioConfig.S3_SECRET_ACCESS_KEY

Secret access key to use with access key ID for connecting to S3 server

ioConfig.USE_SSL

Flag to use SSL when downloading. Defaults to "true"

engineConfig

Map of environment variables to pass to engine. See Config

tests

tests.pvc

PersistentVolumeClaim where tests are stored in

tests.mountPath

Path to mount tests PVC to in Cicada engine

Defaults to /tests

tests.remotePath

Path to remotely stored tests. Allows for the following forms:

S3 path: s3://bucket/path/to/file(s)
Git path: git://org/repo.git/path/to/tests?protocol=https&branch=master

Note: S3 path is copied recursively Note: Git branch defaults to master Note: Git protocol defaults to https. Valid values are:

http
https
ftp
ftps
git
ssh

tests.localPath

Path to download tests to in IO initializer

Defaults to /{pvc}

reports

reports.pvc

PersistentVolumeClaim to store reports in

reports.mountPath

Path to mount reports PVC to in Cicada engine

Defaults to /reports

reports.remotePath

Remote path to upload reports to. Allows for the following forms:

S3 path: s3://bucket/path/where/files/should/be

Note: Files are copied from the directory recursively

reports.localPath

Path in IO Initializer to upload reports from

Defaults to /{pvc}