Skip to main content

Kubernetes library for Robot Framework

Project description


RobotFramework library for testing Kubernetes cluster

Quick start

# install library itself
pip install robotframework-kubelibrary

export KUBECONFIG=~/.kube/config

# run example tests
pip install robotframework-requests
git clone
cd KubeLibrary
robot testcases

Example testcase

Pods in kube-system are ok
    [Documentation]  Test if all pods in kube-system initiated correctly and are running or succeeded
    [Tags]    cluster    smoke
    Given kubernetes API responds
    When getting all pods in  "kube-system"
    Then all pods in "kube-system" are running or succeeded

Grafana has correct version
    [Documentation]  Test if Grafana container image is in correct version
    [Tags]    grafana
    Given kubernetes API responds
    When accessing "grafana-" excluding "svclb" container images version in "default"
    Then "grafana/grafana:6.5.0" version is used

More examples in testcases/ directory.

To see all the tests passing execute below commands.

Cluster Tests

# run cluster tests
robot -i cluster testcases/

Grafana Tests

helm install grafana stable/grafana -f testcases/grafana/values.yaml

# run grafana tests
export KLIB_POD_PATTERN='grafana.*'
export KLIB_POD_ANNOTATIONS='{"checksum/config":"3bb97e1695589c9bcdf6a6cd10c03517286ab7697626e6f02dd6fb2bc4a27796"}'
export KLIB_POD_NAMESPACE=default

robot -i grafana testcases/

Octopus Tests

git clone
helm install octopus octopus/chart/octopus/

# run octopus tests
export KLIB_POD_PATTERN='octopus.*'
export KLIB_POD_LABELS='{"app":"octopus"}'
export KLIB_ENV_VARS='{"SECRET_NAME":"webhook-server-secret"}'
export KLIB_POD_NAMESPACE=default

robot -i octopus testcases/

Other Tests

These tests require the kubelib-test helm-chart to be installed in your test cluster.

# run other library tests
export KLIB_POD_PATTERN='busybox.*'
export KLIB_POD_NAMESPACE=kubelib-tests
export KLIB_POD_LABELS='job-name=busybox-job'

kubectl create namespace $KLIB_POD_NAMESPACE
kubectl label namespaces kubelib-tests test=test
helm install kubelib-test ./test-objects-chart -n $KLIB_POD_NAMESPACE

robot -i other testcases/

Multi Cluster Tests

These tests require more than one cluster and utilize KinD as a setup. Download KinD and install it.

# Create Test Cluster 1
kind create cluster --kubeconfig ./cluster1-conf --name kind-cluster-1

# Create namespace in Test Cluster 1
kubectl create namespace test-ns-1 --context kind-kind-cluster-1 --kubeconfig ./cluster1-conf

# Create Test Cluster 2
kind create cluster --kubeconfig ./cluster2-conf --name kind-cluster-2

# Create namespace in Test Cluster 2
kubectl create namespace test-ns-2 --context kind-kind-cluster-2 --kubeconfig ./cluster2-conf

robot -i reload-config testcases/

# Clean up
kind delete cluster --name kind-cluster-1
kind delete cluster --name kind-cluster-2

Keywords documentation

Keywords documentation can be found in docs/.

Further reading

DevOps spiral article on KubeLibrary

RobotFramewrok User Guide


# clone repo
git clone
cd KubeLibrary

# create virtualenv
virtualenv .venv
. .venv/bin/activate
pip install -r requirements

Create keyword and test file, import KubeLibrary using below to point to library under development.

| ***** Settings ***** |

| Library ../src/KubeLibrary/ |

For development cluster you can use k3s/k3d as described in DevOps spiral article on K3d and skaffold.

Generate docs

python -m robot.libdoc src/KubeLibrary/ docs/KubeLibrary.html

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for robotframework-kubelibrary, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size robotframework_kubelibrary-0.2.0-py3-none-any.whl (7.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size robotframework-kubelibrary-0.2.0.tar.gz (9.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page