diff options
Diffstat (limited to 'python-robotframework-kubelibrary.spec')
| -rw-r--r-- | python-robotframework-kubelibrary.spec | 646 |
1 files changed, 646 insertions, 0 deletions
diff --git a/python-robotframework-kubelibrary.spec b/python-robotframework-kubelibrary.spec new file mode 100644 index 0000000..0dd192f --- /dev/null +++ b/python-robotframework-kubelibrary.spec @@ -0,0 +1,646 @@ +%global _empty_manifest_terminate_build 0 +Name: python-robotframework-kubelibrary +Version: 0.8.5 +Release: 1 +Summary: Kubernetes library for Robot Framework +License: MIT +URL: https://github.com/devopsspiral/KubeLibrary +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/a4/49/e473b09b6af22e2b3be416da2c921193dd96b6ccda069f57d0e07b18a420/robotframework-kubelibrary-0.8.5.tar.gz +BuildArch: noarch + +Requires: python3-google-auth +Requires: python3-kubernetes +Requires: python3-robotframework +Requires: python3-urllib3-mock + +%description +# 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 +) +``` + + + + +%package -n python3-robotframework-kubelibrary +Summary: Kubernetes library for Robot Framework +Provides: python-robotframework-kubelibrary +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-robotframework-kubelibrary +# 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 +) +``` + + + + +%package help +Summary: Development documents and examples for robotframework-kubelibrary +Provides: python3-robotframework-kubelibrary-doc +%description help +# 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 +) +``` + + + + +%prep +%autosetup -n robotframework-kubelibrary-0.8.5 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-robotframework-kubelibrary -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Wed May 10 2023 Python_Bot <Python_Bot@openeuler.org> - 0.8.5-1 +- Package Spec generated |