Testkube CLI

Welcome to Testkube - Your friendly cloud-native testing framework for Kubernetes

Website | Documentation | Twitter | Slack | Blog

This is a Jenkins Plugin for managing your Testkube installation.

Use it to install Testkube CLI to manage your resources, run tests and test suites, or anything else.

• Testkube Jenkins Plugin
  • Table of content
  • Usage
    • Testkube Pro
    • Self-hosted instance
    • Examples
  • Inputs
    • Common
    • Kubernetes (kubectl)
    • Pro and Enterprise

To use the Jenkins Plugin for the Testkube Pro, you need to create API token.

Then, pass the TK_ORG , TK_ENV and TK_API_TOKEN environment variables to configure the CLI. Additional parameters can be passed to the CLI directly based on your use case:

pipeline {
    agent any

    environment {
        TK_ORG = "org-id"
        TK_ENV = "env-id"
        TK_API_TOKEN = credentials("tk_api_token")
    }
    stages {
        stage('Example') {
            steps {
                script {
                    setupTestkube()
                    sh 'testkube run test your-test'
                    sh 'testkube run testsuite your-test-suite --some-arg --other-arg'
                }
            }
        }
    }
}

Storing sensitive information directly in the workflow's YAML configuration is likely unsafe.
Instead, it's recommended to utilize Jenkins Credentials, a standard method for handling secrets, as detailed in the Jenkins documentation.

To connect to the self-hosted instance, you need to have kubectl configured for accessing your Kubernetes cluster, and simply passing optional namespace, if the Testkube is not deployed in the default testkube namespace, i.e.:

pipeline {
    agent any

    environment {
        TK_NAMESPACE = 'custom-testkube-namespace'
    }
    stages {
        stage('Example') {
            steps {
                script {
                    setupTestkube()
                    sh 'testkube run test your-test'
                }
            }
        }
    }
}

In addition to the common inputs, there are specific inputs for connecting to kubectl and Testkube Pro.