Triggers

Dashboard

Testkube allows you to automate running tests and test suites by defining triggers on certain events for various Kubernetes resources.

What is a Testkube Test Trigger?

In generic terms, a Trigger defines an action which will be executed for a given execution when a certain event on a specific resource occurs. For example, we could define a TestTrigger which runs a Test when a ConfigMap gets modified.

Watch our video guide on using Testkube Test Triggers to perform Asynchronous Testing in Kubernetes.

Creating Test Triggers in the Testkube Dashboard

Click on the lightening bolt icon on the left of the Testkube IDE to open the dialog to create test triggers. Any current test triggers will be listed and the Create a new trigger button is at the top right of the screen.

The Create new trigger dialog opens:

Input the condition that will cause the trigger and click Next.

Input the action that will be the result of the trigger condition happening and click Create.

Get all the details in the video below!

Video Tutorial

CLI

Testkube allows you to automate running tests and test suites by defining triggers on certain events for various Kubernetes resources.

What is a Testkube Test Trigger?

In generic terms, a Trigger defines an action which will be executed for a given execution when a certain event on a specific resource occurs having a given concurrencyPolicy. For example, we could define a TestTrigger which runs a Test when a ConfigMap gets modified.

Watch our video guide on using Testkube Test Triggers to perform Asynchronous Testing in Kubernetes.

Custom Resource Definition Model

Selectors

The resourceSelector and testSelector fields support selecting resources either by name or using the Kubernetes Label Selector.

Each selector should specify the namespace of the object, otherwise the namespace defaults to testkube.

selector := resourceSelector | testSelector

Name Selector

Name selectors are used when we want to select a specific resource in a specific namespace.

selector:
  name: Kubernetes object name
  nameRegex: Kubernetes object name regex (for example, "test.*")
  namespace: Kubernetes object namespace (default is **testkube**)

Label Selector

Label selectors are used when we want to select a group of resources in a specific namespace.

selector:
  namespace: Kubernetes object namespace (default is **testkube**)
  labelSelector:
    matchLabels: map of key-value pairs
    matchExpressions:
      - key: label name
        operator: [In | NotIn | Exists | DoesNotExist
        values: list of values

Resource Conditions

Resource Conditions allows triggers to be defined based on the status conditions for a specific resource.

conditionSpec:
  timeout: Duration in seconds the test trigger waits for conditions, until its stopped.
  delay: Duration in seconds the test trigger waits between condition checks.
  conditions:
    - type: test trigger condition type
      status: test trigger condition status, supported values - True, False, Unknown
      reason: test trigger condition reason
      ttl: test trigger condition ttl

Resource Probes

Resource Probes allows triggers to be defined based on the probe status.

probeSpec:
  timeout: Duration in seconds the test trigger waits for probes, until its stopped.
  delay: Duration in seconds the test trigger waits between probes.
  probes:
    - scheme: test trigger condition probe scheme to connect to host, default is http
      host: test trigger condition probe host, default is pod ip or service name
      path: test trigger condition probe path to check, default is /
      port: test trigger condition probe port to connect
      headers: test trigger condition probe headers to submit

Supported Values

• Resource - pod, deployment, statefulset, daemonset, service, ingress, event, configmap
• Action - run
• Event - created, modified, deleted
• Execution - test, testsuite
• ConcurrencyPolicy - allow, forbid, replace

Example

Here is an example for a Test Trigger default/testtrigger-example which runs the TestSuite frontend/sanity-test when a deployment containing the label testkube.io/tier: backend gets modified and also has the conditions Progressing: True: NewReplicaSetAvailable and Available: True.

apiVersion: tests.testkube.io/v1
kind: TestTrigger
metadata:
  name: testtrigger-example
  namespace: default
spec:
  resource: deployment
  resourceSelector:
    labelSelector:
      matchLabels:
        testkube.io/tier: backend
  event: modified
  conditionSpec:
    timeout: 100
    delay: 2
    conditions:
      - type: Progressing
        status: "True"
        reason: "NewReplicaSetAvailable"
        ttl: 60
      - type: Available
        status: "True"
  probeSpec:
    timeout: 50
    delay: 1
    probes:
      - scheme: http
        host: testkube-api-server
        path: /health
        port: 8088
        headers:
          X-Token: "12345"
      - host: testkube-dashboard
        port: 8080
  action: run
  execution: testsuite
  concurrencyPolicy: allow
  testSelector:
    name: sanity-test
    namespace: frontend

Architecture

Testkube uses Informers to watch Kubernetes resources and register handlers on certain actions on the watched Kubernetes resources.

Informers are a reliable, scalable and fault-tolerant Kubernetes concept where each informer registers handlers with the Kubernetes API and gets notified by Kubernetes on each event on the watched resources.

API

Testkube exposes CRUD operations on test triggers in the REST API. Check out the Open API docs for more info.

Injected Environment Variables

The following environment variables are automatically injected into each triggered test pod:

WATCHER_EVENT_RESOURCE: resource type
WATCHER_EVENT_NAME: resource name
WATCHER_EVENT_NAMESPACE: resource namespace
WATCHER_EVENT_EVENT_TYPE: event type

Video Tutorial