# KubeLibrary
[](https://circleci.com/gh/devopsspiral/KubeLibrary)[](https://pypi.org/project/robotframework-kubelibrary/)[](https://pypi.python.org/pypi/robotframework-kubelibrary)[](https://raw.githubusercontent.com/devopsspiral/k3d-orb/master/LICENSE)[](https://robotframework.slack.com/archives/C017AKKS06R)
RobotFramework library for testing Kubernetes cluster
## Quick start
```
# install library itself
pip install robotframework-kubelibrary
# export KUBECONFIG
export KUBECONFIG=~/.kube/config
# run example tests
pip install robotframework-requests
git clone https://github.com/devopsspiral/KubeLibrary.git
cd KubeLibrary
robot -e prerelease testcases
```
## Documentation
[Library docs](http://devopsspiral.com/KubeLibrary/)
## Example testcase
```
testcases/system_smoke.robot
*** Settings ***
(1)Resource ./system_smoke_kw.robot
*** Variables ***
(2)${KUBELET_VERSION} %{KUBELET_VERSION}
${NUM_NODES} 2
${NUM_WORKERS} 1
*** Test Cases ***
(3)Pods in kube-system are ok
(4) [Documentation] Test if all pods in kube-system initiated correctly and are running or succeeded
(5) [Tags] cluster smoke
(6) Given kubernetes API responds
(7) When getting all pods names in "kube-system"
(8) Then all pods in "kube-system" are running or succeeded
```
1 - keyword definitions in separate file relative to testcase file
2 - defining local variable taking value from environment variable
3 - testcase definition
4 - Documentation/comments
5 - Tags, you can include (-i) and exclude (-e) tests by tag.
6(7,8) - Given, When, Then clause. It is only way of organizing your test steps, given, when, then are just omitted, real keywords definition needs to match 'kubernetes API responds', 'getting all pods names in ...' etc.(see testcases/system_smoke_kw.robot)
7 - kube-system in quotes is treated as parameter for 'getting all pods names in ...' keyword.
More examples in testcases/ directory.
To see all the tests passing execute below commands.
### Cluster Tests
```
# run cluster tests
robot -i cluster -e prerelease testcases/
```
### Grafana Tests
```
helm repo add grafana https://grafana.github.io/helm-charts
helm repo update
helm install grafana grafana/grafana -f testcases/grafana/values.yaml
# run grafana tests
export KLIB_POD_PATTERN='grafana.*'
export KLIB_POD_ANNOTATIONS='{"kubelibrary":"testing"}'
export KLIB_POD_NAMESPACE=default
robot -i grafana -e prerelease 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 -e prerelease testcases/
```
### Multi Cluster Tests
These tests require more than one cluster and utilize [KinD](https://kind.sigs.k8s.io/) as a setup.
[Download KinD and install it.](https://kind.sigs.k8s.io/docs/user/quick-start/)
```
# 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
# For bearer token auth
kubectl apply -f testcases/reload-config/sa.yaml
MYSA_TOKEN_SECRET=$(kubectl get sa mysa -o jsonpath="{.secrets[0].name}")
export K8S_TOKEN=$(kubectl get secret $MYSA_TOKEN_SECRET --template={{.data.token}} | base64 -d)
kubectl get secret $MYSA_TOKEN_SECRET -o jsonpath="{.data.ca\.crt}" | base64 -d > ca.crt
export K8S_API_URL=$(kubectl config view -o jsonpath='{.clusters[0].cluster.server}')
export K8S_CA_CRT=./ca.crt
# 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 -e prerelease 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/.
## Proxy configuration
To access cluster via proxy set `http_proxy` or `HTTP_PROXY` environment variable.
In similar way you can set `no_proxy` or `NO_PROXY` variable to specify hosts that should be excluded from proxying.
**IMPORTANT:** Lowercase environment variables have higher priority than uppercase
## Further reading
[DevOps spiral article on KubeLibrary](https://devopsspiral.com/articles/k8s/robotframework-kubelibrary/)
[KubeLibrary: Testing Kubernetes with RobotFramework | Humanitec](https://humanitec.com/blog/kubelibrary-testing-kubernetes-with-robotframework)
[RobotFramework User Guide](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html)
## Development
```
# clone repo
git clone https://github.com/devopsspiral/KubeLibrary.git
cd KubeLibrary
# create virtualenv
virtualenv .venv
. .venv/bin/activate
pip install -r requirements-dev.txt
```
Create keyword and test file, import KubeLibrary using below to point to library under development.
```
*** Settings ***
Library ../src/KubeLibrary/KubeLibrary.py
```
For development cluster you can use k3s/k3d as described in [DevOps spiral article on K3d and skaffold](https://devopsspiral.com/articles/k8s/k3d-skaffold/).
### Generate docs
```
(
# To generate keyword documentation a connection
# to a cluster is not necessary. Skip to load a
# cluster configuration.
#
# Set the variable local for the libdoc call only
export INIT_FOR_LIBDOC_ONLY=1
python -m robot.libdoc src/KubeLibrary docs/index.html
)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/devopsspiral/KubeLibrary",
"name": "robotframework-kubelibrary",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "robotframework testing test automation kubernetes",
"author": "Micha\u0142 Wcis\u0142o",
"author_email": "mwcislo999@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/38/d9/d064b74227228daee90763f6c404d805c2485db55d2300d72d2912f2fb3e/robotframework-kubelibrary-0.8.7.tar.gz",
"platform": null,
"description": "# KubeLibrary\n[](https://circleci.com/gh/devopsspiral/KubeLibrary)[](https://pypi.org/project/robotframework-kubelibrary/)[](https://pypi.python.org/pypi/robotframework-kubelibrary)[](https://raw.githubusercontent.com/devopsspiral/k3d-orb/master/LICENSE)[](https://robotframework.slack.com/archives/C017AKKS06R)\n\n\nRobotFramework library for testing Kubernetes cluster\n\n## Quick start\n\n```\n# install library itself\npip install robotframework-kubelibrary\n\n# export KUBECONFIG\nexport KUBECONFIG=~/.kube/config\n\n# run example tests\npip install robotframework-requests\ngit clone https://github.com/devopsspiral/KubeLibrary.git\ncd KubeLibrary\nrobot -e prerelease testcases\n```\n\n## Documentation\n\n[Library docs](http://devopsspiral.com/KubeLibrary/)\n\n## Example testcase\n\n```\ntestcases/system_smoke.robot\n\n*** Settings ***\n(1)Resource ./system_smoke_kw.robot\n\n*** Variables ***\n(2)${KUBELET_VERSION} %{KUBELET_VERSION}\n${NUM_NODES} 2\n${NUM_WORKERS} 1\n\n*** Test Cases ***\n\n(3)Pods in kube-system are ok\n(4) [Documentation] Test if all pods in kube-system initiated correctly and are running or succeeded\n(5) [Tags] cluster smoke\n(6) Given kubernetes API responds\n(7) When getting all pods names in \"kube-system\"\n(8) Then all pods in \"kube-system\" are running or succeeded\n\n```\n\n1 - keyword definitions in separate file relative to testcase file\n\n2 - defining local variable taking value from environment variable\n\n3 - testcase definition\n\n4 - Documentation/comments\n\n5 - Tags, you can include (-i) and exclude (-e) tests by tag.\n\n6(7,8) - Given, When, Then clause. It is only way of organizing your test steps, given, when, then are just omitted, real keywords definition needs to match 'kubernetes API responds', 'getting all pods names in ...' etc.(see testcases/system_smoke_kw.robot)\n\n7 - kube-system in quotes is treated as parameter for 'getting all pods names in ...' keyword.\n\nMore examples in testcases/ directory.\n\nTo see all the tests passing execute below commands.\n\n\n### Cluster Tests\n```\n# run cluster tests\nrobot -i cluster -e prerelease testcases/\n```\n\n### Grafana Tests\n```\nhelm repo add grafana https://grafana.github.io/helm-charts\nhelm repo update\nhelm install grafana grafana/grafana -f testcases/grafana/values.yaml\n\n# run grafana tests\nexport KLIB_POD_PATTERN='grafana.*'\nexport KLIB_POD_ANNOTATIONS='{\"kubelibrary\":\"testing\"}'\nexport KLIB_POD_NAMESPACE=default\n\nrobot -i grafana -e prerelease testcases/\n```\n### Other Tests\nThese tests require the kubelib-test helm-chart to be installed in your test cluster.\n```\n# run other library tests\nexport KLIB_POD_PATTERN='busybox.*'\nexport KLIB_POD_NAMESPACE=kubelib-tests\nexport KLIB_POD_LABELS='job-name=busybox-job'\n\nkubectl create namespace $KLIB_POD_NAMESPACE\nkubectl label namespaces kubelib-tests test=test\nhelm install kubelib-test ./test-objects-chart -n $KLIB_POD_NAMESPACE\n\nrobot -i other -e prerelease testcases/\n```\n### Multi Cluster Tests\nThese tests require more than one cluster and utilize [KinD](https://kind.sigs.k8s.io/) as a setup.\n[Download KinD and install it.](https://kind.sigs.k8s.io/docs/user/quick-start/)\n```\n# Create Test Cluster 1\nkind create cluster --kubeconfig ./cluster1-conf --name kind-cluster-1\n\n# Create namespace in Test Cluster 1\nkubectl create namespace test-ns-1 --context kind-kind-cluster-1 --kubeconfig ./cluster1-conf\n# For bearer token auth\nkubectl apply -f testcases/reload-config/sa.yaml\nMYSA_TOKEN_SECRET=$(kubectl get sa mysa -o jsonpath=\"{.secrets[0].name}\")\nexport K8S_TOKEN=$(kubectl get secret $MYSA_TOKEN_SECRET --template={{.data.token}} | base64 -d)\nkubectl get secret $MYSA_TOKEN_SECRET -o jsonpath=\"{.data.ca\\.crt}\" | base64 -d > ca.crt\nexport K8S_API_URL=$(kubectl config view -o jsonpath='{.clusters[0].cluster.server}')\nexport K8S_CA_CRT=./ca.crt\n\n# Create Test Cluster 2\nkind create cluster --kubeconfig ./cluster2-conf --name kind-cluster-2\n\n# Create namespace in Test Cluster 2\nkubectl create namespace test-ns-2 --context kind-kind-cluster-2 --kubeconfig ./cluster2-conf\n\nrobot -i reload-config -e prerelease testcases/\n\n# Clean up\nkind delete cluster --name kind-cluster-1\nkind delete cluster --name kind-cluster-2\n```\n\n## Keywords documentation\n\nKeywords documentation can be found in docs/.\n\n## Proxy configuration\n\nTo access cluster via proxy set `http_proxy` or `HTTP_PROXY` environment variable. \n\nIn similar way you can set `no_proxy` or `NO_PROXY` variable to specify hosts that should be excluded from proxying.\n\n**IMPORTANT:** Lowercase environment variables have higher priority than uppercase\n\n## Further reading\n\n[DevOps spiral article on KubeLibrary](https://devopsspiral.com/articles/k8s/robotframework-kubelibrary/)\n\n[KubeLibrary: Testing Kubernetes with RobotFramework | Humanitec](https://humanitec.com/blog/kubelibrary-testing-kubernetes-with-robotframework)\n\n[RobotFramework User Guide](https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html)\n\n## Development\n\n```\n# clone repo\ngit clone https://github.com/devopsspiral/KubeLibrary.git\ncd KubeLibrary\n\n# create virtualenv\nvirtualenv .venv\n. .venv/bin/activate\npip install -r requirements-dev.txt\n```\n\nCreate keyword and test file, import KubeLibrary using below to point to library under development.\n\n```\n*** Settings ***\n\nLibrary ../src/KubeLibrary/KubeLibrary.py\n```\n\nFor development cluster you can use k3s/k3d as described in [DevOps spiral article on K3d and skaffold](https://devopsspiral.com/articles/k8s/k3d-skaffold/).\n\n### Generate docs\n\n```\n(\n # To generate keyword documentation a connection\n # to a cluster is not necessary. Skip to load a\n # cluster configuration.\n #\n # Set the variable local for the libdoc call only\n export INIT_FOR_LIBDOC_ONLY=1\n python -m robot.libdoc src/KubeLibrary docs/index.html\n)\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Kubernetes library for Robot Framework",
"version": "0.8.7",
"project_urls": {
"Homepage": "https://github.com/devopsspiral/KubeLibrary"
},
"split_keywords": [
"robotframework",
"testing",
"test",
"automation",
"kubernetes"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bd898c44a7b3cee6e2c6d28646ea4173585461ed074568403e390b227a85d5d1",
"md5": "6e2440bc6507a8d352d9b87ddfc476f9",
"sha256": "0b01f7a8156293f40d44bba48a4d8da20895bcaec3b4040fe3c1e1a83f3c4ae8"
},
"downloads": -1,
"filename": "robotframework_kubelibrary-0.8.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6e2440bc6507a8d352d9b87ddfc476f9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 13449,
"upload_time": "2023-11-19T18:26:07",
"upload_time_iso_8601": "2023-11-19T18:26:07.110288Z",
"url": "https://files.pythonhosted.org/packages/bd/89/8c44a7b3cee6e2c6d28646ea4173585461ed074568403e390b227a85d5d1/robotframework_kubelibrary-0.8.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "38d9d064b74227228daee90763f6c404d805c2485db55d2300d72d2912f2fb3e",
"md5": "63b188afbcc28bcdd717ce70a9edf94a",
"sha256": "69bef1485f1e6f1fa2ad3eb0f07997ec8e59bacea5f5f93e1107b01f1d4cdbad"
},
"downloads": -1,
"filename": "robotframework-kubelibrary-0.8.7.tar.gz",
"has_sig": false,
"md5_digest": "63b188afbcc28bcdd717ce70a9edf94a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 21659,
"upload_time": "2023-11-19T18:26:08",
"upload_time_iso_8601": "2023-11-19T18:26:08.624636Z",
"url": "https://files.pythonhosted.org/packages/38/d9/d064b74227228daee90763f6c404d805c2485db55d2300d72d2912f2fb3e/robotframework-kubelibrary-0.8.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-19 18:26:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "devopsspiral",
"github_project": "KubeLibrary",
"travis_ci": false,
"coveralls": true,
"github_actions": false,
"circle": true,
"requirements": [],
"lcname": "robotframework-kubelibrary"
}
JSON
