Development

Running with CRDs on a Kubernetes Cluster

To install Testkube CRDs into your local cluster, install the Testkube Helm chart or apply the CRD manifests from the Testkube repository directly:

kubectl apply -f https://raw.githubusercontent.com/kubeshop/testkube/main/config/crd/bases/

The next critical components are the Testkube API and an executor. You can use your own tests' executor or an existing one from Testkube.

Checkout the Testkube project and run a local API server:

make run-mongo-dev run-api

Next, run the Testkube Postman executor. The postman executor is MongoDB based so it will launch MongoDB with the API server step:

make run-executor

If you want to debug an API server locally, you can run a local kube-proxy which makes all calls to kube proxy URIs directly to API server instances.

make run-proxy

And when calling any of kubectl testkube subcommands, pass the direct client flag (-cdirect)

Install development executors by running them from the Testkube project:

make dev-install-local-executors

This will register Custom Resources for the following test types:

Create a Test Custom Resource with one of the types above to be executed on the given executor:

kubectl testkube create test --file my_collection_file.json --name my-test-name --type local-postman/collection

To summarize: type is the single relation between Test and Executor.

For debugging on Kubernetes, intercept the whole API Server (or Postman executor) service by using Telepresence.

Simply intercept the API server with the local instance.

To create/run tests pointed to in-cluster executors, start the API Server with telepresence mode:

make run-api-telepresence